An abstraction or emulation of a hardware entity that may or may not be based on physical hardware.
Syntax
[Abstract, Version("2.8.0"), UMLPackagePath("CIM::Core::Device"), AMENDMENT]
class CIM_LogicalDevice : CIM_EnabledLogicalElement
{
string SystemCreationClassName;
string SystemName;
string CreationClassName;
string DeviceID;
boolean PowerManagementSupported;
uint16 PowerManagementCapabilities[];
uint16 Availability;
uint16 StatusInfo;
uint32 LastErrorCode;
string ErrorDescription;
boolean ErrorCleared;
string OtherIdentifyingInfo[];
uint64 PowerOnHours;
uint64 TotalPowerOnHours;
string IdentifyingDescriptions[];
uint16 AdditionalAvailability[];
uint64 MaxQuiesceTime;
};
Members
The CIM_LogicalDevice class has these types of members:
Methods
The CIM_LogicalDevice class has these methods.
| Method | Description |
|---|---|
| EnableDevice | This method is deprecated. Instead, use the RequestStateChange method. Deprecated description: Enables or disables the logical device. |
| OnlineDevice | This method is deprecated. Instead, use the RequestStateChange method. Deprecated description: Brings the logical device online so it can accept requests, or offline so it can no longer accept requests. |
| QuiesceDevice | This method is deprecated. Instead, use the RequestStateChange method. Deprecated description: Temporarily suspends activity on the logical device, or re-enables the activity. |
| Reset | Resets the logical device. |
| RestoreProperties | Restores a previous configuration and state of the logical device. |
| SaveProperties | Saves the configuration and state of the logical device. |
| SetPowerState | This method is deprecated. Instead, use the SetPowerState property of the CIM_PowerManagementService class. Deprecated description: Sets the power state of the logical device. |
Properties
The CIM_LogicalDevice class has these properties.
AdditionalAvailability
Data type: uint16 array
Access type: Read-only
Qualifiers: ModelCorrespondence ("CIM_LogicalDevice.Availability")
An array that contains availability information about of the logical device, in addition to the that of the Availability property.
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)
Quiesced (21)
Availability
Data type: uint16
Access type: Read-only
Qualifiers: MappingStrings ("MIF.DMTF|Operational State|006.5", "MIB.IETF|HOST-RESOURCES-MIB.hrDeviceStatus", "MIF.DMTF|Host Device|001.5"), ModelCorrespondence ("CIM_LogicalDevice.AdditionalAvailability")
Contains the availability of the logical device.
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)
Quiesced (21)
CreationClassName
Data type: string
Access type: Read-only
The class name used to create an instance of the logical device. CreationClassName is combined with other key properties of this class to uniquely identify instances of this class and its subclasses.
DeviceID
Data type: string
Access type: Read-only
A unique identifier of the logical device, such as the address.
ErrorCleared
Data type: boolean
Access type: Read-only
Qualifiers: Deprecated ("CIM_ManagedSystemElement.OperationalStatus")
This property is deprecated. Instead, use the OperationalStatus property from the CIM_ManagedSystemElement class.
Deprecated description: Indicates whether an error reported by the LastErrorCode property is cleared.
ErrorDescription
Data type: string
Access type: Read-only
Qualifiers: Deprecated ("CIM_DeviceErrorData.ErrorDescription")
This property is deprecated. Instead, use the ErrorDescription property from the CIM_DeviceErrorData class.
Deprecated description: Additional information about the error reported by the LastErrorCode property.
IdentifyingDescriptions
Data type: string array
Access type: Read-only
Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_LogicalDevice.OtherIdentifyingInfo")
An array of strings that describe the OtherIdentifyingInfo array items of the same index.
LastErrorCode
Data type: uint32
Access type: Read-only
Qualifiers: Deprecated ("CIM_DeviceErrorData.LastErrorCode")
This property is deprecated. Instead, we use the LastErrorCode property from theCIM_DeviceErrorData class.
Deprecated description: The last error code reported by the logical device.
MaxQuiesceTime
Data type: uint64
Access type: Read-only
Qualifiers: Deprecated ("No value"), Units ("MilliSeconds")
This property is deprecated and should not be used.
Deprecated description: The maximum time in milliseconds, that a device can remain in a temporarily disabled state (Availability and AdditionalAvailability properties set to "21" quiescent ). A value of "0" indicates that the logical device can remain in a temporarily disabled state indefinitely.
OtherIdentifyingInfo
Data type: string array
Access type: Read-only
Qualifiers: ArrayType ("Indexed"), MaxLen (256), ModelCorrespondence ("CIM_LogicalDevice.IdentifyingDescriptions")
Information that identifies the logical device, other than DeviceID.
PowerManagementCapabilities
Data type: uint16 array
Access type: Read-only
Qualifiers: Deprecated ("CIM_PowerManagementCapabilities.PowerCapabilities")
This property is deprecated. Instead, use the CIM_PowerManagementCapabilities class.
Deprecated description: An array that contains the power management capabilities of the device.
Unknown (0)
Not Supported (1)
Disabled (2)
Enabled (3)
Power Saving Modes Entered Automatically (4)
Power State Settable (5)
Power Cycling Supported (6)
Timed Power On Supported (7)
PowerManagementSupported
Data type: boolean
Access type: Read-only
Qualifiers: Deprecated ("CIM_PowerManagementCapabilities")
This property is deprecated. Instead, use the PowerManagementCapabilities class.
Deprecated description: true if the logical device can be power managed; otherwise, false.
PowerOnHours
Data type: uint64
Access type: Read-only
Qualifiers: Units ("Hours"), Counter
The number of consecutive hours the logical device has been powered, since its last power cycle.
StatusInfo
Data type: uint16
Access type: Read-only
Qualifiers: Deprecated ("CIM_EnabledLogicalElement.EnabledState"), MappingStrings ("MIF.DMTF|Operational State|006.4")
This property is deprecated. Instead, use the CIM_PowerManagementCapabilities class.
Deprecated description: Indicates whether the logical device is enabled or in a related state.
Other (1)
Unknown (2)
Enabled (3)
Disabled (4)
Not Applicable (5)
SystemCreationClassName
Data type: string
Access type: Read-only
Qualifiers: Key, MaxLen (256), Propagated ("CIM_System.CreationClassName")
The class name used to create an instance of the system that contains the logical device. SystemCreationClassName is combined with other key properties of this class to uniquely identify instances of this class and its subclasses.
SystemName
Data type: string
Access type: Read-only
Qualifiers: Key, MaxLen (256), Propagated ("CIM_System.Name")
The name of the system that contains the logical device.
TotalPowerOnHours
Data type: uint64
Access type: Read-only
Qualifiers: Units ("Hours"), Counter
The total number of hours the logical device has been powered.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows 8 |
| Minimum supported server | Windows Server 2012 |
| Namespace | Root\virtualization\v2 |
| MOF | WindowsVirtualization.V2.mof |
| DLL | Vmms.exe |
See also
Source: Microsoft Learn / Windows Win32 documentation by Microsoft and contributors. Documentation licensed CC BY 4.0. Code samples are covered by the MIT License. Converted from Markdown, with links normalized and embedded media omitted.
