Export (0) Print
Expand All

CIM_LogicalDevice class

The CIM_LogicalDevice class represents a hardware entity that may or may not be realized in physical hardware.

Important  The DMTF (Distributed Management Task Force) CIM (Common Information Model) classes are the parent classes upon which WMI classes are built. WMI currently supports only the CIM 2.x version schemas.

The following syntax is simplified from Managed Object Format (MOF) code and includes all inherited properties. Properties are listed in alphabetic order, not MOF order.

Syntax

class CIM_LogicalDevice : CIM_LogicalElement
{
  string   Caption;
  string   Description;
  string   ElementName;
           InstanceId;
  datetime REF InstallDate;
  string   Name;
           OperationalStatus;
           StatusDescriptions;
  string   Status;
           HealthState;
           CommunicationStatus;
  uint16   DetailedStatus;
           OperatingStatus;
  uint16   PrimaryStatus;
  unit16   AdditionalAvailability;
  uint16   Availability;
  uint32   ConfigManagerErrorCode;
  boolean  ConfigManagerUserConfig;
  string   CreationClassName;
  string   DeviceID;
  boolean  ErrorCleared;
  string   ErrorDescription;
  string   IdentifyingDescriptions[1];
  uint32   LastErrorCode;
  uint64   MaxQuiesceTime;
  uint64   OtherIdentifyingInfo;
  string   PNPDeviceID;
  uint16   PowerManagementCapabilities[];
  boolean  PowerManagementSupported;
  uint16   StatusInfo;
  uint64   PowerOnHours;
  string   SystemCreationClassName;
  string   SystemName;
  uint64   TotalPowerOnHours;
};

Members

The CIM_LogicalDevice class has these types of members:

Methods

The CIM_LogicalDevice class has these methods.

MethodDescription
Reset

Requests a reset of the logical device. Not implemented by WMI.

SetPowerState

Defines the desired power state for a logical device and when a device should be put into that state. Not implemented by WMI.

 

Properties

The CIM_LogicalDevice class has these properties.

AdditionalAvailability
Data type: unit16
Access type: Write-only

Additional availability and status of the Device, beyond that specified in the Availability property. The Availability property denotes the primary status and availability of the Device. In some cases, this will not be sufficient to denote the complete status of the Device. In those cases, the AdditionalAvailability property can be used to provide further information. For example, a Device's primary Availability may be Off line (value=8), but it may also be in a low power state (AdditonalAvailability value=14), or the Device could be running Diagnostics (AdditionalAvailability value=5, In Test)."

Other (1)
Unknown (2)
Running/Full Power (3)
Warning (4)
In Test (5)
Not Applicable (6)
Power Off (7)
Off Line (8)
Off Duty (9)
Degraded (10)
Not Installed (11)
Install Error (12)
Power Save - Unknown (13)
Power Save - Low Power Mode (14)
Power Save - Standby (15)
Power Cycle (16)
Power Save - Warning (17)
Paused (18)
Not Ready (19)
Not Configured (20)
Quiesce (21)
Availability
Data type: uint16
Access type: Read-only

Availability and status of the device.

ValueMeaning
Other
1 (0x1)
Unknown
2 (0x2)
Running/Full Power
3 (0x3)
Warning
4 (0x4)
In Test
5 (0x5)
Not Applicable
6 (0x6)
Power Off
7 (0x7)
Off Line
8 (0x8)
Off Duty
9 (0x9)
Degraded
10 (0xA)
Not Installed
11 (0xB)
Install Error
12 (0xC)
Power Save - Unknown
13 (0xD)

The device is known to be in a power save mode, but its exact status is unknown.

Power Save - Low Power Mode
14 (0xE)

The device is in a power save state but still functioning, and may exhibit degraded performance.

Power Save - Standby
15 (0xF)

The device is not functioning but could be brought to full power quickly.

Power Cycle
16 (0x10)
Power Save - Warning
17 (0x11)

The device is in a warning state, though also in a power save mode.

 

Caption
Data type: string
Access type: Read-only
Qualifiers: MaxLen ( 64 )

A short textual description of the object. This property inherits from CIM_ManagedElement.

