Class CIM_MediaAccessDevice
extends CIM_LogicalDevice

A MediaAccessDevice represents the ability to access one or more media and use this media to store and retrieve data.

Table of Contents
Hierarchy
Direct Known Subclasses
Class Qualifiers
Class Properties
Class Methods

Class Hierarchy

CIM_ManagedElement
   |
   +--CIM_ManagedSystemElement
   |
   +--CIM_LogicalElement
   |
   +--CIM_EnabledLogicalElement
   |
   +--CIM_LogicalDevice
   |
   +--CIM_MediaAccessDevice

Direct Known Subclasses

CIM_CDROMDrive
CIM_DiskDrive
CIM_DisketteDrive
CIM_DVDDrive
CIM_MagnetoOpticalDrive
CIM_TapeDrive
CIM_WORMDrive

Class Qualifiers

NameData TypeValue
DescriptionstringA MediaAccessDevice represents the ability to access one or more media and use this media to store and retrieve data.
UMLPackagePathstringCIM::Device::StorageDevices
Versionstring2.6.0

Class Properties

Local Class Properties

NameData TypeDefault ValueQualifiers
NameData TypeValue
CompressionMethodstring
DescriptionstringA free form string indicating the algorithm or tool used by the device to support compression. If it is not possible or not desired to describe the compression scheme (perhaps because it is not known), recommend using the following words: "Unknown" to represent that it is not known whether the device supports compression capabilities or not, "Compressed" to represent that the device supports compression capabilities but either its compression scheme is not known or not disclosed, and "Not Compressed" to represent that the devices does not support compression capabilities.
DefaultBlockSizeuint64
DescriptionstringDefault block size, in bytes, for this Device.
PUnitstringbyte
UnitsstringBytes
ErrorMethodologystring
DescriptionstringErrorMethodology is a free-form string describing the type(s) of error detection and correction supported by this Device.
LastCleaneddatetime
DescriptionstringThe date and time on which the Device was last cleaned.
LoadTimeuint64
DescriptionstringTime in milliseconds from 'load' to being able to read or write a Media. For example, for DiskDrives, this is the interval between a disk not spinning to the disk reporting that it is ready for read/write (ie, the disk spinning at nominal speeds). For TapeDrives, 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.
PUnitstringsecond * 10^-3
UnitsstringMilliSeconds
MaxAccessTimeuint64
DescriptionstringTime in milliseconds to move from the first location on the Media to the location that is furthest with respect to time. For a DiskDrive, this represents full seek + full rotational delay. For TapeDrives, 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.)
PUnitstringsecond * 10^-3
UnitsstringMilliSeconds
MaxBlockSizeuint64
DescriptionstringMaximum block size, in bytes, for media accessed by this Device.
PUnitstringbyte
UnitsstringBytes
MaxMediaSizeuint64
DescriptionstringMaximum size, in KBytes, of media supported by this Device. KBytes is interpreted as the number of bytes multiplied by 1000 (NOT the number of bytes multiplied by 1024).
MappingStringsstringMIF.DMTF|Sequential Access Devices|001.2, MIF.DMTF|Host Disk|001.5
MaxUnitsBeforeCleaninguint64
DescriptionstringAn unsigned integer indicating the maximum 'units' that can be used, with respect to the AccessDevice, before the Device should be cleaned. The property, UnitsDescription, defines how 'units' should be interpreted.
ModelCorrespondencestringCIM_MediaAccessDevice.UnitsDescription
MediaIsLockedboolean
DescriptionstringTrue indicates that the media is locked in the Device and can not be ejected. For non-removeable Devices, this value should be true.
MinBlockSizeuint64
DescriptionstringMinimum block size, in bytes, for media accessed by this Device.
PUnitstringbyte
UnitsstringBytes
MountCountuint64
Counterbooleantrue
DescriptionstringFor a MediaAccessDevice 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.
NeedsCleaningboolean
DescriptionstringBoolean indicating that the MediaAccessDevice needs cleaning. Whether manual or automatic cleaning is possible is indicated in the Capabilities array property.
NumberOfMediaSupporteduint32
DescriptionstringWhen the MediaAccessDevice supports multiple individual Media, this property defines the maximum number which can be supported or inserted.
Securityuint16
DescriptionstringAn enumeration indicating the operational security defined for the MediaAccessDevice. For example, information that the Device is "Read Only" (value=4) or "Boot Bypass" (value=6) can be described using this property.
MappingStringsstringMIF.DMTF|Disks|003.22
ValueMapstring1, 2, 3, 4, 5, 6, 7
ValuesstringOther, Unknown, None, Read Only, Locked Out, Boot Bypass, Boot Bypass and Read Only
TimeOfLastMountdatetime
DescriptionstringFor a MediaAccessDevice 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.
TotalMountTimeuint64
DescriptionstringFor a MediaAccessDevice 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.
UncompressedDataRateuint32
DescriptionstringThe 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.
PUnitstringbyte / second * 10^3
UnitsstringKiloBytes per Second
UnitsDescriptionstring
DescriptionstringDefines 'Units' relative to its use in the property, MaxUnitsBeforeCleaning. This describes the criteria used to determine when the MediaAccessDevice should be cleaned.
ModelCorrespondencestringCIM_MediaAccessDevice.MaxUnitsBeforeCleaning, CIM_MediaAccessDevice.UnitsUsed
UnitsUseduint64
DescriptionstringAn unsigned integer indicating the currently used 'units' of the AccessDevice, helpful to describe when the Device may require cleaning. The property, UnitsDescription, defines how 'units' should be interpreted.
Gaugebooleantrue
ModelCorrespondencestringCIM_MediaAccessDevice.UnitsDescription, CIM_MediaAccessDevice.MaxUnitsBeforeCleaning
UnloadTimeuint64
DescriptionstringTime in milliseconds from being able to read or write a Media to its 'unload'. For example, for DiskDrives, this is the interval between a disk spinning at nominal speeds and a disk not spinning. For TapeDrives, this is the time for a Media to go from its BOT to being fully ejected and accessible to a PickerElement or human operator.
PUnitstringsecond * 10^-3
UnitsstringMilliSeconds
Capabilitiesuint16[]
ArrayTypestringIndexed
DescriptionstringCapabilities of the MediaAccessDevice. For example, the Device may support "Random Access", removeable media and "Automatic Cleaning". In this case, the values 3, 7 and 9 would be written to the array. Several of the enumerated values require some explanation: 1) Value 11, Supports Dual Sided Media, distinguishes a Device that can access both sides of dual sided Media, from a Device that reads only a single side and requires the Media to be flipped; and, 2) Value 12, Predismount Eject Not Required, indicates that Media does not have to be explicitly ejected from the Device before being accessed by a PickerElement.
MappingStringsstringMIF.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
ModelCorrespondencestringCIM_MediaAccessDevice.CapabilityDescriptions
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12
ValuesstringUnknown, Other, Sequential Access, Random Access, Supports Writing, Encryption, Compression, Supports Removeable Media, Manual Cleaning, Automatic Cleaning, SMART Notification, Supports Dual Sided Media, Predismount Eject Not Required
CapabilityDescriptionsstring[]
ArrayTypestringIndexed
DescriptionstringAn array of free-form strings providing more detailed explanations for any of the AccessDevice features indicated in the Capabilities array. Note, each entry of this array is related to the entry in the Capabilities array that is located at the same index.
ModelCorrespondencestringCIM_MediaAccessDevice.Capabilities

