Export (0) Print
Expand All

Win32_LogicalDisk class

The Win32_LogicalDiskWMI class represents a data source that resolves to an actual local storage device on a computer system running Windows.

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

[Provider("CIMWin32")]class Win32_LogicalDisk : CIM_LogicalDisk
{
  uint16   Access;
  uint16   Availability;
  uint64   BlockSize;
  string   Caption;
  boolean  Compressed;
  uint32   ConfigManagerErrorCode;
  boolean  ConfigManagerUserConfig;
  string   CreationClassName;
  string   Description;
  string   DeviceID;
  uint32   DriveType;
  boolean  ErrorCleared;
  string   ErrorDescription;
  string   ErrorMethodology;
  string   FileSystem;
  uint64   FreeSpace;
  datetime InstallDate;
  uint32   LastErrorCode;
  uint32   MaximumComponentLength;
  uint32   MediaType;
  string   Name;
  uint64   NumberOfBlocks;
  string   PNPDeviceID;
  uint16   PowerManagementCapabilities[];
  boolean  PowerManagementSupported;
  string   ProviderName;
  string   Purpose;
  boolean  QuotasDisabled;
  boolean  QuotasIncomplete;
  boolean  QuotasRebuilding;
  uint64   Size;
  string   Status;
  uint16   StatusInfo;
  boolean  SupportsDiskQuotas;
  boolean  SupportsFileBasedCompression;
  string   SystemCreationClassName;
  string   SystemName;
  boolean  VolumeDirty;
  string   VolumeName;
  string   VolumeSerialNumber;
};

Members

The Win32_LogicalDisk class has these types of members:

Methods

The Win32_LogicalDisk class has these methods.

MethodDescription
Chkdsk

Invokes the Chkdsk operation on the disk.

ExcludeFromAutochk

Excludes disks from the Chkdsk operation to be run at the next restart.

Reset

Not implemented. For more information about how to implement this method, see the Reset method in CIM_LogicalDisk for documentation.

ScheduleAutoChk

Schedules Chkdsk to be run at the next restart if the dirty bit has been set.

SetPowerState

Not implemented. For more information about how to implement this method, see the SetPowerState method in CIM_LogicalDisk.

 

Properties

The Win32_LogicalDisk class has these properties.

Access
Data type: uint16
Access type: Read-only

Type of media access available. This property is inherited from CIM_StorageExtent.

ValueMeaning
0

Unknown

1

Readable

2

Writable

3

Read/Write Supported

4

Write Once

 

Availability
Data type: uint16
Access type: Read-only

Availability and status of the device. Inherited from CIM_LogicalDevice.

ValueMeaning
1 (0x1)

Other

2 (0x2)

Unknown

3 (0x3)

Running or Full Power

4 (0x4)

Warning

5 (0x5)

In Test

6 (0x6)

Not Applicable

7 (0x7)

Power Off

8 (0x8)

Offline

9 (0x9)

Off Duty

10 (0xA)

Degraded

11 (0xB)

Not Installed

12 (0xC)

Install Error

13 (0xD)

Power Save - Unknown

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

14 (0xE)

Power Save - Low Power Mode

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

15 (0xF)

Power Save - Standby

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

16 (0x10)

Power Cycle

17 (0x11)

Power Save - Warning

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

 

BlockSize
Data type: uint64
Access type: Read-only

Size, in bytes, of the blocks that form this storage extent. If unknown or if a block concept is not valid (for example, for aggregate extents, memory or logical disks), enter 1. This property is inherited from CIM_StorageExtent.

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

Caption
Data type: string
Access type: Read-only

Short description of the object—a one-line string. This property is inherited from CIM_ManagedSystemElement.

Compressed
Data type: boolean
Access type: Read-only

If True, the logical volume exists as a single compressed entity, such as a DoubleSpace volume. If file based compression is supported, such as on NTFS, this property is False.

ConfigManagerErrorCode
Data type: uint32
Access type: Read-only

Windows Configuration Manager error code.

ValueMeaning
0 (0x0)

Device is working properly.

1 (0x1)

Device is not configured correctly.

2 (0x2)

Windows cannot load the driver for this device.

3 (0x3)

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

4 (0x4)

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

5 (0x5)

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

6 (0x6)

Boot configuration for the device conflicts with other devices.

7 (0x7)

Cannot filter.

8 (0x8)

Driver loader for the device is missing.

9 (0x9)

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

10 (0xA)

Device cannot start.

11 (0xB)

Device failed.

12 (0xC)

Device cannot find enough free resources to use.

13 (0xD)

Windows cannot verify the device resources.

14 (0xE)

Device cannot work properly until the computer is restarted.

