CIM211 Class Declaration
CIM_EthernetPort

Table of Contents:
Class Hierarchy
Class Attributes
Class Qualifiers
Properties
Methods
Associations in which the class can participate
Sub Profiling Summary

Class Hierarchy

CIM_EthernetPort --> CIM_NetworkPort --> CIM_LogicalPort --> CIM_LogicalDevice --> CIM_EnabledLogicalElement --> CIM_LogicalElement --> CIM_ManagedSystemElement --> CIM_ManagedElement --> [top]

Class Attributes

Class Declaration Attributes
NameValue
SUPERCLASSCIM_NetworkPort
NAMECIM_EthernetPort

Class Qualifiers

Class CIM_EthernetPort Qualifiers
NameTypeValueFrom Class
Versionstring2.10.0 CIM_EthernetPort
DescriptionstringCapabilities and management of an EthernetPort. CIM_EthernetPort
DescriptionstringNetworkPort is the logical representation of network communications hardware such as a physical connector and the setup or operation of the network chips, at the lowest layers of a network stack. CIM_NetworkPort
DescriptionstringThe abstraction of a port or connection point of a Device. This object should be instantiated when the Port has independent management characteristics from the Device that includes it. Examples are a Fibre Channel Port and a USB Port. CIM_LogicalPort
DescriptionstringAn 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
DescriptionstringThis class extends LogicalElement to abstract the concept of an element that is enabled and disabled, such as a LogicalDevice or a ServiceAccessPoint. CIM_EnabledLogicalElement
DescriptionstringCIM_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
DescriptionstringCIM_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
DescriptionstringManagedElement 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

Properties

Properties
NameTypeValueQualifiersClassOrigin
PortTypeuint16 Override
Description
ValueMap
Values
ModelCorrespondence
CIM_EthernetPort
NetworkAddressesstring[] Override
Description
MaxLen
MappingStrings
CIM_EthernetPort
MaxDataSizeuint32 Description
MappingStrings
CIM_EthernetPort
Capabilitiesuint16[] Description
ValueMap
Values
ArrayType
ModelCorrespondence
CIM_EthernetPort
CapabilityDescriptionsstring[] Description
ArrayType
ModelCorrespondence
CIM_EthernetPort
EnabledCapabilitiesuint16[] Description
ValueMap
Values
ArrayType
ModelCorrespondence
CIM_EthernetPort
OtherEnabledCapabilitiesstring[] Description
ArrayType
ModelCorrespondence
CIM_EthernetPort
Speeduint64 Override
Description
Units
MappingStrings
CIM_NetworkPort
OtherNetworkPortTypestring Deprecated
Description
ModelCorrespondence
CIM_NetworkPort
PortNumberuint16 Description CIM_NetworkPort
LinkTechnologyuint16 Description
ValueMap
Values
ModelCorrespondence
CIM_NetworkPort
OtherLinkTechnologystring Description
ModelCorrespondence
CIM_NetworkPort
PermanentAddressstring Description
MaxLen
MappingStrings
CIM_NetworkPort
FullDuplexboolean Description CIM_NetworkPort
AutoSenseboolean Description CIM_NetworkPort
SupportedMaximumTransmissionUnituint64 Description
Units
CIM_NetworkPort
ActiveMaximumTransmissionUnituint64 Description
Units
CIM_NetworkPort
MaxSpeeduint64 Description
Units
CIM_LogicalPort
RequestedSpeeduint64 Write
Description
Units
ModelCorrespondence
CIM_LogicalPort
UsageRestrictionuint16 Description
ValueMap
Values
CIM_LogicalPort
OtherPortTypestring Description
ModelCorrespondence
CIM_LogicalPort
SystemCreationClassNamestring Key
Propagated
Description
MaxLen
CIM_LogicalDevice
SystemNamestring Key
Propagated
Description
MaxLen
CIM_LogicalDevice
CreationClassNamestring Key
Description
MaxLen
CIM_LogicalDevice
DeviceIDstring Key
Description
MaxLen
CIM_LogicalDevice
PowerManagementSupportedboolean Deprecated
Description
CIM_LogicalDevice
PowerManagementCapabilitiesuint16[] Deprecated
Description
ValueMap
Values
CIM_LogicalDevice
Availabilityuint16 Deprecated
Description
ValueMap
Values
MappingStrings
ModelCorrespondence
CIM_LogicalDevice
StatusInfouint16 Deprecated
Description
ValueMap
Values
MappingStrings
CIM_LogicalDevice
LastErrorCodeuint32 Deprecated
Description
CIM_LogicalDevice
ErrorDescriptionstring Deprecated
Description
CIM_LogicalDevice
ErrorClearedboolean Deprecated
Description
CIM_LogicalDevice
OtherIdentifyingInfostring[] Description
MaxLen
ArrayType
ModelCorrespondence
CIM_LogicalDevice
PowerOnHoursuint64 Deprecated
Description
Units
Counter
CIM_LogicalDevice
TotalPowerOnHoursuint64 Deprecated
Description
Units
Counter
CIM_LogicalDevice
IdentifyingDescriptionsstring[] Description
ArrayType
ModelCorrespondence
CIM_LogicalDevice
AdditionalAvailabilityuint16[] Description
ValueMap
Values
ModelCorrespondence
CIM_LogicalDevice
MaxQuiesceTimeuint64 Deprecated
Description
Units
CIM_LogicalDevice
LocationIndicatoruint16 Experimental
Write
Description
ValueMap
Values
ModelCorrespondence
CIM_LogicalDevice
EnabledStateuint165 Description
ValueMap
Values
ModelCorrespondence
CIM_EnabledLogicalElement
OtherEnabledStatestring Description
ModelCorrespondence
CIM_EnabledLogicalElement
RequestedStateuint1612 Description
ValueMap
Values
ModelCorrespondence
CIM_EnabledLogicalElement
EnabledDefaultuint162 Write
Description
ValueMap
Values
CIM_EnabledLogicalElement
TimeOfLastStateChangedatetime Description CIM_EnabledLogicalElement
InstallDatedatetime Description
MappingStrings
CIM_ManagedSystemElement
Namestring Description
MaxLen
CIM_ManagedSystemElement
OperationalStatusuint16[] Description
ValueMap
Values
ArrayType
ModelCorrespondence
CIM_ManagedSystemElement
StatusDescriptionsstring[] Description
ArrayType
ModelCorrespondence
CIM_ManagedSystemElement
Statusstring Deprecated
Description
ValueMap
MaxLen
CIM_ManagedSystemElement
HealthStateuint16 Description
ValueMap
Values
CIM_ManagedSystemElement
Captionstring Description
MaxLen
CIM_ManagedElement
Descriptionstring Description CIM_ManagedElement
ElementNamestring Description CIM_ManagedElement