CommunicationStatus
Access type: Write-only

Indicates the ability of the instrumentation to communicate with the underlying ManagedElement. This property inherits from CIM_ManagedSystemElement.

ValueMeaning
Not Available
0

the implementation (provider) is capable of returning a value for this property, but not ever for this particular piece of hardware/software or the property is intentionally not used because it adds no meaningful information (as in the case of a property that is intended to add additional info to another property).

No Additional Information
1

the element is functioning normally as indicated by PrimaryStatus = OK.

Stressed
2

the element is functioning, but needs attention. Examples of Stressed states are overload, overheated, and so on.

Predictive Failure
3

an element is functioning normally but a failure is predicted in the near future.

Non-Recoverable Error
4

this element is in an error condition that requires human intervention.

Supporting Entity in Error
5

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.

DMTF Reserved
..
Vendor Reserved
0x800

 

ConfigManagerErrorCode
Data type: uint32
Access type: Read-only

Win32 Configuration Manager error code.

ValueMeaning
0 (0x0)

Device is working properly.

1 (0x1)

Device is not configured correctly.

2 (0x2)

Windows cannot load the driver for this device.

3 (0x3)

Driver for this device might be corrupted, or the system may be low on memory or other resources.

4 (0x4)

Device is not working properly. One of its drivers or the registry might be corrupted.

5 (0x5)

Driver for the device requires a resource that Windows cannot manage.

6 (0x6)

Boot configuration for the device conflicts with other devices.

7 (0x7)

Cannot filter.

8 (0x8)

Driver loader for the device is missing.

9 (0x9)

Device is not working properly; the controlling firmware is incorrectly reporting the resources for the device.

10 (0xA)

Device cannot start.

11 (0xB)

Device failed.

12 (0xC)

Device cannot find enough free resources to use.

13 (0xD)

Windows cannot verify the device's resources.

14 (0xE)

Device cannot work properly until the computer is restarted.

15 (0xF)

Device is not working properly due to a possible re-enumeration problem.

16 (0x10)

Windows cannot identify all of the resources that the device uses.

17 (0x11)

Device is requesting an unknown resource type.

18 (0x12)

Device drivers must be reinstalled.

19 (0x13)

Failure using the VxD loader.

20 (0x14)

Registry might be corrupted.

21 (0x15)

System failure. If changing the device driver is ineffective, see the hardware documentation. Windows is removing the device.

22 (0x16)

Device is disabled.

23 (0x17)

System failure. If changing the device driver is ineffective, see the hardware documentation.

24 (0x18)

Device is not present, not working properly, or does not have all of its drivers installed.

25 (0x19)

Windows is still setting up the device.

26 (0x1A)

Windows is still setting up the device.

27 (0x1B)

Device does not have valid log configuration.

28 (0x1C)

Device drivers are not installed.

29 (0x1D)

Device is disabled; the device firmware did not provide the required resources.

30 (0x1E)

Device is using an IRQ resource that another device is using.

31 (0x1F)

Device is not working properly; Windows cannot load the required device drivers.

 

ConfigManagerUserConfig
Data type: boolean
Access type: Read-only

If TRUE, the device is using a user-defined configuration.

CreationClassName
Data type: string
Access type: Read-only

Name of the class or subclass used in the creation of an instance. When used with other key properties of the class, this property allows all instances of the class and its subclasses to be uniquely identified.

Description
Data type: string
Access type: Read-only

A textual description of the object. This property inherits from CIM_ManagedElement.

DetailedStatus
Data type: uint16
Access type: Write-only

Compliments PrimaryStatus with additional status detail. Detailed status is used to expand upon the PrimaryStatus of the element. This property inherits from CIM_ManagedSystemElement.

ValueMeaning
Not Available
0

he implementation (provider) is capable of returning a value for this property, but not ever for this particular piece of hardware/software or the property is intentionally not used because it adds no meaningful information (as in the case of a property that is intended to add additional info to another property).

No Additional Information
1

the element is functioning normally as indicated by PrimaryStatus = OK.

Stressed
2

Stressed\" indicates that the element is functioning, but needs attention. Examples of Stressed states are overload, overheated, and so on.

