CIM_TapeDrive class

  • Article

Represents the capabilities and management of a tape drive.

The following syntax is simplified from Managed Object Format (MOF) code and includes all of the inherited properties.

Syntax

[Abstract, Version("2.6.0"), UMLPackagePath("CIM::Device::StorageDevices")]
class CIM_TapeDrive : CIM_MediaAccessDevice
{
  string   InstanceID;
  string   Caption;
  string   Description;
  string   ElementName;
  datetime InstallDate;
  string   Name;
  uint16   OperationalStatus[];
  string   StatusDescriptions[];
  string   Status;
  uint16   HealthState;
  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 = 12;
  string   SystemCreationClassName;
  string   SystemName;
  string   CreationClassName;
  string   DeviceID;
  boolean  PowerManagementSupported;
  uint16   PowerManagementCapabilities[];
  uint16   Availability;
  uint16   StatusInfo;
  uint32   LastErrorCode;
  string   ErrorDescription;
  boolean  ErrorCleared;
  string   OtherIdentifyingInfo[];
  uint64   PowerOnHours;
  uint64   TotalPowerOnHours;
  string   IdentifyingDescriptions[];
  uint16   AdditionalAvailability[];
  uint64   MaxQuiesceTime;
  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;
  uint32   EOTWarningZoneSize;
  uint32   MaxPartitionCount;
  uint32   Padding;
  uint64   MaxRewindTime;
};

Members

The CIM_TapeDrive class has these types of members:

Methods

The CIM_TapeDrive class has these methods.

Method Description
EnableDevice Deprecated description: Enables or disables the logical device.
This method is deprecated. Instead we recommend that you use the RequestStateChange method.
This method is inherited from CIM_LogicalDevice.
LockMedia Locks and unlocks removable media in a media access device.
This method is inherited from CIM_MediaAccessDevice.
OnlineDevice Deprecated description: Brings the logical device online so it can accept requests, or offline so it can no longer accept requests.
This method is deprecated. Instead we recommend that you use the RequestStateChange method.
This method is inherited from CIM_LogicalDevice.
QuiesceDevice Deprecated description: Temporarily suspends activity on the logical device, or re-enables the activity.
This method is deprecated. Instead we recommend that you use the RequestStateChange method.
This method is inherited from CIM_LogicalDevice.
RequestStateChange Requests that the state of the element be changed to the specified value.
This method is inherited from CIM_EnabledLogicalElement.
Reset Resets the logical device.
This method is inherited from CIM_LogicalDevice.
RestoreProperties Restores a previous configuration and state of the logical device.
This method is inherited from CIM_LogicalDevice.
SaveProperties Saves the configuration and state of the logical device.
This method is inherited from CIM_LogicalDevice.
SetPowerState Deprecated description: Sets the power state of the logical device.
Instead we recommend that you use the SetPowerState property of the CIM_PowerManagementService class.
This method is inherited from CIM_LogicalDevice.

Properties

The CIM_TapeDrive class has these properties.

AdditionalAvailability

Data type: uint16 array

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_LogicalDevice.Availability")

An array that contains availability information about of the logical device, in addition to the that of the Availability property.

This property is inherited from CIM_LogicalDevice.

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: MappingStrings ("MIF.DMTF|Operational State|006.5", "MIB.IETF|HOST-RESOURCES-MIB.hrDeviceStatus", "MIF.DMTF|Host Device|001.5"), ModelCorrespondence ("CIM_LogicalDevice.AdditionalAvailability")

Deprecated description: Contains the availability of the logical device.

This property is deprecated. Instead we recommend that you use the CIM_PowerManagementCapabilities class.

This property is inherited from CIM_LogicalDevice.

This property contains the following values:

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)

AvailableRequestedStates

Data type: uint16 array

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.RequestStateChange", "CIM_EnabledLogicalElementCapabilities.RequestedStatesSupported")

Indicates the possible values for the RequestedState parameter of the RequestStateChange method.

The listed values must be a subset of the values that are contained in the RequestedStatesSupported property of the associated CIM_EnabledLogicalElementCapabilities instance. This property is NULL if the implementation cannot determine the set of possible values for the current state of the element.

This property is inherited from CIM_EnabledLogicalElement.

The possible values are.

Enabled (2)

Disabled (3)

Shut Down (4)

Offline (6)

Test (7)

Defer (8)

Quiesce (9)

Reboot (10)

Reset (11)

DMTF Reserved