Property Qualifiers

Property PortType Qualifiers
NameTypeValueFrom Class
OverridestringPortType CIM_EthernetPort
DescriptionstringThe specific mode that is currently enabled for the Port. When set to 1 ( " Other " ), the related property OtherPortType contains a string description of the type of port. CIM_EthernetPort
ValueMapstring
[See below.]
CIM_EthernetPort
ValuesstringUnknown
Other
10BaseT
10-100BaseT
100BaseT
1000BaseT
2500BaseT
10GBaseT
10GBase-CX4
100Base-FX
100Base-SX
1000Base-SX
1000Base-LX
1000Base-CX
10GBase-SR
10GBase-SW
10GBase-LX4
10GBase-LR
10GBase-LW
10GBase-ER
10GBase-EW
Vendor Reserved
CIM_EthernetPort
ModelCorrespondencestringCIM_NetworkPort.OtherNetworkPortType CIM_EthernetPort

NameValue
0Unknown
1Other
5010BaseT
5110-100BaseT
52100BaseT
531000BaseT
542500BaseT
5510GBaseT
5610GBase-CX4
100100Base-FX
101100Base-SX
1021000Base-SX
1031000Base-LX
1041000Base-CX
10510GBase-SR
10610GBase-SW
10710GBase-LX4
10810GBase-LR
10910GBase-LW
11010GBase-ER
11110GBase-EW
16000..65535Vendor Reserved
Property NetworkAddresses Qualifiers
NameTypeValueFrom Class
OverridestringNetworkAddresses CIM_EthernetPort
DescriptionstringEthernet/802.3 MAC addresses formatted as twelve hexadecimal digits (for example, " 010203040506 " ), with each pair representing one of the six octets of the MAC address in " canonical " bit order. (Therefore, the Group address bit is found in the low order bit of the first character of the string.) CIM_EthernetPort
MaxLenuint3264 CIM_EthernetPort
MappingStringsstringMIF.DMTF|Network Adapter 802 Port|001.3 CIM_EthernetPort

Property MaxDataSize Qualifiers
NameTypeValueFrom Class
DescriptionstringThe maximum size of the INFO (non-MAC) field that will be received or transmitted. CIM_EthernetPort
MappingStringsstringMIB.IETF|BRIDGE-MIB.dot1dTpPortMaxInfo CIM_EthernetPort

Property Capabilities Qualifiers
NameTypeValueFrom Class
DescriptionstringCapabilities of the EthernetPort. For example, the Device might support AlertOnLan, WakeOnLan, Load Balancing, or FailOver. If failover or load balancing capabilities are listed, a SpareGroup (failover) or ExtraCapacityGroup (load balancing) should also be defined to completely describe the capability. CIM_EthernetPort
ValueMapstring
[See below.]
CIM_EthernetPort
ValuesstringUnknown
Other
AlertOnLan
WakeOnLan
FailOver
LoadBalancing
CIM_EthernetPort
ArrayTypestringIndexed CIM_EthernetPort
ModelCorrespondencestringCIM_EthernetPort.CapabilityDescriptions CIM_EthernetPort

NameValue
0Unknown
1Other
2AlertOnLan
3WakeOnLan
4FailOver
5LoadBalancing
Property CapabilityDescriptions Qualifiers
NameTypeValueFrom Class
DescriptionstringAn array of free-form strings that provides more detailed explanations for any of the EthernetPort features that are 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_EthernetPort
ArrayTypestringIndexed CIM_EthernetPort
ModelCorrespondencestringCIM_EthernetPort.Capabilities CIM_EthernetPort

Property EnabledCapabilities Qualifiers
NameTypeValueFrom Class
DescriptionstringSpecifies which capabilities are enabled from the list of all supported ones, which are defined in the Capabilities array. CIM_EthernetPort
ValueMapstring
[See below.]
CIM_EthernetPort
ValuesstringUnknown
Other
AlertOnLan
WakeOnLan
FailOver
LoadBalancing
CIM_EthernetPort
ArrayTypestringIndexed CIM_EthernetPort
ModelCorrespondencestringCIM_EthernetPort.Capabilities
CIM_EthernetPort.OtherEnabledCapabilities
CIM_EthernetPort