Predictive Failure
3

indicates that an element is functioning normally but a failure is predicted in the near future.

Non-Recoverable Error
4

indicates that this element is in an error condition that requires human intervention.

Supporting Entity in Error
5

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.

DMTF Reserved
...
Vendor Reserved
0x800

 

DeviceID
Data type: string
Access type: Read-only

Address or other identifying information to uniquely name the logical device.

ElementName
Data type: string
Access type: Read-only

A user-friendly name for the object. This property enables each instance to define a display name in addition to its key properties, identity data, and description information. Be aware that the Name property of ManagedSystemElement is also defined as a display name. However, it is often subclassed to be a Key. 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. This property inherits from CIM_ManagedElement.

ErrorCleared
Data type: boolean
Access type: Read-only
Qualifiers: Depricated

If TRUE, the error reported in the LastErrorCode property is now cleared.

ErrorDescription
Data type: string
Access type: Read-only
Qualifiers: Depricated

Free-form string that supplies information about the error recorded in the LastErrorCode property and corrective actions to perform.

HealthState
Access type: Write-only

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. This property inherits from CIM_ManagedSystemElement.

ValueMeaning
Unknown
0

The implementation cannot report on HealthState at this time.

OK
5

The element is fully functional and is operating within normal operational parameters and without error.

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.

Minor Failure
15

All functionality is available but some might be degraded.

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.

Critical Failure
25

The element is non-functional and recovery might not be possible.

Non-recoverable Error
30

The element has completely failed, and recovery is not possible. All functionality provided by this element has been lost.

Reserved
...

The remaining values are reserved for DTMF use.

 

IdentifyingDescriptions
Data type: string array
Access type: Read-only

An array of free-form strings providing explanations and details behind the entries in the OtherIdentifyingInfo array. Note, each entry of this array is related to the entry in OtherIdentifyingInfo that is located at the same index.

InstallDate
Data type: datetime
Access type: Read-only

Indicates when the object was installed. Lack of a value does not indicate that the object is not installed. This property inherits from CIM_ManagedSystemElement.

InstanceId
Access type: Read-only

Within the scope of the instantiating Namespace, InstanceID opaquely and uniquely identifies an instance of this class. To ensure uniqueness within the NameSpace, the value of InstanceID should be constructed using the following "preferred" algorithm: OrgID:LocalID Where OrgID and LocalID are separated by a colon (:), and where OrgID must include a copyrighted, trademarked, or otherwise unique name that is owned by the business entity that is creating or defining the InstanceID or that is a registered ID assigned to the business entity by a recognized global authority. (This requirement is similar to the SchemaName_ClassName structure of Schema class names.) In addition, to ensure uniqueness, OrgID must not contain a colon (:). When using this algorithm, the first colon to appear in InstanceID must appear between OrgID and LocalID. LocalID is chosen by the business entity and should not be reused to identify different underlying (real-world) elements. If the above preferred algorithm is not used, the defining entity must assure that the resulting InstanceID is not reused across any InstanceIDs produced by this or other providers for the NameSpace of this instance. For DMTF-defined instances, the "preferred" algorithm must be used with the OrgID set to CIM. This property inherits from CIM_ManagedElement.

LastErrorCode
Data type: uint32
Access type: Read-only
Qualifiers: Depricated

Last error code reported by the logical device.

MaxQuiesceTime
Data type: uint64
Access type: Read-only
Qualifiers: Depricated

Maximum time in milliseconds, that a Device can run in a Quiesced state. A Device's state is defined in its Availability and AdditionalAvailability properties, where Quiesced is conveyed by the value 21. What occurs at the end of the time limit is device-specific. The Device may unquiesce, may offline or take other action. A value of 0 indicates that a Device can remain quiesced indefinitely.

Note  

"The MaxQuiesceTime property has been deprecated. When evaluating the use of Quiesce, it was determine that this single property is not adequate for describing when a device will automatically exit a quiescent state. In fact, the most likely scenario for a device to exit a quiescent state was determined to be based on the number of outstanding requests queued rather than on a maximum time. This will be re-evaluated and repositioned later. \n

Name
Data type: string
Access type: Read-only

