Class CIM_MediaAccessDevice


CIM_ManagedElement
\_CIM_ManagedSystemElement
  \_CIM_LogicalElement
    \_CIM_EnabledLogicalElement
      \_CIM_LogicalDevice


Description

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

Subclasses

CIM_DiskDrive IBMTSDS_DiskDrive

Referenced By

CIM_MediaPresent

Properties

IdTypeRangeDescription
Key
CreationClassName string
Max Length256
CreationClassName indicates the name of the class or the subclass used in the creation of an instance. When used with the other key properties of this class, this property allows all instances of this class and its subclasses to be uniquely identified.
DeviceID string
Max Length64
An address or other identifying information used to uniquely name the LogicalDevice.
SystemCreationClassName string
Max Length256
The CreationClassName of the scoping system.
SystemName string
Max Length256
The System Name of the scoping system.
Read Only
Capabilities uint16
Unknown0
Other1
Sequential Access2
Random Access3
Supports Writing4
Encryption5
Compression6
Supports Removeable Media7
Manual Cleaning8
Automatic Cleaning9
SMART Notification10
Supports Dual Sided Media11
Predismount Eject Not Required12
Capabilities 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.
CapabilityDescriptions string
An 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.
CompressionMethod string
A 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.
DefaultBlockSize uint64
Default block size, in bytes, for this Device.
ErrorMethodology string
ErrorMethodology is a free-form string describing the type(s) of error detection and correction supported by this Device.
LastCleaned datetime
The date and time on which the Device was last cleaned.
LoadTime uint64
Time 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.
MaxAccessTime uint64
Time 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.)
MaxBlockSize uint64
Maximum block size, in bytes, for media accessed by this Device.
MaxMediaSize uint64
Maximum 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).
MaxUnitsBeforeCleaning uint64
An 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.
MediaIsLocked boolean
True indicates that the media is locked in the Device and can not be ejected. For non-removeable Devices, this value should be true.
MinBlockSize uint64
Minimum block size, in bytes, for media accessed by this Device.
MountCount uint64
For 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.
NeedsCleaning boolean
Boolean indicating that the MediaAccessDevice needs cleaning. Whether manual or automatic cleaning is possible is indicated in the Capabilities array property.
NumberOfMediaSupported uint32
When the MediaAccessDevice supports multiple individual Media, this property defines the maximum number which can be supported or inserted.
Security uint16
Other1
Unknown2
None3
Read Only4
Locked Out5
Boot Bypass6
Boot Bypass and Read Only7
An 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.
TimeOfLastMount datetime
For 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.
TotalMountTime uint64
For 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.
UncompressedDataRate uint32
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.
UnitsDescription string
Defines'Units'relative to its use in the property, MaxUnitsBeforeCleaning. This describes the criteria used to determine when the MediaAccessDevice should be cleaned.
UnitsUsed uint64
An 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.
UnloadTime uint64
Time 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.
Read Write
 
Inherited from class CIM_ManagedElement
Caption, Description, ElementName
 
Inherited from class CIM_ManagedSystemElement
HealthState, InstallDate, Name, OperationalStatus, Status, StatusDescriptions
 
Inherited from class CIM_EnabledLogicalElement
EnabledState, OtherEnabledState, RequestedState, TimeOfLastStateChange, EnabledDefault
 
Inherited from class CIM_LogicalDevice
AdditionalAvailability, Availability, ErrorCleared, ErrorDescription, IdentifyingDescriptions, LastErrorCode, MaxQuiesceTime, OtherIdentifyingInfo, PowerManagementCapabilities, PowerManagementSupported, PowerOnHours, StatusInfo, TotalPowerOnHours
 

Method Summary

NameDescription
LockMediaMethod to lock and unlock the media in a removeable Access Device.
 
Inherited from class CIM_EnabledLogicalElement
RequestStateChange
 
Inherited from class CIM_LogicalDevice
EnableDevice, OnlineDevice, QuiesceDevice, Reset, RestoreProperties, SaveProperties, SetPowerState
 

Method Detail


LockMedia

Description

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

Parameters

IdTypeRangeDescription
In
Lock boolean
If TRUE, lock the media. If FALSE release the media.
out
none
Return Codes
none