NameValue
0Unknown
1Other
2AlertOnLan
3WakeOnLan
4FailOver
5LoadBalancing
Property OtherEnabledCapabilities Qualifiers
NameTypeValueFrom Class
DescriptionstringAn array of free-form strings that provides more detailed explanations for any of the enabled capabilities that are specified as ’ Other ’ . CIM_EthernetPort
ArrayTypestringIndexed CIM_EthernetPort
ModelCorrespondencestringCIM_EthernetPort.EnabledCapabilities CIM_EthernetPort

Property Speed Qualifiers
NameTypeValueFrom Class
OverridestringSpeed CIM_NetworkPort
DescriptionstringThe current bandwidth of the Port in Bits per Second. For ports that vary in bandwidth or for those where no accurate estimation can be made, this property should contain the nominal bandwidth. CIM_NetworkPort
UnitsstringBits per Second CIM_NetworkPort
MappingStringsstringMIB.IETF|MIB-II.ifSpeed
MIF.DMTF|Network Adapter 802 Port|001.5
CIM_NetworkPort

Property OtherNetworkPortType Qualifiers
NameTypeValueFrom Class
DescriptionstringNote: The use of this property is deprecated in lieu of CIM_LogicalPort.PortType. Deprecated description: The type of module, when PortType is set to 1 ( " Other " .) CIM_NetworkPort
ModelCorrespondencestringCIM_LogicalPort.PortType CIM_NetworkPort

Property PortNumber Qualifiers
NameTypeValueFrom Class
DescriptionstringNetworkPorts are often numbered relative to either a logical module or a network element. CIM_NetworkPort

Property LinkTechnology Qualifiers
NameTypeValueFrom Class
DescriptionstringAn enumeration of the types of links. When set to 1 ( " Other " ), the related property OtherLinkTechnology contains a string description of the type of link. CIM_NetworkPort
ValueMapstring
[See below.]
CIM_NetworkPort
ValuesstringUnknown
Other
Ethernet
IB
FC
FDDI
ATM
Token Ring
Frame Relay
Infrared
BlueTooth
Wireless LAN
CIM_NetworkPort
ModelCorrespondencestringCIM_NetworkPort.OtherLinkTechnology CIM_NetworkPort

NameValue
0Unknown
1Other
2Ethernet
3IB
4FC
5FDDI
6ATM
7Token Ring
8Frame Relay
9Infrared
10BlueTooth
11Wireless LAN
Property OtherLinkTechnology Qualifiers
NameTypeValueFrom Class
DescriptionstringA string value that describes LinkTechnology when it is set to 1, " Other " . CIM_NetworkPort
ModelCorrespondencestringCIM_NetworkPort.LinkTechnology CIM_NetworkPort

Property PermanentAddress Qualifiers
NameTypeValueFrom Class
DescriptionstringPermanentAddress defines the network address that is hardcoded into a port. This ’ hardcoded ’ address can be changed using a firmware upgrade or a software configuration. When this change is made, the field should be updated at the same time. PermanentAddress should be left blank if no ’ hardcoded ’ address exists for the NetworkAdapter. CIM_NetworkPort
MaxLenuint3264 CIM_NetworkPort
MappingStringsstringMIF.DMTF|Network Adapter 802 Port|001.2 CIM_NetworkPort

Property NetworkAddresses Qualifiers
NameTypeValueFrom Class
DescriptionstringAn array of strings that indicates the network addresses for the port. CIM_NetworkPort
MaxLenuint3264 CIM_NetworkPort
MappingStringsstringMIF.DMTF|Network Adapter 802 Port|001.3 CIM_NetworkPort

Property FullDuplex Qualifiers
NameTypeValueFrom Class
DescriptionstringBoolean that indicates that the port is operating in full duplex mode. CIM_NetworkPort

Property AutoSense Qualifiers
NameTypeValueFrom Class
DescriptionstringA Boolean that indicates whether the NetworkPort is capable of automatically determining the speed or other communications characteristics of the attached network media. CIM_NetworkPort

Property SupportedMaximumTransmissionUnit Qualifiers
NameTypeValueFrom Class
DescriptionstringThe maximum transmission unit (MTU) that can be supported. CIM_NetworkPort
UnitsstringBytes CIM_NetworkPort

Property ActiveMaximumTransmissionUnit Qualifiers
NameTypeValueFrom Class
DescriptionstringThe active or negotiated maximum transmission unit (MTU) that can be supported. CIM_NetworkPort
UnitsstringBytes CIM_NetworkPort

Property Speed Qualifiers
NameTypeValueFrom Class
DescriptionstringThe bandwidth of the Port in Bits per Second. CIM_LogicalPort
UnitsstringBits per Second CIM_LogicalPort

Property MaxSpeed Qualifiers
NameTypeValueFrom Class
DescriptionstringThe maximum bandwidth of the Port in Bits per Second. CIM_LogicalPort
UnitsstringBits per Second CIM_LogicalPort

Property RequestedSpeed Qualifiers
NameTypeValueFrom Class
Writebooleantrue CIM_LogicalPort
DescriptionstringThe requested bandwidth of the Port in Bits per Second. The actual bandwidth is reported in LogicalPort.Speed. CIM_LogicalPort
UnitsstringBits per Second CIM_LogicalPort
ModelCorrespondencestringCIM_LogicalPort.Speed CIM_LogicalPort