12 65535

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.

This property is inherited from CIM_MediaAccessDevice.

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.

This property is inherited from CIM_MediaAccessDevice.

Caption

Data type: string

Access type: Read-only

Qualifiers: MaxLen (64)

A short textual 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 this element. A NULL value indicates that instrumentation does not support this property.

This property is inherited from CIM_ManagedSystemElement.

Unknown (0)

Indicates that the instrumentation cannot report on the CommunicationStatus property at this time.

Not Available (1)

Indicates that the instrumentation is capable of reporting this property, but intentionally does not for this element.

Communication OK (2)

Indicates only that communication is established with the element.

Lost Communication (3)

Indicates that the element has been contacted in the past, but is currently unreachable.

No Contact (4)

Indicates that the instrumentation has contact information for this element, but has never been able to communicate with it.

DMTF Reserved

Reserved.

Vendor Reserved

Reserved.

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.

This property is inherited from CIM_MediaAccessDevice.

CreationClassName

Data type: string

Access type: Read-only

Qualifiers: Key, MaxLen (256)

The class name used to create an instance of the logical device. CreationClassName is combined with other key properties of this class to uniquely identify instances of this class and its subclasses.

This property is inherited from CIM_LogicalDevice.

DefaultBlockSize

Data type: uint64

Access type: Read-only

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

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 textual description of the object.

This property is inherited from CIM_ManagedElement.

DetailedStatus

Data type: uint16

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.PrimaryStatus", "CIM_ManagedSystemElement.HealthState")

Indicates additional status details that complement the PrimaryStatus property. A NULL value indicates that the instrumentation does not support this property.

This property is inherited from CIM_ManagedSystemElement.

Not Available (0)

Indicates that the instrumentation is capable of reporting this property, but intentionally does not report it for this element.

No Additional Information (1)

Indicates that no details have to be added to the PrimaryStatus property, for example when the PrimaryStatus is set to OK.

Stressed (2)

Indicates that the element functions, but requires attention. Overload and overheated are examples of Stressed states.

Predictive Failure (3)

Indicates that an element functions nominally, but predicts a failure in the near future.

Non-Recoverable Error (4)

Indicates that this element is in an error condition that requires human intervention.

Supporting Entity in Error (5)

Indicates that an element on which this element depends is in error. This element might be OK but cannot function because of the state of a dependent element. An example is a network service or endpoint that cannot function due to lower-layer networking problems.

DMTF Reserved

Reserved.

Vendor Reserved

Reserved.

DeviceID

Data type: string

Access type: Read-only

Qualifiers: Key, MaxLen (64)

A unique identifier of the logical device, such as the address.

This property is inherited from CIM_LogicalDevice.

ElementName

Data type: string

Access type: Read-only

A user-friendly name for the object. This property allows each instance to define a user-friendly name in addition to its key properties, identity data, and description information.

This property is inherited from CIM_ManagedElement.

EnabledDefault

Data type: uint16

Access type: Read/write

Indicates an administrator's default or startup configuration for the enabled state of an element. The default value Enabled (2).

This property is inherited from CIM_EnabledLogicalElement.

The possible values are.

Enabled (2)

Disabled (3)

Not Applicable (5)

Enabled but Offline (6)

No Default (7)

Quiesce (9)

DMTF Reserved

10 32767

Vendor Reserved

32768 65535

EnabledState

Data type: uint16

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.OtherEnabledState")

Indicates the enabled state of an element. Possible values include the transitions between states. For example, Shutting Down (4) and Starting (10) are transient states between Enabled and Disabled.

This property is inherited from CIM_EnabledLogicalElement.

Unknown (0)

Indicates that the state of the element is unknown.

Other (1)

Indicates that the state of the element is described in the OtherEnabledState property.

Enabled (2)

Indicates that the element executes or could execute commands, processes any queued commands, and queues new requests.

Disabled (3)

Indicates that the element does not execute commands and that it drops any new requests.

Shutting Down (4)

Indicates that the element is in the process of changing to a Disabled state.

Not Applicable (5)

Indicates the element does not support to be enabled or disabled.

Enabled but Offline (6)

Indicates that the element might be completing commands and that it drops any new requests.

In Test (7)

Indicates that the element is in a test state.

Deferred (8)

Indicates that the element might be completing commands, but that it queues any new requests.

Quiesce (9)

Indicates that the element is enabled but is in a restricted mode.

Starting (10)

