Share via

Msvm_LogicalDisk class

  • Article

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   Caption;
  string   Description;
  string   ElementName;
  datetime InstallDate;
  uint16   OperationalStatus[] = 2;
  string   StatusDescriptions[] = { "OK" };
  string   Status;
  uint16   HealthState = 5;
  uint16   EnabledState = 5;
  string   OtherEnabledState;
  uint16   RequestedState = 12;
  uint16   EnabledDefault = 2;
  datetime TimeOfLastStateChange;
  string   SystemCreationClassName = "Msvm_ComputerSystem";
  string   SystemName;
  string   CreationClassName = "Msvm_ComputerSystem";
  string   DeviceID = "Microsoft:GUID\device-specific-data";
  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   LocationIndicator = 4;
  uint16   DataOrganization = 2;
  string   Purpose;
  uint16   Access;
  string   ErrorMethodology;
  uint64   NumberOfBlocks;
  uint64   ConsumableBlocks = 0;
  boolean  IsBasedOnUnderlyingRedundancy = FALSE;
  boolean  SequentialAccess;
  uint16   ExtentStatus[] = 2;
  boolean  NoSinglePointOfFailure = FALSE;
  uint16   DataRedundancy = 0;
  uint16   PackageRedundancy = 0;
  uint8    DeltaReservation = 0;
  boolean  Primordial = FALSE;
  string   Name;
  string   OtherNameNamespace;
  string   OtherNameFormat;
  uint16   NameFormat = 12;
  uint16   NameNamespace = 8;
  uint64   BlockSize;
};

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 This method is not supported.
Reset This method is not supported.
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. If the pass-through media is a CD/DVD disk, the value is set to 1 (Readable); if the pass-through media is a physical disk, the value is set to 3 (Both).

The possible values are:

Unknown (0)

Readable (1)

Writeable (2)

Read/Write Supported (3)

Write Once (4)

AdditionalAvailability

Data type: uint16 array

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_LogicalDevice.Availability")

This property is inherited from CIM_LogicalDevice and it is set to 6 (Not Applicable).

Availability

Data type: uint16

Access type: Read-only

Qualifiers: Deprecated ("CIM_AssociatedPowerManagementService.PowerState", "CIM_ManagedSystemElement.OperationalStatus", "CIM_EnabledLogicalElement.EnabledState"), MappingStrings ("MIF.DMTF|Operational State|006.5", "MIB.IETF|HOST-RESOURCES-MIB.hrDeviceStatus", "MIF.DMTF|Host Device|001.5"), ModelCorrespondence ("CIM_LogicalDevice.AdditionalAvailability")

This property is inherited from CIM_LogicalDevice and it is set to 6 (Not Applicable).

BlockSize

Data type: uint64

Access type: Read-only

Qualifiers: Units ("Bytes"), MappingStrings ("MIF.DMTF|Host Storage|001.4", "MIB.IETF|HOST-RESOURCES-MIB.hrStorageAllocationUnits", "MIF.DMTF|Storage Devices|001.5")

The size, in bytes, of the blocks that form the storage extent. If variable block size, 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), enter a 1 (one). This property is inherited from CIM_StorageExtent.

Caption

Data type: string

Access type: Read-only

Qualifiers: MaxLen (64)

A short textual description (one-line string) of the object. This property is inherited from CIM_ManagedElement and it is set to "ISO Disk Image", "Hard Disk Image", "Floppy Disk Image", or "CD/DVD Disk" depending on the type of media.

ConsumableBlocks

Data type: uint64

Access type: Read-only

This property is inherited from CIM_StorageExtent and it is set to 0.

CreationClassName

Data type: string

Access type: Read-only

Qualifiers: Key, MaxLen (256)

The name of the class or subclass used in the creation of an instance. This property is inherited from CIM_LogicalDevice and it is set to "Msvm_LogicalDisk".

DataOrganization

Data type: uint16

Access type: Read-only

The type of data organization used. This property is inherited from CIM_StorageExtent and it is set to 2 (Fixed Block).

DataRedundancy

Data type: uint16

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_StorageSetting.DataRedundancyGoal", "CIM_StorageSetting.DataRedundancyMax", "CIM_StorageSetting.DataRedundancyMin")

The number of complete copies of data currently maintained. This property is inherited from CIM_StorageExtent and it is set to 0.

DeltaReservation

Data type: uint8

Access type: Read-only

