Win32_TapeDrive class

Article
01/06/2021

The Win32_TapeDrive WMI class represents a tape drive on a computer system running Windows. Tape drives are primarily distinguished by the fact that they can only be accessed sequentially.

The following syntax is simplified from Managed Object Format (MOF) code and includes all of the inherited properties. Properties are listed in alphabetic order, not MOF order.

Syntax

[Dynamic, Provider("CIMWin32"), UUID("{8502C4B1-5FBB-11D2-AAC1-006008C78BC7}"), AMENDMENT]
class Win32_TapeDrive : CIM_TapeDrive
{
  uint16   Availability;
  uint16   Capabilities[];
  string   CapabilityDescriptions[];
  string   Caption;
  uint32   Compression;
  string   CompressionMethod;
  uint32   ConfigManagerErrorCode;
  boolean  ConfigManagerUserConfig;
  string   CreationClassName;
  uint64   DefaultBlockSize;
  string   Description;
  string   DeviceID;
  uint32   ECC;
  uint32   EOTWarningZoneSize;
  boolean  ErrorCleared;
  string   ErrorDescription;
  string   ErrorMethodology;
  uint32   FeaturesHigh;
  uint32   FeaturesLow;
  string   Id;
  datetime InstallDate;
  uint32   LastErrorCode;
  string   Manufacturer;
  uint64   MaxBlockSize;
  uint64   MaxMediaSize;
  uint32   MaxPartitionCount;
  string   MediaType;
  uint64   MinBlockSize;
  string   Name;
  boolean  NeedsCleaning;
  uint32   NumberOfMediaSupported;
  uint32   Padding;
  string   PNPDeviceID;
  uint16   PowerManagementCapabilities[];
  boolean  PowerManagementSupported;
  uint32   ReportSetMarks;
  string   Status;
  uint16   StatusInfo;
  string   SystemCreationClassName;
  string   SystemName;
};

Members

The Win32_TapeDrive class has these types of members:

Methods
Properties

Methods

The Win32_TapeDrive class has these methods.

Method	Description
Reset	Not implemented. To implement this method, see the Reset method in CIM_TapeDrive.
SetPowerState	Not implemented. To implement this method, see the SetPowerState method in CIM_TapeDrive.

Properties

The Win32_TapeDrive class has these properties.

Availability

Data type: uint16
Access type: Read-only
Qualifiers: MappingStrings ("MIF.DMTF|Operational State|003.5", "MIB.IETF|HOST-RESOURCES-MIB.hrDeviceStatus")

Availability and status of the device.

This property is inherited from CIM_LogicalDevice.

Other (1)

Unknown (2)

Running/Full Power (3)

Running or Full Power

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)

The device is known to be in a power save mode, but its exact status is unknown.

Power Save - Low Power Mode (14)

The device is in a power save state but still functioning, and may exhibit degraded performance.

Power Save - Standby (15)

The device is not functioning, but could be brought to full power quickly.

Power Cycle (16)

Power Save - Warning (17)

The device is in a warning state, though also in a power save mode.

Paused (18)

The device is paused.

Not Ready (19)

The device is not ready.

Not Configured (20)

The device is not configured.

Quiesced (21)

The device is quiet.

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

Array of capabilities of the media access device. For example, the device may support Random Access, removable media and Automatic Cleaning. In this case, the values 3, 7, and 9 would be written to the array.

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)

Supports Removable Media

Manual Cleaning (8)

Automatic Cleaning (9)

SMART Notification (10)

Supports Dual Sided Media (11)

Supports Dual-Sided Media

Predismount Eject Not Required (12)

CapabilityDescriptions

Data type: string array
Access type: Read-only
Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_MediaAccessDevice.Capabilities")

Array of free-form strings providing more detailed explanations for any of the access device features indicated in the Capabilities array. Note that each entry of this array is related to the entry in the Capabilities array that is located at the same index.

This property is inherited from CIM_MediaAccessDevice.

Caption

Data type: string
Access type: Read-only
Qualifiers: MaxLen (64), DisplayName ("Caption")

Short description of the object.

This property is inherited from CIM_ManagedSystemElement.

Compression

Data type: uint32
Access type: Read-only
Qualifiers: MappingStrings ("Win32API|Tape Backup Structures|TAPE_GET_DRIVE_PARAMETERS|Compression")

If TRUE, hardware data compression is enabled.

FALSE

TRUE

CompressionMethod

Data type: string
Access type: Read-only

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), use 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 device does not support compression capabilities.