Indicates that the element is in the process of changing to an Enabled state. New requests are queued.

DMTF Reserved

Reserved.

Vendor Reserved

Reserved.

EOTWarningZoneSize

Data type: uint32

Access type: Read-only

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

The size, in bytes, of the area designated as "end of tape". Access in this area generates an "end of tape" warning.

ErrorCleared

Data type: boolean

Access type: Read-only

Qualifiers: Deprecated ("CIM_ManagedSystemElement.OperationalStatus")

Deprecated description: Indicates whether an error reported by the LastErrorCode property is cleared.

This property is deprecated. Instead we recommend that you use the OperationalStatus property from the CIM_ManagedSystemElement class.

This property is inherited from CIM_LogicalDevice.

ErrorDescription

Data type: string

Access type: Read-only

Qualifiers: Deprecated ("CIM_DeviceErrorData.ErrorDescription")

Deprecated description: Additional information about the error reported by the LastErrorCode property.

This property is deprecated. Instead we recommend that you use the ErrorDescription property from the CIM_DeviceErrorData class.

This property is inherited from CIM_LogicalDevice.

ErrorMethodology

Data type: string

Access type: Read-only

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

This property is inherited from CIM_MediaAccessDevice.

HealthState

Data type: uint16

Access type: Read-only

Indicates the current health of the element. This attribute expresses the health of this element, but not necessarily the health of its subcomponents.

This property is inherited from CIM_ManagedSystemElement.

Unknown (0)

The implementation cannot report on HealthState at this time.

OK (5)

The element is fully functional and operates within normal operational parameters and without error.

Degraded/Warning (10)

The element is in working order, and all functionality is provided. However, the element does not function to the best of its abilities. For example, the element might not operate at optimal performance, or it might report recoverable errors.

Minor failure (15)

All functionality is available, but some functionality might be degraded.

Major failure (20)

The element is failing. It is possible that some or all of the functionality of this component is degraded or does not work.

Critical failure (25)

The element is nonfunctional, and recovery might not be possible.

Non-recoverable error (30)

The element has completely failed, and recovery is not possible. All functionality that this element provides has been lost.

DMTF Reserved

Reserved.

IdentifyingDescriptions

Data type: string array

Access type: Read-only

Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_LogicalDevice.OtherIdentifyingInfo")

An array of strings that describe the OtherIdentifyingInfo array items of the same index.

This property is inherited from CIM_LogicalDevice.

InstallDate

Data type: datetime

Access type: Read-only

Qualifiers: MappingStrings ("MIF.DMTF|ComponentID|001.5")

Indicates when the object was installed. The lack of a value does not indicate that the object is not installed.

This property is inherited from CIM_ManagedSystemElement.

InstanceID

Data type: string

Access type: Read-only

Uniquely and opaquely identifies an instance of this class within the scope of the containing namespace.

[!Important]

In order to ensure uniqueness within the namespace, the value of the InstanceID property should be constructed in the following pattern: OrgID:LocalID

OrgID must include a copyrighted, trademarked or otherwise unique name that is owned by the business entity that defines the InstanceID, or be a registered ID that is assigned by a recognized global authority. This pattern is similar to the structure of schema class names. In addition, to ensure uniqueness, the first colon in InstanceID must be between the OrgID andLocalID. Therefore the OrgID must not contain a colon (':').

LocalID is chosen by the business entity and should not be re-used to identify different underlying real-world elements.

If the above pattern is not used, the defining entity must assure that the resultant InstanceID value is not re-used across any InstanceID properties that are produced by this provider or other providers for this namespace.

For Distributed Management Task Force (DMTF) defined instances, the pattern must be used with the OrgID set to CIM.

This property is inherited from CIM_ManagedElement.

LastCleaned

Data type: datetime

Access type: Read-only

The date and time when the device was last cleaned.

This property is inherited from CIM_MediaAccessDevice.

LastErrorCode

Data type: uint32

Access type: Read-only

Qualifiers: Deprecated ("CIM_DeviceErrorData.LastErrorCode")

Deprecated description: The last error code reported by the logical device.

This property is deprecated. Instead we recommend that you use the LastErrorCode property from theCIM_DeviceErrorData class.

This property is inherited from CIM_LogicalDevice.

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.

This property is inherited from CIM_MediaAccessDevice.

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.

This property is inherited from CIM_MediaAccessDevice.

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.

This property is inherited from CIM_MediaAccessDevice.

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.