Qualifiers: Units ("Percentage"), MinValue (1), MaxValue (100), ModelCorrespondence ("CIM_StorageSetting.DeltaReservationGoal", "CIM_StorageSetting.DeltaReservationMax", "CIM_StorageSetting.DeltaReservationMin")

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 and it is set to 0.

Description

Data type: string

Access type: Read-only

A textual description of the object. This property is inherited from CIM_ManagedElement and it is set to "ISO Disk Image", "Hard Disk Image", "Floppy Disk Image", or "CD/DVD Disk" depending on the type of media.

DeviceID

Data type: string

Access type: Read-only

Qualifiers: Key, MaxLen (64)

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 user-friendly name for the object. This property is inherited from CIM_ManagedElement and it is set to "Floppy Disk Image", "Hard Disk Image", or "CD/DVD Disk" depending on the type of media.

EnabledDefault

Data type: uint16

Access type: Read/write

An administrator's default or startup configuration for the enabled state of an element. This property is inherited from CIM_EnabledLogicalElement and it is always set to 2 (Enabled).

EnabledState

Data type: uint16

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.OtherEnabledState")

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 and it is always set to 5 (Not Applicable).

Not Applicable (5)

Indicates the element does not support to be enabled or disabled.

ErrorCleared

Data type: boolean

Access type: Read-only

Qualifiers: Deprecated ("CIM_ManagedSystemElement.OperationalStatus")

This property is inherited from CIM_LogicalDevice but it is not used.

ErrorDescription

Data type: string

Access type: Read-only

Qualifiers: Deprecated ("CIM_DeviceErrorData.ErrorDescription")

This property is inherited from CIM_LogicalDevice but it is not used.

ErrorMethodology

Data type: string

Access type: Read-only

A free-form string that describes the type(s) of error detection and correction supported by this device. This property is inherited from CIM_StorageExtent and it is set to NULL.

ExtentStatus

Data type: uint16 array

Access type: Read-only

Any additional status information beyond that captured in the OperationalStatus and other inherited properties. This property is inherited from CIM_StorageExtent and it is set to 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 non-functional. This property is inherited from CIM_ManagedSystemElement and it is always set to 5.

OK (5)

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

IdentifyingDescriptions

Data type: string array

Access type: Read-only

Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_LogicalDevice.OtherIdentifyingInfo")

This property is inherited from CIM_LogicalDevice and it is set to NULL.

InstallDate

Data type: datetime

Access type: Read-only

Qualifiers: MappingStrings ("MIF.DMTF|ComponentID|001.5")

The date and time the virtual machine configuration was created. This property is inherited from CIM_ManagedSystemElement.

IsBasedOnUnderlyingRedundancy

Data type: boolean

Access type: Read-only

Indicates whether the underlying storage extent(s) participate in a storage redundancy group. This property is inherited from CIM_StorageExtent and it is set to FALSE.

LastErrorCode

Data type: uint32

Access type: Read-only

Qualifiers: Deprecated ("CIM_DeviceErrorData.LastErrorCode")

This property is inherited from CIM_LogicalDevice but it is not used.

LocationIndicator

Data type: uint16

Access type: Read/write

Qualifiers: Experimental, ModelCorrespondence ("CIM_AlarmDevice.AlarmState", "CIM_AlarmDevice.AudioIndicatorIsDisabled", "CIM_AlarmDevice.VisualIndicatorIsDisabled", "CIM_AlarmDevice.MotionIndicatorIsDisabled")

This property is inherited from CIM_LogicalDevice and it is set to 4 (Not Supported).

MaxQuiesceTime

Data type: uint64

Access type: Read-only

Qualifiers: Deprecated ("No value"), Units ("MilliSeconds")

This property is inherited from CIM_LogicalDevice but it is not used.

Name

Data type: string

Access type: Read-only

Qualifiers: MappingStrings ("SPC.INCITS-T10| VPD 83, Association 0 | Identifier"), ModelCorrespondence ("CIM_StorageExtent.NameFormat", "CIM_StorageExtent.NameNamespace")

The label by which the object is known. This property is inherited from CIM_LogicalDisk and it is the same as the ElementName property.

NameFormat

Data type: uint16

Access type: Read-only

This property is inherited from CIM_LogicalDisk and it is always set to 12 (OS Device Name).

NameNamespace

Data type: uint16

Access type: Read-only

This property is inherited from CIM_LogicalDisk and it is always set to 8 (OS Device Namespace).

NoSinglePointOfFailure

Data type: boolean

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_StorageSetting.NoSinglePointOfFailure")

Indicates whether there exists no single point of failure. This property is inherited from CIM_StorageExtent and it is set to FALSE.

