CIM_DiskDrive class (CIMWin32 WMI Providers)

The CIM_DiskDrive class represents a physical disk drive as seen by the operating system. The disk drive features correspond to the logical and management characteristics of the drive, and in some cases, may not reflect the physical characteristics of the device. An interface to a physical drive is a member of this class. However, an object based on another logical device is not a member of this class.

Important

The DMTF (Distributed Management Task Force) CIM (Common Information Model) classes are the parent classes upon which WMI classes are built. WMI currently supports only the CIM 2.x version schemas.

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

Syntax

[Abstract, UUID("{8502C52C-5FBB-11D2-AAC1-006008C78BC7}"), AMENDMENT]
class CIM_DiskDrive : CIM_MediaAccessDevice
{
  uint16   Availability;
  uint16   Capabilities[];
  string   CapabilityDescriptions[];
  string   Caption;
  string   CompressionMethod;
  uint32   ConfigManagerErrorCode;
  boolean  ConfigManagerUserConfig;
  string   CreationClassName;
  uint64   DefaultBlockSize;
  string   Description;
  string   DeviceID;
  boolean  ErrorCleared;
  string   ErrorDescription;
  string   ErrorMethodology;
  datetime InstallDate;
  uint32   LastErrorCode;
  uint64   MaxBlockSize;
  uint64   MaxMediaSize;
  uint64   MinBlockSize;
  string   Name;
  boolean  NeedsCleaning;
  uint32   NumberOfMediaSupported;
  string   PNPDeviceID;
  uint16   PowerManagementCapabilities[];
  boolean  PowerManagementSupported;
  string   Status;
  uint16   StatusInfo;
  string   SystemCreationClassName;
  string   SystemName;
};

Members

The CIM_DiskDrive class has these types of members:

• Methods
• Properties

Methods

The CIM_DiskDrive class has these methods.

Method	Description
Reset	Requests a reset of the logical device. Not implemented by WMI.
SetPowerState	Defines the desired power state for a logical device and when a device should be put into that state. Not implemented by WMI.

Properties

The CIM_DiskDrive 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)

Other.

Unknown (2)

Unknown.

Running/Full Power (3)

Running/full power.

Warning (4)

Warning.

In Test (5)

Testing.

Not Applicable (6)

Not applicable.

Power Off (7)

Power off.

Off Line (8)

Offline.

Off Duty (9)

Off duty.

Degraded (10)

Degraded.

Not Installed (11)

Not installed.

Install Error (12)

Install error.

Power Save - Unknown (13)

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

Power Save - Low Power Mode (14)

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

Power Save - Standby (15)

Device is not functioning but could be brought to full power 'quickly'.

Power Cycle (16)

Power cycle.

Power Save - Warning (17)

Device is in a warning state and also in a power-save mode.

Paused (18)

Paused.

Not Ready (19)

Not ready.

Not Configured (20)

Not configured.

Quiesced (21)

The disk drive is unavailable.

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")

Capabilities of the media access device. This property is inherited from CIM_MediaAccessDevice.

Unknown (0)

Unknown.

Other (1)

Other.

Sequential Access (2)

Sequential access.

Random Access (3)

Random access.

Supports Writing (4)

Writing.

Encryption (5)

Encryption.

Compression (6)

Compression.

Supports Removeable Media (7)

Removable media.

Manual Cleaning (8)

Manual cleaning.

Automatic Cleaning (9)

Automatic cleaning.

SMART Notification (10)

SMART notification.

Supports Dual Sided Media (11)

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 turned over.

Predismount Eject Not Required (12)

Indicates that the media does not have to be explicitly ejected from the device before being accessed by a picker element.

CapabilityDescriptions

Data type: string array

Access type: Read-only

Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_MediaAccessDevice.Capabilities")

Array of free-form strings that provide detailed explanations for access device features indicated in the Capabilities array. This property is inherited from CIM_MediaAccessDevice.

Note

Each entry of this array is related to the entry in the Capabilities array that is located at the same index.

