Share via

Msvm_DVDDrive class

  • Article

Represents a DVD drive inside of a virtual machine. This DVD drive can either be a pass-through device (if a physical hard disk was attached to the virtual machine) or synthetic and populated with ISO file media. Because virtual and physical DVD drives can be added and removed from the virtual machine, there are two resource pools associated with this class, one for pass-through DVD drives, and the other for virtual DVD drives. DVD drives can only be added or removed if the virtual machine is offline.

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_DVDDrive : CIM_DVDDrive
{
  string   Caption = "DVD Drive";
  string   Description = "Microsoft Virtual DVD Drive";
  string   ElementName = "DVD Drive";
  datetime InstallDate;
  string   Name = "DVD Drive";
  uint16   OperationalStatus[] = 2;
  string   Status;
  uint16   HealthState = 5;
  uint16   EnabledState = 5;
  string   OtherEnabledState;
  datetime TimeOfLastStateChange;
  string   SystemCreationClassName = "Msvm_ComputerSystem";
  string   SystemName;
  string   CreationClassName = "Msvm_DVDDrive";
  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   Capabilities[];
  string   CapabilityDescriptions[];
  string   ErrorMethodology = "None";
  string   CompressionMethod = "Not Compressed";
  uint64   MaxMediaSize = 9400000;
  uint64   DefaultBlockSize = 2048;
  uint64   MaxBlockSize = 2048;
  uint64   MinBlockSize = 2048;
  boolean  NeedsCleaning = FALSE;
  boolean  MediaIsLocked = FALSE;
  uint16   Security = 3;
  datetime LastCleaned;
  uint64   MaxAccessTime = 0;
  uint32   UncompressedDataRate;
  uint64   LoadTime = 0;
  uint64   MountCount = 0;
  datetime TimeOfLastMount;
  uint64   TotalMountTime = 0;
  uint64   MaxUnitsBeforeCleaning = 0xffffffffffffffff;
  uint64   UnitsUsed = 0;
  uint16   FormatsSupported[];
  string   StatusDescriptions[] = { "OK" };
  uint16   RequestedState = 12;
  uint16   EnabledDefault = 2;
  uint32   NumberOfMediaSupported = 1;
  uint64   UnloadTime = 0;
  string   UnitsDescription;
};

Members

The Msvm_DVDDrive class has these types of members:

Methods

The Msvm_DVDDrive class has these methods.

Method Description
EnableDevice This method is not supported.
LockMedia 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_DVDDrive class has these properties.

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).

The possible values are.

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)

Quiescent

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).

Capabilities

Data type: uint16 array

Access type: Read-only

Qualifiers: MappingStrings ("MIF.DMTF|Storage Devices|001.9", "MIF.DMTF|Storage Devices|001.11", "MIF.DMTF|Storage Devices|001.12", "MIF.DMTF|Disks|003.7", "MIF.DMTF|Host Disk|001.2", "MIF.DMTF|Host Disk|001.4"), ArrayType ("Indexed"), ModelCorrespondence ("CIM_MediaAccessDevice.CapabilityDescriptions")

The capabilities of the media access device. This property is inherited from CIM_MediaAccessDevice and it is set to the following values.

Unknown (0)

Other (1)

Sequential Access (2)

Random Access (3)

The corresponding entry in CapabilityDescriptions is "Random Access".

Supports Writing (4)

Encryption (5)

Compression (6)

Supports Removeable Media (7)

The corresponding entry in CapabilityDescriptions is "Supports Removable Media".

Manual Cleaning (8)

Automatic Cleaning (9)

SMART Notification (10)

Supports Dual Sided Media (11)

Predismount Eject Not Required (12)

CapabilityDescriptions

Data type: string array

Access type: Read-only

Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_MediaAccessDevice.Capabilities")

