Class Hierarchy
Class Attributes
Class Qualifiers
Properties
Methods
Associations in which the class can participate
Sub Profiling Summary
CIM_PhysicalExtent --> CIM_StorageExtent --> CIM_LogicalDevice --> CIM_EnabledLogicalElement --> CIM_LogicalElement --> CIM_ManagedSystemElement --> CIM_ManagedElement --> [top]
Class Declaration Attributes Name Value SUPERCLASS CIM_StorageExtent NAME CIM_PhysicalExtent
Class CIM_PhysicalExtent Qualifiers Name Type Value From Class Deprecated string CIM_ProtectedExtentBasedOn
CIM_CompositeExtentBasedOnCIM_PhysicalExtent Version string 2.7.0 CIM_PhysicalExtent Description string Deprecated - use CIM_ProtectedExtentBasedOn or CIM_CompositeExtentBasedOn instead. The information on check and user data is better expressed in the association that layers the storage, than in the extent itself. A PhysicalExtent is used to model an SCC RAID implementation. It defines the consecutive addressable block addresses on a single storage device, that are treated as a single StorageExtent and that are in the same StorageRedundancyGroup. An alternate possibility, if automatic configuration is used, is to instantiate or extend the AggregatePExtent class. CIM_PhysicalExtent Description string StorageExtent describes the capabilities and management of the various media that exist to store data and allow data retrieval. This superclass could be used to represent the various components of RAID (Hardware or Software) or as a raw logical extent on top of physical media. CIM_StorageExtent Description string An abstraction or emulation of a hardware entity, that may or may not be Realized in physical hardware. Any characteristics of a LogicalDevice that are used to manage its operation or configuration are contained in, or associated with, the LogicalDevice object. Examples of the operational properties of a Printer would be paper sizes supported, or detected errors. Examples of the configuration properties of a Sensor Device would be threshold settings. Various configurations could exist for a LogicalDevice. These configurations could be contained in Setting objects and associated with the LogicalDevice. CIM_LogicalDevice Description string This class extends LogicalElement to abstract the concept of an element that is enabled and disabled, such as a LogicalDevice or a ServiceAccessPoint. CIM_EnabledLogicalElement Description string CIM_LogicalElement is a base class for all the components of a System that represent abstract system components, such as Files, Processes, or LogicalDevices. CIM_LogicalElement Description string CIM_ManagedSystemElement is the base class for the System Element hierarchy. Any distinguishable component of a System is a candidate for inclusion in this class. Examples of system components include: - software components such as application servers, databases, and applications - operating system components such as files, processes, and threads - device components such as disk drives, controllers, processors, and printers - physical components such as chips and cards. CIM_ManagedSystemElement Description string ManagedElement is an abstract class that provides a common superclass (or top of the inheritance tree) for the non-association classes in the CIM Schema. CIM_ManagedElement
Property Qualifiers
Property BlockSize Qualifiers Name Type Value From Class Override string BlockSize CIM_PhysicalExtent MappingStrings string MIF.DMTF|Physical Extent|001.4 CIM_PhysicalExtent Description string Size in bytes of the blocks which form this StorageExtent. If variable block size, then the maximum block size in bytes should be specified. If the block size is unknown or if a block concept is not valid (for example, for AggregateExtents, Memory or LogicalDisks), enter a 1. CIM_PhysicalExtent Units string Bytes CIM_PhysicalExtent
Property NumberOfBlocks Qualifiers Name Type Value From Class Override string NumberOfBlocks CIM_PhysicalExtent MappingStrings string MIF.DMTF|Physical Extent|001.3 CIM_PhysicalExtent Description string Total number of logically contiguous blocks, of size Block Size, which form this Extent. The total size of the Extent can be calculated by multiplying BlockSize by NumberOfBlocks. If the BlockSize is 1, this property is the total size of the Extent. CIM_PhysicalExtent
Property UnitsBeforeCheckDataInterleave Qualifiers Name Type Value From Class Description string Number of bytes of user data to skip before starting the check data interleave. CIM_PhysicalExtent Units string Bytes CIM_PhysicalExtent MappingStrings string MIF.DMTF|Physical Extent|001.6 CIM_PhysicalExtent
Property UnitsOfCheckData Qualifiers Name Type Value From Class Description string Number of bytes to be reserved for check data. CIM_PhysicalExtent Units string Bytes CIM_PhysicalExtent MappingStrings string MIF.DMTF|Physical Extent|001.7 CIM_PhysicalExtent
Property UnitsOfUserData Qualifiers Name Type Value From Class Description string Number of bytes to be reserved for user data. CIM_PhysicalExtent Units string Bytes CIM_PhysicalExtent MappingStrings string MIF.DMTF|Physical Extent|001.8 CIM_PhysicalExtent
Property DataOrganization Qualifiers Name Type Value From Class Description string Type of data organization used. CIM_StorageExtent ValueMap string [See below.] CIM_StorageExtent Values string Other
Unknown
Fixed Block
Variable Block
Count Key DataCIM_StorageExtent
Name Value 0 Other 1 Unknown 2 Fixed Block 3 Variable Block 4 Count Key Data
Property Purpose Qualifiers Name Type Value From Class Description string A free form string describing the media and/or its use. CIM_StorageExtent MappingStrings string MIB.IETF|HOST-RESOURCES-MIB.hrStorageDescr CIM_StorageExtent
Property Access Qualifiers Name Type Value From Class Description string Access describes whether the media is readable (value=1), writeable (value=2), or both (value=3). " Unknown " (0) and " Write Once " (4) can also be defined. CIM_StorageExtent ValueMap string [See below.] CIM_StorageExtent Values string Unknown
Readable
Writeable
Read/Write Supported
Write OnceCIM_StorageExtent
Name Value 0 Unknown 1 Readable 2 Writeable 3 Read/Write Supported 4 Write Once
Property ErrorMethodology Qualifiers Name Type Value From Class Description string ErrorMethodology is a free-form string describing the type of error detection and correction supported by this StorageExtent. CIM_StorageExtent
Property BlockSize Qualifiers Name Type Value From Class Description string Size in bytes of the blocks which form this StorageExtent. If variable block size, then the maximum block size in bytes should be specified. If the block size is unknown or if a block concept is not valid (for example, for AggregateExtents, Memory or LogicalDisks), enter a 1. CIM_StorageExtent Units string Bytes CIM_StorageExtent MappingStrings string MIF.DMTF|Host Storage|001.4
MIB.IETF|HOST-RESOURCES-MIB.hrStorageAllocationUnits
MIF.DMTF|Storage Devices|001.5CIM_StorageExtent
Property NumberOfBlocks Qualifiers Name Type Value From Class Description string Total number of logically contiguous blocks, of size Block Size, which form this Extent. The total size of the Extent can be calculated by multiplying BlockSize by NumberOfBlocks. If the BlockSize is 1, this property is the total size of the Extent. CIM_StorageExtent MappingStrings string MIF.DMTF|Host Storage|001.5
MIB.IETF|HOST-RESOURCES-MIB.hrStorageSizeCIM_StorageExtent
Property ConsumableBlocks Qualifiers Name Type Value From Class Description string The maximum number of blocks, of size BlockSize, which are available for consumption when layering StorageExtents using the BasedOn association. This property only has meaning when this StorageExtent is an Antecedent reference in a BasedOn relationship. For example, a StorageExtent could be composed of 120 blocks. However, the Extent itself may use 20 blocks for redundancy data. If another StorageExtent is BasedOn this Extent, only 100 blocks would be available to it. This information ( ’ 100 blocks is available for consumption ’ ) is indicated in the ConsumableBlocks property. CIM_StorageExtent
Property IsBasedOnUnderlyingRedundancy Qualifiers Name Type Value From Class Description string True indicates that the underlying StorageExtent(s) participate in a StorageRedundancyGroup. CIM_StorageExtent
Property SequentialAccess Qualifiers Name Type Value From Class Description string Boolean set to TRUE if the Storage is sequentially accessed by a MediaAccessDevice. A TapePartition is an example of a sequentially accessed StorageExtent. StorageVolumes, Disk Partitions and LogicalDisks represent randomly accessed Extents. CIM_StorageExtent
Property ExtentStatus Qualifiers Name Type Value From Class Description string StorageExtents have additional status information beyond that captured in the OperationalStatus and other properties, inherited from ManagedSystemElement. This additional information (for example, " Protection Disabled " , value=9) is captured in the VolumeStatus property. CIM_StorageExtent ValueMap string [See below.] CIM_StorageExtent Values string Other
Unknown
None/Not Applicable
Broken
Data Lost
Dynamic Reconfig
Exposed
Fractionally Exposed
Partially Exposed
Protection Disabled
Readying
Rebuild
Recalculate
Spare in Use
Verify In Progress
DMTF Reserved
Vendor ReservedCIM_StorageExtent
Name Value 0 Other 1 Unknown 2 None/Not Applicable 3 Broken 4 Data Lost 5 Dynamic Reconfig 6 Exposed 7 Fractionally Exposed 8 Partially Exposed 9 Protection Disabled 10 Readying 11 Rebuild 12 Recalculate 13 Spare in Use 14 Verify In Progress 15..32767 DMTF Reserved 32768..65535 Vendor Reserved
Property NoSinglePointOfFailure Qualifiers Name Type Value From Class Description string Indicates whether or not there exists no single point of failure. CIM_StorageExtent ModelCorrespondence string CIM_StorageSetting.NoSinglePointOfFailure CIM_StorageExtent
Property DataRedundancy Qualifiers Name Type Value From Class Description string Number of complete copies of data currently maintained. CIM_StorageExtent ModelCorrespondence string CIM_StorageSetting.DataRedundancyGoal
CIM_StorageSetting.DataRedundancyMax
CIM_StorageSetting.DataRedundancyMinCIM_StorageExtent
Property PackageRedundancy Qualifiers Name Type Value From Class Description string How many physical packages can currently fail without data loss. For example, in the storage domain, this might be disk spindles. CIM_StorageExtent ModelCorrespondence string CIM_StorageSetting.PackageRedundancyGoal
CIM_StorageSetting.PackageRedundancyMax
CIM_StorageSetting.PackageRedundancyMinCIM_StorageExtent
Property DeltaReservation Qualifiers Name Type Value From Class Description string Current value for Delta reservation. This is a percentage that specifies the amount of space that should be reserved in a replica for caching changes. CIM_StorageExtent Units string Percentage CIM_StorageExtent MinValue sint64 1 CIM_StorageExtent MaxValue sint64 100 CIM_StorageExtent ModelCorrespondence string CIM_StorageSetting.DeltaReservationGoal
CIM_StorageSetting.DeltaReservationMax
CIM_StorageSetting.DeltaReservationMinCIM_StorageExtent
Property Primordial Qualifiers Name Type Value From Class Description string If true, " Primordial " indicates that the containing System does not have the ability to create or delete this operational element. This is important because StorageExtents are assembled into higher-level abstractions using the BasedOn association. Although the higher-level abstractions can be created and deleted, the most basic, (i.e. primordial), hardware-based storage entities cannot. They are physically realized as part of the System, or are actually managed by some other System and imported as if they were physically realized. In other words, a Primordial StorageExtent exists in, but is not created by its System and conversely a non-Primordial StorageExtent is created in the context of its System. For StorageVolumes, this property will generally be false. One use of this property is to enable algorithms that aggregate StorageExtent.ConsumableSpace across all, StorageExtents but that also want to distinquish the space that underlies Primordial StoragePools. Since implementations are not required to surface all Component StorageExtents of a StoragePool, this information is not accessible in any other way. CIM_StorageExtent
Property SystemCreationClassName Qualifiers Name Type Value From Class Key boolean true CIM_LogicalDevice Propagated string CIM_System.CreationClassName CIM_LogicalDevice Description string The scoping System ’ s CreationClassName. CIM_LogicalDevice MaxLen uint32 256 CIM_LogicalDevice
Property SystemName Qualifiers Name Type Value From Class Key boolean true CIM_LogicalDevice Propagated string CIM_System.Name CIM_LogicalDevice Description string The scoping System ’ s Name. CIM_LogicalDevice MaxLen uint32 256 CIM_LogicalDevice
Property CreationClassName Qualifiers Name Type Value From Class Key boolean true CIM_LogicalDevice Description string CreationClassName indicates the name of the class or the subclass used in the creation of an instance. When used with the other key properties of this class, this property allows all instances of this class and its subclasses to be uniquely identified. CIM_LogicalDevice MaxLen uint32 256 CIM_LogicalDevice
Property DeviceID Qualifiers Name Type Value From Class Key boolean true CIM_LogicalDevice Description string An address or other identifying information to uniquely name the LogicalDevice. CIM_LogicalDevice MaxLen uint32 64 CIM_LogicalDevice
Property PowerManagementSupported Qualifiers Name Type Value From Class Description string Boolean indicating that the Device can be power managed. The use of this property has been deprecated. Instead, the existence of an associated PowerManagementCapabilities class (associated using the ElementCapabilities relationhip) indicates that power management is supported. CIM_LogicalDevice
Property PowerManagementCapabilities Qualifiers Name Type Value From Class Description string An enumerated array describing the power management capabilities of the Device. The use of this property has been deprecated. Instead, the PowerCapabilites property in an associated PowerManagementCapabilities class should be used. CIM_LogicalDevice ValueMap string [See below.] CIM_LogicalDevice Values string Unknown
Not Supported
Disabled
Enabled
Power Saving Modes Entered Automatically
Power State Settable
Power Cycling Supported
Timed Power On SupportedCIM_LogicalDevice
Name Value 0 Unknown 1 Not Supported 2 Disabled 3 Enabled 4 Power Saving Modes Entered Automatically 5 Power State Settable 6 Power Cycling Supported 7 Timed Power On Supported
Property Availability Qualifiers Name Type Value From Class Description string The primary availability and status of the Device. (Additional status information can be specified using the Additional Availability array property.) For example, the Availability property indicates that the Device is running and has full power (value=3), or is in a warning (4), test (5), degraded (10) or power save state (values 13-15 and 17). Regarding the Power Save states, these are defined as follows: Value 13 ( " Power Save - Unknown " ) indicates that the Device is known to be in a power save mode, but its exact status in this mode is unknown; 14 ( " Power Save - Low Power Mode " ) indicates that the Device is in a power save state but still functioning, and may exhibit degraded performance; 15 ( " Power Save - Standby " ) describes that the Device is not functioning but could be brought to full power ’ quickly ’ ; and value 17 ( " Power Save - Warning " ) indicates that the Device is in a warning state, though also in a power save mode. CIM_LogicalDevice ValueMap string [See below.] CIM_LogicalDevice Values string Other
Unknown
Running/Full Power
Warning
In Test
Not Applicable
Power Off
Off Line
Off Duty
Degraded
Not Installed
Install Error
Power Save - Unknown
Power Save - Low Power Mode
Power Save - Standby
Power Cycle
Power Save - Warning
Paused
Not Ready
Not Configured
QuiescedCIM_LogicalDevice MappingStrings string MIF.DMTF|Operational State|006.5
MIB.IETF|HOST-RESOURCES-MIB.hrDeviceStatus
MIF.DMTF|Host Device|001.5CIM_LogicalDevice ModelCorrespondence string CIM_LogicalDevice.AdditionalAvailability CIM_LogicalDevice
Name Value 1 Other 2 Unknown 3 Running/Full Power 4 Warning 5 In Test 6 Not Applicable 7 Power Off 8 Off Line 9 Off Duty 10 Degraded 11 Not Installed 12 Install Error 13 Power Save - Unknown 14 Power Save - Low Power Mode 15 Power Save - Standby 16 Power Cycle 17 Power Save - Warning 18 Paused 19 Not Ready 20 Not Configured 21 Quiesced
Property StatusInfo Qualifiers Name Type Value From Class Description string The StatusInfo property indicates whether the Logical Device is in an enabled (value = 3), disabled (value = 4) or some other (1) or unknown (2) state. If this property does not apply to the LogicalDevice, the value, 5 ( " Not Applicable " ), should be used. StatusInfo has been deprecated in lieu of a more clearly named property with additional enumerated values (EnabledState), that is inherited from ManagedSystemElement. If a Device is ( " Enabled " )(value=3), it has been powered up, and is configured and operational. The Device may or may not be functionally active, depending on whether its Availability (or AdditionalAvailability) indicate that it is ( " Running/Full Power " )(value=3) or ( " Off line " ) (value=8). In an enabled but offline mode, a Device may be performing out-of-band requests, such as running Diagnostics. If ( " Disabled " ) StatusInfo value=4), a Device can only be " enabled " or powered off. In a personal computer environment, ( " Disabled " ) means that the Device ’ s driver is not available in the stack. In other environments, a Device can be disabled by removing its configuration file. A disabled device is physically present in a System and consuming resources, but can not be communicated with until a load of a driver, a load of a configuration file or some other " enabling " activity has occurred. CIM_LogicalDevice ValueMap string [See below.] CIM_LogicalDevice Values string Other
Unknown
Enabled
Disabled
Not ApplicableCIM_LogicalDevice MappingStrings string MIF.DMTF|Operational State|006.4 CIM_LogicalDevice
Name Value 1 Other 2 Unknown 3 Enabled 4 Disabled 5 Not Applicable
Property LastErrorCode Qualifiers Name Type Value From Class Description string LastErrorCode captures the last error code reported by the LogicalDevice. CIM_LogicalDevice
Property ErrorDescription Qualifiers Name Type Value From Class Description string ErrorDescription is a free-form string supplying more information about the error recorded in LastErrorCode, and information on any corrective actions that may be taken. CIM_LogicalDevice
Property ErrorCleared Qualifiers Name Type Value From Class Description string ErrorCleared is a boolean property indicating that the error reported in LastErrorCode is now cleared. CIM_LogicalDevice
Property OtherIdentifyingInfo Qualifiers Name Type Value From Class Description string OtherIdentifyingInfo captures additional data, beyond DeviceID information, that could be used to identify a LogicalDevice. One example would be to hold the Operating System ’ s user friendly name for the Device in this property. CIM_LogicalDevice MaxLen uint32 256 CIM_LogicalDevice ArrayType string Indexed CIM_LogicalDevice ModelCorrespondence string CIM_LogicalDevice.IdentifyingDescriptions CIM_LogicalDevice
Property PowerOnHours Qualifiers Name Type Value From Class Description string The number of consecutive hours that this Device has been powered, since its last power cycle. CIM_LogicalDevice Units string Hours CIM_LogicalDevice Counter boolean true CIM_LogicalDevice
Property TotalPowerOnHours Qualifiers Name Type Value From Class Description string The total number of hours that this Device has been powered. CIM_LogicalDevice Units string Hours CIM_LogicalDevice Counter boolean true CIM_LogicalDevice
Property IdentifyingDescriptions Qualifiers Name Type Value From Class Description string An array of free-form strings providing explanations and details behind the entries in the OtherIdentifyingInfo array. Note, each entry of this array is related to the entry in OtherIdentifyingInfo that is located at the same index. CIM_LogicalDevice ArrayType string Indexed CIM_LogicalDevice ModelCorrespondence string CIM_LogicalDevice.OtherIdentifyingInfo CIM_LogicalDevice
Property AdditionalAvailability Qualifiers Name Type Value From Class Description string Additional availability and status of the Device, beyond that specified in the Availability property. The Availability property denotes the primary status and availability of the Device. In some cases, this will not be sufficient to denote the complete status of the Device. In those cases, the AdditionalAvailability property can be used to provide further information. For example, a Device ’ s primary Availability may be " Off line " (value=8), but it may also be in a low power state (AdditonalAvailability value=14), or the Device could be running Diagnostics (AdditionalAvailability value=5, " In Test " ). CIM_LogicalDevice ValueMap string [See below.] CIM_LogicalDevice Values string Other
Unknown
Running/Full Power
Warning
In Test
Not Applicable
Power Off
Off Line
Off Duty
Degraded
Not Installed
Install Error
Power Save - Unknown
Power Save - Low Power Mode
Power Save - Standby
Power Cycle
Power Save - Warning
Paused
Not Ready
Not Configured
QuiescedCIM_LogicalDevice ModelCorrespondence string CIM_LogicalDevice.Availability CIM_LogicalDevice
Name Value 1 Other 2 Unknown 3 Running/Full Power 4 Warning 5 In Test 6 Not Applicable 7 Power Off 8 Off Line 9 Off Duty 10 Degraded 11 Not Installed 12 Install Error 13 Power Save - Unknown 14 Power Save - Low Power Mode 15 Power Save - Standby 16 Power Cycle 17 Power Save - Warning 18 Paused 19 Not Ready 20 Not Configured 21 Quiesced
Property MaxQuiesceTime Qualifiers Name Type Value From Class Description string The MaxQuiesceTime property has been deprecated. When evaluating the use of Quiesce, it was determine that this single property is not adequate for describing when a device will automatically exit a quiescent state. In fact, the most likely scenario for a device to exit a quiescent state was determined to be based on the number of outstanding requests queued rather than on a maximum time. This will be re-evaluated and repositioned later. Maximum time in milliseconds, that a Device can run in a " Quiesced " state. A Device ’ s state is defined in its Availability and AdditionalAvailability properties, where " Quiesced " is conveyed by the value 21. What occurs at the end of the time limit is device-specific. The Device may unquiesce, may offline or take other action. A value of 0 indicates that a Device can remain quiesced indefinitely. CIM_LogicalDevice Units string MilliSeconds CIM_LogicalDevice
Property EnabledState Qualifiers Name Type Value From Class Description string EnabledState is an integer enumeration that indicates the enabled/disabled states of an element. It can also indicate the transitions between these requested states. For example, shutting down (value = 4) and starting (value=10) are transient states between enabled and disabled. The following text briefly summarizes the various enabled/disabled states: Enabled (2) indicates that the element is/could be executing commands, will process any queued commands, and queues new requests. Disabled (3) indicates that the element will not execute commands and will drop any new requests. Shutting Down (4) indicates that the element is in the process of going to a Disabled state. Not Applicable (5) indicates the element doesn ’ t support being enabled/disabled. Enabled but Offline (6) indicates that the element may be completing commands, and will drop any new requests. Test (7) indicates that the element is in a test state. Deferred (8) indicates that the element may be completing commands, but will queue any new requests. Quiesce (9) indicates that the element is enabled but in a restricted mode. The element ’ s behavior is similar to the Enabled state, but it only processes a restricted set of commands. All other requests are queued. Starting (10) indicates that the element is in the process of going to an Enabled state. New requests are queued. CIM_EnabledLogicalElement ValueMap string [See below.] CIM_EnabledLogicalElement Values string Unknown
Other
Enabled
Disabled
Shutting Down
Not Applicable
Enabled but Offline
In Test
Deferred
Quiesce
Starting
DMTF Reserved
Vendor ReservedCIM_EnabledLogicalElement ModelCorrespondence string CIM_EnabledLogicalElement.OtherEnabledState CIM_EnabledLogicalElement
Name Value 0 Unknown 1 Other 2 Enabled 3 Disabled 4 Shutting Down 5 Not Applicable 6 Enabled but Offline 7 In Test 8 Deferred 9 Quiesce 10 Starting 11..32767 DMTF Reserved 32768..65535 Vendor Reserved
Property OtherEnabledState Qualifiers Name Type Value From Class Description string A string describing the element ’ s enabled/disabled state when the EnabledState property is set to 1 ( " Other " ). This property MUST be set to NULL when EnabledState is any value other than 1. CIM_EnabledLogicalElement ModelCorrespondence string CIM_EnabledLogicalElement.EnabledState CIM_EnabledLogicalElement
Property RequestedState Qualifiers Name Type Value From Class Description string RequestedState is an integer enumeration indicating the last requested or desired state for the element. The actual state of the element is represented by EnabledState. This property is provided to compare the last requested and current enabled/disabled states. Note that when EnabledState is set to 5 ( " Not Applicable " ), then this property has no meaning. By default, the element ’ s RequestedState is 5 ( " No Change " ). Refer to the EnabledState ’ s property Description for explanations of the values in the RequestedState enumeration. It should be noted that there are two new values in RequestedState that build on the statuses of EnabledState. These are " Reboot " (10) and " Reset " (11). The former, Reboot, refers to doing a " Shut Down " and then moving to an " Enabled " state. The latter, Reset, indicates that the element is first " Disabled " and then " Enabled " . The distinction between requesting " Shut Down " and " Disabled " should also be noted. The former, Shut Down, requests an orderly transition to the Disabled state, and MAY involve removing power, to completely erase any existing state. The latter, the Disabled state, requests an immediate disabling of the element, such that it will not execute or accept any commands or processing requests. This property is set as the result of a method invocation (such as Start or StopService on CIM_Service), or may be overridden and defined as WRITEable in a subclass. The method approach is considered superior to a WRITEable property, since it allows an explicit invocation of the operation and the return of a result code. CIM_EnabledLogicalElement ValueMap string [See below.] CIM_EnabledLogicalElement Values string Enabled
Disabled
Shut Down
No Change
Offline
Test
Deferred
Quiesce
Reboot
Reset
DMTF Reserved
Vendor ReservedCIM_EnabledLogicalElement ModelCorrespondence string CIM_EnabledLogicalElement.EnabledState CIM_EnabledLogicalElement
Name Value 2 Enabled 3 Disabled 4 Shut Down 5 No Change 6 Offline 7 Test 8 Deferred 9 Quiesce 10 Reboot 11 Reset .. DMTF Reserved 32768..65535 Vendor Reserved
Property EnabledDefault Qualifiers Name Type Value From Class Write boolean true CIM_EnabledLogicalElement Description string An enumerated value indicating an administrator ’ s default/startup configuration for an element ’ s Enabled State. By default, the element is " Enabled " (value=2). CIM_EnabledLogicalElement ValueMap string [See below.] CIM_EnabledLogicalElement Values string Enabled
Disabled
Not Applicable
Enabled but Offline
No Default
DMTF Reserved
Vendor ReservedCIM_EnabledLogicalElement
Name Value 2 Enabled 3 Disabled 5 Not Applicable 6 Enabled but Offline 7 No Default 8..32767 DMTF Reserved 32768..65535 Vendor Reserved
Property TimeOfLastStateChange Qualifiers Name Type Value From Class Description string The date/time when the element ’ s EnabledState last changed. If the state of the element has not changed and this property is populated, then it MUST be set to a 0 interval value. If a state change was requested, but rejected or not yet processed, the property MUST NOT be updated. CIM_EnabledLogicalElement
Property InstallDate Qualifiers Name Type Value From Class Description string A datetime value indicating when the object was installed. A lack of a value does not indicate that the object is not installed. CIM_ManagedSystemElement MappingStrings string MIF.DMTF|ComponentID|001.5 CIM_ManagedSystemElement
Property Name Qualifiers Name Type Value From Class Description string The Name property defines the label by which the object is known. When subclassed, the Name property can be overridden to be a Key property. CIM_ManagedSystemElement MaxLen uint32 1024 CIM_ManagedSystemElement
Property OperationalStatus Qualifiers Name Type Value From Class Description string Indicates the current status(es) of the element. Various health and operational statuses are defined. Many of the enumeration ’ s values are self- explanatory. However, a few are not and are described in more detail. " Stressed " indicates that the element is functioning, but needs attention. Examples of " Stressed " states are overload, overheated, etc. " Predictive Failure " indicates that an element is functioning nominally but predicting a failure in the near future. " In Service " describes an element being configured, maintained, cleaned, or otherwise administered. " No Contact " indicates that the monitoring system has knowledge of this element, but has never been able to establish communications with it. " Lost Communication " indicates that the ManagedSystem Element is known to exist and has been contacted successfully in the past, but is currently unreachable. " Stopped " and " Aborted " are similar, although the former implies a clean and orderly stop, while the latter implies an abrupt stop where the element ’ s state and configuration may need to be updated. " Dormant " indicates that the element is inactive or quiesced. " Supporting Entity in Error " describes that this element may be " OK " but that another element, on which it is dependent, is in error. An example is a network service or endpoint that cannot function due to lower layer networking problems. " Completed " indicates the element has completed its operation. This value should be combined with either OK, Error, or Degraded so that a client can till if the complete operation passed (Completed with OK), and failure (Completed with Error). Completed with Degraded would imply the operation finished, but did not complete OK or report an error. " Power Mode " indicates the element has additional power model information contained in the Associated PowerManagementService association. OperationalStatus replaces the Status property on ManagedSystemElement to provide a consistent approach to enumerations, to address implementation needs for an array property, and to provide a migration path from today ’ s environment to the future. This change was not made earlier since it required the DEPRECATED qualifier. Due to the widespread use of the existing Status property in management applications, it is strongly RECOMMENDED that providers/instrumentation provide BOTH the Status and OperationalStatus properties. Further, the first value of OperationalStatus SHOULD contain the primary status for the element. When instrumented, Status (since it is single-valued) SHOULD also provide the primary status of the element. CIM_ManagedSystemElement ValueMap string [See below.] CIM_ManagedSystemElement Values string Unknown
Other
OK
Degraded
Stressed
Predictive Failure
Error
Non-Recoverable Error
Starting
Stopping
Stopped
In Service
No Contact
Lost Communication
Aborted
Dormant
Supporting Entity in Error
Completed
Power Mode
DMTF Reserved
Vendor ReservedCIM_ManagedSystemElement ArrayType string Indexed CIM_ManagedSystemElement ModelCorrespondence string CIM_ManagedSystemElement.StatusDescriptions CIM_ManagedSystemElement
Name Value 0 Unknown 1 Other 2 OK 3 Degraded 4 Stressed 5 Predictive Failure 6 Error 7 Non-Recoverable Error 8 Starting 9 Stopping 10 Stopped 11 In Service 12 No Contact 13 Lost Communication 14 Aborted 15 Dormant 16 Supporting Entity in Error 17 Completed 18 Power Mode .. DMTF Reserved 0x8000.. Vendor Reserved
Property StatusDescriptions Qualifiers Name Type Value From Class Description string Strings describing the various OperationalStatus array values. For example, if " Stopping " is the value assigned to OperationalStatus, then this property may contain an explanation as to why an object is being stopped. Note that entries in this array are correlated with those at the same array index in OperationalStatus. CIM_ManagedSystemElement ArrayType string Indexed CIM_ManagedSystemElement ModelCorrespondence string CIM_ManagedSystemElement.OperationalStatus CIM_ManagedSystemElement
Property Status Qualifiers Name Type Value From Class Description string A string indicating the current status of the object. Various operational and non-operational statuses are defined. This property is deprecated in lieu of OperationalStatus, which includes the same semantics in its enumeration. This change is made for 3 reasons: 1) Status is more correctly defined as an array. This overcomes the limitation of describing status via a single value, when it is really a multi-valued property (for example, an element may be OK AND Stopped. 2) A MaxLen of 10 is too restrictive and leads to unclear enumerated values. And, 3) The change to a uint16 data type was discussed when CIM V2.0 was defined. However, existing V1.0 implementations used the string property and did not want to modify their code. Therefore, Status was grandfathered into the Schema. Use of the Deprecated qualifier allows the maintenance of the existing property, but also permits an improved definition using OperationalStatus. CIM_ManagedSystemElement ValueMap string [See below.] CIM_ManagedSystemElement MaxLen uint32 10 CIM_ManagedSystemElement
Name Value OK [none] Error [none] Degraded [none] Unknown [none] Pred Fail [none] Starting [none] Stopping [none] Service [none] Stressed [none] NonRecover [none] No Contact [none] Lost Comm [none] Stopped [none]
Property Caption Qualifiers Name Type Value From Class Description string The Caption property is a short textual description (one- line string) of the object. CIM_ManagedElement MaxLen uint32 64 CIM_ManagedElement
Property Description Qualifiers Name Type Value From Class Description string The Description property provides a textual description of the object. CIM_ManagedElement
Property ElementName Qualifiers Name Type Value From Class Description string A user-friendly name for the object. This property allows each instance to define a user-friendly name IN ADDITION TO its key properties/identity data, and description information. Note that ManagedSystemElement ’ s Name property is also defined as a user-friendly name. But, it is often subclassed to be a Key. It is not reasonable that the same property can convey both identity and a user friendly name, without inconsistencies. Where Name exists and is not a Key (such as for instances of LogicalDevice), the same information MAY be present in both the Name and ElementName properties. CIM_ManagedElement
Name Type Value Qualifiers Parameters ClassOrigin SetPowerState uint32 Deprecated
DescriptionPowerState
TimeCIM_LogicalDevice Reset uint32 Description CIM_LogicalDevice EnableDevice uint32 Deprecated
DescriptionEnabled CIM_LogicalDevice OnlineDevice uint32 Deprecated
DescriptionOnline CIM_LogicalDevice QuiesceDevice uint32 Deprecated
DescriptionQuiesce CIM_LogicalDevice SaveProperties uint32 Description CIM_LogicalDevice RestoreProperties uint32 Description CIM_LogicalDevice RequestStateChange uint32 Description
ValueMap
Values
ModelCorrespondenceRequestedState
TimeoutPeriodCIM_EnabledLogicalElement Method Qualifiers
Method SetPowerState Qualifiers Name Type Value From Class Description string Sets the power state of the Device. The use of this method has been deprecated. Instead, use the SetPowerState method in the associated PowerManagementService class. CIM_LogicalDevice
Method Reset Qualifiers Name Type Value From Class Description string Requests a reset of the LogicalDevice. The return value should be 0 if the request was successfully executed, 1 if the request is not supported and some other value if an error occurred. In a subclass, the set of possible return codes could be specified, using a ValueMap qualifier on the method. The strings to which the ValueMap contents are ’ translated ’ may also be specified in the subclass as a Values array qualifier. CIM_LogicalDevice
Method EnableDevice Qualifiers Name Type Value From Class Description string The EnableDevice method has been deprecated in lieu of the more general RequestStateChange method that directly overlaps with the functionality provided by this method. Requests that the LogicalDevice be enabled ( " Enabled " input parameter = TRUE) or disabled (= FALSE). If successful, the Device ’ s StatusInfo/EnabledState properties should reflect the desired state (enabled/disabled). Note that this method ’ s function overlaps with the RequestedState property. RequestedState was added to the model to maintain a record (i.e., a persisted value) of the last state request. Invoking the EnableDevice method should set the RequestedState property appropriately. The return code should be 0 if the request was successfully executed, 1 if the request is not supported and some other value if an error occurred. In a subclass, the set of possible return codes could be specified, using a ValueMap qualifier on the method. The strings to which the ValueMap contents are ’ translated ’ may also be specified in the subclass as a Values array qualifier. CIM_LogicalDevice
Method OnlineDevice Qualifiers Name Type Value From Class Description string The OnlineDevice method has been deprecated in lieu of the more general RequestStateChange method that directly overlaps with the functionality provided by this method. Requests that the LogicalDevice be brought online ( " Online " input parameter = TRUE) or taken offline (= FALSE). " Online " indicates that the Device is ready to accept requests, and is operational and fully functioning. In this case, the Device ’ s Availability property would be set to a value of 3 ( " Running/Full Power " ). " Offline " indicates that a Device is powered up and operational, but not processing functional requests. In an offline state, a Device may be capable of running diagnostics or generating operational alerts. For example, when the " Offline " button is pushed on a Printer, the Device is no longer available to process print jobs, but could be available for diagnostics or maintenance. If this method is successful, the Device ’ s Availability and AdditionalAvailability properties should reflect the updated status. If a failure occurs trying to bring the Device online or offline, it should remain in its current state. IE, the request, if unsuccessful, should not leave the Device in an indeterminate state. When bringing a Device back " Online " , from an " Offline " mode, the Device should be restored to its last " Online " state, if at all possible. Only a Device that has an EnabledState/StatusInfo of " Enabled " and has been configured can be brought online or taken offline. OnlineDevice should return 0 if successful, 1 if the request is not supported at all, 2 if the request is not supported due to the current state of the Device, and some other value if any other error occurred. In a subclass, the set of possible return codes could be specified, using a ValueMap qualifier on the method. The strings to which the ValueMap contents are ’ translated ’ may also be specified in the subclass as a Values array qualifier. Note that this method ’ s function overlaps with the RequestedState property. RequestedState was added to the model to maintain a record (i.e., a persisted value) of the last state request. Invoking the OnlineDevice method should set the RequestedState property appropriately. CIM_LogicalDevice
Method QuiesceDevice Qualifiers Name Type Value From Class Description string The QuiesceDevice method has been deprecated in lieu of the more general RequestStateChange method that directly overlaps with the functionality provided by this method. Requests that the LogicalDevice cleanly cease all current activity ( " Quiesce " input parameter = TRUE) or resume activity (= FALSE). For this method to quiesce a Device, that Device should have an Availability (or Additional Availability) of " Running/Full Power " (value=3) and an EnabledStatus/StatusInfo of " Enabled " . For example, if quiesced, a Device may then be offlined for diagnostics, or disabled for power off and hot swap. For the method to " unquiesce " a Device, that Device should have an Availability (or AdditionalAvailability) of " Quiesced " (value=21) and an EnabledStatus/StatusInfo of " Enabled " . In this case, the Device would be returned to an " Enabled " and " Running/Full Power " status. The method ’ s return code should indicate the success or failure of the quiesce. It should return 0 if successful, 1 if the request is not supported at all, 2 if the request is not supported due to the current state of the Device, and some other value if any other error occurred. In a subclass, the set of possible return codes could be specified, using a ValueMap qualifier on the method. The strings to which the ValueMap contents are ’ translated ’ may also be specified in the subclass as a Values array qualifier. CIM_LogicalDevice
Method SaveProperties Qualifiers Name Type Value From Class Description string Requests that the Device capture its current configuration, setup and/or state information in a backing store. The goal would be to use this information at a later time (via the RestoreProperties method), to return a Device to its present " condition " . This method may not be supported by all Devices. The method should return 0 if successful, 1 if the request is not supported, and some other value if any other error occurred. In a subclass, the set of possible return codes could be specified, using a ValueMap qualifier on the method. The strings to which the ValueMap contents are ’ translated ’ may also be specified in the subclass as a Values array qualifier. CIM_LogicalDevice
Method RestoreProperties Qualifiers Name Type Value From Class Description string Requests that the Device re-establish its configuration, setup and/or state information from a backing store. The intent is to capture this information at an earlier time (via the SaveProperties method), and use it to return a Device to this earlier " condition " . This method may not be supported by all Devices. The method should return 0 if successful, 1 if the request is not supported, and some other value if any other error occurred. In a subclass, the set of possible return codes could be specified, using a ValueMap qualifier on the method. The strings to which the ValueMap contents are ’ translated ’ may also be specified in the subclass as a Values array qualifier. CIM_LogicalDevice
Method RequestStateChange Qualifiers Name Type Value From Class Description string Requests that the element ’ s state be changed to the value specified in the RequestedState parameter. When the requested state change takes place, the element ’ s EnabledState and RequestedState will be the same. Invoking the RequestStateChange method multiple times could result in earlier requests being overwritten/lost. If 0 is returned, then the task completed successfully and the use of ConcreteJob was not required. If 4096 (0x1000) is returned, then the task will take some time to complete, ConcreteJob will be created, and its reference returned in the output parameter Job. Any other return code indicates an error condition. CIM_EnabledLogicalElement ValueMap string [See below.] CIM_EnabledLogicalElement Values string Completed with No Error
Not Supported
Unknown/Unspecified Error
Can NOT complete within Timeout Period
Failed
Invalid Parameter
In Use
DMTF Reserved
Method Parameters Checked - Job Started
Invalid State Transition
Use of Timeout Parameter Not Supported
Busy
Method Reserved
Vendor SpecificCIM_EnabledLogicalElement ModelCorrespondence string CIM_EnabledLogicalElement.RequestedState CIM_EnabledLogicalElement Parameters
Method SetPowerState Parameters Name Type Qualifiers PowerState uint16 IN
Description
ValueMap
ValuesTime datetime IN
Description
Method EnableDevice Parameters Name Type Qualifiers Enabled boolean IN
Description
Method OnlineDevice Parameters Name Type Qualifiers Online boolean IN
Description
Method QuiesceDevice Parameters Name Type Qualifiers Quiesce boolean IN
Description
Method RequestStateChange Parameters Name Type Qualifiers RequestedState uint16 IN
Description
ValueMap
Values
ModelCorrespondenceTimeoutPeriod datetime IN
DescriptionParameter Qualifiers
Parameter PowerState Qualifiers Name Type Value From Class IN boolean true CIM_LogicalDevice Description string The power state to set. CIM_LogicalDevice ValueMap string [See below.] CIM_LogicalDevice Values string Full Power
Power Save - Low Power Mode
Power Save - Standby
Power Save - Other
Power Cycle
Power OffCIM_LogicalDevice
Parameter Time Qualifiers Name Type Value From Class IN boolean true CIM_LogicalDevice Description string Time indicates when the power state should be set, either as a regular date-time value or as an interval value (where the interval begins when the method invocation is received. CIM_LogicalDevice
Parameter Enabled Qualifiers Name Type Value From Class IN boolean true CIM_LogicalDevice Description string If TRUE enable the device, if FALSE disable the device. CIM_LogicalDevice
Parameter Online Qualifiers Name Type Value From Class IN boolean true CIM_LogicalDevice Description string If TRUE, take the device online, if FALSE, take the device OFFLINE. CIM_LogicalDevice
Parameter Quiesce Qualifiers Name Type Value From Class IN boolean true CIM_LogicalDevice Description string If set to TRUE then cleanly cease all activity, if FALSE resume activity. CIM_LogicalDevice
Parameter RequestedState Qualifiers Name Type Value From Class IN boolean true CIM_EnabledLogicalElement Description string The state requested for the element. This information will be placed into the instance ’ s RequestedState property if the RequestStateChange method ’ s return code is 0, 3, or 4096 (0x1000) - ’ Completed with No Error ’ , ’ Timeout ’ , or ’ Job Started ’ respectively. Refer to the description of the EnabledState and RequestedState properties for the detailed meanings of the RequestedState values. CIM_EnabledLogicalElement ValueMap string [See below.] CIM_EnabledLogicalElement Values string Enabled
Disabled
Shut Down
Offline
Test
Defer
Quiesce
Reboot
Reset
DMTF Reserved
Vendor ReservedCIM_EnabledLogicalElement ModelCorrespondence string CIM_EnabledLogicalElement.RequestedState CIM_EnabledLogicalElement
Parameter TimeoutPeriod Qualifiers Name Type Value From Class IN boolean true CIM_EnabledLogicalElement Description string A timeout period that specifies the maximum amount of time that the client expects the transition to the new state to take. The interval format MUST be used to specify the TimeoutPeriod. A value of 0 or a null parameter indicates that the client has no time requirements for the transition. If this property does not contain 0 or null and the implementation doesn ’ t support this parameter. A return code of ’ Use Of Timeout Parameter Not Supported ’ MUST be returned. CIM_EnabledLogicalElement