Inherited Properties

NameData TypeClass Origin
Availabilityuint16CIM_LogicalDevice
CaptionstringCIM_ManagedElement
CommunicationStatusuint16CIM_ManagedSystemElement
CreationClassNamestringCIM_LogicalDevice
DescriptionstringCIM_ManagedElement
DetailedStatusuint16CIM_ManagedSystemElement
DeviceIDstringCIM_LogicalDevice
ElementNamestringCIM_ManagedElement
EnabledDefaultuint16CIM_EnabledLogicalElement
EnabledStateuint16CIM_EnabledLogicalElement
ErrorClearedbooleanCIM_LogicalDevice
ErrorDescriptionstringCIM_LogicalDevice
Generationuint64CIM_ManagedElement
HealthStateuint16CIM_ManagedSystemElement
InstallDatedatetimeCIM_ManagedSystemElement
InstanceIDstringCIM_ManagedElement
LastErrorCodeuint32CIM_LogicalDevice
LocationIndicatoruint16CIM_LogicalDevice
MaxQuiesceTimeuint64CIM_LogicalDevice
NamestringCIM_ManagedSystemElement
OperatingStatusuint16CIM_ManagedSystemElement
OtherEnabledStatestringCIM_EnabledLogicalElement
PowerManagementSupportedbooleanCIM_LogicalDevice
PowerOnHoursuint64CIM_LogicalDevice
PrimaryStatusuint16CIM_ManagedSystemElement
RequestedStateuint16CIM_EnabledLogicalElement
StatusstringCIM_ManagedSystemElement
StatusInfouint16CIM_LogicalDevice
SystemCreationClassNamestringCIM_LogicalDevice
SystemNamestringCIM_LogicalDevice
TimeOfLastStateChangedatetimeCIM_EnabledLogicalElement
TotalPowerOnHoursuint64CIM_LogicalDevice
TransitioningToStateuint16CIM_EnabledLogicalElement
AdditionalAvailabilityuint16[]CIM_LogicalDevice
AvailableRequestedStatesuint16[]CIM_EnabledLogicalElement
IdentifyingDescriptionsstring[]CIM_LogicalDevice
OperationalStatusuint16[]CIM_ManagedSystemElement
OtherIdentifyingInfostring[]CIM_LogicalDevice
PowerManagementCapabilitiesuint16[]CIM_LogicalDevice
StatusDescriptionsstring[]CIM_ManagedSystemElement

Class Methods

Local Class Methods

LockMedia (uint32)

Method Qualifiers (LockMedia)

NameData TypeValue
DescriptionstringMethod to lock and unlock the media in a removeable Access Device. The method takes one parameter as input - a boolean indicating whether to lock or unlock. TRUE indicates that the media should be locked in the Device, FALSE indicates that the media should be unlocked. The method returns 0 if successful, 1 if not supported, and any other value if an error occurred. The set of possible return codes should be specified in a ValueMap qualifier on the method. The strings to which the ValueMap contents are 'translated' should be specified as a Values array qualifier on the method.

Method Parameters (LockMedia)

NameTypeQualifiers
NameData TypeValue
Lockboolean
DescriptionstringIf TRUE, lock the media. If FALSE release the media.
INbooleantrue

Inherited Class Methods

NameReturn TypeClass Origin
EnableDeviceuint32CIM_LogicalDevice
OnlineDeviceuint32CIM_LogicalDevice
QuiesceDeviceuint32CIM_LogicalDevice
RequestStateChangeuint32CIM_EnabledLogicalElement
Resetuint32CIM_LogicalDevice
RestorePropertiesuint32CIM_LogicalDevice
SavePropertiesuint32CIM_LogicalDevice
SetPowerStateuint32CIM_LogicalDevice