Caption

Data type: string

Access type: Read-only

Qualifiers: MaxLen (64), DisplayName ("Caption")

Short textual description of the object.

This property is inherited from CIM_ManagedSystemElement.

CompressionMethod

Data type: string

Access type: Read-only

Free-form string that indicates the algorithm or tool used to compress the logical file. If the compression scheme is unknown or not described, use "Unknown". If the logical file is compressed, but the compression scheme is unknown or not described, use "Compressed". If the logical file is not compressed, use "Not Compressed".

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")

Windows 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 class (or subclass) used in the creation of an instance. When used with other key properties of the class, this property allows all instances of the 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 the 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")

Textual description of the object.

This property is inherited from CIM_ManagedSystemElement.

DeviceID

Data type: string

Access type: Read-only

Qualifiers: CIM_Key

Address or other identifying information to uniquely name the logical device.

This property is inherited from CIM_LogicalDevice.

ErrorCleared

Data type: boolean

Access type: Read-only

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

This property is inherited from CIM_LogicalDevice.

ErrorDescription

Data type: string

Access type: Read-only

Free-form string that supplies information about the error recorded in the LastErrorCode property and corrective actions to perform.

This property is inherited from CIM_LogicalDevice.

ErrorMethodology

Data type: string

Access type: Read-only

Free-form string that describes the type of error detection and correction supported by the device.

This property is inherited from CIM_MediaAccessDevice.

InstallDate

Data type: datetime

Access type: Read-only

Qualifiers: MappingStrings ("MIF.DMTF|ComponentID|001.5"), DisplayName ("Install Date")

Date and time when 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.

MaxBlockSize

Data type: uint64

Access type: Read-only

Qualifiers: Units ("bytes")

Maximum block size, in bytes, for media accessed by the 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 the device. Kilobytes are interpreted as the number of bytes multiplied by 1000 (not the number of bytes multiplied by 1024).

This property is inherited from CIM_MediaAccessDevice.

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

MinBlockSize

Data type: uint64

Access type: Read-only

Qualifiers: Units ("bytes")

Minimum block size, in bytes, for media accessed by the 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, this 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 array property.

This property is inherited from CIM_MediaAccessDevice.

NumberOfMediaSupported

Data type: uint32

Access type: Read-only

When the media access device supports multiple individual media, this property defines the maximum number that can be supported or inserted.

This property is inherited from CIM_MediaAccessDevice.

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

Specific power-related capabilities of the logical device.

This property is inherited from CIM_LogicalDevice.

Unknown (0)

Unknown.

Not Supported (1)

Not supported.

Disabled (2)

Disabled.

Enabled (3)

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

Power Saving Modes Entered Automatically (4)

Device can change its power state based on use or other criteria.

Power State Settable (5)

The SetPowerState method is supported.

Power Cycling Supported (6)

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

Timed Power On Supported (7)

The SetPowerState method can be invoked with the PowerState parameter set to 5 ("Power Cycle") and the Time parameter 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, that is, put into a power-save state. If False, the integer value 1 ("Not Supported") should be the only entry in the PowerManagementCapabilities array.

This property does not indicate whether power management features are currently enabled, or if enabled, which features are supported. For more information, see the PowerManagementCapabilities array. This property is inherited from CIM_LogicalDevice.

Status

Data type: string

Access type: Read-only

Qualifiers: MaxLen (10), DisplayName ("Status")

Current status of the object.

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

Scoping system'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

Scoping system's Name property.

This property is inherited from CIM_LogicalDevice.

Remarks

The CIM_DiskDrive class is derived from CIM_MediaAccessDevice.

WMI does not implement this class. See Win32 Classes for classes derived from CIM_DiskDrive.

This documentation is derived from the CIM class descriptions published by the DMTF. Microsoft may have made changes to correct minor errors, conform to Microsoft SDK documentation standards, or provide more information.

Requirements

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

See also

CIM_MediaAccessDevice