Property UsageRestriction Qualifiers
NameTypeValueFrom Class
DescriptionstringIn some circumstances, a LogicalPort might be identifiable as a front end or back end port. An example of this situation would be a storage array that might have back end ports to communicate with disk drives and front end ports to communicate with hosts. If there is no restriction on the use of the port, then the value should be set to ’ not restricted ’ . CIM_LogicalPort
ValueMapstring
[See below.]
CIM_LogicalPort
ValuesstringUnknown
Front-end only
Back-end only
Not restricted
CIM_LogicalPort

NameValue
0Unknown
2Front-end only
3Back-end only
4Not restricted
Property PortType Qualifiers
NameTypeValueFrom Class
DescriptionstringPortType is defined to force consistent naming of the ’ type ’ property in subclasses and to guarantee unique enum values for all instances of NetworkPort. When set to 1 ( " Other " ), related property OtherPortType contains a string description of the type of port. A range of values, DMTF_Reserved, has been defined that allows subclasses to override and define their specific types of ports. CIM_LogicalPort
ValueMapstring
[See below.]
CIM_LogicalPort
ValuesstringUnknown
Other
Not Applicable
DMTF Reserved
Vendor Reserved
CIM_LogicalPort
ModelCorrespondencestringCIM_NetworkPort.OtherNetworkPortType CIM_LogicalPort

NameValue
0Unknown
1Other
2Not Applicable
3..15999DMTF Reserved
16000..65535Vendor Reserved
Property OtherPortType Qualifiers
NameTypeValueFrom Class
DescriptionstringDescribes the type of module, when PortType is set to 1 ( " Other " ). CIM_LogicalPort
ModelCorrespondencestringCIM_LogicalPort.PortType CIM_LogicalPort

Property SystemCreationClassName Qualifiers
NameTypeValueFrom Class
Keybooleantrue CIM_LogicalDevice
PropagatedstringCIM_System.CreationClassName CIM_LogicalDevice
DescriptionstringThe CreationClassName of the scoping system. CIM_LogicalDevice
MaxLenuint32256 CIM_LogicalDevice

Property SystemName Qualifiers
NameTypeValueFrom Class
Keybooleantrue CIM_LogicalDevice
PropagatedstringCIM_System.Name CIM_LogicalDevice
DescriptionstringThe System Name of the scoping system. CIM_LogicalDevice
MaxLenuint32256 CIM_LogicalDevice

Property CreationClassName Qualifiers
NameTypeValueFrom Class
Keybooleantrue CIM_LogicalDevice
DescriptionstringCreationClassName 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
MaxLenuint32256 CIM_LogicalDevice

Property DeviceID Qualifiers
NameTypeValueFrom Class
Keybooleantrue CIM_LogicalDevice
DescriptionstringAn address or other identifying information used to uniquely name the LogicalDevice. CIM_LogicalDevice
MaxLenuint3264 CIM_LogicalDevice

Property PowerManagementSupported Qualifiers
NameTypeValueFrom Class
DescriptionstringNote: 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
NameTypeValueFrom Class
DescriptionstringNote: 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
ValueMapstring
[See below.]
CIM_LogicalDevice
ValuesstringUnknown
Not Supported
Disabled
Enabled
Power Saving Modes Entered Automatically
Power State Settable
Power Cycling Supported
Timed Power On Supported
CIM_LogicalDevice

NameValue
0Unknown
1Not Supported
2Disabled
3Enabled
4Power Saving Modes Entered Automatically
5Power State Settable
6Power Cycling Supported
7Timed Power On Supported
Property Availability Qualifiers
NameTypeValueFrom Class
DescriptionstringNote: 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
ValueMapstring
[See below.]
CIM_LogicalDevice
ValuesstringOther
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
Quiesced
CIM_LogicalDevice
MappingStringsstringMIF.DMTF|Operational State|006.5
MIB.IETF|HOST-RESOURCES-MIB.hrDeviceStatus
MIF.DMTF|Host Device|001.5
CIM_LogicalDevice
ModelCorrespondencestringCIM_LogicalDevice.AdditionalAvailability CIM_LogicalDevice

NameValue
1Other
2Unknown
3Running/Full Power
4Warning
5In Test
6Not Applicable
7Power Off
8Off Line
9Off Duty
10Degraded
11Not Installed
12Install Error
13Power Save - Unknown
14Power Save - Low Power Mode
15Power Save - Standby
16Power Cycle
17Power Save - Warning
18Paused
19Not Ready
20Not Configured
21Quiesced
Property StatusInfo Qualifiers
NameTypeValueFrom Class
DescriptionstringNote: 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
ValueMapstring
[See below.]
CIM_LogicalDevice
ValuesstringOther
Unknown
Enabled
Disabled
Not Applicable
CIM_LogicalDevice
MappingStringsstringMIF.DMTF|Operational State|006.4 CIM_LogicalDevice

NameValue
1Other
2Unknown
3Enabled
4Disabled
5Not Applicable
Property LastErrorCode Qualifiers
NameTypeValueFrom Class
DescriptionstringNote: The use of this method is deprecated. Deprecated description: LastErrorCode captures the last error code reported by the LogicalDevice. CIM_LogicalDevice