Label by which the object is known. When subclassed, this property can be overridden to be a key property. This property inherits from CIM_ManagedSystemElement.

OperatingStatus
Access type: Read-only

Provides a current status value for the operational condition of the element and can be used for providing more detail with respect to the value of EnabledState. It can also provide the transitional states when an element is transitioning from one state to another, such as when an element is transitioning between EnabledState and RequestedState, as well as other transitional conditions. This property inherits from CIM_ManagedSystemElement.

ValueMeaning
Unknown
0

the implementation is in general capable of returning this property, but is unable to do so at this time.

Not Available
1

the implementation (provider) is capable of returning a value for this property, but not ever for this particular piece of hardware/software or the property is intentionally not used because it adds no meaningful information (as in the case of a property that is intended to add additional info to another property).

Servicing
2

describes an element being configured, maintained, cleaned, or otherwise administered. Starting describes an element being initialized. \n\"Stopping\" describes an element being brought to an orderly stop.

Starting
3

The element is starting.

Stopping
4

The element is stopping.

Stopped
5

A a clean and orderly stop has occurred.

Aborted
6

An abrupt stop has occurred; the state and configuration of the element might need to be updated.

Dormant
7

The element is inactive or quiesced.

Completed
8

The element has completed its operation. This value should be combined with either OK, Error, or Degraded in the PrimaryStatus 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).

Migrating
9

The element is being moved between host elements.

Emigrating
10

The element is being moved away from host element.

Immigrating
11

The element is being moved to new host element.

Snapshotting
12
Shutting Down
13

The element being brought to an abrupt stop.

In Test
14

The element is performing test functions.

Transitioning
15

The element is between states, that is, it is not fully available in either its previous state or its next state. This value should be used if other values indicating a transition to a specific state are not applicable.

In Service
16

The element is in service and operational."

DTMF Reserved
..
Vendor Reserved
0x800

 

OperationalStatus
Data type:
Access type: Write-only

The current statuses of the element. This property inherits from CIM_ManagedSystemElement.

ValueMeaning
Unknown
0

An unknown error has occured.

Other
1

An error other than one on this list has occured.

OK
2

The elemetn is OK.

Degraded
3

The element has been degraded.

Stressed
4

The element is functioning, but needs attention. Examples of Stressed states are overload, overheated, and so on.

Predictive Failure
5

An element is functioning nominally but predicting a failure in the near future.

Error
6

An error has occurred.

Non-Recoverable Error
7

A non-recoverable error has occurred.

Starting
8

The element is in the process of starting.

Stopping
9

The element is in the process of stopping.

Stopped
10

A clean and orderly stop has occurred.

In Service
11

An element being configured, maintained, cleaned, or otherwise administered.

No Contact
12

The monitoring system has knowledge of this element, but has never been able to establish communications with it.

Lost Communication
13

The Managed System Element is known to exist and has been contacted successfully in the past, but is currently unreachable.

Aborted
14

An abrupt stop has occurred; the state and configuration of the element might need to be updated.

Dormant
15

The element is inactive or quiesced.

Supporting Entity in Error
16

The current 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
17

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
18

The element has additional power model information contained in the Associated PowerManagementService association.

Relocating
19

indicates the element is being relocated. 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.

DMTF Reserved
..

Reserved for the DTMF.

Vendor Reserved
0x8000

Reserved for the vendors.

 

OtherIdentifyingInfo
Data type: uint64
Access type: Read-only

Array that captures additional data, beyond DeviceID information, that could be used to identify a LogicalDevice. One example would be to hold the Operating System's user friendly name for the Device in this property. Maximum length is 256.

PNPDeviceID
Data type: string
Access type: Read-only

Indicates the Win32 Plug and Play device identifier of the logical device.

Example: "*PNP030b"

PowerManagementCapabilities
Data type: uint16 array
Access type: Read-only
Qualifiers: Depricated

Array of the specific power-related capabilities of a logical device. This property is inherited from CIM_LogicalDevice.

ValueMeaning
Unknown
0 (0x0)
Not Supported
1 (0x1)
Disabled
2 (0x2)
Enabled
3 (0x3)