This property is inherited from CIM_MediaAccessDevice.

MaxPartitionCount

Data type: uint32

Access type: Read-only

The maximum partition count for the tape drive.

MaxQuiesceTime

Data type: uint64

Access type: Read-only

Qualifiers: Deprecated ("No value"), Units ("MilliSeconds")

Deprecated description: The maximum time in milliseconds, that a device can remain in a temporarily disabled state (Availability and AdditionalAvailability properties set to "21" quiescent ). A value of "0" indicates that the logical device can remain in a temporarily disabled state indefinitely.

This property is deprecated and should not be used.

This property is inherited from CIM_LogicalDevice.

MaxRewindTime

Data type: uint64

Access type: Read-only

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

The time, in milliseconds, to move from the most physically distant point on the tape to the beginning.

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.

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 can not be ejected; otherwise, false. For non-removable devices, this value should be true.

This property is inherited from CIM_MediaAccessDevice.

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.

This property is inherited from CIM_MediaAccessDevice.

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.

This property is inherited from CIM_MediaAccessDevice.

Name

Data type: string

Access type: Read-only

Qualifiers: MaxLen (1024)

The label by which the object is known. When subclassed, the Name property can be overridden to be a key property.

This property is inherited from CIM_ManagedSystemElement.

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.

This property is inherited from CIM_MediaAccessDevice.

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.

This property is inherited from CIM_MediaAccessDevice.

OperatingStatus

Data type: uint16

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.EnabledState")

Indicates the current operational condition of the element. This property can be used to provide more detail about the value of the EnabledState property. A NULL value indicates that the instrumentation does not support this property.

This property is inherited from CIM_ManagedSystemElement.

Unknown (0)

Indicates that the instrumentation cannot report on the OperatingStatus property at this time.

Not Available (1)

Indicates that the instrumentation is capable of reporting this property, but intentionally does not report it for this element.

Servicing (2)

Indicates that the element is in process to be configured, maintained, cleaned, or otherwise administered.

Starting (3)

Indicates that the element is being initialized.

Stopping (4)

Indicates that the element is being brought to an orderly stop.

Stopped (5)

Indicates that the element is intentionally stopped.

Aborted (6)

Indicates that the element stopped in an unexpected way.

Dormant (7)

Indicates that the element is inactive.

Completed (8)

Indicates that the element completed its operation. We recommend using a PrimaryStatus property value of OK, Error, or Degraded to indicate success or failure of the operation.

Migrating (9)

Indicates that the element is being moved between host elements.

Emigrating (10)

Indicates that the element is being moved away from the host element.

Immigrating (11)

Indicates that the element is being moved to a new host element.

Snapshotting (12)

Indicates that a snapshot copy of the element is being created.

Shutting Down (13)

Indicates that the element is being brought to an abrupt stop.

In Test (14)

Indicates that the element is performing test functions.

Transitioning (15)

Indicates that the element is between states and is not fully available in either state. Use another value that indicates a more specific transition if one is available.

In Service (16)

Indicates that the element is in service and operational.

DMTF Reserved

Reserved.

Vendor Reserved

Reserved.

OperationalStatus

Data type: uint16 array

Access type: Read-only

Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_ManagedSystemElement.StatusDescriptions")

Contains indicators of the current status of the element. The first value of the OperationalStatus property should contain the primary status for the element.

Note

The OperationalStatus property replaces the deprecated Status property. Due to the widespread use of the existing Status property in management applications, we strongly recommend that providers or instrumentation provide both the Status and OperationalStatus properties. When instrumented, Status, because it is a single-valued property, should also provide the primary status of the element.

This property is inherited from CIM_ManagedSystemElement.

Unknown (0)

Indicates that the implementation cannot report on the OperationalStatus property at this time.

Other (1)

Indicates an undefined state.

OK (2)

Indicates full functionality without errors.

Degraded (3)

Indicates that the element is in working order and that all functionality is provided. However, the element does not function to the best of its abilities. For example, the element might not operate at optimal performance, or it might report recoverable errors.

Stressed (4)

Indicates that the element functions, but requires attention. Overload and overheated are examples of Stressed states.

Predictive Failure (5)

Indicates that an element functions nominally, but predicts a failure in the near future.

Error (6)

Indicates that an error has occurred.

Non-Recoverable Error (7)

Indicates that a nonrecoverable error has occurred.

Starting (8)

Indicates that the job is starting.

Stopping (9)

Indicates that the job is stopping.