Property ErrorDescription Qualifiers
NameTypeValueFrom Class
DescriptionstringNote: 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
NameTypeValueFrom Class
DescriptionstringNote: 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
NameTypeValueFrom Class
DescriptionstringOtherIdentifyingInfo 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
MaxLenuint32256 CIM_LogicalDevice
ArrayTypestringIndexed CIM_LogicalDevice
ModelCorrespondencestringCIM_LogicalDevice.IdentifyingDescriptions CIM_LogicalDevice

Property PowerOnHours Qualifiers
NameTypeValueFrom Class
DescriptionstringNote: 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
UnitsstringHours CIM_LogicalDevice
Counterbooleantrue CIM_LogicalDevice

Property TotalPowerOnHours Qualifiers
NameTypeValueFrom Class
DescriptionstringNote: The use of this method is deprecated. Deprecated description: The total number of hours that this Device has been powered on. CIM_LogicalDevice
UnitsstringHours CIM_LogicalDevice
Counterbooleantrue CIM_LogicalDevice

Property IdentifyingDescriptions Qualifiers
NameTypeValueFrom Class
DescriptionstringAn 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
ArrayTypestringIndexed CIM_LogicalDevice
ModelCorrespondencestringCIM_LogicalDevice.OtherIdentifyingInfo CIM_LogicalDevice

Property AdditionalAvailability Qualifiers
NameTypeValueFrom Class
DescriptionstringAdditional 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
ValueMapstring
[See below.]
CIM_LogicalDevice
ValuesstringOther
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
Quiesced
CIM_LogicalDevice
ModelCorrespondencestringCIM_LogicalDevice.Availability CIM_LogicalDevice

NameValue
1Other
2Unknown
3Running/Full Power
4Warning
5In Test
6Not Applicable
7Power Off
8Off Line
9Off Duty
10Degraded
11Not Installed
12Install Error
13Power Save - Unknown
14Power Save - Low Power Mode
15Power Save - Standby
16Power Cycle
17Power Save - Warning
18Paused
19Not Ready
20Not Configured
21Quiesced
Property MaxQuiesceTime Qualifiers
NameTypeValueFrom Class
DescriptionstringNote: 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
UnitsstringMilliSeconds CIM_LogicalDevice

Property LocationIndicator Qualifiers
NameTypeValueFrom Class
Writebooleantrue CIM_LogicalDevice
DescriptionstringAn 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
ValueMapstring
[See below.]
CIM_LogicalDevice
ValuesstringUnknown
On
Off
Not Supported
CIM_LogicalDevice
ModelCorrespondencestringCIM_AlarmDevice.AlarmState
CIM_AlarmDevice.AudioIndicatorIsDisabled
CIM_AlarmDevice.VisualIndicatorIsDisabled
CIM_AlarmDevice.MotionIndicatorIsDisabled
CIM_LogicalDevice

NameValue
0Unknown
2On
3Off
4Not Supported
NameValue
0Unknown
2On
3Off
4Not Supported
NameValue
0Unknown
2On
3Off
4Not Supported
NameValue
0Unknown
2On
3Off
4Not Supported
NameValue
0Unknown
2On
3Off
4Not Supported
NameValue
0Unknown
2On
3Off
4Not Supported
NameValue
0Unknown
2On
3Off
4Not Supported
NameValue
0Unknown
2On
3Off
4Not Supported
Property EnabledState Qualifiers
NameTypeValueFrom Class
DescriptionstringEnabledState 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
ValueMapstring
[See below.]
CIM_EnabledLogicalElement
ValuesstringUnknown
Other
Enabled
Disabled
Shutting Down
Not Applicable
Enabled but Offline
In Test
Deferred
Quiesce
Starting
DMTF Reserved
Vendor Reserved
CIM_EnabledLogicalElement
ModelCorrespondencestringCIM_EnabledLogicalElement.OtherEnabledState CIM_EnabledLogicalElement

NameValue
0Unknown
1Other
2Enabled
3Disabled
4Shutting Down
5Not Applicable
6Enabled but Offline
7In Test
8Deferred
9Quiesce
10Starting
11..32767DMTF Reserved
32768..65535Vendor Reserved
Property OtherEnabledState Qualifiers
NameTypeValueFrom Class
DescriptionstringA 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
ModelCorrespondencestringCIM_EnabledLogicalElement.EnabledState CIM_EnabledLogicalElement

Property RequestedState Qualifiers
NameTypeValueFrom Class
DescriptionstringRequestedState 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
ValueMapstring
[See below.]
CIM_EnabledLogicalElement
ValuesstringEnabled
Disabled
Shut Down
No Change
Offline
Test
Deferred
Quiesce
Reboot
Reset
Not Applicable
DMTF Reserved
Vendor Reserved
CIM_EnabledLogicalElement
ModelCorrespondencestringCIM_EnabledLogicalElement.EnabledState CIM_EnabledLogicalElement

NameValue
2Enabled
3Disabled
4Shut Down
5No Change
6Offline
7Test
8Deferred
9Quiesce
10Reboot
11Reset
12Not Applicable
..DMTF Reserved
32768..65535Vendor Reserved
Property EnabledDefault Qualifiers
NameTypeValueFrom Class
Writebooleantrue CIM_EnabledLogicalElement
DescriptionstringAn 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
ValueMapstring
[See below.]
CIM_EnabledLogicalElement
ValuesstringEnabled
Disabled
Not Applicable
Enabled but Offline
No Default
DMTF Reserved
Vendor Reserved
CIM_EnabledLogicalElement

