Class Hierarchy
Class Attributes
Class Qualifiers
Properties
Methods
Associations in which the class can participate
Sub Profiling Summary
CIM_DVDDrive --> CIM_MediaAccessDevice --> CIM_LogicalDevice --> CIM_EnabledLogicalElement --> CIM_LogicalElement --> CIM_ManagedSystemElement --> CIM_ManagedElement --> [top]
Class Declaration Attributes Name Value SUPERCLASS CIM_MediaAccessDevice NAME CIM_DVDDrive
Class CIM_DVDDrive Qualifiers Name Type Value From Class Version string 2.6.0 CIM_DVDDrive Description string Capabilities and management of a DVDDrive, a subtype of MediaAccessDevice. CIM_DVDDrive Description string A MediaAccessDevice represents the ability to access one or more media and use this media to store and retrieve data. CIM_MediaAccessDevice Description string An abstraction or emulation of a hardware entity, that might or might 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 FormatsSupported Qualifiers Name Type Value From Class Description string The CD and DVD formats that are supported by this Device. For example, the Drive may support " CD-ROM " and " DVD-RAM " . In this case, the values 16 and 24 would be written to the array. This property ’ s values align with those defined in PhysicalMedia.MediaType. CIM_DVDDrive ValueMap string [See below.] CIM_DVDDrive Values string Unknown
Other
CD-ROM
CD-ROM/XA
CD-I
CD Recordable
DVD
DVD-RW+
DVD-RAM
DVD-ROM
DVD-Video
Divx
CD-RW
CD-DA
CD+
DVD Recordable
DVD-RW
DVD-Audio
DVD-5
DVD-9
DVD-10
DVD-18CIM_DVDDrive ModelCorrespondence string CIM_PhysicalMedia.MediaType CIM_DVDDrive
Name Value 0 Unknown 1 Other 16 CD-ROM 17 CD-ROM/XA 18 CD-I 19 CD Recordable 22 DVD 23 DVD-RW+ 24 DVD-RAM 25 DVD-ROM 26 DVD-Video 27 Divx 33 CD-RW 34 CD-DA 35 CD+ 36 DVD Recordable 37 DVD-RW 38 DVD-Audio 39 DVD-5 40 DVD-9 41 DVD-10 42 DVD-18
Property Capabilities Qualifiers Name Type Value From Class Description string Capabilities of the MediaAccessDevice. For example, the Device may support " Random Access " , removeable media and " Automatic Cleaning " . In this case, the values 3, 7 and 9 would be written to the array. Several of the enumerated values require some explanation: 1) Value 11, Supports Dual Sided Media, distinguishes a Device that can access both sides of dual sided Media, from a Device that reads only a single side and requires the Media to be flipped; and, 2) Value 12, Predismount Eject Not Required, indicates that Media does not have to be explicitly ejected from the Device before being accessed by a PickerElement. CIM_MediaAccessDevice ValueMap string [See below.] CIM_MediaAccessDevice Values string Unknown
Other
Sequential Access
Random Access
Supports Writing
Encryption
Compression
Supports Removeable Media
Manual Cleaning
Automatic Cleaning
SMART Notification
Supports Dual Sided Media
Predismount Eject Not RequiredCIM_MediaAccessDevice MappingStrings string MIF.DMTF|Storage Devices|001.9
MIF.DMTF|Storage Devices|001.11
MIF.DMTF|Storage Devices|001.12
MIF.DMTF|Disks|003.7
MIF.DMTF|Host Disk|001.2
MIF.DMTF|Host Disk|001.4CIM_MediaAccessDevice ArrayType string Indexed CIM_MediaAccessDevice ModelCorrespondence string CIM_MediaAccessDevice.CapabilityDescriptions CIM_MediaAccessDevice
Name Value 0 Unknown 1 Other 2 Sequential Access 3 Random Access 4 Supports Writing 5 Encryption 6 Compression 7 Supports Removeable Media 8 Manual Cleaning 9 Automatic Cleaning 10 SMART Notification 11 Supports Dual Sided Media 12 Predismount Eject Not Required
Property CapabilityDescriptions Qualifiers Name Type Value From Class Description string An array of free-form strings providing more detailed explanations for any of the AccessDevice features indicated in the Capabilities array. Note, each entry of this array is related to the entry in the Capabilities array that is located at the same index. CIM_MediaAccessDevice ArrayType string Indexed CIM_MediaAccessDevice ModelCorrespondence string CIM_MediaAccessDevice.Capabilities CIM_MediaAccessDevice
Property ErrorMethodology Qualifiers Name Type Value From Class Description string ErrorMethodology is a free-form string describing the type(s) of error detection and correction supported by this Device. CIM_MediaAccessDevice
Property CompressionMethod Qualifiers Name Type Value From Class Description string A free form string indicating the algorithm or tool used by the device to support compression. If it is not possible or not desired to describe the compression scheme (perhaps because it is not known), recommend using the following words: " Unknown " to represent that it is not known whether the device supports compression capabilities or not, " Compressed " to represent that the device supports compression capabilities but either its compression scheme is not known or not disclosed, and " Not Compressed " to represent that the devices does not support compression capabilities. CIM_MediaAccessDevice
Property NumberOfMediaSupported Qualifiers Name Type Value From Class Description string When the MediaAccessDevice supports multiple individual Media, this property defines the maximum number which can be supported or inserted. CIM_MediaAccessDevice
Property MaxMediaSize Qualifiers Name Type Value From Class Description string Maximum size, in KBytes, of media supported by this Device. KBytes is interpreted as the number of bytes multiplied by 1000 (NOT the number of bytes multiplied by 1024). CIM_MediaAccessDevice MappingStrings string MIF.DMTF|Sequential Access Devices|001.2
MIF.DMTF|Host Disk|001.5CIM_MediaAccessDevice
Property DefaultBlockSize Qualifiers Name Type Value From Class Description string Default block size, in bytes, for this Device. CIM_MediaAccessDevice Units string Bytes CIM_MediaAccessDevice
Property MaxBlockSize Qualifiers Name Type Value From Class Description string Maximum block size, in bytes, for media accessed by this Device. CIM_MediaAccessDevice Units string Bytes CIM_MediaAccessDevice
Property MinBlockSize Qualifiers Name Type Value From Class Description string Minimum block size, in bytes, for media accessed by this Device. CIM_MediaAccessDevice Units string Bytes CIM_MediaAccessDevice
Property NeedsCleaning Qualifiers Name Type Value From Class Description string Boolean indicating that the MediaAccessDevice needs cleaning. Whether manual or automatic cleaning is possible is indicated in the Capabilities array property. CIM_MediaAccessDevice
Property MediaIsLocked Qualifiers Name Type Value From Class Description string True indicates that the media is locked in the Device and can not be ejected. For non-removeable Devices, this value should be true. CIM_MediaAccessDevice
Property Security Qualifiers Name Type Value From Class Description string An enumeration indicating the operational security defined for the MediaAccessDevice. For example, information that the Device is " Read Only " (value=4) or " Boot Bypass " (value=6) can be described using this property. CIM_MediaAccessDevice ValueMap string [See below.] CIM_MediaAccessDevice Values string Other
Unknown
None
Read Only
Locked Out
Boot Bypass
Boot Bypass and Read OnlyCIM_MediaAccessDevice MappingStrings string MIF.DMTF|Disks|003.22 CIM_MediaAccessDevice
Name Value 1 Other 2 Unknown 3 None 4 Read Only 5 Locked Out 6 Boot Bypass 7 Boot Bypass and Read Only
Property LastCleaned Qualifiers Name Type Value From Class Description string The date and time on which the Device was last cleaned. CIM_MediaAccessDevice
Property MaxAccessTime Qualifiers Name Type Value From Class Description string Time in milliseconds to move from the first location on the Media to the location that is furthest with respect to time. For a DiskDrive, this represents full seek + full rotational delay. For TapeDrives, this represents a search from the beginning of the tape to the most physically distant point. (The end of a tape may be at its most physically distant point, but this is not necessarily true.) CIM_MediaAccessDevice Units string MilliSeconds CIM_MediaAccessDevice
Property UncompressedDataRate Qualifiers Name Type Value From Class Description string The sustained data transfer rate in KB/sec that the Device can read from and write to a Media. This is a sustained, raw data rate. Maximum rates or rates assuming compression should not be reported in this property. CIM_MediaAccessDevice Units string KiloBytes per Second CIM_MediaAccessDevice
Property LoadTime Qualifiers Name Type Value From Class Description string Time in milliseconds from ’ load ’ to being able to read or write a Media. For example, for DiskDrives, this is the interval between a disk not spinning to the disk reporting that it is ready for read/write (ie, the disk spinning at nominal speeds). For TapeDrives, this is the time from a Media being injected to reporting that it is ready for an application. This is usually at the tape ’ s BOT area. CIM_MediaAccessDevice Units string MilliSeconds CIM_MediaAccessDevice
Property UnloadTime Qualifiers Name Type Value From Class Description string Time in milliseconds from being able to read or write a Media to its ’ unload ’ . For example, for DiskDrives, this is the interval between a disk spinning at nominal speeds and a disk not spinning. For TapeDrives, this is the time for a Media to go from its BOT to being fully ejected and accessible to a PickerElement or human operator. CIM_MediaAccessDevice Units string MilliSeconds CIM_MediaAccessDevice
Property MountCount Qualifiers Name Type Value From Class Description string For a MediaAccessDevice that supports removable Media, the number of times that Media have been mounted for data transfer or to clean the Device. For Devices accessing nonremovable Media, such as hard disks, this property is not applicable and should be set to 0. CIM_MediaAccessDevice Counter boolean true CIM_MediaAccessDevice
Property TimeOfLastMount Qualifiers Name Type Value From Class Description string For a MediaAccessDevice that supports removable Media, the most recent date and time that Media was mounted on the Device. For Devices accessing nonremovable Media, such as hard disks, this property has no meaning and is not applicable. CIM_MediaAccessDevice
Property TotalMountTime Qualifiers Name Type Value From Class Description string For a MediaAccessDevice that supports removable Media, the total time (in seconds) that Media have been mounted for data transfer or to clean the Device. For Devices accessing nonremovable Media, such as hard disks, this property is not applicable and should be set to 0. CIM_MediaAccessDevice
Property UnitsDescription Qualifiers Name Type Value From Class Description string Defines ’ Units ’ relative to its use in the property, MaxUnitsBeforeCleaning. This describes the criteria used to determine when the MediaAccessDevice should be cleaned. CIM_MediaAccessDevice ModelCorrespondence string CIM_MediaAccessDevice.MaxUnitsBeforeCleaning
CIM_MediaAccessDevice.UnitsUsedCIM_MediaAccessDevice
Property MaxUnitsBeforeCleaning Qualifiers Name Type Value From Class Description string An unsigned integer indicating the maximum ’ units ’ that can be used, with respect to the AccessDevice, before the Device should be cleaned. The property, UnitsDescription, defines how ’ units ’ should be interpreted. CIM_MediaAccessDevice ModelCorrespondence string CIM_MediaAccessDevice.UnitsDescription CIM_MediaAccessDevice
Property UnitsUsed Qualifiers Name Type Value From Class Description string An unsigned integer indicating the currently used ’ units ’ of the AccessDevice, helpful to describe when the Device may require cleaning. The property, UnitsDescription, defines how ’ units ’ should be interpreted. CIM_MediaAccessDevice Gauge boolean true CIM_MediaAccessDevice ModelCorrespondence string CIM_MediaAccessDevice.UnitsDescription
CIM_MediaAccessDevice.MaxUnitsBeforeCleaningCIM_MediaAccessDevice
Property SystemCreationClassName Qualifiers Name Type Value From Class Key boolean true CIM_LogicalDevice Propagated string CIM_System.CreationClassName CIM_LogicalDevice Description string The CreationClassName of the scoping system. 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 System Name of the scoping system. 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 used to uniquely name the LogicalDevice. CIM_LogicalDevice MaxLen uint32 64 CIM_LogicalDevice
Property PowerManagementSupported Qualifiers Name Type Value From Class Description string Note: The use of this property has been deprecated. Instead, the existence of an associated PowerManagementCapabilities class (associated using the ElementCapabilities relationship) indicates that power management is supported. Deprecated description: Boolean that indicates that the Device can use power management. CIM_LogicalDevice
Property PowerManagementCapabilities Qualifiers Name Type Value From Class Description string Note: The use of this property has been deprecated. Instead, use the PowerCapabilites property in an associated PowerManagementCapabilities class. Deprecated description: An enumerated array describing the power management capabilities of the Device. 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 Note: The use of this property has been deprecated. Deprecated description: 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). The Power Save states 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; value 14 ( " Power Save - Low Power Mode " ) indicates that the Device is in a power save state but still functioning, and might exhibit degraded performance; value 15 ( " Power Save - Standby " ) indicates 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, but is 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 Note: The use of this method is deprecated in lieu of a more clearly named property (EnabledState) that is inherited from ManagedSystemElement and that has additional enumerated values. Deprecated description: The StatusInfo property indicates whether the Logical Device is in an enabled state (value=3), disabled state (value=4), some other state (value=1), or an unknown state (value=2). If this property does not apply to the LogicalDevice, the value 5 ( " Not Applicable " ) should be used. If a Device is ( " Enabled " )(value=3), it has been powered up and is configured and operational. The Device might or might not be functionally active, depending on whether its Availability (or AdditionalAvailability) indicates that it is ( " Running/Full Power " )(value=3) or ( " Off line " ) (value=8). In an enabled but offline mode, a Device might be performing out-of-band requests, such as running Diagnostics. If StatusInfo is ( " Disabled " ) (value=4), a Device can only be " enabled " or powered off. In a personal computer environment, ( " Disabled " ) means that the driver of the device 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 it cannot be communicated with until a driver is loaded, a configuration file is loaded, 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 Note: The use of this method is deprecated. Deprecated description: LastErrorCode captures the last error code reported by the LogicalDevice. CIM_LogicalDevice
Property ErrorDescription Qualifiers Name Type Value From Class Description string Note: The use of this method is deprecated. Deprecated description: ErrorDescription is a free-form string that supplies more information about the error recorded in LastErrorCode and information on any corrective actions that can be taken. CIM_LogicalDevice
Property ErrorCleared Qualifiers Name Type Value From Class Description string Note: The use of this method is deprecated. Deprecated description: ErrorCleared is a Boolean property that indicates that the error reported in LastErrorCode is now cleared. CIM_LogicalDevice
Property OtherIdentifyingInfo Qualifiers Name Type Value From Class Description string OtherIdentifyingInfo captures data, in addition to DeviceID information, that could be used to identify a LogicalDevice. For example, you could use this property to hold the operating system ’ s user-friendly name for the Device. 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 Note: The use of this method is deprecated. Deprecated description: The number of consecutive hours that this Device has been powered on 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 Note: The use of this method is deprecated. Deprecated description: The total number of hours that this Device has been powered on. 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 that 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 in addition to that specified in the Availability property. The Availability property denotes the primary status and availability of the Device. In some cases, this property 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, the primary Availability of a device might be " Off line " (value=8) or in a low-power state (AdditionalAvailability 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 Note: The use of this property has been deprecated. When evaluating the use of Quiesce, it was determined 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 decision will be re-evaluated and repositioned later. Deprecated description: Maximum time, in milliseconds, that a Device can run in a " Quiesced " state. The 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 can unquiesce, can be offline, or can take other actions. A value of 0 indicates that a Device can remain quiesced indefinitely. CIM_LogicalDevice Units string MilliSeconds CIM_LogicalDevice
Property LocationIndicator Qualifiers Name Type Value From Class Write boolean true CIM_LogicalDevice Description string An integer that reflects the state of an indicator (e.g., LED) that is part of a device. Reading the value gives the current state. Writing the value with ’ On ’ / ’ Off ’ turns the indicator on/off, other values may not be written. CIM_LogicalDevice ValueMap string [See below.] CIM_LogicalDevice Values string Unknown
On
Off
Not SupportedCIM_LogicalDevice ModelCorrespondence string CIM_AlarmDevice.AlarmState
CIM_AlarmDevice.AudioIndicatorIsDisabled
CIM_AlarmDevice.VisualIndicatorIsDisabled
CIM_AlarmDevice.MotionIndicatorIsDisabledCIM_LogicalDevice
Name Value 0 Unknown 2 On 3 Off 4 Not Supported
Name Value 0 Unknown 2 On 3 Off 4 Not Supported
Name Value 0 Unknown 2 On 3 Off 4 Not Supported
Name Value 0 Unknown 2 On 3 Off 4 Not Supported
Name Value 0 Unknown 2 On 3 Off 4 Not Supported
Name Value 0 Unknown 2 On 3 Off 4 Not Supported
Name Value 0 Unknown 2 On 3 Off 4 Not Supported
Name Value 0 Unknown 2 On 3 Off 4 Not Supported
Property EnabledState Qualifiers Name Type Value From Class Description string EnabledState is an integer enumeration that indicates the enabled and 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 and disabled states: Enabled (2) indicates that the element is or 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 does not support being enabled or disabled. Enabled but Offline (6) indicates that the element might 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 might be completing commands, but will queue any new requests. Quiesce (9) indicates that the element is enabled but in a restricted mode. The behavior of the element is similar to the Enabled state, but it processes only 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 that describes the enabled or disabled state of the element 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 that indicates 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 or disabled states. Note that when EnabledState is set to 5 ( " Not Applicable " ), then this property has no meaning. By default, the RequestedState of the element is 5 ( " No Change " ). Refer to the EnabledState 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). Reboot refers to doing a " Shut Down " and then moving to an " Enabled " state. Reset indicates that the element is first " Disabled " and then " Enabled " . The distinction between requesting " Shut Down " and " Disabled " should also be noted. Shut Down requests an orderly transition to the Disabled state, and might involve removing power, to completely erase any existing state. 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 can be overridden and defined as WRITEable in a subclass. The method approach is considered superior to a WRITEable property, because it allows an explicit invocation of the operation and the return of a result code. A particular instance of EnabledLogicalElement might not support RequestedStateChange. If this occurs, the value 12 ( " Not Applicable " ) is used. CIM_EnabledLogicalElement ValueMap string [See below.] CIM_EnabledLogicalElement Values string Enabled
Disabled
Shut Down
No Change
Offline
Test
Deferred
Quiesce
Reboot
Reset
Not Applicable
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 12 Not Applicable .. 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 or startup configuration for the Enabled State of an element. 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 or time when the EnabledState of the element 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 that indicates when the object was installed. 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 statuses of the element. Various operational statuses are defined. Many of the enumeration ’ s values are self-explanatory. However, a few are not and are described here in more detail. " Stressed " indicates that the element is functioning, but needs attention. Examples of " Stressed " states are overload, overheated, and so on. " 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 state and configuration of the element might need to be updated. " Dormant " indicates that the element is inactive or quiesced. " Supporting Entity in Error " indicates that this element might 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 that the element has completed its operation. This value should be combined with either OK, Error, or Degraded so that a client can tell if the complete operation Completed with OK (passed), Completed with Error (failed), or Completed with Degraded (the operation finished, but it did not complete OK or did not report an error). " Power Mode " indicates that 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 because it required the deprecated qualifier. Due to the widespread use of the existing Status property in management applications, it is strongly recommended that providers or 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 (because 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 definition overcomes the limitation of describing status using a single value, when it is really a multi-valued property (for example, an element might be OK AND Stopped. 2) A MaxLen of 10 is too restrictive and leads to unclear enumerated values. 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 HealthState Qualifiers Name Type Value From Class Description string Indicates the current health of the element. This attribute expresses the health of this element but not necessarily that of its subcomponents. The possible values are 0 to 30, where 5 means the element is entirely healthy and 30 means the element is completely non-functional. The following continuum is defined: " Non-recoverable Error " (30) - The element has completely failed, and recovery is not possible. All functionality provided by this element has been lost. " Critical Failure " (25) - The element is non-functional and recovery might not be possible. " Major Failure " (20) - The element is failing. It is possible that some or all of the functionality of this component is degraded or not working. " Minor Failure " (15) - All functionality is available but some might be degraded. " Degraded/Warning " (10) - The element is in working order and all functionality is provided. However, the element is not working to the best of its abilities. For example, the element might not be operating at optimal performance or it might be reporting recoverable errors. " OK " (5) - The element is fully functional and is operating within normal operational parameters and without error. " Unknown " (0) - The implementation cannot report on HealthState at this time. DMTF has reserved the unused portion of the continuum for additional HealthStates in the future. CIM_ManagedSystemElement ValueMap string [See below.] CIM_ManagedSystemElement Values string Unknown
OK
Degraded/Warning
Minor failure
Major failure
Critical failure
Non-recoverable error
DMTF ReservedCIM_ManagedSystemElement
Name Value 0 Unknown 5 OK 10 Degraded/Warning 15 Minor failure 20 Major failure 25 Critical failure 30 Non-recoverable error .. DMTF Reserved
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 the Name property of ManagedSystemElement 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 can be present in both the Name and ElementName properties. CIM_ManagedElement
Name Type Value Qualifiers Parameters ClassOrigin LockMedia uint32 Description Lock CIM_MediaAccessDevice 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 Deprecated
DescriptionCIM_LogicalDevice RestoreProperties uint32 Deprecated
DescriptionCIM_LogicalDevice RequestStateChange uint32 Description
ValueMap
Values
ModelCorrespondenceRequestedState
TimeoutPeriodCIM_EnabledLogicalElement Method Qualifiers
Method LockMedia Qualifiers Name Type Value From Class Description string Method to lock and unlock the media in a removeable Access Device. The method takes one parameter as input - a boolean indicating whether to lock or unlock. TRUE indicates that the media should be locked in the Device, FALSE indicates that the media should be unlocked. The method returns 0 if successful, 1 if not supported, and any other value if an error occurred. The set of possible return codes should be specified in a ValueMap qualifier on the method. The strings to which the ValueMap contents are ’ translated ’ should be specified as a Values array qualifier on the method. CIM_MediaAccessDevice
Method SetPowerState Qualifiers Name Type Value From Class Description string Note: The use of this method has been deprecated. Instead, use the SetPowerState method in the associated PowerManagementService class. Deprecated description: Sets the power state of the Device. 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 ’ can also be specified in the subclass as a Values array qualifier. CIM_LogicalDevice
Method EnableDevice Qualifiers Name Type Value From Class Description string Note: The use of this method has been deprecated in lieu of the more general RequestStateChange method that directly overlaps with the functionality provided by this method. Deprecated description: Requests that the LogicalDevice be enabled ( " Enabled " input parameter=TRUE) or disabled (=FALSE). If successful, the StatusInfo or EnabledState properties of the Device should reflect the desired state (enabled or disabled). Note that this function overlaps with the RequestedState property. RequestedState was added to the model to maintain a record (for example, 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 by using a ValueMap qualifier on the method. The strings to which the ValueMap contents are ’ translated ’ can also be specified in the subclass as a Values array qualifier. CIM_LogicalDevice
Method OnlineDevice Qualifiers Name Type Value From Class Description string Note: The use of this method has been deprecated in lieu of the more general RequestStateChange method that directly overlaps with the functionality provided by this method. Deprecated description: 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 Availability property of the Device would be set to a value of 3 ( " Running/Full Power " ). " Offline " indicates that a Device is powered on and operational, but is not processing functional requests. In an offline state, a Device might 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 it could be available for diagnostics or maintenance. If this method is successful, the Availability and AdditionalAvailability properties of the Device should reflect the updated status. If a failure occurs when you try to bring the Device online or offline, it should remain in its current state. 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 or 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 ’ can also be specified in the subclass as a Values array qualifier. Note that the function of this method overlaps with the RequestedState property. RequestedState was added to the model to maintain a record (for example, 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 Note: The use of this method has been deprecated in lieu of the more general RequestStateChange method that directly overlaps with the functionality provided by this method. Deprecated description: Requests that the LogicalDevice cleanly cease all 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 can then be taken offline 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 or StatusInfo of " Enabled " . In this case, the Device would be returned to an " Enabled " and " Running/Full Power " status. The return code of the method 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 ’ can also be specified in the subclass as a Values array qualifier. CIM_LogicalDevice
Method SaveProperties Qualifiers Name Type Value From Class Description string Note: The use of this method is deprecated. Its function is handled more generally by the ConfigurationData subclass of SettingData. Deprecated description: Requests that the Device capture its current configuration, setup or state information, or both in a backing store. The information returned by this method could be used at a later time (using the RestoreProperties method) to return a Device to its present " condition " . This method might 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 ’ can also be specified in the subclass as a Values array qualifier. CIM_LogicalDevice
Method RestoreProperties Qualifiers Name Type Value From Class Description string Note: The use of this method is deprecated. Its function is handled more generally by the ConfigurationData subclass of SettingData. Requests that the Device re-establish its configuration, setup or state information, or both from a backing store. The information would have been captured at an earlier time (using the SaveProperties method). This method might 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 ’ can 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 state of the element be changed to the value specified in the RequestedState parameter. When the requested state change takes place, the EnabledState and RequestedState of the element will be the same. Invoking the RequestStateChange method multiple times could result in earlier requests being overwritten or 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 or Unspecified Error
Cannot 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 LockMedia Parameters Name Type Qualifiers Lock boolean IN
Description
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 Lock Qualifiers Name Type Value From Class IN boolean true CIM_MediaAccessDevice Description string If TRUE, lock the media. If FALSE release the media. CIM_MediaAccessDevice
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 RequestedState property of the instance if the return code of the RequestStateChange method is 0 ( ’ Completed with No Error ’ ), 3 ( ’ Timeout ’ ), or 4096 (0x1000) ( ’ Job Started ’ ). Refer to the description of the EnabledState and RequestedState properties for the detailed explanations 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 does not support this parameter, a return code of ’ Use Of Timeout Parameter Not Supported ’ must be returned. CIM_EnabledLogicalElement