Stopped (10)

Indicates that the element has been intentionally stopped.

In Service (11)

Indicates that the element is in process to be configured, maintained, cleaned, or otherwise administered.

No Contact (12)

Indicates that the monitoring system has information about this element, but has never been able to establish communications with it.

Lost Communication (13)

Indicates that the monitoring system has successfully contacted this element in the past, but it is currently unavailable.

Aborted (14)

Indicates that the job stopped in an unexpected way. The state and configuration of the job might require an update.

Dormant (15)

Indicates that the job is inactive.

Supporting Entity in Error (16)

Indicates that an element on which this job depends is in error. This element might be OK but cannot function because of the state of a dependent element. An example is a network service or endpoint that cannot function due to lower-layer networking problems.

Completed (17)

Indicates that the job has completed its operation. This value should be combined with either OK, Error, or Degraded to indicate to a client whether the complete operation Completed with OK and passed, or completed with Error and failed, or completed with Degraded and finished the operation, but did not complete OK or did not report an error.

Power Mode (18)

Indicates that the element has additional power model information that is contained in the associated power management service.

DMTF Reserved

Reserved.

Vendor Reserved

Reserved.

OtherEnabledState

Data type: string

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.EnabledState")

Describes the state of the element when the value of the EnabledState property is Other. This property must be set to NULL when EnabledState is not Other.

This property is inherited from CIM_EnabledLogicalElement.

OtherIdentifyingInfo

Data type: string array

Access type: Read-only

Qualifiers: ArrayType ("Indexed"), MaxLen (256), ModelCorrespondence ("CIM_LogicalDevice.IdentifyingDescriptions")

Information that identifies the logical device, other than DeviceID.

This property is inherited from CIM_LogicalDevice.

Padding

Data type: uint32

Access type: Read-only

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

The number of bytes inserted between blocks on tape media.

PowerManagementCapabilities

Data type: uint16 array

Access type: Read-only

Qualifiers: Deprecated ("CIM_PowerManagementCapabilities.PowerCapabilities")

Deprecated description: An array that contains the power management capabilities of the device.

This property is deprecated. Instead we recommend that you use the CIM_PowerManagementCapabilities class.

This property is inherited from CIM_LogicalDevice.

This array contains the following values:

Unknown (0)

Not Supported (1)

Disabled (2)

Enabled (3)

Power Saving Modes Entered Automatically (4)

Power State Settable (5)

Configurable Power State

Power Cycling Supported (6)

Timed Power On Supported (7)

PowerManagementSupported

Data type: boolean

Access type: Read-only

Qualifiers: Deprecated ("CIM_PowerManagementCapabilities")

Deprecated description: true if the logical device can be power managed; otherwise, false.

This property is deprecated. Instead, you should use the PowerManagementCapabilities class.

This property is inherited from CIM_LogicalDevice.

PowerOnHours

Data type: uint64

Access type: Read-only

Qualifiers: Units ("Hours"), Counter

The number of consecutive hours the logical device has been powered, since its last power cycle.

This property is inherited from CIM_LogicalDevice.

PrimaryStatus

Data type: uint16

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_ManagedSystemElement.DetailedStatus", "CIM_ManagedSystemElement.HealthState")

Indicates a high-level status value.

This property is inherited from CIM_ManagedSystemElement.

The possible values are.

Unknown (0)

OK (1)

Degraded (2)

Error (3)

DMTF Reserved

4 32767

Vendor Reserved

32768 65535

RequestedState

Data type: uint16

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.EnabledState")

Indicates the last requested state for the element. The current state is indicated by the EnabledState property. This property enables you to compare the last requested and current states.

Note

When the value of the EnabledState property is Not Applicable, this property has no meaning.

This property is inherited from CIM_EnabledLogicalElement.

Unknown (0)

Indicates the last requested state for the element is unknown.

Enabled (2)

Indicates that the element executes or could execute commands, processes any queued commands, and queues new requests.

Disabled (3)

Indicates a request to immediately disable the element, such that it does not execute or accept any commands or processing requests.

Shut Down (4)

Indicates a request for an orderly transition to the Disabled state, and might require you to shut off the power to completely erase any existing state.

No Change (5)

No state change has been requested.

Offline (6)

Indicates a request to change to the Enabled but Offline state.

Test (7)

Indicates that the element is in a test state.

Deferred (8)

Indicates that the element might be completing commands, but that it queues any new requests.