NameValue
2Enabled
3Disabled
5Not Applicable
6Enabled but Offline
7No Default
8..32767DMTF Reserved
32768..65535Vendor Reserved
Property TimeOfLastStateChange Qualifiers
NameTypeValueFrom Class
DescriptionstringThe 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
NameTypeValueFrom Class
DescriptionstringA datetime value that indicates when the object was installed. Lack of a value does not indicate that the object is not installed. CIM_ManagedSystemElement
MappingStringsstringMIF.DMTF|ComponentID|001.5 CIM_ManagedSystemElement

Property Name Qualifiers
NameTypeValueFrom Class
DescriptionstringThe 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
MaxLenuint321024 CIM_ManagedSystemElement

Property OperationalStatus Qualifiers
NameTypeValueFrom Class
DescriptionstringIndicates 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
ValueMapstring
[See below.]
CIM_ManagedSystemElement
ValuesstringUnknown
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 Reserved
CIM_ManagedSystemElement
ArrayTypestringIndexed CIM_ManagedSystemElement
ModelCorrespondencestringCIM_ManagedSystemElement.StatusDescriptions CIM_ManagedSystemElement

NameValue
0Unknown
1Other
2OK
3Degraded
4Stressed
5Predictive Failure
6Error
7Non-Recoverable Error
8Starting
9Stopping
10Stopped
11In Service
12No Contact
13Lost Communication
14Aborted
15Dormant
16Supporting Entity in Error
17Completed
18Power Mode
..DMTF Reserved
0x8000..Vendor Reserved
Property StatusDescriptions Qualifiers
NameTypeValueFrom Class
DescriptionstringStrings 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
ArrayTypestringIndexed CIM_ManagedSystemElement
ModelCorrespondencestringCIM_ManagedSystemElement.OperationalStatus CIM_ManagedSystemElement

Property Status Qualifiers
NameTypeValueFrom Class
DescriptionstringA 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
ValueMapstring
[See below.]
CIM_ManagedSystemElement
MaxLenuint3210 CIM_ManagedSystemElement

NameValue
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
NameTypeValueFrom Class
DescriptionstringIndicates 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
ValueMapstring
[See below.]
CIM_ManagedSystemElement
ValuesstringUnknown
OK
Degraded/Warning
Minor failure
Major failure
Critical failure
Non-recoverable error
DMTF Reserved
CIM_ManagedSystemElement

NameValue
0Unknown
5OK
10Degraded/Warning
15Minor failure
20Major failure
25Critical failure
30Non-recoverable error
..DMTF Reserved
Property Caption Qualifiers
NameTypeValueFrom Class
DescriptionstringThe Caption property is a short textual description (one- line string) of the object. CIM_ManagedElement
MaxLenuint3264 CIM_ManagedElement

Property Description Qualifiers
NameTypeValueFrom Class
DescriptionstringThe Description property provides a textual description of the object. CIM_ManagedElement

Property ElementName Qualifiers
NameTypeValueFrom Class
DescriptionstringA 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

Methods

NameTypeValueQualifiersParametersClassOrigin
SetPowerStateuint32 Deprecated
Description
PowerState
Time
CIM_LogicalDevice
Resetuint32 Description  CIM_LogicalDevice
EnableDeviceuint32 Deprecated
Description
EnabledCIM_LogicalDevice
OnlineDeviceuint32 Deprecated
Description
OnlineCIM_LogicalDevice
QuiesceDeviceuint32 Deprecated
Description
QuiesceCIM_LogicalDevice
SavePropertiesuint32 Deprecated
Description
 CIM_LogicalDevice
RestorePropertiesuint32 Deprecated
Description
 CIM_LogicalDevice
RequestStateChangeuint32 Description
ValueMap
Values
ModelCorrespondence
RequestedState
TimeoutPeriod
CIM_EnabledLogicalElement

Method Qualifiers

Method SetPowerState Qualifiers
NameTypeValueFrom Class
DescriptionstringNote: 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
NameTypeValueFrom Class
DescriptionstringRequests 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
NameTypeValueFrom Class
DescriptionstringNote: 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
NameTypeValueFrom Class
DescriptionstringNote: 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
NameTypeValueFrom Class
DescriptionstringNote: 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
NameTypeValueFrom Class
DescriptionstringNote: 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
NameTypeValueFrom Class
DescriptionstringNote: 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
NameTypeValueFrom Class
DescriptionstringRequests 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
ValueMapstring
[See below.]
CIM_EnabledLogicalElement
ValuesstringCompleted 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 Specific
CIM_EnabledLogicalElement
ModelCorrespondencestringCIM_EnabledLogicalElement.RequestedState CIM_EnabledLogicalElement

Parameters

Method SetPowerState Parameters
NameTypeQualifiers
PowerStateuint16IN
Description
ValueMap
Values
TimedatetimeIN
Description

Method EnableDevice Parameters
NameTypeQualifiers
EnabledbooleanIN
Description

Method OnlineDevice Parameters
NameTypeQualifiers
OnlinebooleanIN
Description

Method QuiesceDevice Parameters
NameTypeQualifiers
QuiescebooleanIN
Description

Method RequestStateChange Parameters
NameTypeQualifiers
RequestedStateuint16IN
Description
ValueMap
Values
ModelCorrespondence
TimeoutPerioddatetimeIN
Description

Parameter Qualifiers

Parameter PowerState Qualifiers
NameTypeValueFrom Class
INbooleantrue CIM_LogicalDevice
DescriptionstringThe power state to set. CIM_LogicalDevice
ValueMapstring
[See below.]
CIM_LogicalDevice
ValuesstringFull Power
Power Save - Low Power Mode
Power Save - Standby
Power Save - Other
Power Cycle
Power Off
CIM_LogicalDevice