15 (0xF)

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

16 (0x10)

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

17 (0x11)

Device is requesting an unknown resource type.

18 (0x12)

Device drivers must be reinstalled.

19 (0x13)

Failure using the VxD loader.

20 (0x14)

Registry might be corrupted.

21 (0x15)

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

22 (0x16)

Device is disabled.

23 (0x17)

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

24 (0x18)

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

25 (0x19)

Windows is still setting up the device.

26 (0x1A)

Windows is still setting up the device.

27 (0x1B)

Device does not have valid log configuration.

28 (0x1C)

Device drivers are not installed.

29 (0x1D)

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

30 (0x1E)

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

31 (0x1F)

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

 

ConfigManagerUserConfig
Data type: boolean
Access type: Read-only

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

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, the property allows all instances of this class and its subclasses to be uniquely identified. This property is inherited from CIM_LogicalDevice.

Description
Data type: string
Access type: Read-only

Description of the object. This property is inherited from CIM_ManagedSystemElement.

DeviceID
Data type: string
Access type: Read-only
Qualifiers: Key

Unique identifier of the logical disk from other devices on the system. This property is inherited from CIM_LogicalDevice.

For a code example that retrieves this property, see the Remarks section, below.

DriveType
Data type: uint32
Access type: Read-only

Numeric value that corresponds to the type of disk drive this logical disk represents.

ValueMeaning
0

Unknown

1

No Root Directory

2

Removable Disk

3

Local Disk

4

Network Drive

5

Compact Disc

6

RAM Disk

 

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

More information about the error recorded in LastErrorCode, and information on any corrective actions that may be taken. This property is inherited from CIM_LogicalDevice.

ErrorMethodology
Data type: string
Access type: Read-only

Type of error detection and correction supported by this storage extent. This property is inherited from CIM_StorageExtent.

FileSystem
Data type: string
Access type: Read-only

File system on the logical disk.

Example: "NTFS"

FreeSpace
Data type: uint64
Access type: Read-only

Space, in bytes, available on the logical disk. This property is inherited from CIM_LogicalDisk.

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

InstallDate
Data type: datetime
Access type: Read-only

Date and time the object was installed. This property does not require 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.

MaximumComponentLength
Data type: uint32
Access type: Read-only

Maximum length of a filename component supported by the Windows drive. A filename component is that portion of a filename between backslashes. The value can be used to indicate that long names are supported by the specified file system. For example, for a FAT file system supporting long names, the function stores the value 255, rather than the previous 8.3 indicator. Long names can also be supported on systems that use the NTFS file system.

Example: 255

MediaType
Data type: uint32
Access type: Read-only

Type of media currently present in the logical drive. This value will be one of the values of the MEDIA_TYPE enumeration defined in Winioctl.h. The value may not be exact for removable drives if currently there is no media in the drive.

ValueMeaning
0 Unknown

Format is unknown

1 F5_1Pt2_512

5 1/4-Inch Floppy Disk - 1.2 MB - 512 bytes/sector

2 F3_1Pt44_512

3 1/2-Inch Floppy Disk - 1.44 MB -512 bytes/sector

3 F3_2Pt88_512

3 1/2-Inch Floppy Disk - 2.88 MB - 512 bytes/sector

4 F3_20Pt8_512

3 1/2-Inch Floppy Disk - 20.8 MB - 512 bytes/sector

5 F3_720_512

3 1/2-Inch Floppy Disk - 720 KB - 512 bytes/sector

6 F5_360_512

5 1/4-Inch Floppy Disk - 360 KB - 512 bytes/sector

7 F5_320_512

5 1/4-Inch Floppy Disk - 320 KB - 512 bytes/sector

8 F5_320_1024

5 1/4-Inch Floppy Disk - 320 KB - 1024 bytes/sector

9 F5_180_512

5 1/4-Inch Floppy Disk - 180 KB - 512 bytes/sector

10 F5_160_512

5 1/4-Inch Floppy Disk - 160 KB - 512 bytes/sector

11

Removable media other than floppy

12

Fixed hard disk media

13 F3_120M_512

3 1/2-Inch Floppy Disk - 120 MB - 512 bytes/sector

14 F3_640_512

3 1/2-Inch Floppy Disk - 640 KB - 512 bytes/sector

15 F5_640_512

5 1/4-Inch Floppy Disk - 640 KB - 512 bytes/sector

16 F5_720_512

5 1/4-Inch Floppy Disk - 720 KB - 512 bytes/sector

17 F3_1Pt2_512

3 1/2-Inch Floppy Disk - 1.2 MB - 512 bytes/sector

18 F3_1Pt23_1024

