The Win32_SerialPort WMI class represents a serial port on a computer system running Windows.
Methods
Win32_SerialPort has no methods. Inherited methods (Reset and SetPowerState) are not implemented.
Properties
Win32_SerialPort returns 47 properties:
'Availability','Binary','Capabilities','CapabilityDescriptions','Caption',
'ConfigManagerErrorCode','ConfigManagerUserConfig','CreationClassName','Description','DeviceID',
'ErrorCleared','ErrorDescription','InstallDate','LastErrorCode','MaxBaudRate',
'MaximumInputBufferSize','MaximumOutputBufferSize','MaxNumberControlled','Name','OSAutoDiscovered',
'PNPDeviceID','PowerManagementCapabilities','PowerManagementSupported','ProtocolSupported',
'ProviderType','SettableBaudRate','SettableDataBits','SettableFlowControl','SettableParity',
'SettableParityCheck','SettableRLSD','SettableStopBits','Status','StatusInfo','Supports16BitMode',
'SupportsDTRDSR','SupportsElapsedTimeouts','SupportsIntTimeouts','SupportsParityCheck',
'SupportsRLSD','SupportsRTSCTS','SupportsSpecialCharacters','SupportsXOnXOff','SupportsXOnXOffSet',
'SystemCreationClassName','SystemName','TimeOfLastReset'
Unless explicitly marked as writeable, all properties are read-only. Read all properties for all instances:
Get-CimInstance -ClassName Win32_SerialPort -Property *
Most WMI classes return one or more instances.
When
Get-CimInstancereturns no result, then apparently no instances of class Win32_SerialPort 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_SerialPort | Select-Object -Property Caption, $Availability
# ...or dump content of property Availability:
$friendlyValues = Get-CimInstance -Class Win32_SerialPort |
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_SerialPort" to friendly text. This approach is ideal when
there is just one instance to work with.
Note: to use other properties than "Win32_SerialPort", 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_SerialPort"
# 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_SerialPort | 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_SerialPort |
# ...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_SerialPort", 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_SerialPort | 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.
Binary
If TRUE, the serial port is configured for binary data transfer. Because the Windows API does not support nonbinary mode transfers, this property must be TRUE.
Get-CimInstance -ClassName Win32_SerialPort | Select-Object -Property DeviceID, Binary
Capabilities
Array of chip-level compatibility for the serial controller. This property describes the buffering and other capabilities of the serial controller that may be inherent in the chip hardware. The property is an enumerated integer.
Capabilities returns a numeric value. To translate it into a meaningful text, use any of the following approaches:
Use a PowerShell Hashtable
$Capabilities_map = @{
1 = 'Other'
2 = 'Unknown'
3 = 'XT/AT Compatible'
4 = '16450 Compatible'
5 = '16550 Compatible'
6 = '16550A Compatible'
160 = '8251 Compatible'
161 = '8251FIFO Compatible'
}
Use a switch statement
switch([int]$value)
{
1 {'Other'}
2 {'Unknown'}
3 {'XT/AT Compatible'}
4 {'16450 Compatible'}
5 {'16550 Compatible'}
6 {'16550A Compatible'}
160 {'8251 Compatible'}
161 {'8251FIFO Compatible'}
default {"$value"}
}
Use Enum structure
Enum EnumCapabilities
{
Other = 1
Unknown = 2
XTAT_Compatible = 3
_16450_Compatible = 4
_16550_Compatible = 5
_16550A_Compatible = 6
_8251_Compatible = 160
_8251FIFO_Compatible = 161
}
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 = @{
1 = 'Other'
2 = 'Unknown'
3 = 'XT/AT Compatible'
4 = '16450 Compatible'
5 = '16550 Compatible'
6 = '16550A Compatible'
160 = '8251 Compatible'
161 = '8251FIFO Compatible'
}
#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_SerialPort | Select-Object -Property Caption, $Capabilities
# ...or dump content of property Capabilities:
$friendlyValues = Get-CimInstance -Class Win32_SerialPort |
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_SerialPort" to friendly text. This approach is ideal when there
is just one instance to work with.
Note: to use other properties than "Win32_SerialPort", 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_SerialPort"
# to translate other properties, use their translation table instead
$Capabilities_map = @{
1 = 'Other'
2 = 'Unknown'
3 = 'XT/AT Compatible'
4 = '16450 Compatible'
5 = '16550 Compatible'
6 = '16550A Compatible'
160 = '8251 Compatible'
161 = '8251FIFO Compatible'
}
#endregion define hashtable
# get one instance:
$instance = Get-CimInstance -Class Win32_SerialPort | 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)
{
1 {'Other'}
2 {'Unknown'}
3 {'XT/AT Compatible'}
4 {'16450 Compatible'}
5 {'16550 Compatible'}
6 {'16550A Compatible'}
160 {'8251 Compatible'}
161 {'8251FIFO Compatible'}
default {"$value"}
}
}
$result
}
}
#endregion define calculated property
# retrieve all instances...
Get-CimInstance -ClassName Win32_SerialPort |
# ...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_SerialPort", 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
{
Other = 1
Unknown = 2
XTAT_Compatible = 3
_16450_Compatible = 4
_16550_Compatible = 5
_16550A_Compatible = 6
_8251_Compatible = 160
_8251FIFO_Compatible = 161
}
#endregion define enum
# get one instance:
$instance = Get-CimInstance -Class Win32_SerialPort | 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
Array of free-form strings providing more detailed explanations for any of the serial controller 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_SerialPort | Select-Object -Property DeviceID, CapabilityDescriptions
Caption
Short description of the object.
Get-CimInstance -ClassName Win32_SerialPort | Select-Object -Property DeviceID, Caption
ConfigManagerErrorCode
Win32 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_SerialPort | Select-Object -Property Caption, $ConfigManagerErrorCode
# ...or dump content of property ConfigManagerErrorCode:
$friendlyValues = Get-CimInstance -Class Win32_SerialPort |
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_SerialPort" to friendly text. This approach is ideal when
there is just one instance to work with.
Note: to use other properties than "Win32_SerialPort", 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_SerialPort"
# 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_SerialPort | 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_SerialPort |
# ...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_SerialPort", 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_SerialPort | 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_SerialPort | 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_SerialPort | Select-Object -Property DeviceID, CreationClassName
Description
Description of the object.
Get-CimInstance -ClassName Win32_SerialPort | Select-Object -Property DeviceID, Description
DeviceID
Unique identifier of the serial port with other devices on the system.
Get-CimInstance -ClassName Win32_SerialPort | Select-Object -Property DeviceID
ErrorCleared
If TRUE, the error reported in LastErrorCode is now cleared.
Get-CimInstance -ClassName Win32_SerialPort | Select-Object -Property DeviceID, ErrorCleared
ErrorDescription
Free-form string supplying more information about the error recorded in LastErrorCode, and information about any corrective actions that may be taken.
Get-CimInstance -ClassName Win32_SerialPort | Select-Object -Property DeviceID, ErrorDescription
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_SerialPort | Select-Object -Property DeviceID, InstallDate
LastErrorCode
Last error code reported by the logical device.
Get-CimInstance -ClassName Win32_SerialPort | Select-Object -Property DeviceID, LastErrorCode
MaxBaudRate
Maximum baud rate (in bits per second) supported by the serial controller.
Get-CimInstance -ClassName Win32_SerialPort | Select-Object -Property DeviceID, MaxBaudRate
MaximumInputBufferSize
Maximum size of the serial port driver’s internal input buffer. A value of 0 (zero) indicates that no maximum value is imposed by the serial provider.
Get-CimInstance -ClassName Win32_SerialPort | Select-Object -Property DeviceID, MaximumInputBufferSize
MaximumOutputBufferSize
Maximum size of the serial port driver’s internal output buffer. A value of 0 (zero) indicates that no maximum value is imposed by the serial provider.
Get-CimInstance -ClassName Win32_SerialPort | Select-Object -Property DeviceID, MaximumOutputBufferSize
MaxNumberControlled
Maximum number of directly addressable entities supportable by this controller. A value of 0 (zero) should be used if the number is unknown.
Get-CimInstance -ClassName Win32_SerialPort | Select-Object -Property DeviceID, MaxNumberControlled
Name
Label by which the object is known. When subclassed, the property can be overridden to be a key property.
Get-CimInstance -ClassName Win32_SerialPort | Select-Object -Property DeviceID, Name
OSAutoDiscovered
If TRUE, the instances of this class were automatically discovered by the operating system. If, for example, hardware was added through Control Panel, the operating system finds instances of this class by querying hardware from the instances of this class.
Get-CimInstance -ClassName Win32_SerialPort | Select-Object -Property DeviceID, OSAutoDiscovered
PNPDeviceID
Windows Plug and Play device identifier of the logical device.
Example: “*PNP030b”
Get-CimInstance -ClassName Win32_SerialPort | 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_SerialPort | Select-Object -Property Caption, $PowerManagementCapabilities
# ...or dump content of property PowerManagementCapabilities:
$friendlyValues = Get-CimInstance -Class Win32_SerialPort |
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_SerialPort" to friendly text. This approach is ideal when there
is just one instance to work with.
Note: to use other properties than "Win32_SerialPort", 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_SerialPort"
# 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_SerialPort | 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_SerialPort |
# ...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_SerialPort", 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_SerialPort | 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_SerialPort | Select-Object -Property DeviceID, PowerManagementSupported
ProtocolSupported
Protocol used by the controller to access “controlled” devices.
ProtocolSupported returns a numeric value. To translate it into a meaningful text, use any of the following approaches:
Use a PowerShell Hashtable
$ProtocolSupported_map = @{
1 = 'Other'
2 = 'Unknown'
3 = 'EISA'
4 = 'ISA'
5 = 'PCI'
6 = 'ATA/ATAPI'
7 = 'Flexible Diskette'
8 = '1496'
9 = 'SCSI Parallel Interface'
10 = 'SCSI Fibre Channel Protocol'
11 = 'SCSI Serial Bus Protocol'
1394 = 'SCSI Serial Bus Protocol-2'
13 = 'SCSI Serial Storage Architecture'
14 = 'VESA'
15 = 'PCMCIA'
16 = 'Universal Serial Bus'
17 = 'Parallel Protocol'
18 = 'ESCON'
19 = 'Diagnostic'
20 = 'I2C'
21 = 'Power'
22 = 'HIPPI'
23 = 'MultiBus'
24 = 'VME'
25 = 'IPI'
26 = 'IEEE-488'
27 = 'RS232'
28 = 'IEEE 802.3 10BASE5'
29 = 'IEEE 802.3 10BASE2'
30 = 'IEEE 802.3 1BASE5'
31 = 'IEEE 802.3 10BROAD36'
32 = 'IEEE 802.3 100BASEVG'
33 = 'IEEE 802.5 Token-Ring'
34 = 'ANSI X3T9.5 FDDI'
35 = 'MCA'
36 = 'ESDI'
37 = 'IDE'
38 = 'CMD'
39 = 'ST506'
40 = 'DSSI'
41 = 'QIC2'
42 = 'Enhanced ATA/IDE'
43 = 'AGP'
44 = 'TWIRP (two-way infrared)'
45 = 'FIR (fast infrared)'
46 = 'SIR (serial infrared)'
47 = 'IrBus'
}
Use a switch statement
switch([int]$value)
{
1 {'Other'}
2 {'Unknown'}
3 {'EISA'}
4 {'ISA'}
5 {'PCI'}
6 {'ATA/ATAPI'}
7 {'Flexible Diskette'}
8 {'1496'}
9 {'SCSI Parallel Interface'}
10 {'SCSI Fibre Channel Protocol'}
11 {'SCSI Serial Bus Protocol'}
1394 {'SCSI Serial Bus Protocol-2'}
13 {'SCSI Serial Storage Architecture'}
14 {'VESA'}
15 {'PCMCIA'}
16 {'Universal Serial Bus'}
17 {'Parallel Protocol'}
18 {'ESCON'}
19 {'Diagnostic'}
20 {'I2C'}
21 {'Power'}
22 {'HIPPI'}
23 {'MultiBus'}
24 {'VME'}
25 {'IPI'}
26 {'IEEE-488'}
27 {'RS232'}
28 {'IEEE 802.3 10BASE5'}
29 {'IEEE 802.3 10BASE2'}
30 {'IEEE 802.3 1BASE5'}
31 {'IEEE 802.3 10BROAD36'}
32 {'IEEE 802.3 100BASEVG'}
33 {'IEEE 802.5 Token-Ring'}
34 {'ANSI X3T9.5 FDDI'}
35 {'MCA'}
36 {'ESDI'}
37 {'IDE'}
38 {'CMD'}
39 {'ST506'}
40 {'DSSI'}
41 {'QIC2'}
42 {'Enhanced ATA/IDE'}
43 {'AGP'}
44 {'TWIRP (two-way infrared)'}
45 {'FIR (fast infrared)'}
46 {'SIR (serial infrared)'}
47 {'IrBus'}
default {"$value"}
}
Use Enum structure
Enum EnumProtocolSupported
{
Other = 1
Unknown = 2
EISA = 3
ISA = 4
PCI = 5
ATAATAPI = 6
Flexible_Diskette = 7
_1496 = 8
SCSI_Parallel_Interface = 9
SCSI_Fibre_Channel_Protocol = 10
SCSI_Serial_Bus_Protocol = 11
SCSI_Serial_Bus_Protocol_2 = 1394
SCSI_Serial_Storage_Architecture = 13
VESA = 14
PCMCIA = 15
Universal_Serial_Bus = 16
Parallel_Protocol = 17
ESCON = 18
Diagnostic = 19
I2C = 20
Power = 21
HIPPI = 22
MultiBus = 23
VME = 24
IPI = 25
IEEE_488 = 26
RS232 = 27
IEEE_8023_10BASE5 = 28
IEEE_8023_10BASE2 = 29
IEEE_8023_1BASE5 = 30
IEEE_8023_10BROAD36 = 31
IEEE_8023_100BASEVG = 32
IEEE_8025_Token_Ring = 33
ANSI_X3T95_FDDI = 34
MCA = 35
ESDI = 36
IDE = 37
CMD = 38
ST506 = 39
DSSI = 40
QIC2 = 41
Enhanced_ATAIDE = 42
AGP = 43
TWIRP_two_way_infrared = 44
FIR_fast_infrared = 45
SIR_serial_infrared = 46
IrBus = 47
}
Examples
Use $ProtocolSupported_map in a calculated property for Select-Object
<#
this example uses a hashtable to translate raw numeric values for
property "ProtocolSupported" to friendly text
Note: to use other properties than "ProtocolSupported", 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 "ProtocolSupported"
# to translate other properties, use their translation table instead
$ProtocolSupported_map = @{
1 = 'Other'
2 = 'Unknown'
3 = 'EISA'
4 = 'ISA'
5 = 'PCI'
6 = 'ATA/ATAPI'
7 = 'Flexible Diskette'
8 = '1496'
9 = 'SCSI Parallel Interface'
10 = 'SCSI Fibre Channel Protocol'
11 = 'SCSI Serial Bus Protocol'
1394 = 'SCSI Serial Bus Protocol-2'
13 = 'SCSI Serial Storage Architecture'
14 = 'VESA'
15 = 'PCMCIA'
16 = 'Universal Serial Bus'
17 = 'Parallel Protocol'
18 = 'ESCON'
19 = 'Diagnostic'
20 = 'I2C'
21 = 'Power'
22 = 'HIPPI'
23 = 'MultiBus'
24 = 'VME'
25 = 'IPI'
26 = 'IEEE-488'
27 = 'RS232'
28 = 'IEEE 802.3 10BASE5'
29 = 'IEEE 802.3 10BASE2'
30 = 'IEEE 802.3 1BASE5'
31 = 'IEEE 802.3 10BROAD36'
32 = 'IEEE 802.3 100BASEVG'
33 = 'IEEE 802.5 Token-Ring'
34 = 'ANSI X3T9.5 FDDI'
35 = 'MCA'
36 = 'ESDI'
37 = 'IDE'
38 = 'CMD'
39 = 'ST506'
40 = 'DSSI'
41 = 'QIC2'
42 = 'Enhanced ATA/IDE'
43 = 'AGP'
44 = 'TWIRP (two-way infrared)'
45 = 'FIR (fast infrared)'
46 = 'SIR (serial infrared)'
47 = 'IrBus'
}
#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 "ProtocolSupported", 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:
#>
$ProtocolSupported = @{
Name = 'ProtocolSupported'
Expression = {
# property is an array, so process all values
$value = $_.ProtocolSupported
$ProtocolSupported_map[[int]$value]
}
}
#endregion define calculated property
# retrieve the instances, and output the properties "Caption" and "ProtocolSupported". The latter
# is defined by the hashtable in $ProtocolSupported:
Get-CimInstance -Class Win32_SerialPort | Select-Object -Property Caption, $ProtocolSupported
# ...or dump content of property ProtocolSupported:
$friendlyValues = Get-CimInstance -Class Win32_SerialPort |
Select-Object -Property $ProtocolSupported |
Select-Object -ExpandProperty ProtocolSupported
# output values
$friendlyValues
# output values as comma separated list
$friendlyValues -join ', '
# output values as bullet list
$friendlyValues | ForEach-Object { "- $_" }
Use $ProtocolSupported_map to directly translate raw values from an instance
<#
this example uses a hashtable to manually translate raw numeric values
for property "Win32_SerialPort" to friendly text. This approach is ideal when
there is just one instance to work with.
Note: to use other properties than "Win32_SerialPort", 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_SerialPort"
# to translate other properties, use their translation table instead
$ProtocolSupported_map = @{
1 = 'Other'
2 = 'Unknown'
3 = 'EISA'
4 = 'ISA'
5 = 'PCI'
6 = 'ATA/ATAPI'
7 = 'Flexible Diskette'
8 = '1496'
9 = 'SCSI Parallel Interface'
10 = 'SCSI Fibre Channel Protocol'
11 = 'SCSI Serial Bus Protocol'
1394 = 'SCSI Serial Bus Protocol-2'
13 = 'SCSI Serial Storage Architecture'
14 = 'VESA'
15 = 'PCMCIA'
16 = 'Universal Serial Bus'
17 = 'Parallel Protocol'
18 = 'ESCON'
19 = 'Diagnostic'
20 = 'I2C'
21 = 'Power'
22 = 'HIPPI'
23 = 'MultiBus'
24 = 'VME'
25 = 'IPI'
26 = 'IEEE-488'
27 = 'RS232'
28 = 'IEEE 802.3 10BASE5'
29 = 'IEEE 802.3 10BASE2'
30 = 'IEEE 802.3 1BASE5'
31 = 'IEEE 802.3 10BROAD36'
32 = 'IEEE 802.3 100BASEVG'
33 = 'IEEE 802.5 Token-Ring'
34 = 'ANSI X3T9.5 FDDI'
35 = 'MCA'
36 = 'ESDI'
37 = 'IDE'
38 = 'CMD'
39 = 'ST506'
40 = 'DSSI'
41 = 'QIC2'
42 = 'Enhanced ATA/IDE'
43 = 'AGP'
44 = 'TWIRP (two-way infrared)'
45 = 'FIR (fast infrared)'
46 = 'SIR (serial infrared)'
47 = 'IrBus'
}
#endregion define hashtable
# get one instance:
$instance = Get-CimInstance -Class Win32_SerialPort | 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.ProtocolSupported
# translate raw value to friendly text:
$friendlyName = $ProtocolSupported_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 "ProtocolSupported" 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 "ProtocolSupported", 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 "ProtocolSupported", 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:
#>
$ProtocolSupported = @{
Name = 'ProtocolSupported'
Expression = {
# property is an array, so process all values
$value = $_.ProtocolSupported
switch([int]$value)
{
1 {'Other'}
2 {'Unknown'}
3 {'EISA'}
4 {'ISA'}
5 {'PCI'}
6 {'ATA/ATAPI'}
7 {'Flexible Diskette'}
8 {'1496'}
9 {'SCSI Parallel Interface'}
10 {'SCSI Fibre Channel Protocol'}
11 {'SCSI Serial Bus Protocol'}
1394 {'SCSI Serial Bus Protocol-2'}
13 {'SCSI Serial Storage Architecture'}
14 {'VESA'}
15 {'PCMCIA'}
16 {'Universal Serial Bus'}
17 {'Parallel Protocol'}
18 {'ESCON'}
19 {'Diagnostic'}
20 {'I2C'}
21 {'Power'}
22 {'HIPPI'}
23 {'MultiBus'}
24 {'VME'}
25 {'IPI'}
26 {'IEEE-488'}
27 {'RS232'}
28 {'IEEE 802.3 10BASE5'}
29 {'IEEE 802.3 10BASE2'}
30 {'IEEE 802.3 1BASE5'}
31 {'IEEE 802.3 10BROAD36'}
32 {'IEEE 802.3 100BASEVG'}
33 {'IEEE 802.5 Token-Ring'}
34 {'ANSI X3T9.5 FDDI'}
35 {'MCA'}
36 {'ESDI'}
37 {'IDE'}
38 {'CMD'}
39 {'ST506'}
40 {'DSSI'}
41 {'QIC2'}
42 {'Enhanced ATA/IDE'}
43 {'AGP'}
44 {'TWIRP (two-way infrared)'}
45 {'FIR (fast infrared)'}
46 {'SIR (serial infrared)'}
47 {'IrBus'}
default {"$value"}
}
}
}
#endregion define calculated property
# retrieve all instances...
Get-CimInstance -ClassName Win32_SerialPort |
# ...and output properties "Caption" and "ProtocolSupported". The latter is defined
# by the hashtable in $ProtocolSupported:
Select-Object -Property Caption, $ProtocolSupported
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_SerialPort", look up the appropriate
enum definition for the property you would like to use instead.
#>
#region define enum with value-to-text translation:
Enum EnumProtocolSupported
{
Other = 1
Unknown = 2
EISA = 3
ISA = 4
PCI = 5
ATAATAPI = 6
Flexible_Diskette = 7
_1496 = 8
SCSI_Parallel_Interface = 9
SCSI_Fibre_Channel_Protocol = 10
SCSI_Serial_Bus_Protocol = 11
SCSI_Serial_Bus_Protocol_2 = 1394
SCSI_Serial_Storage_Architecture = 13
VESA = 14
PCMCIA = 15
Universal_Serial_Bus = 16
Parallel_Protocol = 17
ESCON = 18
Diagnostic = 19
I2C = 20
Power = 21
HIPPI = 22
MultiBus = 23
VME = 24
IPI = 25
IEEE_488 = 26
RS232 = 27
IEEE_8023_10BASE5 = 28
IEEE_8023_10BASE2 = 29
IEEE_8023_1BASE5 = 30
IEEE_8023_10BROAD36 = 31
IEEE_8023_100BASEVG = 32
IEEE_8025_Token_Ring = 33
ANSI_X3T95_FDDI = 34
MCA = 35
ESDI = 36
IDE = 37
CMD = 38
ST506 = 39
DSSI = 40
QIC2 = 41
Enhanced_ATAIDE = 42
AGP = 43
TWIRP_two_way_infrared = 44
FIR_fast_infrared = 45
SIR_serial_infrared = 46
IrBus = 47
}
#endregion define enum
# get one instance:
$instance = Get-CimInstance -Class Win32_SerialPort | 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.ProtocolSupported
#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 **ProtocolSupported**
[EnumProtocolSupported]$rawValue
# get a comma-separated string:
[EnumProtocolSupported]$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 [EnumProtocolSupported]
#endregion
Enums must cover all possible values. If ProtocolSupported 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.
ProviderType
Communications provider type.
The values are:
FAX Device (“FAX Device”)
LAT Protocol (“LAT Protocol”)
Modem Device (“Modem Device”)
Network Bridge (“Network Bridge”)
Parallel Port (“Parallel Port”)
RS232 Serial Port (“RS232 Serial Port”)
RS422 Port (“RS422 Port”)
RS423 Port (“RS423 Port”)
RS449 Port (“RS449 Port”)
Scanner Device (“Scanner Device”)
TCP/IP TelNet (“TCP/IP TelNet”)
X.25 (“X.25”)
Unspecified (“Unspecified”)
Get-CimInstance -ClassName Win32_SerialPort | Select-Object -Property DeviceID, ProviderType
SettableBaudRate
If TRUE, the baud rate can be changed for this serial port.
Get-CimInstance -ClassName Win32_SerialPort | Select-Object -Property DeviceID, SettableBaudRate
SettableDataBits
If TRUE, data bits can be set for this serial port.
Get-CimInstance -ClassName Win32_SerialPort | Select-Object -Property DeviceID, SettableDataBits
SettableFlowControl
If TRUE, flow control can be set for this serial port.
Get-CimInstance -ClassName Win32_SerialPort | Select-Object -Property DeviceID, SettableFlowControl
SettableParity
If TRUE, parity can be set for this serial port.
Get-CimInstance -ClassName Win32_SerialPort | Select-Object -Property DeviceID, SettableParity
SettableParityCheck
If TRUE, parity checking can be set for this serial port (if parity checking is supported).
Get-CimInstance -ClassName Win32_SerialPort | Select-Object -Property DeviceID, SettableParityCheck
SettableRLSD
If TRUE, Received Line Signal Detect (RLSD) can be set for this serial port (if RLSD is supported).
Get-CimInstance -ClassName Win32_SerialPort | Select-Object -Property DeviceID, SettableRLSD
SettableStopBits
If TRUE, stop bits can be set for this serial port.
Get-CimInstance -ClassName Win32_SerialPort | Select-Object -Property DeviceID, SettableStopBits
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_SerialPort | 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_SerialPort | Select-Object -Property Caption, $StatusInfo
# ...or dump content of property StatusInfo:
$friendlyValues = Get-CimInstance -Class Win32_SerialPort |
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_SerialPort" to friendly text. This approach is ideal when
there is just one instance to work with.
Note: to use other properties than "Win32_SerialPort", 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_SerialPort"
# 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_SerialPort | 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_SerialPort |
# ...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_SerialPort", 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_SerialPort | 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.
Supports16BitMode
If TRUE, 16-bit mode is supported on this serial port.
Get-CimInstance -ClassName Win32_SerialPort | Select-Object -Property DeviceID, Supports16BitMode
SupportsDTRDSR
If TRUE, data terminal ready (DTR) and data set ready (DSR) signals are supported on this serial port.
Get-CimInstance -ClassName Win32_SerialPort | Select-Object -Property DeviceID, SupportsDTRDSR
SupportsElapsedTimeouts
If TRUE, elapsed time-outs are supported on this serial port. Elapsed timeouts track the total amount of time between data transmissions.
Get-CimInstance -ClassName Win32_SerialPort | Select-Object -Property DeviceID, SupportsElapsedTimeouts
SupportsIntTimeouts
If TRUE, interval time-outs are supported. An interval timeout is the amount of time allowed to elapse between the arrival of each piece of data.
Get-CimInstance -ClassName Win32_SerialPort | Select-Object -Property DeviceID, SupportsIntTimeouts
SupportsParityCheck
If TRUE, parity checking is supported on this serial port.
Get-CimInstance -ClassName Win32_SerialPort | Select-Object -Property DeviceID, SupportsParityCheck
SupportsRLSD
If TRUE, Received Line Signal Detect (RLSD) is supported on this serial port.
Get-CimInstance -ClassName Win32_SerialPort | Select-Object -Property DeviceID, SupportsRLSD
SupportsRTSCTS
If TRUE, ready to send (RTS) and clear to send (CTS) signals are supported on this serial port.
Get-CimInstance -ClassName Win32_SerialPort | Select-Object -Property DeviceID, SupportsRTSCTS
SupportsSpecialCharacters
If TRUE, serial port control characters are supported. These characters signal events rather than data. These characters are not displayable and are set by the driver. They include EofChar, ErrorChar, BreakChar, EventChar, XonChar, and XoffChar.
Get-CimInstance -ClassName Win32_SerialPort | Select-Object -Property DeviceID, SupportsSpecialCharacters
SupportsXOnXOff
If TRUE, XON or XOFF flow-control is supported on this serial port.
Get-CimInstance -ClassName Win32_SerialPort | Select-Object -Property DeviceID, SupportsXOnXOff
SupportsXOnXOffSet
If TRUE, the communications provider supports configuration of the XONor XOFF flow-control setting.
Get-CimInstance -ClassName Win32_SerialPort | Select-Object -Property DeviceID, SupportsXOnXOffSet
SystemCreationClassName
Value of the scoping computer’s CreationClassName property.
Get-CimInstance -ClassName Win32_SerialPort | Select-Object -Property DeviceID, SystemCreationClassName
SystemName
Name of the scoping system.
Get-CimInstance -ClassName Win32_SerialPort | Select-Object -Property DeviceID, SystemName
TimeOfLastReset
Date and time this controller was last reset. This could mean the controller was powered down, or reinitialized.
Get-CimInstance -ClassName Win32_SerialPort | Select-Object -Property DeviceID, TimeOfLastReset
Examples
List all instances of Win32_SerialPort
Get-CimInstance -ClassName Win32_SerialPort
Learn more about Get-CimInstance and the deprecated Get-WmiObject.
View all properties
Get-CimInstance -ClassName Win32_SerialPort -Property *
View key properties only
Get-CimInstance -ClassName Win32_SerialPort -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',
'Binary',
'Capabilities',
'CapabilityDescriptions',
'Caption',
'ConfigManagerErrorCode',
'ConfigManagerUserConfig',
'CreationClassName',
'Description',
'DeviceID',
'ErrorCleared',
'ErrorDescription',
'InstallDate',
'LastErrorCode',
'MaxBaudRate',
'MaximumInputBufferSize',
'MaximumOutputBufferSize',
'MaxNumberControlled',
'Name',
'OSAutoDiscovered',
'PNPDeviceID',
'PowerManagementCapabilities',
'PowerManagementSupported',
'ProtocolSupported',
'ProviderType',
'SettableBaudRate',
'SettableDataBits',
'SettableFlowControl',
'SettableParity',
'SettableParityCheck',
'SettableRLSD',
'SettableStopBits',
'Status',
'StatusInfo',
'Supports16BitMode',
'SupportsDTRDSR',
'SupportsElapsedTimeouts',
'SupportsIntTimeouts',
'SupportsParityCheck',
'SupportsRLSD',
'SupportsRTSCTS',
'SupportsSpecialCharacters',
'SupportsXOnXOff',
'SupportsXOnXOffSet',
'SystemCreationClassName',
'SystemName',
'TimeOfLastReset'
Get-CimInstance -ClassName Win32_SerialPort | 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_SerialPort -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_SerialPort -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 OSAutoDiscovered, CreationClassName, ConfigManagerUserConfig, DeviceID FROM Win32_SerialPort WHERE Caption LIKE 'a%'"
Any property you did not specify is still present but empty. You might need to use
Select-Objectto remove all unwanted properties:Get-CimInstance -Query "SELECT OSAutoDiscovered, CreationClassName, ConfigManagerUserConfig, DeviceID FROM Win32_SerialPort WHERE Caption LIKE 'a%'" | Select-Object -Property OSAutoDiscovered, CreationClassName, ConfigManagerUserConfig, DeviceID
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_SerialPort -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_SerialPort -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_SerialPort, 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_SerialPort was introduced on clients with Windows Vista and on servers with Windows Server 2008.
Namespace
Win32_SerialPort 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_SerialPort 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
PREVIOUSArchive