The power management features are currently enabled but the exact feature set is unknown or the information is unavailable.

Power Saving Modes Entered Automatically
4 (0x4)

The device can change its power state based on usage or other criteria.

Power State Settable
5 (0x5)

The SetPowerState method is supported. This method is found on the parent CIM_LogicalDevice class and can be implemented. For more information, see Designing Managed Object Format (MOF) Classes.

Power Cycling Supported
6 (0x6)

The SetPowerState method can be invoked with the PowerState parameter set to 5 ("Power Cycle").

Timed Power On Supported
7 (0x7)

The SetPowerState method can be invoked with the PowerStateparameter set to 5 ("Power Cycle") and Time set to a specific date and time, or interval, for power-on.

 

PowerManagementSupported
Data type: boolean
Access type: Read-only
Qualifiers: Depricated

If TRUE, the device can be power managed, that is, put into a power-save state. If FALSE, the integer value 1 ("Not Supported") should be the only entry in the PowerManagementCapabilities array.

This property does not indicate whether power management features are currently enabled, or if enabled, which features are supported. For more information, see the PowerManagementCapabilities array.

PowerOnHours
Data type: uint64
Access type: Read-only

The number of consecutive hours that this Device has been powered, since its last power cycle.

PrimaryStatus
Data type: uint16
Access type: Write-only

provides a high level status value, intended to align with Red-Yellow-Green type representation of status. It should be used in conjunction with DetailedStatus to provide high level and detailed health status of the ManagedElement and its subcomponents. This property inherits from CIM_ManagedSystemElement.

Unknown (0)
OK (1)
Degraded (2)
Error (3)
DMTF Reserved (...)
Vendor Reserved (0x8000)
Status
Data type: string
Access type: Read-only

String that indicates the current status of the object. Operational and non-operational status can be defined. Operational status can include "OK", "Degraded", and "Pred Fail". "Pred Fail" indicates that an element is functioning properly, but is predicting a failure (for example, a SMART-enabled hard disk drive).

Non-operational status can include "Error", "Starting", "Stopping", and "Service". "Service" can apply during disk mirror-resilvering, reloading a user permissions list, or other administrative work. Not all such work is online, but the managed element is neither "OK" nor in one of the other states. This property inherits from CIM_ManagedSystemElement.

Values include the following:

"OK"
"Error"
"Degraded"
"Unknown"
"Pred Fail"
"Starting"
"Stopping"
"Service"
"Stressed"
"NonRecover"
"No Contact"
"Lost Comm"
StatusDescriptions
Data type:
Access type: Write-only

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. This property inherits from CIM_ManagedSystemElement.

StatusInfo
Data type: uint16
Access type: Read-only
Qualifiers: Depricated

State of the logical device. If this property does not apply to the logical device, the value 5 ("Not Applicable") should be used.

Other (1 (0x1))
Unknown (2 (0x2))
Enabled (3 (0x3))
Disabled (4 (0x4))
Not Applicable (5 (0x5))
SystemCreationClassName
Data type: string
Access type: Read-only

Scoping system's creation class name.

SystemName
Data type: string
Access type: Read-only

Scoping system's name.

TotalPowerOnHours
Data type: uint64
Access type: Read-only

The total number of hours that this device has been powered.

Remarks

Logical device characteristics that manage operation or configuration are contained in, or associated with, the CIM_LogicalDevice object. Printer operational properties, for example, are supported paper sizes or detected errors. Sensor device configuration properties, for example, are threshold settings. Various configurations can exist for a logical device and are contained in the CIM_Setting objects, which are associated with the logical device.

The CIM_LogicalDevice class is derived from CIM_LogicalElement.

WMI does not implement this class. For classes derived from CIM_LogicalDevice, see Win32 Classes.

This documentation is derived from the CIM class descriptions published by the DMTF. Microsoft may have made changes to correct minor errors, conform to Microsoft SDK documentation standards, or provide more information.

Requirements

Minimum supported client

Windows Vista

Minimum supported server

Windows Server 2003

Namespace

\root\CIMV2

MOF

CIMWin32.mof

DLL

CIMWin32.dll

 

 

Show:
© 2014 Microsoft