Parameter Time Qualifiers
NameTypeValueFrom Class
INbooleantrue CIM_LogicalDevice
DescriptionstringTime 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
NameTypeValueFrom Class
INbooleantrue CIM_LogicalDevice
DescriptionstringIf TRUE, enable the device. If FALSE, disable the device. CIM_LogicalDevice

Parameter Online Qualifiers
NameTypeValueFrom Class
INbooleantrue CIM_LogicalDevice
DescriptionstringIf TRUE, take the device online. If FALSE, take the device offline. CIM_LogicalDevice

Parameter Quiesce Qualifiers
NameTypeValueFrom Class
INbooleantrue CIM_LogicalDevice
DescriptionstringIf set to TRUE, then cleanly cease all activity. If FALSE, resume activity. CIM_LogicalDevice

Parameter RequestedState Qualifiers
NameTypeValueFrom Class
INbooleantrue CIM_EnabledLogicalElement
DescriptionstringThe 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
ValueMapstring
[See below.]
CIM_EnabledLogicalElement
ValuesstringEnabled
Disabled
Shut Down
Offline
Test
Defer
Quiesce
Reboot
Reset
DMTF Reserved
Vendor Reserved
CIM_EnabledLogicalElement
ModelCorrespondencestringCIM_EnabledLogicalElement.RequestedState CIM_EnabledLogicalElement

Parameter TimeoutPeriod Qualifiers
NameTypeValueFrom Class
INbooleantrue CIM_EnabledLogicalElement
DescriptionstringA 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

Associations this class can participate in

