Edit

Share via

CIM_MediaAccessDevice class (Hyper-V management)

  • Article

Represents a device that can use media to store and retrieve data.

Syntax

[Abstract, Version("2.6.0"), UMLPackagePath("CIM::Device::StorageDevices"), AMENDMENT]
class CIM_MediaAccessDevice : CIM_LogicalDevice
{
  uint16   Capabilities[];
  string   CapabilityDescriptions[];
  string   ErrorMethodology;
  string   CompressionMethod;
  uint32   NumberOfMediaSupported;
  uint64   MaxMediaSize;
  uint64   DefaultBlockSize;
  uint64   MaxBlockSize;
  uint64   MinBlockSize;
  boolean  NeedsCleaning;
  boolean  MediaIsLocked;
  uint16   Security;
  datetime LastCleaned;
  uint64   MaxAccessTime;
  uint32   UncompressedDataRate;
  uint64   LoadTime;
  uint64   UnloadTime;
  uint64   MountCount;
  datetime TimeOfLastMount;
  uint64   TotalMountTime;
  string   UnitsDescription;
  uint64   MaxUnitsBeforeCleaning;
  uint64   UnitsUsed;
};

Members

The CIM_MediaAccessDevice class has these types of members:

Methods

The CIM_MediaAccessDevice class has these methods.

Method Description
LockMedia Locks and unlocks removable media in a media access device.

Properties

The CIM_MediaAccessDevice class has these properties.

Capabilities

Data type: uint16 array

Access type: Read-only

Qualifiers: ArrayType ("Indexed"), 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"), ModelCorrespondence ("CIM_MediaAccessDevice.CapabilityDescriptions")

An array that contains the capabilities of the media access device.

Unknown (0)

Other (1)

Sequential Access (2)

Random Access (3)

Supports Writing (4)

Encryption (5)

Compression (6)

Supports Removeable Media (7)

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 feature descriptions for the items in the Capabilities array.

CompressionMethod

Data type: string

Access type: Read-only

The name of the algorithm or tool used by the device to support compression.

If a compression type is not specified, one of the following values can be used:

  • "Unknown" compression support is unknown or not specified.
  • "Compressed" compression is supported but the type is unknown or unspecified.
  • "Not Compressed" the device does not support compression capabilities.

DefaultBlockSize

Data type: uint64

Access type: Read-only

Qualifiers: Units ("Bytes"), PUnit ("byte")

The default block size, in bytes, for the device.

ErrorMethodology

Data type: string

Access type: Read-only

The type of error detection and correction supported by the device.

LastCleaned

Data type: datetime

Access type: Read-only

The date and time when the device was last cleaned.

LoadTime

Data type: uint64

Access type: Read-only

Qualifiers: Units ("MilliSeconds"), PUnit ("second * 10^-3")

The time it takes, in milliseconds, for the device to be able to read or write a media after the device starts loading. 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 operations. For tape drives, this starts when media is inserted and ends when the drive reports that it is ready for an application. This is usually at the tape's beginning-of-tape (BOT) area.

MaxAccessTime

Data type: uint64

Access type: Read-only

Qualifiers: Units ("MilliSeconds"), PUnit ("second * 10^-3")

The maximum access time of the media, in milliseconds. For a disk drive, this represents full seek and full rotational delay. For tape drives, this represents a search from the beginning of the tape to the most physically distant point.

MaxBlockSize

Data type: uint64

Access type: Read-only

Qualifiers: Units ("Bytes"), PUnit ("byte")

The maximum block size, in bytes, for media accessed by the device.

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.

MaxUnitsBeforeCleaning

Data type: uint64

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_MediaAccessDevice.UnitsDescription")

The maximum number of units that can be used before the device should be cleaned. UnitsDescription defines how the unit type.

MediaIsLocked

Data type: boolean

Access type: Read-only

true if the media is locked in the device and cannot be ejected; otherwise, false. For non-removable devices, this value should be true.

MinBlockSize

Data type: uint64

Access type: Read-only

Qualifiers: Units ("Bytes"), PUnit ("byte")

The minimum block size, in bytes, for media accessed by the device.

MountCount

Data type: uint64

Access type: Read-only

Qualifiers: Counter

The number of times that media has been mounted for data transfer or to clean the device. If the device does not support removable media, this property should be set to zero.

NeedsCleaning

Data type: boolean

Access type: Read-only

true if the device needs cleaning; otherwise, false.

Note

The Capabilities property indicates whether manual or automatic cleaning is possible.

NumberOfMediaSupported

Data type: uint32

Access type: Read-only

If the device supports multiple individual media, this property defines the maximum number which can be supported or inserted.

Security

Data type: uint16

Access type: Read-only

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

The operational security for the device.

Other (1)

Unknown (2)

None (3)

Read Only (4)

Locked Out (5)

Boot Bypass (6)

Boot Bypass and Read Only (7)

TimeOfLastMount

Data type: datetime

Access type: Read-only

The most recent date and time when media was mounted on the device. This property is only used by devices that support removable media.

TotalMountTime

Data type: uint64

Access type: Read-only

The time, in seconds, that media has been mounted for data transfer or to clean the device. If the device does not support removable media, this property should be set to zero.

UncompressedDataRate

Data type: uint32

Access type: Read-only

Qualifiers: Units ("KiloBytes per Second"), PUnit ("byte / second * 10^3")

The sustained data transfer rate in kilobytes at which the device can read and write to a media. This is a sustained, raw data rate. Maximum rates or rates with compression should not be reported in this property.

UnitsDescription

Data type: string

Access type: Read-only

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

Describes the unit type of the MaxUnitsBeforeCleaning and UnitsUsed properties.

UnitsUsed

Data type: uint64

Access type: Read-only

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

The number of units used by the device. This property is used to determine when the device should be cleaned. UnitsDescription defines how the unit type.

UnloadTime

Data type: uint64

Access type: Read-only

Qualifiers: Units ("MilliSeconds"), PUnit ("second * 10^-3")

The time it takes, in milliseconds, for the device to transition from reading or writing media to unloading. For example, for disk drives, this is the interval between a disk spinning at nominal speeds and a disk not spinning. For tape drives, this is the time for a media to go from its BOT to being fully ejected and accessible to a picker element or human operator.

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

CIM_LogicalDevice