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   InstanceID;
  string   Caption = "DVD Drive";
  string   Description = "Microsoft Virtual DVD Drive";
  string   ElementName = "DVD Drive";
  datetime InstallDate;
  string   Name = "DVD Drive";
  uint16   OperationalStatus[] = { 2 };
  string   StatusDescriptions[] = { "OK" };
  string   Status;
  uint16   HealthState = 5;
  uint16   CommunicationStatus;
  uint16   DetailedStatus;
  uint16   OperatingStatus;
  uint16   PrimaryStatus;
  uint16   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_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;
  uint32   Capabilities[] = {3, 7};
  string   CapabilityDescriptions[] = {"Random Access", "Supports Removable Media"};
  string   ErrorMethodology = "None";
  string   CompressionMethod = "Not Compressed";
  uint32   NumberOfMediaSupported = 1;
  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   UnloadTime = 0;
  uint64   MountCount = 0;
  datetime TimeOfLastMount;
  uint64   TotalMountTime = 0;
  string   UnitsDescription;
  uint64   MaxUnitsBeforeCleaning = 0xffffffffffffffff;
  uint64   UnitsUsed = 0;
  uint16   FormatsSupported[] = {16, 22};
};

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 Locks or releases the media.
OnlineDevice This method is not supported.
QuiesceDevice This method is not supported.
RequestStateChange Requests a state change.
Reset Resets the virtual device.
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

Any additional availability and status of the device. This property is inherited from CIM_LogicalDevice, and it is set to 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, and it is set to 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.

Capabilities

Data type: uint32 array

Access type: Read-only

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

Value Meaning
{3, 7}
3
 The corresponding entry in CapabilityDescriptions is "Random Access".
7
 The corresponding entry in CapabilityDescriptions is "Supports Removable Media".

CapabilityDescriptions

Data type: string array

Access type: Read-only

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

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

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.

CompressionMethod

Data type: string

Access type: Read-only

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

"Not Compressed"

"Unknown"

"Compressed"

"Not Compressed"

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.

DefaultBlockSize

Data type: uint64

Access type: Read-only

The default block size, in bytes, for the device. This property is inherited from CIM_MediaAccessDevice.

Description

Data type: string

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.

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: uint16

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

FormatsSupported

Data type: uint16 array

Access type: Read-only

The CD and DVD formats that are supported by this device. This property is inherited from CIM_DVDDrive.

This array contains the following values for ISO.

{16, 22}

CD-ROM (16)

DVD (22)

This array contains the following values for physical pass-through.

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

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.

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.

LoadTime

Data type: uint64

Access type: Read-only

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.

MaxAccessTime

Data type: uint64

Access type: Read-only

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.

MaxBlockSize

Data type: uint64

Access type: Read-only

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

MaxMediaSize

Data type: uint64

Access type: Read-only

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.

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.

MaxUnitsBeforeCleaning

Data type: uint64

Access type: Read-only

The maximum units that can be used before the device should be cleaned. This property is inherited from CIM_MediaAccessDevice.

MediaIsLocked

Data type: boolean

Access type: Read-only

True if the media is locked in the device and cannot be ejected; otherwise, False. This property is inherited from CIM_MediaAccessDevice.

MinBlockSize

Data type: uint64

Access type: Read-only

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

MountCount

Data type: uint64

Access type: Read-only

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.

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.

NeedsCleaning

Data type: boolean

Access type: Read-only

True if the media access device needs cleaning; otherwise, False. This property is inherited from CIM_MediaAccessDevice.

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.

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

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

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

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.

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

Security

Data type: uint16

Access type: Read-only

The operational security defined for the device. This property is inherited from CIM_MediaAccessDevice.

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.

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.

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.

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.

UncompressedDataRate

Data type: uint32

Access type: Read-only

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.

UnitsDescription

Data type: string

Access type: Read-only

The units relative to its use in MaxUnitsBeforeCleaning. This property is inherited from CIM_MediaAccessDevice.

UnitsUsed

Data type: uint64

Access type: Read-only

The current number of units used. This property is inherited from CIM_MediaAccessDevice.

UnloadTime

Data type: uint64

Access type: Read-only

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

Remarks

Access to the Msvm_DVDDrive 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
WindowsVirtualization.V2.mof
DLL
Vmms.exe

See also

CIM_DVDDrive

CIM_DVDDrive

Storage Classes