Windows Dev Center

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

[Abstract, UUID("{8502C529-5FBB-11D2-AAC1-006008C78BC7}"), AMENDMENT]
class CIM_LogicalDevice : CIM_LogicalElement
{
  string   Caption;
  string   Description;
  datetime InstallDate;
  string   Name;
  uint16   OperationalStatus;
  string   Status;
  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
Qualifiers: MappingStrings ("MIF.DMTF|Operational State|003.5", "MIB.IETF|HOST-RESOURCES-MIB.hrDeviceStatus")

Availability and status of the device.

ValueMeaning
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

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

Power Save - Low Power Mode
14

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

Power Save - Standby
15

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

Power Cycle
16
Power Save - Warning
17

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

Paused
18

The device is paused.

Not Ready
19

The device is not ready.

Not Configured
20

The device is not configured.

Quiesced
21

The device is quiet.

 

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

A short textual description of the object. This property is inherited from CIM_ManagedSystemElement.

ConfigManagerErrorCode
Data type: uint32
Access type: Read-only
Qualifiers: Schema ("Win32")

Win32 Configuration Manager error code.

ValueMeaning
This device is working properly.
0

Device is working properly.

This device is not configured correctly.
1

Device is not configured correctly.

Windows cannot load the driver for this device.
2

Windows cannot load the driver for this device.

The driver for this device might be corrupted, or your system may be running low on memory or other resources.
3

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

This device is not working properly. One of its drivers or your registry might be corrupted.
4

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

The driver for this device needs a resource that Windows cannot manage.
5

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

The boot configuration for this device conflicts with other devices.
6

Boot configuration for the device conflicts with other devices.

Cannot filter.
7

Cannot filter.

The driver loader for the device is missing.
8

Driver loader for the device is missing.

This device is not working properly because the controlling firmware is reporting the resources for the device incorrectly.
9

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

This device cannot start.
10

Device cannot start.

This device failed.
11

Device failed.

This device cannot find enough free resources that it can use.
12

Device cannot find enough free resources to use.

Windows cannot verify this device's resources.
13

Windows cannot verify the device's resources.

This device cannot work properly until you restart your computer.
14

Device cannot work properly until the computer is restarted.

This device is not working properly because there is probably a re-enumeration problem.
15

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

Windows cannot identify all the resources this device uses.
16

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

This device is asking for an unknown resource type.
17

Device is requesting an unknown resource type.

Reinstall the drivers for this device.
18

Device drivers must be reinstalled.

Failure using the VxD loader.
19

Failure using the VxD loader.

Your registry might be corrupted.
20

Registry might be corrupted.

System failure: Try changing the driver for this device. If that does not work, see your hardware documentation. Windows is removing this device.
21

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

This device is disabled.
22

Device is disabled.

System failure: Try changing the driver for this device. If that doesn't work, see your hardware documentation.
23

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

This device is not present, is not working properly, or does not have all its drivers installed.
24

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

Windows is still setting up this device.
25

Windows is still setting up the device.

Windows is still setting up this device.
26

Windows is still setting up the device.

This device does not have valid log configuration.
27

Device does not have valid log configuration.

The drivers for this device are not installed.
28

Device drivers are not installed.

This device is disabled because the firmware of the device did not give it the required resources.
29

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

This device is using an Interrupt Request (IRQ) resource that another device is using.
30

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

This device is not working properly because Windows cannot load the drivers required for this device.
31

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

 

ConfigManagerUserConfig
Data type: boolean
Access type: Read-only
Qualifiers: Schema ("Win32")

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

CreationClassName
Data type: string
Access type: Read-only
Qualifiers: CIM_Key

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
Qualifiers: DisplayName ("Description")

A textual description of the object. This property is inherited from CIM_ManagedSystemElement.

DeviceID
Data type: string
Access type: Read-only
Qualifiers: CIM_Key

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

ErrorCleared
Data type: boolean
Access type: Read-only

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

ErrorDescription
Data type: string
Access type: Read-only

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

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
Qualifiers: MappingStrings ("MIF.DMTF|ComponentID|001.5") , DisplayName ("Install Date")

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

LastErrorCode
Data type: uint32
Access type: Read-only

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
Qualifiers: DisplayName ("Name")

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

OperationalStatus
Data type: uint16
Access type: Read-only

The current statuses of the element. This property is inherited from CIM_ManagedSystemElement.

ValueMeaning
Unknown
0

An unknown error has occurred.

Other
1

An error other than one on this list has occurred.

OK
2

The element 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
19–32767

DMTF has reserved this portion of the range for additional OperationalStatus values in the future.

Vendor Reserved
32768–65535

Microsoft has reserved the unused portion of the range for additional OperationalStatus values in the future.

 

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
Qualifiers: Schema ("Win32")

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

Example: "*PNP030b"

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

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

ValueMeaning
Unknown
0
Not Supported
1
Disabled
2
Enabled
3

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

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

Power State Settable
5

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

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

Timed Power On Supported
7

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

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.

Status
Data type: string
Access type: Read-only
Qualifiers: MaxLen (10) , DisplayName ("Status")

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 is inherited from CIM_ManagedSystemElement.

Values include the following:

OK ("OK")
Error ("Error")
Degraded ("Degraded")
Unknown ("Unknown")
Pred Fail ("Pred Fail")
Starting ("Starting")
Stopping ("Stopping")
Service ("Service")
Stressed ("Stressed")
NonRecover ("NonRecover")
No Contact ("No Contact")
Lost Comm ("Lost Comm")
StatusInfo
Data type: uint16
Access type: Read-only
Qualifiers: MappingStrings ("MIF.DMTF|Operational State|003.3")

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)
Unknown (2)
Enabled (3)
Disabled (4)
Not Applicable (5)
SystemCreationClassName
Data type: string
Access type: Read-only
Qualifiers: Propagated ("CIM_System.CreationClassName") , CIM_Key

Scoping system's creation class name.

SystemName
Data type: string
Access type: Read-only
Qualifiers: Propagated ("CIM_System.Name") , CIM_Key

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:
© 2015 Microsoft