Association
Class
Reference
Class
Role
CIM_ModulePortCIM_NetworkPortPartComponent
CIM_PortActiveConnectionCIM_NetworkPortDependent
CIM_OOBAlertServiceOnNetworkPortCIM_NetworkPortAntecedent
CIM_WakeUpServiceOnNetworkPortCIM_NetworkPortAntecedent
CIM_PortOnDeviceCIM_LogicalPortDependent
CIM_ProtocolControllerForPortCIM_LogicalPortDependent
CIM_PortImplementsEndpointCIM_LogicalPortAntecedent
CIM_SystemDeviceCIM_LogicalDevicePartComponent
CIM_PortOnDeviceCIM_LogicalDeviceAntecedent
CIM_SharingDependencyCIM_LogicalDeviceAntecedent
CIM_SharingDependencyCIM_LogicalDeviceDependent
CIM_PackageDependencyCIM_LogicalDeviceAntecedent
CIM_ProtocolControllerForDeviceCIM_LogicalDeviceDependent
CIM_ProtocolControllerForUnitCIM_LogicalDeviceDependent
CIM_ProtocolControllerAccessesUnitCIM_LogicalDeviceDependent
CIM_RealizesCIM_LogicalDeviceDependent
CIM_SuppliesPowerCIM_LogicalDeviceDependent
CIM_AllocatedResourceCIM_LogicalDeviceDependent
CIM_AllocatedDMACIM_LogicalDeviceDependent
CIM_AssociatedAlarmCIM_LogicalDeviceDependent
CIM_AssociatedSensorCIM_LogicalDeviceDependent
CIM_DeviceAccessedByFileCIM_LogicalDeviceDependent
CIM_DeviceConnectionCIM_LogicalDeviceAntecedent
CIM_DeviceConnectionCIM_LogicalDeviceDependent
CIM_ControlledByCIM_LogicalDeviceDependent
CIM_DeviceSAPImplementationCIM_LogicalDeviceAntecedent
CIM_DeviceServiceImplementationCIM_LogicalDeviceAntecedent
CIM_DeviceSoftwareCIM_LogicalDeviceDependent
CIM_DoorAccessToDeviceCIM_LogicalDeviceDependent
CIM_AssociatedBatteryCIM_LogicalDeviceDependent
CIM_AssociatedCoolingCIM_LogicalDeviceDependent
CIM_AssociatedLabelReaderCIM_LogicalDeviceDependent
CIM_DeviceIdentityCIM_LogicalDeviceSystemElement
CIM_DeviceIdentityCIM_LogicalDeviceSameElement
CIM_DeviceStatisticsCIM_LogicalDeviceElement
CIM_ErrorCountersForDeviceCIM_LogicalDeviceElement
CIM_SCSIInitiatorTargetLogicalUnitPathCIM_LogicalDeviceLogicalUnit
CIM_ReplicaPoolForStorageCIM_EnabledLogicalElementAntecedent
CIM_RemoteAccessAvailableToElementCIM_EnabledLogicalElementDependent
CIM_LogicalElementPerformsUoWCIM_LogicalElementAntecedent
CIM_ImportedShareRootCIM_LogicalElementAntecedent
CIM_ImportedShareRootCIM_LogicalElementDependent
CIM_LogicalElementUnitOfWorkDefCIM_LogicalElementAntecedent
CIM_SharedElementRootCIM_LogicalElementAntecedent
CIM_OperationLogCIM_LogicalElementDependent
CIM_AllocatedFromStoragePoolCIM_LogicalElementDependent
CIM_ResidesOnExtentCIM_LogicalElementDependent
CIM_AssociatedMemoryCIM_LogicalElementDependent
CIM_AttachedElementCIM_LogicalElementSystemElement
CIM_AttachedElementCIM_LogicalElementSameElement
CIM_MountedElementCIM_LogicalElementSystemElement
CIM_MountedElementCIM_LogicalElementSameElement
CIM_ImportedShareCIM_LogicalElementSystemElement
CIM_ImportedShareCIM_LogicalElementSameElement
CIM_SharedElementCIM_LogicalElementSystemElement
CIM_RedundancyComponentCIM_ManagedSystemElementPartComponent
CIM_SystemComponentCIM_ManagedSystemElementPartComponent
CIM_UseOfLogCIM_ManagedSystemElementDependent
CIM_DiagnosticTestForMSECIM_ManagedSystemElementDependent
CIM_CollectedMSEsCIM_ManagedSystemElementMember
CIM_DiagnosticResultForMSECIM_ManagedSystemElementSystemElement
CIM_ElementConfigurationCIM_ManagedSystemElementElement
CIM_ElementSettingCIM_ManagedSystemElementElement
CIM_ActsAsSpareCIM_ManagedSystemElementSpare
CIM_ComponentCIM_ManagedElementGroupComponent
CIM_ComponentCIM_ManagedElementPartComponent
CIM_ConcreteComponentCIM_ManagedElementGroupComponent
CIM_ConcreteComponentCIM_ManagedElementPartComponent
CIM_CredentialContextCIM_ManagedElementElementProvidingContext
CIM_DefaultElementCapabilitiesCIM_ManagedElementManagedElement
CIM_DependencyCIM_ManagedElementAntecedent
CIM_DependencyCIM_ManagedElementDependent
CIM_HostedDependencyCIM_ManagedElementAntecedent
CIM_HostedDependencyCIM_ManagedElementDependent
CIM_ScopedSettingCIM_ManagedElementAntecedent
CIM_MetricDefForMECIM_ManagedElementAntecedent
CIM_MetricForMECIM_ManagedElementAntecedent
CIM_RelatedElementCausingErrorCIM_ManagedElementDependent
CIM_RelatedElementCausingErrorCIM_ManagedElementAntecedent
CIM_SparedCIM_ManagedElementAntecedent
CIM_SparedCIM_ManagedElementDependent
CIM_ConcreteDependencyCIM_ManagedElementAntecedent
CIM_ConcreteDependencyCIM_ManagedElementDependent
CIM_ElementAsUserCIM_ManagedElementAntecedent
CIM_RecordAppliesToElementCIM_ManagedElementDependent
CIM_AuthenticationTargetCIM_ManagedElementDependent
CIM_AuthorizationSubjectCIM_ManagedElementDependent
CIM_AuthorizationTargetCIM_ManagedElementDependent
CIM_ElementSoftwareIdentityCIM_ManagedElementDependent
CIM_IsSpareCIM_ManagedElementAntecedent
CIM_ProvidesServiceToElementCIM_ManagedElementDependent
CIM_ElementCapabilitiesCIM_ManagedElementManagedElement
CIM_IdentityContextCIM_ManagedElementElementProvidingContext
CIM_LogicalIdentityCIM_ManagedElementSystemElement
CIM_LogicalIdentityCIM_ManagedElementSameElement
CIM_ConcreteIdentityCIM_ManagedElementSystemElement
CIM_ConcreteIdentityCIM_ManagedElementSameElement
CIM_SWRManageableAspectCIM_ManagedElementSystemElement
CIM_MemberOfCollectionCIM_ManagedElementMember
CIM_MemberPrincipalCIM_ManagedElementMember
CIM_ElementInPolicyRoleCollectionCIM_ManagedElementMember
CIM_OwningCollectionElementCIM_ManagedElementOwningElement
CIM_ParametersForMethodCIM_ManagedElementTheMethod
CIM_ParameterValueSourcesCIM_ManagedElementValueSource
CIM_PolicySetAppliesToElementCIM_ManagedElementManagedElement
CIM_AuthorizationRuleAppliesToTargetCIM_ManagedElementManagedElement
CIM_RoleLimitedToTargetCIM_ManagedElementTargetElement
CIM_StatisticsCIM_ManagedElementElement
CIM_SynchronizedCIM_ManagedElementSystemElement
CIM_SynchronizedCIM_ManagedElementSyncedElement
CIM_StorageSynchronizedCIM_ManagedElementSystemElement
CIM_StorageSynchronizedCIM_ManagedElementSyncedElement
CIM_AssignedIdentityCIM_ManagedElementManagedElement
CIM_AuthorizedSubjectCIM_ManagedElementPrivilegedElement
CIM_AuthorizedTargetCIM_ManagedElementTargetElement
CIM_ElementConformsToProfileCIM_ManagedElementManagedElement
CIM_ElementLocationCIM_ManagedElementElement
CIM_ElementProfileCIM_ManagedElementManagedElement
CIM_ElementSecuritySensitivityCIM_ManagedElementManagedElement
CIM_ElementSettingDataCIM_ManagedElementManagedElement
CIM_ElementStatisticalDataCIM_ManagedElementManagedElement
CIM_OwningJobElementCIM_ManagedElementOwningElement
CIM_AffectedJobElementCIM_ManagedElementAffectedElement
CIM_ServiceAffectsElementCIM_ManagedElementAffectedElement
CIM_ServiceAvailableToElementCIM_ManagedElementUserOfService
CIM_SAPAvailableForElementCIM_ManagedElementManagedElement
CIM_ManagementSAPCIM_ManagedElementManagedElement