An array of free-form strings that provides detailed explanations for access device features indicated in the Capabilities property array. Each entry of this array is related to the entry in the Capabilities property array, located at the same index. This property is inherited from CIM_MediaAccessDevice.

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 always set to "DVD Drive".

CompressionMethod

Data type: string

Access type: Read-only

A free-form string that indicates the algorithm or tool used to compress the logical file. If the compression scheme is unknown or not described, use "Unknown". If the logical file is compressed, but the compression scheme is unknown or not described, use "Compressed". If the logical file is not compressed, use "Not Compressed". This property is inherited from CIM_MediaAccessDevice and it is set to "Not Compressed".

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_DVDDrive".

DefaultBlockSize

Data type: uint64

Access type: Read-only

Qualifiers: Units ("Bytes")

The default block size, in bytes, for the device. This property is inherited from CIM_MediaAccessDevice and it is set to 2048.

Description

Data type: string

Access type: Read-only

A textual description of the object. This property is inherited from CIM_ManagedElement and it is always set to "Microsoft Virtual DVD Drive".

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 "DVD Drive" by default.

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_MediaAccessDevice and it is set to "None".

FormatsSupported

Data type: uint16 array

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_PhysicalMedia.MediaType")

The CD and DVD formats that are supported by this device. This property is inherited from CIM_DVDDrive and it is set to the following values for ISO.

Unknown (0)

Other (1)

CD-ROM (16)

CD-ROM/XA (17)

CD-I (18)

CD Recordable (19)

DVD (22)

DVD-RW+ (23)

DVD-RAM (24)

DVD-ROM (25)

DVD-Video (26)

Divx (27)

CD-RW (33)

CD-DA (34)

CD+ (35)

DVD Recordable (36)

DVD-RW (37)

DVD-Audio (38)

DVD-5 (39)

DVD-9 (40)

DVD-10 (41)

DVD-18 (42)

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.

LastCleaned

Data type: datetime

Access type: Read-only

The date and time on which the device was last cleaned. This property is inherited from CIM_MediaAccessDevice and it is set to NULL.

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.

LoadTime

Data type: uint64

Access type: Read-only

Qualifiers: Units ("MilliSeconds")

The time, in milliseconds, from 'load' to being able to read or write a media. For example, for disk drives, this is the interval between a disk not spinning to the disk reporting that it is ready for read/write (that is, the disk spinning at nominal speeds). For tape drives, this is the time from a media being injected to reporting that it is ready for an application. This is usually at the tape's BOT area. This property is inherited from CIM_MediaAccessDevice and it is set to 0.

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).

Unknown (0)

On (2)

Off (3)

Not Supported (4)

MaxAccessTime

Data type: uint64

Access type: Read-only

Qualifiers: Units ("MilliSeconds")

The time, in milliseconds, to move from the first location on the media to the location that is furthest with respect to time. For a disk drive, this represents full seek + full rotational delay. For tape drives, this represents a search from the beginning of the tape to the most physically distant point. (The end of a tape may be at its most physically distant point, but this is not necessarily true.) This property is inherited from CIM_MediaAccessDevice and it is set to 0.

MaxBlockSize

Data type: uint64

Access type: Read-only

Qualifiers: Units ("Bytes")

The maximum block size, in bytes, for media accessed by the device. This property is inherited from CIM_MediaAccessDevice and it is set to 2048.

MaxMediaSize

Data type: uint64

Access type: Read-only

Qualifiers: MappingStrings ("MIF.DMTF|Sequential Access Devices|001.2", "MIF.DMTF|Host Disk|001.5")

The maximum size, in kilobytes, of media supported by this device. Kilobytes are interpreted as the number of bytes multiplied by 1000 (not the number of bytes multiplied by 1024). This property is inherited from CIM_MediaAccessDevice and it is set to 9,400,000.

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.

MaxUnitsBeforeCleaning

Data type: uint64

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_MediaAccessDevice.UnitsDescription")

