Msvm_LogicalDisk class
Represents storage drive media and is used to populate the storage drives. The media types supported include virtual hard files, virtual floppy files, ISO files, and physical device media.
The following syntax is simplified Managed Object Format (MOF) code, and it includes all of the inherited properties.
Syntax
[Dynamic, Provider("VmmsWmiInstanceAndMethodProvider"), AMENDMENT]
class Msvm_LogicalDisk : CIM_LogicalDisk
{
string InstanceID;
string Caption;
uint64 Description;
string ElementName;
datetime InstallDate;
string Name;
uint16 OperationalStatus[] = 2;
string StatusDescriptions[] = { "OK" };
string Status;
uint16 HealthState = 5;
uint16 CommunicationStatus;
uint16 DetailedStatus;
uint16 OperatingStatus;
uint16 PrimaryStatus;
string EnabledState = 5;
string OtherEnabledState;
uint16 RequestedState = 12;
uint16 EnabledDefault = 2;
datetime TimeOfLastStateChange;
uint16 AvailableRequestedStates[];
uint16 TransitioningToState;
string SystemCreationClassName = "Msvm_ComputerSystem";
string SystemName;
uint16 CreationClassName = "Msvm_LogicalDisk";
string DeviceID;
boolean PowerManagementSupported;
uint16 PowerManagementCapabilities[];
uint16 Availability = 6;
uint16 StatusInfo;
uint32 LastErrorCode;
string ErrorDescription;
boolean ErrorCleared;
string OtherIdentifyingInfo[];
uint64 PowerOnHours;
uint64 TotalPowerOnHours;
string IdentifyingDescriptions[];
uint16 AdditionalAvailability[] = { 6 };
uint64 MaxQuiesceTime;
uint16 DataOrganization = 2;
string Purpose;
uint16 Access;
string ErrorMethodology;
uint64 BlockSize = 512;
uint64 NumberOfBlocks = 266338304;
uint64 ConsumableBlocks = 0;
boolean IsBasedOnUnderlyingRedundancy = False;
boolean SequentialAccess = False;
uint16 ExtentStatus[] = { 2 };
boolean NoSinglePointOfFailure = False;
uint16 DataRedundancy = 0;
uint16 PackageRedundancy = 0;
uint8 DeltaReservation = 0;
boolean Primordial = False;
uint16 NameFormat = 12;
uint16 NameNamespace = 8;
string OtherNameNamespace;
string OtherNameFormat;
};
Members
The Msvm_LogicalDisk class has these types of members:
Methods
The Msvm_LogicalDisk class has these methods.
| Method | Description |
|---|---|
| EnableDevice | This method is not supported. |
| OnlineDevice | This method is not supported. |
| QuiesceDevice | This method is not supported. |
| RequestStateChange | Requests a state change. |
| Reset | Resets the service. |
| RestoreProperties | This method is not supported. |
| SaveProperties | This method is not supported. |
| SetPowerState | This method is not supported. |
Properties
The Msvm_LogicalDisk class has these properties.
-
Access
-
-
Data type: uint16
-
Access type: Read-only
Indicates whether the media is readable, writeable, or both. This property is inherited from CIM_StorageExtent.
Value Meaning - 0
Unknown - 1
Readable. - 2
Writeable. - 3
Read/write. - 4
Write once. -
-
AdditionalAvailability
-
-
Data type: uint16 array
-
Access type: Read-only
Any additional availability and status of the device. This property is inherited from CIM_LogicalDevice.
Value Meaning - { 6 }
Not applicable. -
-
Availability
-
-
Data type: uint16
-
Access type: Read-only
The primary availability and status of the device. This property is inherited from CIM_LogicalDevice.
Value Meaning - 6
Not applicable. -
-
AvailableRequestedStates
-
-
Data type: uint16 array
-
Access type: Read-only
Indicates the possible values for the RequestedState parameter of the RequestStateChange method used to initiate a state change. The values listed will be a subset of the values contained in the RequestedStatesSupported property of the associated instance of CIM_EnabledLogicalElementCapabilities, where the values selected are a function of the current state of the CIM_EnabledLogicalElement object. This property can be non-Null if an implementation is able to advertise the set of possible values as a function of the current state. This property will be Null if an implementation is unable to determine the set of possible values as a function of the current state.
This property is inherited from CIM_EnabledLogicalElement.
-
-
BlockSize
-
-
Data type: uint64
-
Access type: Read-only
The size, in bytes, of the blocks that form the storage extent. If the block size is variable, then the maximum block size, in bytes, should be specified. If the block size is unknown, or if a block concept is not valid (for example, for aggregate extents, memory, or logical disks), this will contain 1. This property is inherited from CIM_StorageExtent.
-
-
Caption
-
-
Data type: string
-
Access type: Read-only
A short description of the object. This property is inherited from CIM_ManagedElement.
"ISO Disk Image"
"Hard Disk Image"
"Floppy Disk Image"
"CD/DVD Disk"
-
-
CommunicationStatus
-
-
Data type: uint16
-
Access type: Read-only
Indicates the ability of the instrumentation to communicate with the underlying managed element. A Null value indicates that this property is not implemented. This property is inherited from CIM_ManagedSystemElement.
-
-
ConsumableBlocks
-
-
Data type: uint64
-
Access type: Read-only
The maximum number of blocks, of size BlockSize, that are available for consumption when layering storage extents using the Msvm_BasedOn association. This property is inherited from CIM_StorageExtent.
-
-
CreationClassName
-
-
Data type: uint16
-
Access type: Read-only
The name of the class or subclass used in the creation of an instance. This property is inherited from CIM_LogicalDevice.
-
-
DataOrganization
-
-
Data type: uint16
-
Access type: Read-only
The type of data organization used. This property is inherited from CIM_StorageExtent.
Value Meaning - 2
Fixed block. -
-
DataRedundancy
-
-
Data type: uint16
-
Access type: Read-only
The number of complete copies of data currently maintained. This property is inherited from CIM_StorageExtent.
-
-
DeltaReservation
-
-
Data type: uint8
-
Access type: Read-only
A percentage that specifies the amount of space that should be reserved in a replica for caching changes. This property is inherited from CIM_StorageExtent.
-
-
Description
-
-
Data type: uint64
-
Access type: Read-only
A description of the object. This property is inherited from CIM_ManagedElement.
-
-
DetailedStatus
-
-
Data type: uint16
-
Access type: Read-only
Complements the PrimaryStatus property with additional status detail. A Null value indicates that this property is not implemented. This property is inherited from CIM_ManagedSystemElement.
-
-
DeviceID
-
-
Data type: string
-
Access type: Read-only
This property is inherited from CIM_LogicalDevice, and it is set to "Microsoft:GUID\device-specific-data".
-
-
ElementName
-
-
Data type: string
-
Access type: Read-only
A display name for the object. This property is inherited from CIM_ManagedElement.
"ISO Disk Image"
"Hard Disk Image"
"Floppy Disk Image"
"CD/DVD Disk"
-
-
EnabledDefault
-
-
Data type: uint16
-
Access type: Read-only
An administrator's default or startup configuration for the enabled state of an element. This property is inherited from CIM_EnabledLogicalElement.
-
-
EnabledState
-
-
Data type: string
-
Access type: Read-only
The enabled and disabled states of an element. It can also indicate the transitions between these requested states. This property is inherited from CIM_EnabledLogicalElement.
-
-
ErrorCleared
-
-
Data type: boolean
-
Access type: Read-only
Indicates whether the error reported in LastErrorCode is now cleared. This property is inherited from CIM_LogicalDevice, but it is not used.
-
-
ErrorDescription
-
-
Data type: string
-
Access type: Read-only
A string that provides more information about the error recorded in LastErrorCode and information about any corrective actions that can be taken. This property is inherited from CIM_LogicalDevice, but it is not used.
-
-
ErrorMethodology
-
-
Data type: string
-
Access type: Read-only
A string that describes the types of error detection and correction supported by this device. This property is inherited from CIM_StorageExtent.
-
-
ExtentStatus
-
-
Data type: uint16 array
-
Access type: Read-only
Any additional status information beyond that captured in the OperationalStatus and other inherited properties.
Value Meaning - { 2 }
None/Not applicable. -
-
HealthState
-
-
Data type: uint16
-
Access type: Read-only
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 nonfunctional. This property is inherited from CIM_ManagedSystemElement.
-
-
IdentifyingDescriptions
-
-
Data type: string array
-
Access type: Read-only
An array of free-form strings that provide explanations and details behind the entries in the OtherIdentifyingInfo property array. This property is inherited from CIM_LogicalDevice, and it is set to Null.
-
-
InstallDate
-
-
Data type: datetime
-
Access type: Read-only
The date and time the virtual machine configuration was created. This property is inherited from CIM_ManagedSystemElement.
-
-
InstanceID
-
-
Data type: string
-
Access type: Read-only
-
Qualifiers: Key
Uniquely identifies an instance of this class. This property is inherited from CIM_ManagedElement.
-
-
IsBasedOnUnderlyingRedundancy
-
-
Data type: boolean
-
Access type: Read-only
Indicates whether the underlying storage extents participate in a storage redundancy group. This property is inherited from CIM_StorageExtent.
-
-
LastErrorCode
-
-
Data type: uint32
-
Access type: Read-only
The last error code reported by the logical device. This property is inherited from CIM_LogicalDevice, but it is not used.
-
-
MaxQuiesceTime
-
-
Data type: uint64
-
Access type: Read-only
This property has been deprecated. This property is inherited from CIM_LogicalDevice, but it is not used.
-
-
Name
-
-
Data type: string
-
Access type: Read-only
The label by which the object is known. This property is inherited from CIM_ManagedSystemElement, and it is the same as the ElementName property.
-
-
NameFormat
-
-
Data type: uint16
-
Access type: Read-only
This property is inherited from CIM_StorageExtent.
Value Meaning - 1
Other - 12
Operating system device name -
-
NameNamespace
-
-
Data type: uint16
-
Access type: Read-only
This property is inherited from CIM_StorageExtent.
Value Meaning - 1
Other - 8
Operating system device namespace -
-
NoSinglePointOfFailure
-
-
Data type: boolean
-
Access type: Read-only
Indicates whether there exists no single point of failure. This property is inherited from CIM_StorageExtent.
-
-
NumberOfBlocks
-
-
Data type: uint64
-
Access type: Read-only
The number of consecutive blocks, each block the size of the value contained in the BlockSize property, that form the storage extent. Total size of the storage extent can be calculated by multiplying the value of the BlockSize property by the value of this property. If the value of BlockSize is 1, this property is the total size of the storage extent. This property is inherited from CIM_StorageExtent.
-
-
OperatingStatus
-
-
Data type: uint16
-
Access type: Read-only
Provides current status information for the operational condition of the element and can be used for providing more detail with respect to the value of the EnabledState property. A Null value indicates that this property is not implemented. This property is inherited from CIM_ManagedSystemElement.
-
-
OperationalStatus
-
-
Data type: uint16 array
-
Access type: Read-only
-
Qualifiers: Override ("OperationalStatus"), ArrayType ("Indexed")
The current statuses of the object. This property is inherited from CIM_ManagedSystemElement.
When the required QoS level for the virtual disk can't be satisfied, the primary status (OperationalStatus[0]) is set to Degraded (3) and the OperationalStatus array additionally contains a secondary status value that indicates the specific reason for the QoS condition, according to this table.
Value Description Insufficient Throughput (32788) The requested minimum IOPS rate is currently not available to the device. Note
OperationalStatus is also used to report other error or warning conditions (for example, protocol mismatch between VSP and VSC). If multiple conditions exists, the primary status is set Degraded, and one or more secondary status values, in any order starting at index 1, is filled in the array.
-
-
OK (2)
-
Degraded (3)
-
Non-Recoverable Error (7)
-
In Service (11)
-
Note
Added in Windows 10.
-
No Contact (12)
-
Lost Communication (13)
-
Supporting Entity in Error (16)
-
Note
Added in Windows 10.
-
Protocol Mismatch (32775)
-
Communication Timed Out (32783)
-
Note
Added in Windows 10.
-
Insufficient Throughput (32788)
-
Unknown QoS Policy ID (32791)
-
QoS Not Supported (32792)
-
Note
Added in Windows 10.
-
QoS Configuration Mismatch (32793)
-
Note
Added in Windows 10.
-
Disk Full (32794)
-
Note
Added in Windows 10.
OtherEnabledState
-
Data type: string
-
Access type: Read-only
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. This property is inherited from CIM_EnabledLogicalElement.
OtherIdentifyingInfo
-
Data type: string array
-
Access type: Read-only
Any additional data, beyond device ID information, that could be used to identify a logical device. This property is inherited from CIM_LogicalDevice, and it is set to Null.
OtherNameFormat
-
Data type: string
-
Access type: Read-only
A string that describes the format of the Name property when NameFormat contains the value 1 (Other). This property is inherited from CIM_StorageExtent.
OtherNameNamespace
-
Data type: string
-
Access type: Read-only
A string that describes the namespace of the Name property when NameNamespace contains the value 1 (Other). This property is inherited from CIM_StorageExtent.
PackageRedundancy
-
Data type: uint16
-
Access type: Read-only
The number of physical packages that can currently fail without data loss. This property is inherited from CIM_StorageExtent.
PowerManagementCapabilities
-
Data type: uint16 array
-
Access type: Read-only
The power management capabilities of the device. This property is inherited from CIM_LogicalDevice, but it is not used.
PowerManagementSupported
-
Data type: boolean
-
Access type: Read-only
Indicates whether the device can be power managed. This property is inherited from CIM_LogicalDevice, but it is not used.
PowerOnHours
-
Data type: uint64
-
Access type: Read-only
The number of consecutive hours that this device has been powered on since its last power cycle. This property is inherited from CIM_LogicalDevice, but it is not used.
PrimaryStatus
-
Data type: uint16
-
Access type: Read-only
Provides high level status information. This property should be used in conjunction with the DetailedStatus property to provide high level and detailed health status information for the element and its subcomponents. A Null value indicates that this property is not implemented. This property is inherited from CIM_ManagedSystemElement.
Primordial
-
Data type: boolean
-
Access type: Read-only
Indicates whether the containing system has the ability to create or delete this operational element. This property is inherited from CIM_StorageExtent, and it is set to False for file-based media and True for pass-through media.
Purpose
-
Data type: string
-
Access type: Read-only
A string that describes the media and/or its use. This property is inherited from CIM_StorageExtent.
RequestedState
-
Data type: uint16
-
Access type: Read-only
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. A particular instance of CIM_EnabledLogicalElement might not support the RequestStateChange method. If this occurs, the value 12 (Not Applicable) is used. This property is inherited from CIM_EnabledLogicalElement.
SequentialAccess
-
Data type: boolean
-
Access type: Read-only
Indicates whether the storage is sequentially accessed by a media access device. Pass-through tape media is an example of a sequentially accessed storage extent. This property is inherited from CIM_StorageExtent.
Status
-
Data type: string
-
Access type: Read-only
The current status of the object. This property is inherited from CIM_ManagedSystemElement, but it is not used.
StatusDescriptions
-
Data type: string array
-
Access type: Read-only
Strings that describe the various OperationalStatus array values. This property is inherited from CIM_ManagedSystemElement.
StatusInfo
-
Data type: uint16
-
Access type: Read-only
The current state of the logical device. This property is inherited from CIM_LogicalDevice, but it is not used.
SystemCreationClassName
-
Data type: string
-
Access type: Read-only
The scoping system's creation class name. This property is inherited from CIM_LogicalDevice.
SystemName
-
Data type: string
-
Access type: Read-only
The unique identifier for the scoping virtual machine. This property is inherited from CIM_LogicalDevice.
TimeOfLastStateChange
-
Data type: datetime
-
Access type: Read-only
The date or time when the enabled state of the element last changed. This property is inherited from CIM_EnabledLogicalElement.
TotalPowerOnHours
-
Data type: uint64
-
Access type: Read-only
The total number of hours that this device has been powered. This property is inherited from CIM_LogicalDevice, but it is not used.
TransitioningToState
-
Data type: uint16
-
Access type: Read-only
Indicates the target state to which the instance is transitioning. This property is inherited from CIM_EnabledLogicalElement, but it is not used.
Remarks
Access to the Msvm_LogicalDisk class might be restricted by UAC Filtering. For more information, see User Account Control and WMI.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client |
Windows 8 [desktop apps only] |
| Minimum supported server |
Windows Server 2012 [desktop apps only] |
| Namespace |
Root\Virtualization\V2 |
| MOF |
|
| DLL |
|
See also
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for