3 1/2-Inch Floppy Disk - 1.23 MB - 1024 bytes/sector

19 F5_1Pt23_1024

5 1/4-Inch Floppy Disk - 1.23 MB - 1024 bytes/sector

20 F3_128Mb_512

3 1/2-Inch Floppy Disk - 128 MB - 512 bytes/sector

21 F3_230Mb_512

3 1/2-Inch Floppy Disk - 230 MB - 512 bytes/sector

22 F8_256_128

8-Inch Floppy Disk - 256 KB - 128 bytes/sector

 

Name
Data type: string
Access type: Read-only

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.

NumberOfBlocks
Data type: uint64
Access type: Read-only

Total number of consecutive blocks, each block the size of the value contained in the BlockSize property, which form this storage extent. Total size of the storage extent can be calculated by multiplying the value of the BlockSize property by the value of this property. If the value of BlockSize is 1, this property is the total size of the storage extent. This property is inherited from CIM_StorageExtent.

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

PNPDeviceID
Data type: string
Access type: Read-only

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.

ValueMeaning
0 (0x0)

Unknown

1 (0x1)

Not Supported

2 (0x2)

Disabled

3 (0x3)

Enabled

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

4 (0x4)

Power Saving Modes Entered Automatically

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

5 (0x5)

Power State Settable

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.

6 (0x6)

Power Cycling Supported

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

7 (0x7)

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). This 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.

ProviderName
Data type: string
Access type: Read-only

Network path to the logical device.

Purpose
Data type: string
Access type: Read-only

Free-form string describing the media and its use. This property is inherited from CIM_StorageExtent.

QuotasDisabled
Data type: boolean
Access type: Read-only

Indicates that quota management is not enabled (TRUE) on this system.

QuotasIncomplete
Data type: boolean
Access type: Read-only

Indicates that the quota management was used but has been disabled (True). Incomplete refers to the information left in the file system after quota management was disabled.

QuotasRebuilding
Data type: boolean
Access type: Read-only

If True, indicates that the file system is in the active process of compiling information and setting the disk up for quota management.

Size
Data type: uint64
Access type: Read-only

Size of the disk drive. This property is inherited from CIM_LogicalDisk.

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

For a code example that retrieves this property, see the Remarks section, below.

Status
Data type: string
Access type: Read-only

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.

The values are:

"OK"
"Error"
"Degraded"
"Unknown"
"Pred Fail"
"Starting"
"Stopping"
"Service"
"Stressed"
"NonRecover"
"No Contact"
"Lost Comm"
StatusInfo
Data type: uint16
Access type: Read-only

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.

ValueMeaning
1

Other

2

Unknown

3

Enabled

4

Disabled

5

Not Applicable

 

SupportsDiskQuotas
Data type: boolean
Access type: Read-only

If True, this volume supports disk quotas.

SupportsFileBasedCompression
Data type: boolean
Access type: Read-only

If True, the logical disk partition supports file-based compression, such as is the case with the NTFS file system. This property is False when the Compressed property is True.

SystemCreationClassName
Data type: string
Access type: Read-only

Value of the scoping computer CreationClassName property. This property is inherited from CIM_LogicalDevice.

SystemName
Data type: string
Access type: Read-only

Name of the scoping system. This property is inherited from CIM_LogicalDevice.

VolumeDirty
Data type: boolean
Access type: Read-only

If True, the disk requires ChkDsk to be run at the next restart. This property is only applicable to those instances of logical disk that represent a physical disk in the machine. It is not applicable to mapped logical drives.

VolumeName
Data type: string
Access type: Read/write

Volume name of the logical disk.

Constraints: Maximum 32 characters.

For a code example that retrieves this property, see the Remarks section, below.

VolumeSerialNumber
Data type: string
Access type: Read-only

Volume serial number of the logical disk.

Constraints: Maximum 11 characters.

Example: "A8C3-D032"

Remarks

The Win32_LogicalDisk class is derived from CIM_LogicalDisk which derives from CIM_StorageExtent. The CIM_StorageExtent class is derived from CIM_LogicalDevice.

A physical disk drive is the cornerstone of any storage management system. However, after a physical disk drive has been installed, neither users nor system administrators typically deal with the hardware directly. Instead, both users and system administrators interact with the logical drives that have been created on the disk.

A logical drive is a subdivision of a partition that has been assigned its own drive letter. (It is possible to have a partition that has not been assigned a drive letter.) When you talk about drive C or drive D, you are referring to a logical drive rather than to a physical disk drive. Likewise, when you save a document to drive E, you are saving it to the logical drive. Physical disks compose the hardware that makes up a drive, including such components as heads, sectors, and cylinders. Logical drives, by contrast, have properties such as disk space, available disk space, and drive letters.