Quiesce (9)

Indicates that the element is enabled but is in a restricted mode.

Reboot (10)

Indicates a request to shut down and then change to an Enabled state.

Reset (11)

Indicates a request to change to a Disabled state and then change to an Enabled state.

Not Applicable (12)

Indicates that this instance does not support the RequestedState property.

DMTF Reserved

Reserved.

Vendor Reserved

Reserved.

Security

Data type: uint16

Access type: Read-only

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

The operational security for the device.

This property is inherited from CIM_MediaAccessDevice.

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)

Indicates the primary status of the object.

Note

This property is deprecated. It is replaced by the OperationalStatus property. If you choose to use the Status property for backward compatibility, it should be secondary to the OperationalStatus property.

This property is inherited from CIM_ManagedSystemElement.

The possible values are.

("OK")

("Error")

("Degraded")

("Unknown")

("Pred Fail")

("Starting")

("Stopping")

("Service")

("Stressed")

("NonRecover")

("No Contact")

("Lost Comm")

("Stopped")

StatusDescriptions

Data type: string array

Access type: Read-only

Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_ManagedSystemElement.OperationalStatus")

Indicates descriptions of the corresponding values in the OperationalStatus array. For example, if an element in the OperationalStatus property contains the value Stopping, then the element at the same array index in this property might contain an explanation as to why an object is being stopped.

This property is inherited from CIM_ManagedSystemElement.

StatusInfo

Data type: uint16

Access type: Read-only

Qualifiers: Deprecated ("CIM_EnabledLogicalElement.EnabledState"), MappingStrings ("MIF.DMTF|Operational State|006.4")

Deprecated description: Indicates whether the logical device is enabled or in a related state.

This property is deprecated. Instead we recommend that you use the CIM_PowerManagementCapabilities class.

This property is inherited from CIM_LogicalDevice.

The possible values are:

Other (1)

Unknown (2)

Enabled (3)

Disabled (4)

Not Applicable (5)

SystemCreationClassName

Data type: string

Access type: Read-only

Qualifiers: Key, MaxLen (256), Propagated ("CIM_System.CreationClassName")

The class name used to create an instance of the system that contains the logical device. SystemCreationClassName is combined with other key properties of this class to uniquely identify instances of this class and its subclasses.

This property is inherited from CIM_LogicalDevice.

SystemName

Data type: string

Access type: Read-only

Qualifiers: Key, MaxLen (256), Propagated ("CIM_System.Name")

The name of the system that contains the logical device.

This property is inherited from CIM_LogicalDevice.

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.

This property is inherited from CIM_MediaAccessDevice.

TimeOfLastStateChange

Data type: datetime

Access type: Read-only

Indicates when the element last changed state. If the state of the element has not changed and this property is populated, then it must be set to a zero interval value. If a state change was requested, but was rejected or is not yet processed, the property must not be updated.

This property is inherited from CIM_EnabledLogicalElement.

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.

This property is inherited from CIM_MediaAccessDevice.

TotalPowerOnHours

Data type: uint64

Access type: Read-only

Qualifiers: Units ("Hours"), Counter

The total number of hours the logical device has been powered.

This property is inherited from CIM_LogicalDevice.

TransitioningToState

Data type: uint16

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.RequestStateChange", "CIM_EnabledLogicalElement.RequestedState", "CIM_EnabledLogicalElement.EnabledState")

Indicates the target state to which the instance is changing.

A value of No Change indicates that no transition is in progress. A value of Not Applicable indicates that the implementation does not report ongoing transitions.

This property is inherited from CIM_EnabledLogicalElement.

The possible values are.

Unknown (0)

Enabled (2)

Disabled (3)

Shut Down (4)

No Change (5)

Offline (6)

Test (7)

Defer (8)

Quiesce (9)

Reboot (10)

Reset (11)

Not Applicable (12)

DMTF Reserved

13 65535

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.

This property is inherited from CIM_MediaAccessDevice.

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.

This property is inherited from CIM_MediaAccessDevice.

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.

This property is inherited from CIM_MediaAccessDevice.

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.

This property is inherited from CIM_MediaAccessDevice.

Requirements
Minimum supported client
 None supported
Minimum supported server
 Windows Server 2016
Namespace
 Root\HyperVCluster\v2
MOF
WindowsHyperVCluster.V2.mof
DLL
VMMS.exe

See also

CIM_MediaAccessDevice

Failover Clustering Hyper-V WMI Provider