The Win32_DiskDrive WMI class represents a physical disk drive as seen by a computer running the Windows operating system.
Methods
Win32_DiskDrive has no methods. Inherited methods (Reset and SetPowerState) are not implemented.
Properties
Win32_DiskDrive returns 51 properties:
'Availability','BytesPerSector','Capabilities','CapabilityDescriptions','Caption',
'CompressionMethod','ConfigManagerErrorCode','ConfigManagerUserConfig','CreationClassName',
'DefaultBlockSize','Description','DeviceID','ErrorCleared','ErrorDescription','ErrorMethodology',
'FirmwareRevision','Index','InstallDate','InterfaceType','LastErrorCode','Manufacturer','MaxBlockSize',
'MaxMediaSize','MediaLoaded','MediaType','MinBlockSize','Model','Name','NeedsCleaning',
'NumberOfMediaSupported','Partitions','PNPDeviceID','PowerManagementCapabilities','PowerManagementSupported',
'SCSIBus','SCSILogicalUnit','SCSIPort','SCSITargetId','SectorsPerTrack','SerialNumber',
'Signature','Size','Status','StatusInfo','SystemCreationClassName','SystemName','TotalCylinders',
'TotalHeads','TotalSectors','TotalTracks','TracksPerCylinder'
Unless explicitly marked as writeable, all properties are read-only. Read all properties for all instances:
Get-CimInstance -ClassName Win32_DiskDrive -Property *
Most WMI classes return one or more instances.
When
Get-CimInstance
returns no result, then apparently no instances of class Win32_DiskDrive exist. This is normal behavior.Either the class is not implemented on your system (may be deprecated or due to missing drivers, i.e. CIM_VideoControllerResolution), or there are simply no physical representations of this class currently available (i.e. Win32_TapeDrive).
Availability
Availability and status of the device.
Availability returns a numeric value. To translate it into a meaningful text, use any of the following approaches:
Use a PowerShell Hashtable
$Availability_map = @{
1 = 'Other'
2 = 'Unknown'
3 = 'Running/Full Power'
4 = 'Warning'
5 = 'In Test'
6 = 'Not Applicable'
7 = 'Power Off'
8 = 'Off Line'
9 = 'Off Duty'
10 = 'Degraded'
11 = 'Not Installed'
12 = 'Install Error'
13 = 'Power Save - Unknown'
14 = 'Power Save - Low Power Mode'
15 = 'Power Save - Standby'
16 = 'Power Cycle'
17 = 'Power Save - Warning'
18 = 'Paused'
19 = 'Not Ready'
20 = 'Not Configured'
21 = 'Quiesced'
}
Use a switch statement
switch([int]$value)
{
1 {'Other'}
2 {'Unknown'}
3 {'Running/Full Power'}
4 {'Warning'}
5 {'In Test'}
6 {'Not Applicable'}
7 {'Power Off'}
8 {'Off Line'}
9 {'Off Duty'}
10 {'Degraded'}
11 {'Not Installed'}
12 {'Install Error'}
13 {'Power Save - Unknown'}
14 {'Power Save - Low Power Mode'}
15 {'Power Save - Standby'}
16 {'Power Cycle'}
17 {'Power Save - Warning'}
18 {'Paused'}
19 {'Not Ready'}
20 {'Not Configured'}
21 {'Quiesced'}
default {"$value"}
}
Use Enum structure
Enum EnumAvailability
{
Other = 1
Unknown = 2
RunningFull_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
}
Examples
Use $Availability_map in a calculated property for Select-Object
<#
this example uses a hashtable to translate raw numeric values for
property "Availability" to friendly text
Note: to use other properties than "Availability", look up the appropriate
translation hashtable for the property you would like to use instead.
#>
#region define hashtable to translate raw values to friendly text
# Please note: this hashtable is specific for property "Availability"
# to translate other properties, use their translation table instead
$Availability_map = @{
1 = 'Other'
2 = 'Unknown'
3 = 'Running/Full Power'
4 = 'Warning'
5 = 'In Test'
6 = 'Not Applicable'
7 = 'Power Off'
8 = 'Off Line'
9 = 'Off Duty'
10 = 'Degraded'
11 = 'Not Installed'
12 = 'Install Error'
13 = 'Power Save - Unknown'
14 = 'Power Save - Low Power Mode'
15 = 'Power Save - Standby'
16 = 'Power Cycle'
17 = 'Power Save - Warning'
18 = 'Paused'
19 = 'Not Ready'
20 = 'Not Configured'
21 = 'Quiesced'
}
#endregion define hashtable
#region define calculated property (to be used with Select-Object)
<#
a calculated property is defined by a hashtable with keys "Name" and "Expression"
"Name" defines the name of the property (in this example, it is "Availability", but you can rename it to anything else)
"Expression" defines a scriptblock that calculates the content of this property
in this example, the scriptblock uses the hashtable defined earlier to translate each numeric
value to its friendly text counterpart:
#>
$Availability = @{
Name = 'Availability'
Expression = {
# property is an array, so process all values
$value = $_.Availability
$Availability_map[[int]$value]
}
}
#endregion define calculated property
# retrieve the instances, and output the properties "Caption" and "Availability". The latter
# is defined by the hashtable in $Availability:
Get-CimInstance -Class Win32_DiskDrive | Select-Object -Property Caption, $Availability
# ...or dump content of property Availability:
$friendlyValues = Get-CimInstance -Class Win32_DiskDrive |
Select-Object -Property $Availability |
Select-Object -ExpandProperty Availability
# output values
$friendlyValues
# output values as comma separated list
$friendlyValues -join ', '
# output values as bullet list
$friendlyValues | ForEach-Object { "- $_" }
Use $Availability_map to directly translate raw values from an instance
<#
this example uses a hashtable to manually translate raw numeric values
for property "Win32_DiskDrive" to friendly text. This approach is ideal when
there is just one instance to work with.
Note: to use other properties than "Win32_DiskDrive", look up the appropriate
translation hashtable for the property you would like to use instead.
#>
#region define hashtable to translate raw values to friendly text
# Please note: this hashtable is specific for property "Win32_DiskDrive"
# to translate other properties, use their translation table instead
$Availability_map = @{
1 = 'Other'
2 = 'Unknown'
3 = 'Running/Full Power'
4 = 'Warning'
5 = 'In Test'
6 = 'Not Applicable'
7 = 'Power Off'
8 = 'Off Line'
9 = 'Off Duty'
10 = 'Degraded'
11 = 'Not Installed'
12 = 'Install Error'
13 = 'Power Save - Unknown'
14 = 'Power Save - Low Power Mode'
15 = 'Power Save - Standby'
16 = 'Power Cycle'
17 = 'Power Save - Warning'
18 = 'Paused'
19 = 'Not Ready'
20 = 'Not Configured'
21 = 'Quiesced'
}
#endregion define hashtable
# get one instance:
$instance = Get-CimInstance -Class Win32_DiskDrive | Select-Object -First 1
<#
IMPORTANT: this example processes only one instance to illustrate
the number-to-text translation. To process all instances, replace
"Select-Object -First 1" with a "Foreach-Object" loop, and use
the iterator variable $_ instead of $instance
#>
# query the property
$rawValue = $instance.Availability
# translate raw value to friendly text:
$friendlyName = $Availability_map[[int]$rawValue]
# output value
$friendlyName
Use a switch statement inside a calculated property for Select-Object
<#
this example uses a switch clause to translate raw numeric
values for property "Availability" to friendly text. The switch
clause is embedded into a calculated property so there is
no need to refer to external variables for translation.
Note: to use other properties than "Availability", look up the appropriate
translation switch clause for the property you would like to use instead.
#>
#region define calculated property (to be used with Select-Object)
<#
a calculated property is defined by a hashtable with keys "Name" and "Expression"
"Name" defines the name of the property (in this example, it is "Availability", but you can rename it to anything else)
"Expression" defines a scriptblock that calculates the content of this property
in this example, the scriptblock uses the hashtable defined earlier to translate each numeric
value to its friendly text counterpart:
#>
$Availability = @{
Name = 'Availability'
Expression = {
# property is an array, so process all values
$value = $_.Availability
switch([int]$value)
{
1 {'Other'}
2 {'Unknown'}
3 {'Running/Full Power'}
4 {'Warning'}
5 {'In Test'}
6 {'Not Applicable'}
7 {'Power Off'}
8 {'Off Line'}
9 {'Off Duty'}
10 {'Degraded'}
11 {'Not Installed'}
12 {'Install Error'}
13 {'Power Save - Unknown'}
14 {'Power Save - Low Power Mode'}
15 {'Power Save - Standby'}
16 {'Power Cycle'}
17 {'Power Save - Warning'}
18 {'Paused'}
19 {'Not Ready'}
20 {'Not Configured'}
21 {'Quiesced'}
default {"$value"}
}
}
}
#endregion define calculated property
# retrieve all instances...
Get-CimInstance -ClassName Win32_DiskDrive |
# ...and output properties "Caption" and "Availability". The latter is defined
# by the hashtable in $Availability:
Select-Object -Property Caption, $Availability
Use the Enum from above to auto-translate the code values
<#
this example translates raw values by means of type conversion
the friendly names are defined as enumeration using the
keyword "enum" (PowerShell 5 or better)
The raw value(s) are translated to friendly text by
simply converting them into the enum type.
Note: to use other properties than "Win32_DiskDrive", look up the appropriate
enum definition for the property you would like to use instead.
#>
#region define enum with value-to-text translation:
Enum EnumAvailability
{
Other = 1
Unknown = 2
RunningFull_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
}
#endregion define enum
# get one instance:
$instance = Get-CimInstance -Class Win32_DiskDrive | Select-Object -First 1
<#
IMPORTANT: this example processes only one instance to focus on
the number-to-text type conversion.
To process all instances, replace "Select-Object -First 1"
with a "Foreach-Object" loop, and use the iterator variable
$_ instead of $instance
#>
# query the property:
$rawValue = $instance.Availability
#region using strict type conversion
<#
Note: strict type conversion fails if the raw value is
not defined by the enum. So if the list of allowable values
was extended and the enum does not match the value,
an exception is thrown
#>
# convert the property to the enum **Availability**
[EnumAvailability]$rawValue
# get a comma-separated string:
[EnumAvailability]$rawValue -join ','
#endregion
#region using operator "-as"
<#
Note: the operator "-as" accepts values not defined
by the enum and returns $null instead of throwing
an exception
#>
$rawValue -as [EnumAvailability]
#endregion
Enums must cover all possible values. If Availability returns a value that is not defined in the enum, an exception occurs. The exception reports the value that was missing in the enum. To fix, add the missing value to the enum.
BytesPerSector
Number of bytes in each sector for the physical disk drive.
Example: 512
Get-CimInstance -ClassName Win32_DiskDrive | Select-Object -Property DeviceID, BytesPerSector
Capabilities
Array of capabilities of the media access device. For example, the device may support random access (3), removable media (7), and automatic cleaning (9).
Capabilities returns a numeric value. To translate it into a meaningful text, use any of the following approaches:
Use a PowerShell Hashtable
$Capabilities_map = @{
0 = 'Unknown'
1 = 'Other'
2 = 'Sequential Access'
3 = 'Random Access'
4 = 'Supports Writing'
5 = 'Encryption'
6 = 'Compression'
7 = 'Supports Removeable Media'
8 = 'Manual Cleaning'
9 = 'Automatic Cleaning'
10 = 'SMART Notification'
11 = 'Supports Dual Sided Media'
12 = 'Predismount Eject Not Required'
}
Use a switch statement
switch([int]$value)
{
0 {'Unknown'}
1 {'Other'}
2 {'Sequential Access'}
3 {'Random Access'}
4 {'Supports Writing'}
5 {'Encryption'}
6 {'Compression'}
7 {'Supports Removeable Media'}
8 {'Manual Cleaning'}
9 {'Automatic Cleaning'}
10 {'SMART Notification'}
11 {'Supports Dual Sided Media'}
12 {'Predismount Eject Not Required'}
default {"$value"}
}
Use Enum structure
Enum EnumCapabilities
{
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
}
Examples
Use $Capabilities_map in a calculated property for Select-Object
<#
this example uses a hashtable to translate raw numeric values for
property "Capabilities" to friendly text
Note: to use other properties than "Capabilities", look up the appropriate
translation hashtable for the property you would like to use instead.
#>
#region define hashtable to translate raw values to friendly text
# Please note: this hashtable is specific for property "Capabilities"
# to translate other properties, use their translation table instead
$Capabilities_map = @{
0 = 'Unknown'
1 = 'Other'
2 = 'Sequential Access'
3 = 'Random Access'
4 = 'Supports Writing'
5 = 'Encryption'
6 = 'Compression'
7 = 'Supports Removeable Media'
8 = 'Manual Cleaning'
9 = 'Automatic Cleaning'
10 = 'SMART Notification'
11 = 'Supports Dual Sided Media'
12 = 'Predismount Eject Not Required'
}
#endregion define hashtable
#region define calculated property (to be used with Select-Object)
<#
a calculated property is defined by a hashtable with keys "Name" and "Expression"
"Name" defines the name of the property (in this example, it is "Capabilities", but you can rename it to anything else)
"Expression" defines a scriptblock that calculates the content of this property
in this example, the scriptblock uses the hashtable defined earlier to translate each numeric
value to its friendly text counterpart:
#>
$Capabilities = @{
Name = 'Capabilities'
Expression = {
# property is an array, so process all values
$result = foreach($value in $_.Capabilities)
{
# important: convert original value to [int] because
# hashtable keys are type-aware:
$Capabilities_map[[int]$value]
}
# uncomment to get a comma-separated string instead
# of a string array:
$result <#-join ', '#>
}
}
#endregion define calculated property
# retrieve the instances, and output the properties "Caption" and "Capabilities". The latter
# is defined by the hashtable in $Capabilities:
Get-CimInstance -Class Win32_DiskDrive | Select-Object -Property Caption, $Capabilities
# ...or dump content of property Capabilities:
$friendlyValues = Get-CimInstance -Class Win32_DiskDrive |
Select-Object -Property $Capabilities |
Select-Object -ExpandProperty Capabilities
# output values
$friendlyValues
# output values as comma separated list
$friendlyValues -join ', '
# output values as bullet list
$friendlyValues | ForEach-Object { "- $_" }
Use $Capabilities_map to directly translate raw values from an instance
<#
this example uses a hashtable to manually translate raw numeric values
for property "Win32_DiskDrive" to friendly text. This approach is ideal when there
is just one instance to work with.
Note: to use other properties than "Win32_DiskDrive", look up the appropriate
translation hashtable for the property you would like to use instead.
#>
#region define hashtable to translate raw values to friendly text
# Please note: this hashtable is specific for property "Win32_DiskDrive"
# to translate other properties, use their translation table instead
$Capabilities_map = @{
0 = 'Unknown'
1 = 'Other'
2 = 'Sequential Access'
3 = 'Random Access'
4 = 'Supports Writing'
5 = 'Encryption'
6 = 'Compression'
7 = 'Supports Removeable Media'
8 = 'Manual Cleaning'
9 = 'Automatic Cleaning'
10 = 'SMART Notification'
11 = 'Supports Dual Sided Media'
12 = 'Predismount Eject Not Required'
}
#endregion define hashtable
# get one instance:
$instance = Get-CimInstance -Class Win32_DiskDrive | Select-Object -First 1
<#
IMPORTANT: this example processes only one instance to illustrate
the number-to-text translation. To process all instances, replace
"Select-Object -First 1" with a "Foreach-Object" loop, and use
the iterator variable $_ instead of $instance
#>
# query the property (hint: the property is an array!)
$rawValues = $instance.Capabilities
# translate all raw values into friendly names:
$friendlyNames = foreach($rawValue in $rawValues)
{ $Capabilities_map[[int]$rawValue] }
# output values
$friendlyValues
# output values as comma separated list
$friendlyValues -join ', '
# output values as bullet list
$friendlyValues | ForEach-Object { "- $_" }
Use a switch statement inside a calculated property for Select-Object
<#
this example uses a switch clause to translate raw numeric
values for property "Capabilities" to friendly text. The switch
clause is embedded into a calculated property so there is
no need to refer to external variables for translation.
Note: to use other properties than "Capabilities", look up the appropriate
translation switch clause for the property you would like to use instead.
#>
#region define calculated property (to be used with Select-Object)
<#
a calculated property is defined by a hashtable with keys "Name" and "Expression"
"Name" defines the name of the property (in this example, it is "Capabilities", but you can rename it to anything else)
"Expression" defines a scriptblock that calculates the content of this property
in this example, the scriptblock uses the hashtable defined earlier to translate each numeric
value to its friendly text counterpart:
#>
$Capabilities = @{
Name = 'Capabilities'
Expression = {
# property is an array, so process all values
$result = foreach($value in $_.Capabilities)
{
switch([int]$value)
{
0 {'Unknown'}
1 {'Other'}
2 {'Sequential Access'}
3 {'Random Access'}
4 {'Supports Writing'}
5 {'Encryption'}
6 {'Compression'}
7 {'Supports Removeable Media'}
8 {'Manual Cleaning'}
9 {'Automatic Cleaning'}
10 {'SMART Notification'}
11 {'Supports Dual Sided Media'}
12 {'Predismount Eject Not Required'}
default {"$value"}
}
}
$result
}
}
#endregion define calculated property
# retrieve all instances...
Get-CimInstance -ClassName Win32_DiskDrive |
# ...and output properties "Caption" and "Capabilities". The latter is defined
# by the hashtable in $Capabilities:
Select-Object -Property Caption, $Capabilities
Use the Enum from above to auto-translate the code values
<#
this example translates raw values by means of type conversion
the friendly names are defined as enumeration using the
keyword "enum" (PowerShell 5 or better)
The raw value(s) are translated to friendly text by
simply converting them into the enum type.
Note: to use other properties than "Win32_DiskDrive", look up the appropriate
enum definition for the property you would like to use instead.
#>
#region define enum with value-to-text translation:
Enum EnumCapabilities
{
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
}
#endregion define enum
# get one instance:
$instance = Get-CimInstance -Class Win32_DiskDrive | Select-Object -First 1
<#
IMPORTANT: this example processes only one instance to focus on
the number-to-text type conversion.
To process all instances, replace "Select-Object -First 1"
with a "Foreach-Object" loop, and use the iterator variable
$_ instead of $instance
#>
# query the property:
$rawValue = $instance.Capabilities
#region using strict type conversion
<#
Note: strict type conversion fails if the raw value is
not defined by the enum. So if the list of allowable values
was extended and the enum does not match the value,
an exception is thrown
#>
# convert the property to the enum **Capabilities**
[EnumCapabilities[]]$rawValue
# get a comma-separated string:
[EnumCapabilities[]]$rawValue -join ','
#endregion
#region using operator "-as"
<#
Note: the operator "-as" accepts values not defined
by the enum and returns $null instead of throwing
an exception
#>
$rawValue -as [EnumCapabilities[]]
#endregion
Enums must cover all possible values. If Capabilities returns a value that is not defined in the enum, an exception occurs. The exception reports the value that was missing in the enum. To fix, add the missing value to the enum.
CapabilityDescriptions
List of more detailed explanations for any of the access device features indicated in the Capabilities array. Note, each entry of this array is related to the entry in the Capabilities array that is located at the same index.
Get-CimInstance -ClassName Win32_DiskDrive | Select-Object -Property DeviceID, CapabilityDescriptions
Caption
Short description of the object.
Get-CimInstance -ClassName Win32_DiskDrive | Select-Object -Property DeviceID, Caption
CompressionMethod
The name of the compression algorithm or one of the following values.
(“Unknown”)
Whether the device supports compression capabilities or not is not known.
(“Compressed”)
The device supports compression capabilities but its compression scheme is not known or not disclosed.
(“Not Compressed”)
The device does not support compression.
Get-CimInstance -ClassName Win32_DiskDrive | Select-Object -Property DeviceID, CompressionMethod
ConfigManagerErrorCode
Windows Configuration Manager error code.
ConfigManagerErrorCode returns a numeric value. To translate it into a meaningful text, use any of the following approaches:
Use a PowerShell Hashtable
$ConfigManagerErrorCode_map = @{
0 = 'This device is working properly.'
1 = 'This device is not configured correctly.'
2 = 'Windows cannot load the driver for this device.'
3 = 'The driver for this device might be corrupted, or your system may be running low on memory or other resources.'
4 = 'This device is not working properly. One of its drivers or your registry might be corrupted.'
5 = 'The driver for this device needs a resource that Windows cannot manage.'
6 = 'The boot configuration for this device conflicts with other devices.'
7 = 'Cannot filter.'
8 = 'The driver loader for the device is missing.'
9 = 'This device is not working properly because the controlling firmware is reporting the resources for the device incorrectly.'
10 = 'This device cannot start.'
11 = 'This device failed.'
12 = 'This device cannot find enough free resources that it can use.'
13 = 'Windows cannot verify this device''s resources.'
14 = 'This device cannot work properly until you restart your computer.'
15 = 'This device is not working properly because there is probably a re-enumeration problem.'
16 = 'Windows cannot identify all the resources this device uses.'
17 = 'This device is asking for an unknown resource type.'
18 = 'Reinstall the drivers for this device.'
19 = 'Failure using the VxD loader.'
20 = 'Your registry might be corrupted.'
21 = 'System failure: Try changing the driver for this device. If that does not work, see your hardware documentation. Windows is removing this device.'
22 = 'This device is disabled.'
23 = 'System failure: Try changing the driver for this device. If that doesn''t work, see your hardware documentation.'
24 = 'This device is not present, is not working properly, or does not have all its drivers installed.'
25 = 'Windows is still setting up this device.'
26 = 'Windows is still setting up this device.'
27 = 'This device does not have valid log configuration.'
28 = 'The drivers for this device are not installed.'
29 = 'This device is disabled because the firmware of the device did not give it the required resources.'
30 = 'This device is using an Interrupt Request (IRQ) resource that another device is using.'
31 = 'This device is not working properly because Windows cannot load the drivers required for this device.'
}
Use a switch statement
switch([int]$value)
{
0 {'This device is working properly.'}
1 {'This device is not configured correctly.'}
2 {'Windows cannot load the driver for this device.'}
3 {'The driver for this device might be corrupted, or your system may be running low on memory or other resources.'}
4 {'This device is not working properly. One of its drivers or your registry might be corrupted.'}
5 {'The driver for this device needs a resource that Windows cannot manage.'}
6 {'The boot configuration for this device conflicts with other devices.'}
7 {'Cannot filter.'}
8 {'The driver loader for the device is missing.'}
9 {'This device is not working properly because the controlling firmware is reporting the resources for the device incorrectly.'}
10 {'This device cannot start.'}
11 {'This device failed.'}
12 {'This device cannot find enough free resources that it can use.'}
13 {'Windows cannot verify this device''s resources.'}
14 {'This device cannot work properly until you restart your computer.'}
15 {'This device is not working properly because there is probably a re-enumeration problem.'}
16 {'Windows cannot identify all the resources this device uses.'}
17 {'This device is asking for an unknown resource type.'}
18 {'Reinstall the drivers for this device.'}
19 {'Failure using the VxD loader.'}
20 {'Your registry might be corrupted.'}
21 {'System failure: Try changing the driver for this device. If that does not work, see your hardware documentation. Windows is removing this device.'}
22 {'This device is disabled.'}
23 {'System failure: Try changing the driver for this device. If that doesn''t work, see your hardware documentation.'}
24 {'This device is not present, is not working properly, or does not have all its drivers installed.'}
25 {'Windows is still setting up this device.'}
26 {'Windows is still setting up this device.'}
27 {'This device does not have valid log configuration.'}
28 {'The drivers for this device are not installed.'}
29 {'This device is disabled because the firmware of the device did not give it the required resources.'}
30 {'This device is using an Interrupt Request (IRQ) resource that another device is using.'}
31 {'This device is not working properly because Windows cannot load the drivers required for this device.'}
default {"$value"}
}
Use Enum structure
Enum EnumConfigManagerErrorCode
{
This_device_is_working_properly = 0
This_device_is_not_configured_correctly = 1
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
This_device_is_not_working_properly_One_of_its_drivers_or_your_registry_might_be_corrupted = 4
The_driver_for_this_device_needs_a_resource_that_Windows_cannot_manage = 5
The_boot_configuration_for_this_device_conflicts_with_other_devices = 6
Cannot_filter = 7
The_driver_loader_for_the_device_is_missing = 8
This_device_is_not_working_properly_because_the_controlling_firmware_is_reporting_the_resources_for_the_device_incorrectly = 9
This_device_cannot_start = 10
This_device_failed = 11
This_device_cannot_find_enough_free_resources_that_it_can_use = 12
Windows_cannot_verify_this_devices_resources = 13
This_device_cannot_work_properly_until_you_restart_your_computer = 14
This_device_is_not_working_properly_because_there_is_probably_a_re_enumeration_problem = 15
Windows_cannot_identify_all_the_resources_this_device_uses = 16
This_device_is_asking_for_an_unknown_resource_type = 17
Reinstall_the_drivers_for_this_device = 18
Failure_using_the_VxD_loader = 19
Your_registry_might_be_corrupted = 20
System_failure_Try_changing_the_driver_for_this_device_If_that_does_not_work_see_your_hardware_documentation_Windows_is_removing_this_device = 21
This_device_is_disabled = 22
System_failure_Try_changing_the_driver_for_this_device_If_that_doesnt_work_see_your_hardware_documentation = 23
This_device_is_not_present_is_not_working_properly_or_does_not_have_all_its_drivers_installed = 24
Windows_is_still_setting_up_this_device1 = 25
Windows_is_still_setting_up_this_device2 = 26
This_device_does_not_have_valid_log_configuration = 27
The_drivers_for_this_device_are_not_installed = 28
This_device_is_disabled_because_the_firmware_of_the_device_did_not_give_it_the_required_resources = 29
This_device_is_using_an_Interrupt_Request_IRQ_resource_that_another_device_is_using = 30
This_device_is_not_working_properly_because_Windows_cannot_load_the_drivers_required_for_this_device = 31
}
Examples
Use $ConfigManagerErrorCode_map in a calculated property for Select-Object
<#
this example uses a hashtable to translate raw numeric values for
property "ConfigManagerErrorCode" to friendly text
Note: to use other properties than "ConfigManagerErrorCode", look up the appropriate
translation hashtable for the property you would like to use instead.
#>
#region define hashtable to translate raw values to friendly text
# Please note: this hashtable is specific for property "ConfigManagerErrorCode"
# to translate other properties, use their translation table instead
$ConfigManagerErrorCode_map = @{
0 = 'This device is working properly.'
1 = 'This device is not configured correctly.'
2 = 'Windows cannot load the driver for this device.'
3 = 'The driver for this device might be corrupted, or your system may be running low on memory or other resources.'
4 = 'This device is not working properly. One of its drivers or your registry might be corrupted.'
5 = 'The driver for this device needs a resource that Windows cannot manage.'
6 = 'The boot configuration for this device conflicts with other devices.'
7 = 'Cannot filter.'
8 = 'The driver loader for the device is missing.'
9 = 'This device is not working properly because the controlling firmware is reporting the resources for the device incorrectly.'
10 = 'This device cannot start.'
11 = 'This device failed.'
12 = 'This device cannot find enough free resources that it can use.'
13 = 'Windows cannot verify this device''s resources.'
14 = 'This device cannot work properly until you restart your computer.'
15 = 'This device is not working properly because there is probably a re-enumeration problem.'
16 = 'Windows cannot identify all the resources this device uses.'
17 = 'This device is asking for an unknown resource type.'
18 = 'Reinstall the drivers for this device.'
19 = 'Failure using the VxD loader.'
20 = 'Your registry might be corrupted.'
21 = 'System failure: Try changing the driver for this device. If that does not work, see your hardware documentation. Windows is removing this device.'
22 = 'This device is disabled.'
23 = 'System failure: Try changing the driver for this device. If that doesn''t work, see your hardware documentation.'
24 = 'This device is not present, is not working properly, or does not have all its drivers installed.'
25 = 'Windows is still setting up this device.'
26 = 'Windows is still setting up this device.'
27 = 'This device does not have valid log configuration.'
28 = 'The drivers for this device are not installed.'
29 = 'This device is disabled because the firmware of the device did not give it the required resources.'
30 = 'This device is using an Interrupt Request (IRQ) resource that another device is using.'
31 = 'This device is not working properly because Windows cannot load the drivers required for this device.'
}
#endregion define hashtable
#region define calculated property (to be used with Select-Object)
<#
a calculated property is defined by a hashtable with keys "Name" and "Expression"
"Name" defines the name of the property (in this example, it is "ConfigManagerErrorCode", but you can rename it to anything else)
"Expression" defines a scriptblock that calculates the content of this property
in this example, the scriptblock uses the hashtable defined earlier to translate each numeric
value to its friendly text counterpart:
#>
$ConfigManagerErrorCode = @{
Name = 'ConfigManagerErrorCode'
Expression = {
# property is an array, so process all values
$value = $_.ConfigManagerErrorCode
$ConfigManagerErrorCode_map[[int]$value]
}
}
#endregion define calculated property
# retrieve the instances, and output the properties "Caption" and "ConfigManagerErrorCode". The latter
# is defined by the hashtable in $ConfigManagerErrorCode:
Get-CimInstance -Class Win32_DiskDrive | Select-Object -Property Caption, $ConfigManagerErrorCode
# ...or dump content of property ConfigManagerErrorCode:
$friendlyValues = Get-CimInstance -Class Win32_DiskDrive |
Select-Object -Property $ConfigManagerErrorCode |
Select-Object -ExpandProperty ConfigManagerErrorCode
# output values
$friendlyValues
# output values as comma separated list
$friendlyValues -join ', '
# output values as bullet list
$friendlyValues | ForEach-Object { "- $_" }
Use $ConfigManagerErrorCode_map to directly translate raw values from an instance
<#
this example uses a hashtable to manually translate raw numeric values
for property "Win32_DiskDrive" to friendly text. This approach is ideal when
there is just one instance to work with.
Note: to use other properties than "Win32_DiskDrive", look up the appropriate
translation hashtable for the property you would like to use instead.
#>
#region define hashtable to translate raw values to friendly text
# Please note: this hashtable is specific for property "Win32_DiskDrive"
# to translate other properties, use their translation table instead
$ConfigManagerErrorCode_map = @{
0 = 'This device is working properly.'
1 = 'This device is not configured correctly.'
2 = 'Windows cannot load the driver for this device.'
3 = 'The driver for this device might be corrupted, or your system may be running low on memory or other resources.'
4 = 'This device is not working properly. One of its drivers or your registry might be corrupted.'
5 = 'The driver for this device needs a resource that Windows cannot manage.'
6 = 'The boot configuration for this device conflicts with other devices.'
7 = 'Cannot filter.'
8 = 'The driver loader for the device is missing.'
9 = 'This device is not working properly because the controlling firmware is reporting the resources for the device incorrectly.'
10 = 'This device cannot start.'
11 = 'This device failed.'
12 = 'This device cannot find enough free resources that it can use.'
13 = 'Windows cannot verify this device''s resources.'
14 = 'This device cannot work properly until you restart your computer.'
15 = 'This device is not working properly because there is probably a re-enumeration problem.'
16 = 'Windows cannot identify all the resources this device uses.'
17 = 'This device is asking for an unknown resource type.'
18 = 'Reinstall the drivers for this device.'
19 = 'Failure using the VxD loader.'
20 = 'Your registry might be corrupted.'
21 = 'System failure: Try changing the driver for this device. If that does not work, see your hardware documentation. Windows is removing this device.'
22 = 'This device is disabled.'
23 = 'System failure: Try changing the driver for this device. If that doesn''t work, see your hardware documentation.'
24 = 'This device is not present, is not working properly, or does not have all its drivers installed.'
25 = 'Windows is still setting up this device.'
26 = 'Windows is still setting up this device.'
27 = 'This device does not have valid log configuration.'
28 = 'The drivers for this device are not installed.'
29 = 'This device is disabled because the firmware of the device did not give it the required resources.'
30 = 'This device is using an Interrupt Request (IRQ) resource that another device is using.'
31 = 'This device is not working properly because Windows cannot load the drivers required for this device.'
}
#endregion define hashtable
# get one instance:
$instance = Get-CimInstance -Class Win32_DiskDrive | Select-Object -First 1
<#
IMPORTANT: this example processes only one instance to illustrate
the number-to-text translation. To process all instances, replace
"Select-Object -First 1" with a "Foreach-Object" loop, and use
the iterator variable $_ instead of $instance
#>
# query the property
$rawValue = $instance.ConfigManagerErrorCode
# translate raw value to friendly text:
$friendlyName = $ConfigManagerErrorCode_map[[int]$rawValue]
# output value
$friendlyName
Use a switch statement inside a calculated property for Select-Object
<#
this example uses a switch clause to translate raw numeric
values for property "ConfigManagerErrorCode" to friendly text. The switch
clause is embedded into a calculated property so there is
no need to refer to external variables for translation.
Note: to use other properties than "ConfigManagerErrorCode", look up the appropriate
translation switch clause for the property you would like to use instead.
#>
#region define calculated property (to be used with Select-Object)
<#
a calculated property is defined by a hashtable with keys "Name" and "Expression"
"Name" defines the name of the property (in this example, it is "ConfigManagerErrorCode", but you can rename it to anything else)
"Expression" defines a scriptblock that calculates the content of this property
in this example, the scriptblock uses the hashtable defined earlier to translate each numeric
value to its friendly text counterpart:
#>
$ConfigManagerErrorCode = @{
Name = 'ConfigManagerErrorCode'
Expression = {
# property is an array, so process all values
$value = $_.ConfigManagerErrorCode
switch([int]$value)
{
0 {'This device is working properly.'}
1 {'This device is not configured correctly.'}
2 {'Windows cannot load the driver for this device.'}
3 {'The driver for this device might be corrupted, or your system may be running low on memory or other resources.'}
4 {'This device is not working properly. One of its drivers or your registry might be corrupted.'}
5 {'The driver for this device needs a resource that Windows cannot manage.'}
6 {'The boot configuration for this device conflicts with other devices.'}
7 {'Cannot filter.'}
8 {'The driver loader for the device is missing.'}
9 {'This device is not working properly because the controlling firmware is reporting the resources for the device incorrectly.'}
10 {'This device cannot start.'}
11 {'This device failed.'}
12 {'This device cannot find enough free resources that it can use.'}
13 {'Windows cannot verify this device''s resources.'}
14 {'This device cannot work properly until you restart your computer.'}
15 {'This device is not working properly because there is probably a re-enumeration problem.'}
16 {'Windows cannot identify all the resources this device uses.'}
17 {'This device is asking for an unknown resource type.'}
18 {'Reinstall the drivers for this device.'}
19 {'Failure using the VxD loader.'}
20 {'Your registry might be corrupted.'}
21 {'System failure: Try changing the driver for this device. If that does not work, see your hardware documentation. Windows is removing this device.'}
22 {'This device is disabled.'}
23 {'System failure: Try changing the driver for this device. If that doesn''t work, see your hardware documentation.'}
24 {'This device is not present, is not working properly, or does not have all its drivers installed.'}
25 {'Windows is still setting up this device.'}
26 {'Windows is still setting up this device.'}
27 {'This device does not have valid log configuration.'}
28 {'The drivers for this device are not installed.'}
29 {'This device is disabled because the firmware of the device did not give it the required resources.'}
30 {'This device is using an Interrupt Request (IRQ) resource that another device is using.'}
31 {'This device is not working properly because Windows cannot load the drivers required for this device.'}
default {"$value"}
}
}
}
#endregion define calculated property
# retrieve all instances...
Get-CimInstance -ClassName Win32_DiskDrive |
# ...and output properties "Caption" and "ConfigManagerErrorCode". The latter is defined
# by the hashtable in $ConfigManagerErrorCode:
Select-Object -Property Caption, $ConfigManagerErrorCode
Use the Enum from above to auto-translate the code values
<#
this example translates raw values by means of type conversion
the friendly names are defined as enumeration using the
keyword "enum" (PowerShell 5 or better)
The raw value(s) are translated to friendly text by
simply converting them into the enum type.
Note: to use other properties than "Win32_DiskDrive", look up the appropriate
enum definition for the property you would like to use instead.
#>
#region define enum with value-to-text translation:
Enum EnumConfigManagerErrorCode
{
This_device_is_working_properly = 0
This_device_is_not_configured_correctly = 1
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
This_device_is_not_working_properly_One_of_its_drivers_or_your_registry_might_be_corrupted = 4
The_driver_for_this_device_needs_a_resource_that_Windows_cannot_manage = 5
The_boot_configuration_for_this_device_conflicts_with_other_devices = 6
Cannot_filter = 7
The_driver_loader_for_the_device_is_missing = 8
This_device_is_not_working_properly_because_the_controlling_firmware_is_reporting_the_resources_for_the_device_incorrectly = 9
This_device_cannot_start = 10
This_device_failed = 11
This_device_cannot_find_enough_free_resources_that_it_can_use = 12
Windows_cannot_verify_this_devices_resources = 13
This_device_cannot_work_properly_until_you_restart_your_computer = 14
This_device_is_not_working_properly_because_there_is_probably_a_re_enumeration_problem = 15
Windows_cannot_identify_all_the_resources_this_device_uses = 16
This_device_is_asking_for_an_unknown_resource_type = 17
Reinstall_the_drivers_for_this_device = 18
Failure_using_the_VxD_loader = 19
Your_registry_might_be_corrupted = 20
System_failure_Try_changing_the_driver_for_this_device_If_that_does_not_work_see_your_hardware_documentation_Windows_is_removing_this_device = 21
This_device_is_disabled = 22
System_failure_Try_changing_the_driver_for_this_device_If_that_doesnt_work_see_your_hardware_documentation = 23
This_device_is_not_present_is_not_working_properly_or_does_not_have_all_its_drivers_installed = 24
Windows_is_still_setting_up_this_device1 = 25
Windows_is_still_setting_up_this_device2 = 26
This_device_does_not_have_valid_log_configuration = 27
The_drivers_for_this_device_are_not_installed = 28
This_device_is_disabled_because_the_firmware_of_the_device_did_not_give_it_the_required_resources = 29
This_device_is_using_an_Interrupt_Request_IRQ_resource_that_another_device_is_using = 30
This_device_is_not_working_properly_because_Windows_cannot_load_the_drivers_required_for_this_device = 31
}
#endregion define enum
# get one instance:
$instance = Get-CimInstance -Class Win32_DiskDrive | Select-Object -First 1
<#
IMPORTANT: this example processes only one instance to focus on
the number-to-text type conversion.
To process all instances, replace "Select-Object -First 1"
with a "Foreach-Object" loop, and use the iterator variable
$_ instead of $instance
#>
# query the property:
$rawValue = $instance.ConfigManagerErrorCode
#region using strict type conversion
<#
Note: strict type conversion fails if the raw value is
not defined by the enum. So if the list of allowable values
was extended and the enum does not match the value,
an exception is thrown
#>
# convert the property to the enum **ConfigManagerErrorCode**
[EnumConfigManagerErrorCode]$rawValue
# get a comma-separated string:
[EnumConfigManagerErrorCode]$rawValue -join ','
#endregion
#region using operator "-as"
<#
Note: the operator "-as" accepts values not defined
by the enum and returns $null instead of throwing
an exception
#>
$rawValue -as [EnumConfigManagerErrorCode]
#endregion
Enums must cover all possible values. If ConfigManagerErrorCode returns a value that is not defined in the enum, an exception occurs. The exception reports the value that was missing in the enum. To fix, add the missing value to the enum.
ConfigManagerUserConfig
If True, the device is using a user-defined configuration.
Get-CimInstance -ClassName Win32_DiskDrive | Select-Object -Property DeviceID, ConfigManagerUserConfig
CreationClassName
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.
Get-CimInstance -ClassName Win32_DiskDrive | Select-Object -Property DeviceID, CreationClassName
DefaultBlockSize
Default block size, in bytes, for this device.
For more information about using uint64 values in scripts, see Scripting in WMI.
Get-CimInstance -ClassName Win32_DiskDrive | Select-Object -Property DeviceID, DefaultBlockSize
Description
Description of the object.
Get-CimInstance -ClassName Win32_DiskDrive | Select-Object -Property DeviceID, Description
DeviceID
Unique identifier of the disk drive with other devices on the system.
Get-CimInstance -ClassName Win32_DiskDrive | Select-Object -Property DeviceID
ErrorCleared
If True, the error reported in LastErrorCode is now cleared.
Get-CimInstance -ClassName Win32_DiskDrive | Select-Object -Property DeviceID, ErrorCleared
ErrorDescription
More information about the error recorded in LastErrorCode, and information on any corrective actions that may be taken.
Get-CimInstance -ClassName Win32_DiskDrive | Select-Object -Property DeviceID, ErrorDescription
ErrorMethodology
Type of error detection and correction supported by this device.
Get-CimInstance -ClassName Win32_DiskDrive | Select-Object -Property DeviceID, ErrorMethodology
FirmwareRevision
Revision for the disk drive firmware that is assigned by the manufacturer.
Get-CimInstance -ClassName Win32_DiskDrive | Select-Object -Property DeviceID, FirmwareRevision
Index
Physical drive number of the given drive. This property is filled by the STORAGE_DEVICE_NUMBER structure returned from the IOCTL_STORAGE_GET_DEVICE_NUMBER control code. A value of 0xffffffff indicates that the given drive does not map to a physical drive.
Example: 1
Get-CimInstance -ClassName Win32_DiskDrive | Select-Object -Property DeviceID, Index
InstallDate
Date and time the object was installed. This property does not need a value to indicate that the object is installed.
Get-CimInstance -ClassName Win32_DiskDrive | Select-Object -Property DeviceID, InstallDate
InterfaceType
Interface type of physical disk drive.
The values are:
SCSI
HDC
IDE
USB
1394
Get-CimInstance -ClassName Win32_DiskDrive | Select-Object -Property DeviceID, InterfaceType
LastErrorCode
Last error code reported by the logical device.
Get-CimInstance -ClassName Win32_DiskDrive | Select-Object -Property DeviceID, LastErrorCode
Manufacturer
Name of the disk drive manufacturer.
Example: “Seagate”
Get-CimInstance -ClassName Win32_DiskDrive | Select-Object -Property DeviceID, Manufacturer
MaxBlockSize
Maximum block size, in bytes, for media accessed by this device.
For more information about using uint64 values in scripts, see Scripting in WMI.
Get-CimInstance -ClassName Win32_DiskDrive | Select-Object -Property DeviceID, MaxBlockSize
MaxMediaSize
Maximum media size, in kilobytes, of media supported by this device.
For more information about using uint64 values in scripts, see Scripting in WMI.
Get-CimInstance -ClassName Win32_DiskDrive | Select-Object -Property DeviceID, MaxMediaSize
MediaLoaded
If True, the media for a disk drive is loaded, which means that the device has a readable file system and is accessible. For fixed disk drives, this property will always be TRUE.
Get-CimInstance -ClassName Win32_DiskDrive | Select-Object -Property DeviceID, MediaLoaded
MediaType
Type of media used or accessed by this device.
External hard disk media
Removable media (“Removable media other than floppy”)
Fixed hard disk (“Fixed hard disk media”)
Unknown (“Format is unknown”)
Get-CimInstance -ClassName Win32_DiskDrive | Select-Object -Property DeviceID, MediaType
MinBlockSize
Minimum block size, in bytes, for media accessed by this device.
For more information about using uint64 values in scripts, see Scripting in WMI.
Get-CimInstance -ClassName Win32_DiskDrive | Select-Object -Property DeviceID, MinBlockSize
Model
Manufacturer’s model number of the disk drive.
Example: “ST32171W”
Get-CimInstance -ClassName Win32_DiskDrive | Select-Object -Property DeviceID, Model
Name
Label by which the object is known. When subclassed, the property can be overridden to be a key property.
Get-CimInstance -ClassName Win32_DiskDrive | Select-Object -Property DeviceID, Name
NeedsCleaning
If True, the media access device needs cleaning. Whether manual or automatic cleaning is possible is indicated in the Capabilities property.
Get-CimInstance -ClassName Win32_DiskDrive | Select-Object -Property DeviceID, NeedsCleaning
NumberOfMediaSupported
Maximum number of media which can be supported or inserted (when the media access device supports multiple individual media).
Get-CimInstance -ClassName Win32_DiskDrive | Select-Object -Property DeviceID, NumberOfMediaSupported
Partitions
Number of partitions on this physical disk drive that are recognized by the operating system.
Example: 2
Get-CimInstance -ClassName Win32_DiskDrive | Select-Object -Property DeviceID, Partitions
PNPDeviceID
Windows Plug and Play device identifier of the logical device.
Example: “*PNP030b”
Get-CimInstance -ClassName Win32_DiskDrive | Select-Object -Property DeviceID, PNPDeviceID
PowerManagementCapabilities
Array of the specific power-related capabilities of a logical device.
PowerManagementCapabilities returns a numeric value. To translate it into a meaningful text, use any of the following approaches:
Use a PowerShell Hashtable
$PowerManagementCapabilities_map = @{
0 = 'Unknown'
1 = 'Not Supported'
2 = 'Disabled'
3 = 'Enabled'
4 = 'Power Saving Modes Entered Automatically'
5 = 'Power State Settable'
6 = 'Power Cycling Supported'
7 = 'Timed Power On Supported'
}
Use a switch statement
switch([int]$value)
{
0 {'Unknown'}
1 {'Not Supported'}
2 {'Disabled'}
3 {'Enabled'}
4 {'Power Saving Modes Entered Automatically'}
5 {'Power State Settable'}
6 {'Power Cycling Supported'}
7 {'Timed Power On Supported'}
default {"$value"}
}
Use Enum structure
Enum EnumPowerManagementCapabilities
{
Unknown = 0
Not_Supported = 1
Disabled = 2
Enabled = 3
Power_Saving_Modes_Entered_Automatically = 4
Power_State_Settable = 5
Power_Cycling_Supported = 6
Timed_Power_On_Supported = 7
}
Examples
Use $PowerManagementCapabilities_map in a calculated property for Select-Object
<#
this example uses a hashtable to translate raw numeric values for
property "PowerManagementCapabilities" to friendly text
Note: to use other properties than "PowerManagementCapabilities", look up the appropriate
translation hashtable for the property you would like to use instead.
#>
#region define hashtable to translate raw values to friendly text
# Please note: this hashtable is specific for property "PowerManagementCapabilities"
# to translate other properties, use their translation table instead
$PowerManagementCapabilities_map = @{
0 = 'Unknown'
1 = 'Not Supported'
2 = 'Disabled'
3 = 'Enabled'
4 = 'Power Saving Modes Entered Automatically'
5 = 'Power State Settable'
6 = 'Power Cycling Supported'
7 = 'Timed Power On Supported'
}
#endregion define hashtable
#region define calculated property (to be used with Select-Object)
<#
a calculated property is defined by a hashtable with keys "Name" and "Expression"
"Name" defines the name of the property (in this example, it is "PowerManagementCapabilities", but you can rename it to anything else)
"Expression" defines a scriptblock that calculates the content of this property
in this example, the scriptblock uses the hashtable defined earlier to translate each numeric
value to its friendly text counterpart:
#>
$PowerManagementCapabilities = @{
Name = 'PowerManagementCapabilities'
Expression = {
# property is an array, so process all values
$result = foreach($value in $_.PowerManagementCapabilities)
{
# important: convert original value to [int] because
# hashtable keys are type-aware:
$PowerManagementCapabilities_map[[int]$value]
}
# uncomment to get a comma-separated string instead
# of a string array:
$result <#-join ', '#>
}
}
#endregion define calculated property
# retrieve the instances, and output the properties "Caption" and "PowerManagementCapabilities". The latter
# is defined by the hashtable in $PowerManagementCapabilities:
Get-CimInstance -Class Win32_DiskDrive | Select-Object -Property Caption, $PowerManagementCapabilities
# ...or dump content of property PowerManagementCapabilities:
$friendlyValues = Get-CimInstance -Class Win32_DiskDrive |
Select-Object -Property $PowerManagementCapabilities |
Select-Object -ExpandProperty PowerManagementCapabilities
# output values
$friendlyValues
# output values as comma separated list
$friendlyValues -join ', '
# output values as bullet list
$friendlyValues | ForEach-Object { "- $_" }
Use $PowerManagementCapabilities_map to directly translate raw values from an instance
<#
this example uses a hashtable to manually translate raw numeric values
for property "Win32_DiskDrive" to friendly text. This approach is ideal when there
is just one instance to work with.
Note: to use other properties than "Win32_DiskDrive", look up the appropriate
translation hashtable for the property you would like to use instead.
#>
#region define hashtable to translate raw values to friendly text
# Please note: this hashtable is specific for property "Win32_DiskDrive"
# to translate other properties, use their translation table instead
$PowerManagementCapabilities_map = @{
0 = 'Unknown'
1 = 'Not Supported'
2 = 'Disabled'
3 = 'Enabled'
4 = 'Power Saving Modes Entered Automatically'
5 = 'Power State Settable'
6 = 'Power Cycling Supported'
7 = 'Timed Power On Supported'
}
#endregion define hashtable
# get one instance:
$instance = Get-CimInstance -Class Win32_DiskDrive | Select-Object -First 1
<#
IMPORTANT: this example processes only one instance to illustrate
the number-to-text translation. To process all instances, replace
"Select-Object -First 1" with a "Foreach-Object" loop, and use
the iterator variable $_ instead of $instance
#>
# query the property (hint: the property is an array!)
$rawValues = $instance.PowerManagementCapabilities
# translate all raw values into friendly names:
$friendlyNames = foreach($rawValue in $rawValues)
{ $PowerManagementCapabilities_map[[int]$rawValue] }
# output values
$friendlyValues
# output values as comma separated list
$friendlyValues -join ', '
# output values as bullet list
$friendlyValues | ForEach-Object { "- $_" }
Use a switch statement inside a calculated property for Select-Object
<#
this example uses a switch clause to translate raw numeric
values for property "PowerManagementCapabilities" to friendly text. The switch
clause is embedded into a calculated property so there is
no need to refer to external variables for translation.
Note: to use other properties than "PowerManagementCapabilities", look up the appropriate
translation switch clause for the property you would like to use instead.
#>
#region define calculated property (to be used with Select-Object)
<#
a calculated property is defined by a hashtable with keys "Name" and "Expression"
"Name" defines the name of the property (in this example, it is "PowerManagementCapabilities", but you can rename it to anything else)
"Expression" defines a scriptblock that calculates the content of this property
in this example, the scriptblock uses the hashtable defined earlier to translate each numeric
value to its friendly text counterpart:
#>
$PowerManagementCapabilities = @{
Name = 'PowerManagementCapabilities'
Expression = {
# property is an array, so process all values
$result = foreach($value in $_.PowerManagementCapabilities)
{
switch([int]$value)
{
0 {'Unknown'}
1 {'Not Supported'}
2 {'Disabled'}
3 {'Enabled'}
4 {'Power Saving Modes Entered Automatically'}
5 {'Power State Settable'}
6 {'Power Cycling Supported'}
7 {'Timed Power On Supported'}
default {"$value"}
}
}
$result
}
}
#endregion define calculated property
# retrieve all instances...
Get-CimInstance -ClassName Win32_DiskDrive |
# ...and output properties "Caption" and "PowerManagementCapabilities". The latter is defined
# by the hashtable in $PowerManagementCapabilities:
Select-Object -Property Caption, $PowerManagementCapabilities
Use the Enum from above to auto-translate the code values
<#
this example translates raw values by means of type conversion
the friendly names are defined as enumeration using the
keyword "enum" (PowerShell 5 or better)
The raw value(s) are translated to friendly text by
simply converting them into the enum type.
Note: to use other properties than "Win32_DiskDrive", look up the appropriate
enum definition for the property you would like to use instead.
#>
#region define enum with value-to-text translation:
Enum EnumPowerManagementCapabilities
{
Unknown = 0
Not_Supported = 1
Disabled = 2
Enabled = 3
Power_Saving_Modes_Entered_Automatically = 4
Power_State_Settable = 5
Power_Cycling_Supported = 6
Timed_Power_On_Supported = 7
}
#endregion define enum
# get one instance:
$instance = Get-CimInstance -Class Win32_DiskDrive | Select-Object -First 1
<#
IMPORTANT: this example processes only one instance to focus on
the number-to-text type conversion.
To process all instances, replace "Select-Object -First 1"
with a "Foreach-Object" loop, and use the iterator variable
$_ instead of $instance
#>
# query the property:
$rawValue = $instance.PowerManagementCapabilities
#region using strict type conversion
<#
Note: strict type conversion fails if the raw value is
not defined by the enum. So if the list of allowable values
was extended and the enum does not match the value,
an exception is thrown
#>
# convert the property to the enum **PowerManagementCapabilities**
[EnumPowerManagementCapabilities[]]$rawValue
# get a comma-separated string:
[EnumPowerManagementCapabilities[]]$rawValue -join ','
#endregion
#region using operator "-as"
<#
Note: the operator "-as" accepts values not defined
by the enum and returns $null instead of throwing
an exception
#>
$rawValue -as [EnumPowerManagementCapabilities[]]
#endregion
Enums must cover all possible values. If PowerManagementCapabilities returns a value that is not defined in the enum, an exception occurs. The exception reports the value that was missing in the enum. To fix, add the missing value to the enum.
PowerManagementSupported
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.
Get-CimInstance -ClassName Win32_DiskDrive | Select-Object -Property DeviceID, PowerManagementSupported
SCSIBus
SCSI bus number of the disk drive.
Example: 0
Get-CimInstance -ClassName Win32_DiskDrive | Select-Object -Property DeviceID, SCSIBus
SCSILogicalUnit
SCSI logical unit number (LUN) of the disk drive.
Example: 0
Get-CimInstance -ClassName Win32_DiskDrive | Select-Object -Property DeviceID, SCSILogicalUnit
SCSIPort
SCSI port number of the disk drive.
Example: 0
Get-CimInstance -ClassName Win32_DiskDrive | Select-Object -Property DeviceID, SCSIPort
SCSITargetId
SCSI identifier number of the disk drive.
Example: 0
Get-CimInstance -ClassName Win32_DiskDrive | Select-Object -Property DeviceID, SCSITargetId
SectorsPerTrack
Number of sectors in each track for this physical disk drive.
Example: 63
Get-CimInstance -ClassName Win32_DiskDrive | Select-Object -Property DeviceID, SectorsPerTrack
SerialNumber
Number allocated by the manufacturer to identify the physical media.
Example: WD-WM3493798728
Get-CimInstance -ClassName Win32_DiskDrive | Select-Object -Property DeviceID, SerialNumber
Signature
Disk identification. This property can be used to identify a shared resource.
Get-CimInstance -ClassName Win32_DiskDrive | Select-Object -Property DeviceID, Signature
Size
Size of the disk drive. It is calculated by multiplying the total number of cylinders, tracks in each cylinder, sectors in each track, and bytes in each sector.
For more information about using uint64 values in scripts, see Scripting in WMI.
Get-CimInstance -ClassName Win32_DiskDrive | Select-Object -Property DeviceID, Size
Status
Current status of an object. Various operational and nonoperational statuses can be defined. Available values:
$values = 'Degraded','Error','Lost Comm','No Contact','NonRecover','OK','Pred Fail','Service','Starting','Stopping','Stressed','Unknown'
Get-CimInstance -ClassName Win32_DiskDrive | Select-Object -Property DeviceID, Status
StatusInfo
State of the logical device. If this property does not apply to the logical device, the value 5 (Not Applicable) should be used.
StatusInfo returns a numeric value. To translate it into a meaningful text, use any of the following approaches:
Use a PowerShell Hashtable
$StatusInfo_map = @{
1 = 'Other'
2 = 'Unknown'
3 = 'Enabled'
4 = 'Disabled'
5 = 'Not Applicable'
}
Use a switch statement
switch([int]$value)
{
1 {'Other'}
2 {'Unknown'}
3 {'Enabled'}
4 {'Disabled'}
5 {'Not Applicable'}
default {"$value"}
}
Use Enum structure
Enum EnumStatusInfo
{
Other = 1
Unknown = 2
Enabled = 3
Disabled = 4
Not_Applicable = 5
}
Examples
Use $StatusInfo_map in a calculated property for Select-Object
<#
this example uses a hashtable to translate raw numeric values for
property "StatusInfo" to friendly text
Note: to use other properties than "StatusInfo", look up the appropriate
translation hashtable for the property you would like to use instead.
#>
#region define hashtable to translate raw values to friendly text
# Please note: this hashtable is specific for property "StatusInfo"
# to translate other properties, use their translation table instead
$StatusInfo_map = @{
1 = 'Other'
2 = 'Unknown'
3 = 'Enabled'
4 = 'Disabled'
5 = 'Not Applicable'
}
#endregion define hashtable
#region define calculated property (to be used with Select-Object)
<#
a calculated property is defined by a hashtable with keys "Name" and "Expression"
"Name" defines the name of the property (in this example, it is "StatusInfo", but you can rename it to anything else)
"Expression" defines a scriptblock that calculates the content of this property
in this example, the scriptblock uses the hashtable defined earlier to translate each numeric
value to its friendly text counterpart:
#>
$StatusInfo = @{
Name = 'StatusInfo'
Expression = {
# property is an array, so process all values
$value = $_.StatusInfo
$StatusInfo_map[[int]$value]
}
}
#endregion define calculated property
# retrieve the instances, and output the properties "Caption" and "StatusInfo". The latter
# is defined by the hashtable in $StatusInfo:
Get-CimInstance -Class Win32_DiskDrive | Select-Object -Property Caption, $StatusInfo
# ...or dump content of property StatusInfo:
$friendlyValues = Get-CimInstance -Class Win32_DiskDrive |
Select-Object -Property $StatusInfo |
Select-Object -ExpandProperty StatusInfo
# output values
$friendlyValues
# output values as comma separated list
$friendlyValues -join ', '
# output values as bullet list
$friendlyValues | ForEach-Object { "- $_" }
Use $StatusInfo_map to directly translate raw values from an instance
<#
this example uses a hashtable to manually translate raw numeric values
for property "Win32_DiskDrive" to friendly text. This approach is ideal when
there is just one instance to work with.
Note: to use other properties than "Win32_DiskDrive", look up the appropriate
translation hashtable for the property you would like to use instead.
#>
#region define hashtable to translate raw values to friendly text
# Please note: this hashtable is specific for property "Win32_DiskDrive"
# to translate other properties, use their translation table instead
$StatusInfo_map = @{
1 = 'Other'
2 = 'Unknown'
3 = 'Enabled'
4 = 'Disabled'
5 = 'Not Applicable'
}
#endregion define hashtable
# get one instance:
$instance = Get-CimInstance -Class Win32_DiskDrive | Select-Object -First 1
<#
IMPORTANT: this example processes only one instance to illustrate
the number-to-text translation. To process all instances, replace
"Select-Object -First 1" with a "Foreach-Object" loop, and use
the iterator variable $_ instead of $instance
#>
# query the property
$rawValue = $instance.StatusInfo
# translate raw value to friendly text:
$friendlyName = $StatusInfo_map[[int]$rawValue]
# output value
$friendlyName
Use a switch statement inside a calculated property for Select-Object
<#
this example uses a switch clause to translate raw numeric
values for property "StatusInfo" to friendly text. The switch
clause is embedded into a calculated property so there is
no need to refer to external variables for translation.
Note: to use other properties than "StatusInfo", look up the appropriate
translation switch clause for the property you would like to use instead.
#>
#region define calculated property (to be used with Select-Object)
<#
a calculated property is defined by a hashtable with keys "Name" and "Expression"
"Name" defines the name of the property (in this example, it is "StatusInfo", but you can rename it to anything else)
"Expression" defines a scriptblock that calculates the content of this property
in this example, the scriptblock uses the hashtable defined earlier to translate each numeric
value to its friendly text counterpart:
#>
$StatusInfo = @{
Name = 'StatusInfo'
Expression = {
# property is an array, so process all values
$value = $_.StatusInfo
switch([int]$value)
{
1 {'Other'}
2 {'Unknown'}
3 {'Enabled'}
4 {'Disabled'}
5 {'Not Applicable'}
default {"$value"}
}
}
}
#endregion define calculated property
# retrieve all instances...
Get-CimInstance -ClassName Win32_DiskDrive |
# ...and output properties "Caption" and "StatusInfo". The latter is defined
# by the hashtable in $StatusInfo:
Select-Object -Property Caption, $StatusInfo
Use the Enum from above to auto-translate the code values
<#
this example translates raw values by means of type conversion
the friendly names are defined as enumeration using the
keyword "enum" (PowerShell 5 or better)
The raw value(s) are translated to friendly text by
simply converting them into the enum type.
Note: to use other properties than "Win32_DiskDrive", look up the appropriate
enum definition for the property you would like to use instead.
#>
#region define enum with value-to-text translation:
Enum EnumStatusInfo
{
Other = 1
Unknown = 2
Enabled = 3
Disabled = 4
Not_Applicable = 5
}
#endregion define enum
# get one instance:
$instance = Get-CimInstance -Class Win32_DiskDrive | Select-Object -First 1
<#
IMPORTANT: this example processes only one instance to focus on
the number-to-text type conversion.
To process all instances, replace "Select-Object -First 1"
with a "Foreach-Object" loop, and use the iterator variable
$_ instead of $instance
#>
# query the property:
$rawValue = $instance.StatusInfo
#region using strict type conversion
<#
Note: strict type conversion fails if the raw value is
not defined by the enum. So if the list of allowable values
was extended and the enum does not match the value,
an exception is thrown
#>
# convert the property to the enum **StatusInfo**
[EnumStatusInfo]$rawValue
# get a comma-separated string:
[EnumStatusInfo]$rawValue -join ','
#endregion
#region using operator "-as"
<#
Note: the operator "-as" accepts values not defined
by the enum and returns $null instead of throwing
an exception
#>
$rawValue -as [EnumStatusInfo]
#endregion
Enums must cover all possible values. If StatusInfo returns a value that is not defined in the enum, an exception occurs. The exception reports the value that was missing in the enum. To fix, add the missing value to the enum.
SystemCreationClassName
Value of the scoping computer’s CreationClassName property.
Get-CimInstance -ClassName Win32_DiskDrive | Select-Object -Property DeviceID, SystemCreationClassName
SystemName
Name of the scoping system.
Get-CimInstance -ClassName Win32_DiskDrive | Select-Object -Property DeviceID, SystemName
TotalCylinders
Total number of cylinders on the physical disk drive. Note: the value for this property is obtained through extended functions of BIOS interrupt 13h. The value may be inaccurate if the drive uses a translation scheme to support high-capacity disk sizes. Consult the manufacturer for accurate drive specifications.
Example: 657
For more information about using uint64 values in scripts, see Scripting in WMI.
Get-CimInstance -ClassName Win32_DiskDrive | Select-Object -Property DeviceID, TotalCylinders
TotalHeads
Total number of heads on the disk drive. Note: the value for this property is obtained through extended functions of BIOS interrupt 13h. The value may be inaccurate if the drive uses a translation scheme to support high-capacity disk sizes. Consult the manufacturer for accurate drive specifications.
Get-CimInstance -ClassName Win32_DiskDrive | Select-Object -Property DeviceID, TotalHeads
TotalSectors
Total number of sectors on the physical disk drive. Note: the value for this property is obtained through extended functions of BIOS interrupt 13h. The value may be inaccurate if the drive uses a translation scheme to support high-capacity disk sizes. Consult the manufacturer for accurate drive specifications.
Example: 2649024
For more information about using uint64 values in scripts, see Scripting in WMI.
Get-CimInstance -ClassName Win32_DiskDrive | Select-Object -Property DeviceID, TotalSectors
TotalTracks
Total number of tracks on the physical disk drive. Note: the value for this property is obtained through extended functions of BIOS interrupt 13h. The value may be inaccurate if the drive uses a translation scheme to support high-capacity disk sizes. Consult the manufacturer for accurate drive specifications.
Example: 42048
For more information about using uint64 values in scripts, see Scripting in WMI.
Get-CimInstance -ClassName Win32_DiskDrive | Select-Object -Property DeviceID, TotalTracks
TracksPerCylinder
Number of tracks in each cylinder on the physical disk drive. Note: the value for this property is obtained through extended functions of BIOS interrupt 13h. The value may be inaccurate if the drive uses a translation scheme to support high-capacity disk sizes. Consult the manufacturer for accurate drive specifications.
Example: 64
Get-CimInstance -ClassName Win32_DiskDrive | Select-Object -Property DeviceID, TracksPerCylinder
Examples
List all instances of Win32_DiskDrive
Get-CimInstance -ClassName Win32_DiskDrive
Learn more about Get-CimInstance
and the deprecated Get-WmiObject
.
View all properties
Get-CimInstance -ClassName Win32_DiskDrive -Property *
View key properties only
Get-CimInstance -ClassName Win32_DiskDrive -KeyOnly
Selecting Properties
To select only some properties, pipe the results to Select-Object -Property a,b,c
with a comma-separated list of the properties you require. Wildcards are permitted.
Get-CimInstance
always returns all properties but only retrieves the ones that you specify. All other properties are empty but still present. That’s why you need to pipe the results into Select-Object
if you want to limit the visible properties, i.e. for reporting.
Selecting Properties
The code below lists all available properties. Remove the ones you do not need:
$properties = 'Availability',
'BytesPerSector',
'Capabilities',
'CapabilityDescriptions',
'Caption',
'CompressionMethod',
'ConfigManagerErrorCode',
'ConfigManagerUserConfig',
'CreationClassName',
'DefaultBlockSize',
'Description',
'DeviceID',
'ErrorCleared',
'ErrorDescription',
'ErrorMethodology',
'FirmwareRevision',
'Index',
'InstallDate',
'InterfaceType',
'LastErrorCode',
'Manufacturer',
'MaxBlockSize',
'MaxMediaSize',
'MediaLoaded',
'MediaType',
'MinBlockSize',
'Model',
'Name',
'NeedsCleaning',
'NumberOfMediaSupported',
'Partitions',
'PNPDeviceID',
'PowerManagementCapabilities',
'PowerManagementSupported',
'SCSIBus',
'SCSILogicalUnit',
'SCSIPort',
'SCSITargetId',
'SectorsPerTrack',
'SerialNumber',
'Signature',
'Size',
'Status',
'StatusInfo',
'SystemCreationClassName',
'SystemName',
'TotalCylinders',
'TotalHeads',
'TotalSectors',
'TotalTracks',
'TracksPerCylinder'
Get-CimInstance -ClassName Win32_DiskDrive | Select-Object -Property $properties
Limiting Network Bandwidth
If you work remotely, it makes sense to limit network bandwidth by filtering the properties on the server side, too:
Get-CimInstance -Class Win32_DiskDrive -Property $property |
Select-Object -Property $property
Selecting Instances
To select some instances, use Get-CimInstance and a WMI Query. The wildcard character in WMI Queries is % (and not “*”).
The parameter -Filter runs a simple query.
Listing all instances where the property Caption starts with “A”
Get-CimInstance -Class Win32_DiskDrive -Filter 'Caption LIKE "a%"'
Using a WQL Query
The parameter -Query uses a query similar to SQL and combines the parameters -Filter and -Property. This returns all instances where the property Caption starts with “A”, and returns the properties specified:
Get-CimInstance -Query "SELECT Status, BytesPerSector, Signature, ErrorMethodology FROM Win32_DiskDrive WHERE Caption LIKE 'a%'"
Any property you did not specify is still present but empty. You might need to use
Select-Object
to remove all unwanted properties:Get-CimInstance -Query "SELECT Status, BytesPerSector, Signature, ErrorMethodology FROM Win32_DiskDrive WHERE Caption LIKE 'a%'" | Select-Object -Property Status, BytesPerSector, Signature, ErrorMethodology
Accessing Remote Computers
To access remote systems, you need to have proper permissions. User the parameter -ComputerName to access one or more remote systems.
Authenticating as Current User
# one or more computer names or IP addresses:
$list = 'server1', 'server2'
# authenticate with your current identity:
$result = Get-CimInstance -ClassName Win32_DiskDrive -ComputerName $list
$result
Authenticating as Different User
Use a CIMSession object to authenticate with a new identity:
# one or more computer names or IP addresses:
$list = 'server1', 'server2'
# authenticate with a different identity:
$cred = Get-Credential -Message 'Authenticate to retrieve WMI information:'
$session = New-CimSession -ComputerName $list -Credential $cred
$result = Get-CimInstance Win32_DiskDrive -CimSession $session
# remove the session after use (if you do not plan to re-use it later)
Remove-CimSession -CimSession $session
$result
Learn more about accessing remote computers.
Requirements
To use Win32_DiskDrive, the following requirements apply:
PowerShell
Get-CimInstance
was introduced with PowerShell Version 3.0, which in turn was introduced on clients with Windows 8 and on servers with Windows Server 2012.
If necessary, update Windows PowerShell to Windows PowerShell 5.1, or install PowerShell 7 side-by-side.
Operating System
Win32_DiskDrive was introduced on clients with Windows Vista and on servers with Windows Server 2008.
Namespace
Win32_DiskDrive lives in the Namespace Root/CIMV2. This is the default namespace. There is no need to use the -Namespace parameter in Get-CimInstance
.
Implementation
Win32_DiskDrive is implemented in CIMWin32.dll and defined in CIMWin32.mof. Both files are located in the folder C:\Windows\system32\wbem
:
explorer $env:windir\system32\wbem
notepad $env:windir\system32\wbem\CIMWin32.mof