This property is inherited from CIM_MediaAccessDevice.

("Unknown")

The compression scheme is unknown or not described.

("Compressed")

The logical file is compressed, but the compression scheme is unknown or not described

("Not Compressed")

If the logical file is not compressed

ConfigManagerErrorCode

Data type: uint32
Access type: Read-only
Qualifiers: Schema ("Win32")

Win32 Configuration Manager error code.

This property is inherited from CIM_LogicalDevice.

This device is working properly. (0)

Device is working properly.

This device is not configured correctly. (1)

Device is not configured correctly.

Windows cannot load the driver for this device. (2)

The driver for this device might be corrupted, or your system may be running low on memory or other resources. (3)

Driver for this device might be corrupted, or the system may be low on memory or other resources.

This device is not working properly. One of its drivers or your registry might be corrupted. (4)

Device is not working properly. One of its drivers or the registry might be corrupted.

The driver for this device needs a resource that Windows cannot manage. (5)

Driver for the device requires a resource that Windows cannot manage.

The boot configuration for this device conflicts with other devices. (6)

Boot configuration for the device conflicts with other devices.

Cannot filter. (7)

The driver loader for the device is missing. (8)

Driver loader for the device is missing.

This device is not working properly because the controlling firmware is reporting the resources for the device incorrectly. (9)

Device is not working properly. The controlling firmware is incorrectly reporting the resources for the device.

This device cannot start. (10)

Device cannot start.

This device failed. (11)

Device failed.

This device cannot find enough free resources that it can use. (12)

Device cannot find enough free resources to use.

Windows cannot verify this device's resources. (13)

Windows cannot verify the device's resources.

This device cannot work properly until you restart your computer. (14)

Device cannot work properly until the computer is restarted.

This device is not working properly because there is probably a re-enumeration problem. (15)

Device is not working properly due to a possible re-enumeration problem.

Windows cannot identify all the resources this device uses. (16)

Windows cannot identify all of the resources that the device uses.

This device is asking for an unknown resource type. (17)

Device is requesting an unknown resource type.

Reinstall the drivers for this device. (18)

Device drivers must be reinstalled.

Failure using the VxD loader. (19)

Your registry might be corrupted. (20)

Registry might be corrupted.

System failure: Try changing the driver for this device. If that does not work, see your hardware documentation. Windows is removing this device. (21)

System failure. If changing the device driver is ineffective, see the hardware documentation. Windows is removing the device.

This device is disabled. (22)

Device is disabled.

System failure: Try changing the driver for this device. If that doesn't work, see your hardware documentation. (23)

System failure. If changing the device driver is ineffective, see the hardware documentation.

This device is not present, is not working properly, or does not have all its drivers installed. (24)

Device is not present, not working properly, or does not have all of its drivers installed.

Windows is still setting up this device. (25)

Windows is still setting up the device.

Windows is still setting up this device. (26)

Windows is still setting up the device.

This device does not have valid log configuration. (27)

Device does not have valid log configuration.

The drivers for this device are not installed. (28)

Device drivers are not installed.

This device is disabled because the firmware of the device did not give it the required resources. (29)

Device is disabled. The device firmware did not provide the required resources.

This device is using an Interrupt Request (IRQ) resource that another device is using. (30)

Device is using an IRQ resource that another device is using.

This device is not working properly because Windows cannot load the drivers required for this device. (31)

Device is not working properly. Windows cannot load the required device drivers.

ConfigManagerUserConfig

Data type: boolean
Access type: Read-only
Qualifiers: Schema ("Win32")

If TRUE, the device is using a user-defined configuration.

This property is inherited from CIM_LogicalDevice.

CreationClassName

Data type: string
Access type: Read-only
Qualifiers: CIM_Key

Name of the first concrete class to appear in the inheritance chain used in the creation of an instance. When used with the other key properties of the class, this property allows all instances of this class and its subclasses to be uniquely identified.

This property is inherited from CIM_LogicalDevice.

DefaultBlockSize

Data type: uint64
Access type: Read-only
Qualifiers: Units ("bytes")

Default block size, in bytes, for this device.

This property is inherited from CIM_MediaAccessDevice.

For more information about using uint64 values in scripts, see Scripting in WMI.

Description

Data type: string
Access type: Read-only
Qualifiers: DisplayName ("Description")

Description of the object.

This property is inherited from CIM_ManagedSystemElement.

DeviceID

Data type: string
Access type: Read-only
Qualifiers: Key, Override ("DeviceId"), MappingStrings ("Win32API|File Functions|CreateFile")