Note  The Win32_LogicalDisk class can be used only to enumerate the properties of local disk drives. However, you can use the Win32_MappedLogicalDisk class to enumerate the properties of mapped network drives.

Examples

You can find other examples using Win32_LogicalDisk to obtain disk or volume data in the WMI Tasks: Disks and File Systems topic.

The WMI Information Retriever VBScript code example on the TechNet Gallery uses the Win32_LogicalDisk class to retrieve hardware information from a number of remote computers.

The Get Disk info using wmi/cim... PowerShell code example on the TechNet Gallery uses Win32_LogicalDisk to retrieve DeviceID, VolumeName, and Size from a target device. In particular, this sample includes rigorous exception handling, and returns a single object per computer, rather than per disk.

Enterprise scripting often involves configuring hardware and software on remote computers; in turn, this requires you to know, in advance, the type of disk drives installed on a computer. For example, a script that installs an application on drive E works only if drive E is a hard disk. If drive E happens to represent a floppy disk or a CD-ROM drive, the script fails. The following VBScript identifies the drives and drive types installed on a computer


strComputer = "."
Set objWMIService = GetObject("winmgmts:" _
 & "{impersonationLevel=impersonate}!\\" & strComputer & "\root\cimv2")
Set colDisks = objWMIService.ExecQuery _
 ("SELECT * FROM Win32_LogicalDisk")
For Each objDisk in colDisks
 Wscript.Echo "DeviceID: "& objDisk.DeviceID 
 Select Case objDisk.DriveType
 Case 1
 Wscript.Echo "No root directory."
 Case 2
 Wscript.Echo "DriveType: Removable drive."
 Case 3
 Wscript.Echo "DriveType: Local hard disk."
 Case 4
 Wscript.Echo "DriveType: Network disk." 
 Case 5
 Wscript.Echo "DriveType: Compact disk." 
 Case 6
 Wscript.Echo "DriveType: RAM disk." 
 Case Else
 Wscript.Echo "Drive type could not be determined."
 End Select
Next

The following VBScript sample enumerates the free space on all the hard disk drives on a computer.


Const HARD_DISK = 3
strComputer = "."
Set objWMIService = GetObject("winmgmts:" _
 & "{impersonationLevel=impersonate}!\\" & strComputer & "\root\cimv2")
Set colDisks = objWMIService.ExecQuery _
 ("SELECT * FROM Win32_LogicalDisk WHERE DriveType = " _
 & HARD_DISK & "")
For Each objDisk in colDisks
 Wscript.Echo "Device ID: " & objDisk.DeviceID 
 Wscript.Echo "Free Disk Space: " & objDisk.FreeSpace
Next

The following VBScript code example, returns the type of file system (FAT, NTFS, FAT32, and so on) used on each drive in a computer.


strComputer = "."
Set objWMIService = GetObject("winmgmts:" _
    & "{impersonationLevel=impersonate}!\\" _
    & strComputer & "\root\cimv2")
Set colDisks = objWMIService.ExecQuery _
    ("Select * from Win32_LogicalDisk")
For Each objDisk in colDisks
    Wscript.Echo "DeviceID: "& vbTab &  objDisk.DeviceID  
    Wscript.Echo "File System: "& vbTab & objDisk.FileSystem
Next

The following PowerShell code sample retrieves the device ID and file system type of the local logical disks.


Get-WMIObject Win32_logicaldisk | select deviceid, filesystem | ft -autosize


The following PowerShell code sample retrieves additional information about the logical local disks.


Write-Host "Drive information for $env:ComputerName"

Get-WmiObject -Class Win32_LogicalDisk |
    Where-Object {$_.DriveType -ne 5} |
    Sort-Object -Property Name | 
    Select-Object Name, VolumeName, FileSystem, Description, VolumeDirty, `
        @{"Label"="DiskSize(GB)";"Expression"={"{0:N}" -f ($_.Size/1GB) -as [float]}}, `
        @{"Label"="FreeSpace(GB)";"Expression"={"{0:N}" -f ($_.FreeSpace/1GB) -as [float]}}, `
        @{"Label"="%Free";"Expression"={"{0:N}" -f ($_.FreeSpace/$_.Size*100) -as [float]}} |
    Format-Table -AutoSize

Requirements

Minimum supported client

Windows Vista

Minimum supported server

Windows Server 2003

Namespace

\root\CIMV2

MOF

CIMWin32.mof

DLL

CIMWin32.dll

See also

Computer System Hardware Classes
WMI Tasks: Disks and File Systems

 

 

Show:
© 2014 Microsoft