NumberOfBlocks

Data type: uint64

Access type: Read-only

Qualifiers: MappingStrings ("MIF.DMTF|Host Storage|001.5", "MIB.IETF|HOST-RESOURCES-MIB.hrStorageSize")

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 (one), this property is the total size of the storage extent. This property is inherited from CIM_StorageExtent.

OperationalStatus

Data type: uint16 array

Access type: Read-only

Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_ManagedSystemElement.StatusDescriptions")

The current statuses of the object. This property is inherited from CIM_ManagedSystemElement and each array element is always set to 2 (OK).

OK (2)

Indicates full functionality without errors.

OtherEnabledState

Data type: string

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.EnabledState")

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 and it is always set to NULL.

OtherIdentifyingInfo

Data type: string array

Access type: Read-only

Qualifiers: MaxLen (256), ArrayType ("Indexed"), ModelCorrespondence ("CIM_LogicalDevice.IdentifyingDescriptions")

This property is inherited from CIM_LogicalDevice and it is set to NULL.

OtherNameFormat

Data type: string

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_StorageExtent.NameFormat")

This property is inherited from CIM_StorageExtent and it is set to NULL.

OtherNameNamespace

Data type: string

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_StorageExtent.NameNamespace")

This property is inherited from CIM_StorageExtent and it is set to NULL.

PackageRedundancy

Data type: uint16

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_StorageSetting.PackageRedundancyGoal", "CIM_StorageSetting.PackageRedundancyMax", "CIM_StorageSetting.PackageRedundancyMin")

The number of physical packages that can currently fail without data loss. This property is inherited from CIM_StorageExtent and it is set to 0.

PowerManagementCapabilities

Data type: uint16 array

Access type: Read-only

Qualifiers: Deprecated ("CIM_PowerManagementCapabilities.PowerCapabilities")

This property is inherited from CIM_LogicalDevice but it is not used.

PowerManagementSupported

Data type: boolean

Access type: Read-only

Qualifiers: Deprecated ("CIM_PowerManagementCapabilities")

This property is inherited from CIM_LogicalDevice but it is not used.

PowerOnHours

Data type: uint64

Access type: Read-only

Qualifiers: Deprecated ("CIM_PoweredStatisticalData.PowerOnHours"), Units ("Hours"), Counter

This property is inherited from CIM_LogicalDevice but it is not used.

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

Qualifiers: MappingStrings ("MIB.IETF|HOST-RESOURCES-MIB.hrStorageDescr")

A free-form string that describes the media and/or its use. This property is inherited from CIM_StorageExtent and it is set to NULL.

RequestedState

Data type: uint16

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.EnabledState")

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 and it is always set to 12 (Not Applicable).

Not Applicable (12)

Indicates that this instance does not support the RequestedState property.

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

Qualifiers: Deprecated ("CIM_ManagedSystemElement.OperationalStatus"), MaxLen (10)

This property is inherited from CIM_ManagedSystemElement but it is not used.

StatusDescriptions

Data type: string array

Access type: Read-only

Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_ManagedSystemElement.OperationalStatus")

Strings that describe the various OperationalStatus array values. This property is inherited from CIM_ManagedSystemElement and each array element is always set to "OK".

StatusInfo

Data type: uint16

Access type: Read-only

Qualifiers: Deprecated ("CIM_EnabledLogicalElement.EnabledState"), MappingStrings ("MIF.DMTF|Operational State|006.4")

This property is inherited from CIM_LogicalDevice but it is not used.

SystemCreationClassName

Data type: string

Access type: Read-only

Qualifiers: Key, Propagated ("CIM_System.CreationClassName"), MaxLen (256)

The scoping system's creation class name. This property is inherited from CIM_LogicalDevice and it is set to "Msvm_ComputerSystem".

SystemName

Data type: string

Access type: Read-only

Qualifiers: Key, Propagated ("CIM_System.Name"), MaxLen (256)

The unique identifier for the scoping virtual system. 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 and it is always set to NULL.

TotalPowerOnHours

Data type: uint64

Access type: Read-only

Qualifiers: Deprecated ("CIM_PoweredStatisticalData.TotalPowerOnHours"), Units ("Hours"), Counter

This property is inherited from CIM_LogicalDevice 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
Minimum supported client
 None supported
Minimum supported server
 Windows Server 2008
End of client support
 None supported
End of server support
 Windows Server 2012 R2
Namespace
 Root\Virtualization
MOF
WindowsVirtualization.mof

See also

CIM_LogicalDisk

CIM_LogicalDisk

Storage Classes