Unique identifier of the tape drive with other devices on the system.

This property is inherited from CIM_LogicalDevice.

ECC

Data type: uint32
Access type: Read-only
Qualifiers: MappingStrings ("Win32API|Tape Backup Structures|TAPE_GET_DRIVE_PARAMETERS|ECC")

If TRUE, the device supports hardware error correction.

False (0)

True (1)

EOTWarningZoneSize

Data type: uint32
Access type: Read-only
Qualifiers: Units ("bytes")

Zone size for the end of tape (EOT) warning.

This property is inherited from CIM_TapeDrive.

ErrorCleared

Data type: boolean
Access type: Read-only

If TRUE, the error reported in LastErrorCode is now cleared.

This property is inherited from CIM_LogicalDevice.

ErrorDescription

Data type: string
Access type: Read-only

Free-form string supplying more information about the error recorded in LastErrorCode, and information about any corrective actions that may be taken.

This property is inherited from CIM_LogicalDevice.

ErrorMethodology

Data type: string
Access type: Read-only

Free-form string describing the type of error detection and correction supported by this device.

This property is inherited from CIM_MediaAccessDevice.

FeaturesHigh

Data type: uint32
Access type: Read-only
Qualifiers: MappingStrings ("Win32API|Tape Backup Structures|TAPE_GET_DRIVE_PARAMETERS|FeaturesHigh")

High-order 32 bits of the device features flag.

FeaturesLow

Data type: uint32
Access type: Read-only
Qualifiers: MappingStrings ("Win32API|Tape Backup Structures|TAPE_GET_DRIVE_PARAMETERS|FeaturesLow")

Low-order 32 bits of the device features flag.

Data type: string
Access type: Read-only
Qualifiers: MappingStrings ("Win32API|File Functions")

Manufacturer's identifying name of the Windows CD ROM drive.

Example: "PLEXTOR CD-ROM PX-12CS 1.01"

InstallDate

Data type: datetime
Access type: Read-only
Qualifiers: MappingStrings ("MIF.DMTF|ComponentID|001.5"), DisplayName ("Install Date")

Date and time the object was installed. This property does not need a value to indicate that the object is installed.

This property is inherited from CIM_ManagedSystemElement.

LastErrorCode

Data type: uint32
Access type: Read-only

Last error code reported by the logical device.

This property is inherited from CIM_LogicalDevice.

Manufacturer

Data type: string
Access type: Read-only
Qualifiers: MappingStrings ("Win32Registry")

Manufacturer of the Windows CD-ROM drive.

Example: "PLEXTOR"

MaxBlockSize

Data type: uint64
Access type: Read-only
Qualifiers: Units ("bytes")

Maximum block size, in bytes, for media accessed by this device.

This property is inherited from CIM_MediaAccessDevice.

For more information about using uint64 values in scripts, see Scripting in WMI.

MaxMediaSize

Data type: uint64
Access type: Read-only
Qualifiers: MappingStrings ("MIF.DMTF|Sequential Access Devices|001.2"), Units ("kilobytes")

Maximum size, in kilobytes, of media supported by this device.

This property is inherited from CIM_MediaAccessDevice.

For more information about using uint64 values in scripts, see Scripting in WMI.

MaxPartitionCount

Data type: uint32
Access type: Read-only

Maximum partition count for the tape drive.

This property is inherited from CIM_TapeDrive.

MediaType

Data type: string
Access type: Read-only
Qualifiers: MappingStrings ("Win32_TapeDrive|MediaType|Tape Drive")

Media type used by (or accessed by) this device. In this case, it is set to "Tape Drive".

MinBlockSize

Data type: uint64
Access type: Read-only
Qualifiers: Units ("bytes")

Minimum block size, in bytes, for media accessed by this device.

This property is inherited from CIM_MediaAccessDevice.

For more information about using uint64 values in scripts, see Scripting in WMI.

Name

Data type: string
Access type: Read-only
Qualifiers: DisplayName ("Name")

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

This property is inherited from CIM_ManagedSystemElement.

NeedsCleaning

Data type: boolean
Access type: Read-only

If TRUE, the media access device needs cleaning. Whether manual or automatic cleaning is possible is indicated in the Capabilities property.

This property is inherited from CIM_MediaAccessDevice.

NumberOfMediaSupported

Data type: uint32
Access type: Read-only

Maximum number of individual media which can be supported or inserted in the media access device (when supported).

This property is inherited from CIM_MediaAccessDevice.