The maximum units that can be used before the device should be cleaned. This property is inherited from CIM_MediaAccessDevice and it is set to 0xffffffffffffffff.

MediaIsLocked

Data type: boolean

Access type: Read-only

If TRUE, the media is locked in the device and cannot be ejected. This property is inherited from CIM_MediaAccessDevice and it is set to FALSE.

MinBlockSize

Data type: uint64

Access type: Read-only

Qualifiers: Units ("Bytes")

The minimum block size, in bytes, for media accessed by the device. This property is inherited from CIM_MediaAccessDevice and it is set to 2048.

MountCount

Data type: uint64

Access type: Read-only

Qualifiers: Counter

For a device that supports removable media, the number of times that media have been mounted for data transfer or to clean the device. For devices accessing nonremovable media, such as hard disks, this property is not applicable and should be set to 0. This property is inherited from CIM_MediaAccessDevice and it is set to 0.

Name

Data type: string

Access type: Read-only

Qualifiers: MaxLen (1024)

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

NeedsCleaning

Data type: boolean

Access type: Read-only

If TRUE, the media access device needs cleaning. This property is inherited from CIM_MediaAccessDevice and it is set to FALSE.

NumberOfMediaSupported

Data type: uint32

Access type: Read-only

The maximum number of multiple individual media that can be supported or inserted. This property is inherited from CIM_MediaAccessDevice and it is set to 1.

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 the EnabledState property 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.

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.

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 the EnabledState property. 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.

Security

Data type: uint16

Access type: Read-only

Qualifiers: MappingStrings ("MIF.DMTF|Disks|003.22")

The operational security defined for the device. This property is inherited from CIM_MediaAccessDevice and it is set to 3 (None).

The possible values are:

Other (1)

Unknown (2)

None (3)

Read Only (4)

Locked Out (5)

Boot Bypass (6)

Boot Bypass and Read Only (7)

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 describes 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.

TimeOfLastMount

Data type: datetime

Access type: Read-only

For a device that supports removable media, the most recent date and time that media was mounted on the device. For devices accessing nonremovable media, such as hard disks, this property has no meaning and is not applicable. This property is inherited from CIM_MediaAccessDevice and it is set to NULL.

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.

TotalMountTime

Data type: uint64

Access type: Read-only

For a device that supports removable media, the total time (in seconds) that media have been mounted for data transfer or to clean the device. For devices accessing nonremovable media, such as hard disks, this property is not applicable and should be set to 0. This property is inherited from CIM_MediaAccessDevice and it is set to 0.

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.

UncompressedDataRate

Data type: uint32

Access type: Read-only

Qualifiers: Units ("KiloBytes per Second")

The sustained data transfer rate, in KB/sec, that the device can read from and write to a media. This is a sustained, raw data rate. Maximum rates or rates assuming compression should not be reported in this property. This property is inherited from CIM_MediaAccessDevice and it is set to NULL.

UnitsDescription

Data type: string

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_MediaAccessDevice.MaxUnitsBeforeCleaning", "CIM_MediaAccessDevice.UnitsUsed")

The units relative to its use in MaxUnitsBeforeCleaning. This property is inherited from CIM_MediaAccessDevice and it is set to NULL.

UnitsUsed

Data type: uint64

Access type: Read-only

Qualifiers: Gauge, ModelCorrespondence ("CIM_MediaAccessDevice.UnitsDescription", "CIM_MediaAccessDevice.MaxUnitsBeforeCleaning")

The current number of units used. This property is inherited from CIM_MediaAccessDevice and it is set to 0.

UnloadTime

Data type: uint64

Access type: Read-only

Qualifiers: Units ("MilliSeconds")

The time, in milliseconds, from being able to read or write a media to its 'unload'. This property is inherited from CIM_MediaAccessDevice and it is set to 0.

Remarks

Access to the Msvm_DVDDrive 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_DVDDrive

CIM_DVDDrive

Storage Classes