Padding

Data type: uint32
Access type: Read-only
Qualifiers: Units ("bytes")

Number of bytes inserted between blocks on a tape media.

This property is inherited from CIM_TapeDrive.

PNPDeviceID

Data type: string
Access type: Read-only
Qualifiers: Schema ("Win32")

Windows Plug and Play device identifier of the logical device.

This property is inherited from CIM_LogicalDevice.

Example: "*PNP030b"

PowerManagementCapabilities

Data type: uint16 array
Access type: Read-only

Array of the specific power-related capabilities of a logical device.

This property is inherited from CIM_LogicalDevice.

Unknown (0)

Not Supported (1)

Power-related capacities are not supported for this device.

Disabled (2)

Enabled (3)

The power management features are currently enabled but the exact feature set is unknown or the information is unavailable.

Power Saving Modes Entered Automatically (4)

The device can change its power state based on usage or other criteria.

Power State Settable (5)

The SetPowerState method is supported. This method is found on the parent CIM_LogicalDevice class and can be implemented. For more information, see Designing Managed Object Format (MOF) Classes.

Power Cycling Supported (6)

The SetPowerState method can be invoked with the PowerState parameter set to 5 (Power Cycle).

Timed Power On Supported (7)

Timed Power-On Supported

The SetPowerState method can be invoked with the PowerState parameter set to 5 (Power Cycle) and Time set to a specific date and time, or interval, for power-on.

PowerManagementSupported

Data type: boolean
Access type: Read-only

If TRUE, the device can be power-managed (can be put into suspend mode, and so on). The property does not indicate that power management features are currently enabled, only that the logical device is capable of power management.

This property is inherited from CIM_LogicalDevice.

ReportSetMarks

Data type: uint32
Access type: Read-only
Qualifiers: MappingStrings ("Win32API|Tape Backup Structures|TAPE_GET_DRIVE_PARAMETERS|ReportSetmarks")

If TRUE, setmark reporting is enabled. Setmark reporting makes use of a specialized recorded element that does not contain user data. This recorded element is used to provide a segmentation scheme that is hierarchically superior to filemarks. Setmarks provide faster positioning on high-capacity tapes.

FALSE

TRUE

Status

Data type: string
Access type: Read-only
Qualifiers: MaxLen (10), DisplayName ("Status")

Current status of the object. Various operational and nonoperational statuses can be defined. Operational statuses include: "OK", "Degraded", and "Pred Fail" (an element, such as a SMART-enabled hard disk drive, may be functioning properly but predicting a failure in the near future). Nonoperational statuses include: "Error", "Starting", "Stopping", and "Service". The latter, "Service", could apply during mirror-resilvering of a disk, reload of a user permissions list, or other administrative work. Not all such work is online, yet the managed element is neither "OK" nor in one of the other states.

This property is inherited from CIM_ManagedSystemElement.

Values include the following:

OK ("OK")

Error ("Error")

Degraded ("Degraded")

Unknown ("Unknown")

Pred Fail ("Pred Fail")

Starting ("Starting")

Stopping ("Stopping")

Service ("Service")

Stressed ("Stressed")

NonRecover ("NonRecover")

No Contact ("No Contact")

Lost Comm ("Lost Comm")

StatusInfo

Data type: uint16
Access type: Read-only
Qualifiers: MappingStrings ("MIF.DMTF|Operational State|003.3")

State of the logical device. If this property does not apply to the logical device, the value 5 (Not Applicable) should be used.

This property is inherited from CIM_LogicalDevice.

Other (1)

Unknown (2)

Enabled (3)

Disabled (4)

Not Applicable (5)

SystemCreationClassName

Data type: string
Access type: Read-only
Qualifiers: Propagated ("CIM_System.CreationClassName"), CIM_Key

Value of the scoping computer's CreationClassName property.

This property is inherited from CIM_LogicalDevice.

SystemName

Data type: string
Access type: Read-only
Qualifiers: Propagated ("CIM_System.Name"), CIM_Key

Name of the scoping system.

This property is inherited from CIM_LogicalDevice.

Remarks

The Win32_TapeDrive class is derived from CIM_TapeDrive.

Requirements

Requirement	Value
Minimum supported client	Windows Vista
Minimum supported server	Windows Server 2008
Namespace	Root\CIMV2
MOF	CIMWin32.mof
DLL	CIMWin32.dll

Share via

Win32_TapeDrive class

Syntax

Members

Methods

Properties

Remarks

Requirements

See also

Feedback

Additional resources