The Win32_POTSModem WMI class represents the services and characteristics of a Plain Old Telephone Service (POTS) modem on a computer system running Windows.
Methods
Win32_POTSModem has no methods. Inherited methods (Reset and SetPowerState) are not implemented.
Properties
Win32_POTSModem returns 80 properties:
'AnswerMode','AttachedTo','Availability','BlindOff','BlindOn','Caption',
'CompatibilityFlags','CompressionInfo','CompressionOff','CompressionOn','ConfigManagerErrorCode',
'ConfigManagerUserConfig','ConfigurationDialog','CountriesSupported','CountrySelected','CreationClassName',
'CurrentPasswords','DCB','Default','Description','DeviceID','DeviceLoader','DeviceType','DialType',
'DriverDate','ErrorCleared','ErrorControlForced','ErrorControlInfo','ErrorControlOff',
'ErrorControlOn','ErrorDescription','FlowControlHard','FlowControlOff','FlowControlSoft',
'InactivityScale','InactivityTimeout','Index','IndexEx','InstallDate','LastErrorCode',
'MaxBaudRateToPhone','MaxBaudRateToSerialPort','MaxNumberOfPasswords','Model','ModemInfPath',
'ModemInfSection','ModulationBell','ModulationCCITT','ModulationScheme','Name','PNPDeviceID',
'PortSubClass','PowerManagementCapabilities','PowerManagementSupported','Prefix','Properties',
'ProviderName','Pulse','Reset','ResponsesKeyName','RingsBeforeAnswer','SpeakerModeDial',
'SpeakerModeOff','SpeakerModeOn','SpeakerModeSetup','SpeakerVolumeHigh','SpeakerVolumeInfo',
'SpeakerVolumeLow','SpeakerVolumeMed','Status','StatusInfo','StringFormat','SupportsCallback',
'SupportsSynchronousConnect','SystemCreationClassName','SystemName','Terminator','TimeOfLastReset','Tone',
'VoiceSwitchFeature'
Unless explicitly marked as writeable, all properties are read-only. Read all properties for all instances:
Get-CimInstance -ClassName Win32_POTSModem -Property *
Most WMI classes return one or more instances.
When
Get-CimInstancereturns no result, then apparently no instances of class Win32_POTSModem 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).
AnswerMode
Current auto-answer or callback setting for the modem.
AnswerMode returns a numeric value. To translate it into a meaningful text, use any of the following approaches:
Use a PowerShell Hashtable
$AnswerMode_map = @{
0 = 'Unknown'
1 = 'Other'
2 = 'Disabled'
3 = 'Manual Answer'
4 = 'Auto Answer'
5 = 'Auto Answer with Call-Back'
}
Use a switch statement
switch([int]$value)
{
0 {'Unknown'}
1 {'Other'}
2 {'Disabled'}
3 {'Manual Answer'}
4 {'Auto Answer'}
5 {'Auto Answer with Call-Back'}
default {"$value"}
}
Use Enum structure
Enum EnumAnswerMode
{
Unknown = 0
Other = 1
Disabled = 2
Manual_Answer = 3
Auto_Answer = 4
Auto_Answer_with_Call_Back = 5
}
Examples
Use $AnswerMode_map in a calculated property for Select-Object
<#
this example uses a hashtable to translate raw numeric values for
property "AnswerMode" to friendly text
Note: to use other properties than "AnswerMode", 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 "AnswerMode"
# to translate other properties, use their translation table instead
$AnswerMode_map = @{
0 = 'Unknown'
1 = 'Other'
2 = 'Disabled'
3 = 'Manual Answer'
4 = 'Auto Answer'
5 = 'Auto Answer with Call-Back'
}
#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 "AnswerMode", 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:
#>
$AnswerMode = @{
Name = 'AnswerMode'
Expression = {
# property is an array, so process all values
$value = $_.AnswerMode
$AnswerMode_map[[int]$value]
}
}
#endregion define calculated property
# retrieve the instances, and output the properties "Caption" and "AnswerMode". The latter
# is defined by the hashtable in $AnswerMode:
Get-CimInstance -Class Win32_POTSModem | Select-Object -Property Caption, $AnswerMode
# ...or dump content of property AnswerMode:
$friendlyValues = Get-CimInstance -Class Win32_POTSModem |
Select-Object -Property $AnswerMode |
Select-Object -ExpandProperty AnswerMode
# output values
$friendlyValues
# output values as comma separated list
$friendlyValues -join ', '
# output values as bullet list
$friendlyValues | ForEach-Object { "- $_" }
Use $AnswerMode_map to directly translate raw values from an instance
<#
this example uses a hashtable to manually translate raw numeric values
for property "Win32_POTSModem" to friendly text. This approach is ideal when
there is just one instance to work with.
Note: to use other properties than "Win32_POTSModem", 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_POTSModem"
# to translate other properties, use their translation table instead
$AnswerMode_map = @{
0 = 'Unknown'
1 = 'Other'
2 = 'Disabled'
3 = 'Manual Answer'
4 = 'Auto Answer'
5 = 'Auto Answer with Call-Back'
}
#endregion define hashtable
# get one instance:
$instance = Get-CimInstance -Class Win32_POTSModem | 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.AnswerMode
# translate raw value to friendly text:
$friendlyName = $AnswerMode_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 "AnswerMode" 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 "AnswerMode", 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 "AnswerMode", 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:
#>
$AnswerMode = @{
Name = 'AnswerMode'
Expression = {
# property is an array, so process all values
$value = $_.AnswerMode
switch([int]$value)
{
0 {'Unknown'}
1 {'Other'}
2 {'Disabled'}
3 {'Manual Answer'}
4 {'Auto Answer'}
5 {'Auto Answer with Call-Back'}
default {"$value"}
}
}
}
#endregion define calculated property
# retrieve all instances...
Get-CimInstance -ClassName Win32_POTSModem |
# ...and output properties "Caption" and "AnswerMode". The latter is defined
# by the hashtable in $AnswerMode:
Select-Object -Property Caption, $AnswerMode
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_POTSModem", look up the appropriate
enum definition for the property you would like to use instead.
#>
#region define enum with value-to-text translation:
Enum EnumAnswerMode
{
Unknown = 0
Other = 1
Disabled = 2
Manual_Answer = 3
Auto_Answer = 4
Auto_Answer_with_Call_Back = 5
}
#endregion define enum
# get one instance:
$instance = Get-CimInstance -Class Win32_POTSModem | 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.AnswerMode
#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 **AnswerMode**
[EnumAnswerMode]$rawValue
# get a comma-separated string:
[EnumAnswerMode]$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 [EnumAnswerMode]
#endregion
Enums must cover all possible values. If AnswerMode 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.
AttachedTo
Port to which the POTS modem is attached.
Example: “COM1”
Get-CimInstance -ClassName Win32_POTSModem | Select-Object -Property DeviceID, AttachedTo
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_POTSModem | Select-Object -Property Caption, $Availability
# ...or dump content of property Availability:
$friendlyValues = Get-CimInstance -Class Win32_POTSModem |
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_POTSModem" to friendly text. This approach is ideal when
there is just one instance to work with.
Note: to use other properties than "Win32_POTSModem", 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_POTSModem"
# 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_POTSModem | 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_POTSModem |
# ...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_POTSModem", 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_POTSModem | 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.
BlindOff
Command string used to detect a dial tone before dialing.
Example: “X4”
Get-CimInstance -ClassName Win32_POTSModem | Select-Object -Property DeviceID, BlindOff
BlindOn
Command string used to dial whether or not there is a dial tone.
Example: “X3”
Get-CimInstance -ClassName Win32_POTSModem | Select-Object -Property DeviceID, BlindOn
Caption
Short description of the object.
Get-CimInstance -ClassName Win32_POTSModem | Select-Object -Property DeviceID, Caption
CompatibilityFlags
All modem connection protocols with which this modem device is compatible.
Get-CimInstance -ClassName Win32_POTSModem | Select-Object -Property DeviceID, CompatibilityFlags
CompressionInfo
Data compression characteristics of the modem.
CompressionInfo returns a numeric value. To translate it into a meaningful text, use any of the following approaches:
Use a PowerShell Hashtable
$CompressionInfo_map = @{
0 = 'Unknown'
1 = 'Other'
2 = 'No Compression'
3 = 'MNP 5'
4 = 'V.42bis'
}
Use a switch statement
switch([int]$value)
{
0 {'Unknown'}
1 {'Other'}
2 {'No Compression'}
3 {'MNP 5'}
4 {'V.42bis'}
default {"$value"}
}
Use Enum structure
Enum EnumCompressionInfo
{
Unknown = 0
Other = 1
No_Compression = 2
MNP_5 = 3
V42bis = 4
}
Examples
Use $CompressionInfo_map in a calculated property for Select-Object
<#
this example uses a hashtable to translate raw numeric values for
property "CompressionInfo" to friendly text
Note: to use other properties than "CompressionInfo", 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 "CompressionInfo"
# to translate other properties, use their translation table instead
$CompressionInfo_map = @{
0 = 'Unknown'
1 = 'Other'
2 = 'No Compression'
3 = 'MNP 5'
4 = 'V.42bis'
}
#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 "CompressionInfo", 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:
#>
$CompressionInfo = @{
Name = 'CompressionInfo'
Expression = {
# property is an array, so process all values
$value = $_.CompressionInfo
$CompressionInfo_map[[int]$value]
}
}
#endregion define calculated property
# retrieve the instances, and output the properties "Caption" and "CompressionInfo". The latter
# is defined by the hashtable in $CompressionInfo:
Get-CimInstance -Class Win32_POTSModem | Select-Object -Property Caption, $CompressionInfo
# ...or dump content of property CompressionInfo:
$friendlyValues = Get-CimInstance -Class Win32_POTSModem |
Select-Object -Property $CompressionInfo |
Select-Object -ExpandProperty CompressionInfo
# output values
$friendlyValues
# output values as comma separated list
$friendlyValues -join ', '
# output values as bullet list
$friendlyValues | ForEach-Object { "- $_" }
Use $CompressionInfo_map to directly translate raw values from an instance
<#
this example uses a hashtable to manually translate raw numeric values
for property "Win32_POTSModem" to friendly text. This approach is ideal when
there is just one instance to work with.
Note: to use other properties than "Win32_POTSModem", 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_POTSModem"
# to translate other properties, use their translation table instead
$CompressionInfo_map = @{
0 = 'Unknown'
1 = 'Other'
2 = 'No Compression'
3 = 'MNP 5'
4 = 'V.42bis'
}
#endregion define hashtable
# get one instance:
$instance = Get-CimInstance -Class Win32_POTSModem | 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.CompressionInfo
# translate raw value to friendly text:
$friendlyName = $CompressionInfo_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 "CompressionInfo" 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 "CompressionInfo", 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 "CompressionInfo", 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:
#>
$CompressionInfo = @{
Name = 'CompressionInfo'
Expression = {
# property is an array, so process all values
$value = $_.CompressionInfo
switch([int]$value)
{
0 {'Unknown'}
1 {'Other'}
2 {'No Compression'}
3 {'MNP 5'}
4 {'V.42bis'}
default {"$value"}
}
}
}
#endregion define calculated property
# retrieve all instances...
Get-CimInstance -ClassName Win32_POTSModem |
# ...and output properties "Caption" and "CompressionInfo". The latter is defined
# by the hashtable in $CompressionInfo:
Select-Object -Property Caption, $CompressionInfo
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_POTSModem", look up the appropriate
enum definition for the property you would like to use instead.
#>
#region define enum with value-to-text translation:
Enum EnumCompressionInfo
{
Unknown = 0
Other = 1
No_Compression = 2
MNP_5 = 3
V42bis = 4
}
#endregion define enum
# get one instance:
$instance = Get-CimInstance -Class Win32_POTSModem | 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.CompressionInfo
#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 **CompressionInfo**
[EnumCompressionInfo]$rawValue
# get a comma-separated string:
[EnumCompressionInfo]$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 [EnumCompressionInfo]
#endregion
Enums must cover all possible values. If CompressionInfo 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.
CompressionOff
Command string used to disable hardware data compression.
Example: “S46=136”
Get-CimInstance -ClassName Win32_POTSModem | Select-Object -Property DeviceID, CompressionOff
CompressionOn
Command string used to enable hardware data compression.
Example: “S46=138”
Get-CimInstance -ClassName Win32_POTSModem | Select-Object -Property DeviceID, CompressionOn
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_POTSModem | Select-Object -Property Caption, $ConfigManagerErrorCode
# ...or dump content of property ConfigManagerErrorCode:
$friendlyValues = Get-CimInstance -Class Win32_POTSModem |
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_POTSModem" to friendly text. This approach is ideal when
there is just one instance to work with.
Note: to use other properties than "Win32_POTSModem", 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_POTSModem"
# 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_POTSModem | 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_POTSModem |
# ...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_POTSModem", 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_POTSModem | 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_POTSModem | Select-Object -Property DeviceID, ConfigManagerUserConfig
ConfigurationDialog
Modem initialization string. This property is made up of command strings from other properties of this class.
Get-CimInstance -ClassName Win32_POTSModem | Select-Object -Property DeviceID, ConfigurationDialog
CountriesSupported
Array of countries/regions in which the modem can operate.
Get-CimInstance -ClassName Win32_POTSModem | Select-Object -Property DeviceID, CountriesSupported
CountrySelected
Country/region for which the modem is currently programmed. When multiple countries/regions are supported, this property defines which one is currently selected for use.
Get-CimInstance -ClassName Win32_POTSModem | Select-Object -Property DeviceID, CountrySelected
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_POTSModem | Select-Object -Property DeviceID, CreationClassName
CurrentPasswords
List of currently defined passwords for the modem. This array may be left blank for security reasons.
Get-CimInstance -ClassName Win32_POTSModem | Select-Object -Property DeviceID, CurrentPasswords
DCB
Control settings for a serial communications device, in this case, the modem device.
Get-CimInstance -ClassName Win32_POTSModem | Select-Object -Property DeviceID, DCB
Default
If TRUE, this POTS modem is the default modem on the computer system running Windows.
Get-CimInstance -ClassName Win32_POTSModem | Select-Object -Property DeviceID, Default
Description
Description of the object.
Get-CimInstance -ClassName Win32_POTSModem | Select-Object -Property DeviceID, Description
DeviceID
Unique identifier of this POTS modem from other devices on the system.
Get-CimInstance -ClassName Win32_POTSModem | Select-Object -Property DeviceID
DeviceLoader
Name of the device loader for the modem. A device loader loads and manages device drivers and enumerators for a given device.
Get-CimInstance -ClassName Win32_POTSModem | Select-Object -Property DeviceID, DeviceLoader
DeviceType
Physical type of the modem.
The values are:
Null Modem (“Null Modem”)
Internal Modem (“Internal Modem”)
External Modem (“External Modem”)
PCMCIA Modem (“PCMCIA Modem”)
Unknown (“Unknown”)
Get-CimInstance -ClassName Win32_POTSModem | Select-Object -Property DeviceID, DeviceType
DialType
Type of dialing method used.
DialType returns a numeric value. To translate it into a meaningful text, use any of the following approaches:
Use a PowerShell Hashtable
$DialType_map = @{
0 = 'Unknown'
1 = 'Tone'
2 = 'Pulse'
}
Use a switch statement
switch([int]$value)
{
0 {'Unknown'}
1 {'Tone'}
2 {'Pulse'}
default {"$value"}
}
Use Enum structure
Enum EnumDialType
{
Unknown = 0
Tone = 1
Pulse = 2
}
Examples
Use $DialType_map in a calculated property for Select-Object
<#
this example uses a hashtable to translate raw numeric values for
property "DialType" to friendly text
Note: to use other properties than "DialType", 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 "DialType"
# to translate other properties, use their translation table instead
$DialType_map = @{
0 = 'Unknown'
1 = 'Tone'
2 = 'Pulse'
}
#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 "DialType", 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:
#>
$DialType = @{
Name = 'DialType'
Expression = {
# property is an array, so process all values
$value = $_.DialType
$DialType_map[[int]$value]
}
}
#endregion define calculated property
# retrieve the instances, and output the properties "Caption" and "DialType". The latter
# is defined by the hashtable in $DialType:
Get-CimInstance -Class Win32_POTSModem | Select-Object -Property Caption, $DialType
# ...or dump content of property DialType:
$friendlyValues = Get-CimInstance -Class Win32_POTSModem |
Select-Object -Property $DialType |
Select-Object -ExpandProperty DialType
# output values
$friendlyValues
# output values as comma separated list
$friendlyValues -join ', '
# output values as bullet list
$friendlyValues | ForEach-Object { "- $_" }
Use $DialType_map to directly translate raw values from an instance
<#
this example uses a hashtable to manually translate raw numeric values
for property "Win32_POTSModem" to friendly text. This approach is ideal when
there is just one instance to work with.
Note: to use other properties than "Win32_POTSModem", 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_POTSModem"
# to translate other properties, use their translation table instead
$DialType_map = @{
0 = 'Unknown'
1 = 'Tone'
2 = 'Pulse'
}
#endregion define hashtable
# get one instance:
$instance = Get-CimInstance -Class Win32_POTSModem | 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.DialType
# translate raw value to friendly text:
$friendlyName = $DialType_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 "DialType" 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 "DialType", 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 "DialType", 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:
#>
$DialType = @{
Name = 'DialType'
Expression = {
# property is an array, so process all values
$value = $_.DialType
switch([int]$value)
{
0 {'Unknown'}
1 {'Tone'}
2 {'Pulse'}
default {"$value"}
}
}
}
#endregion define calculated property
# retrieve all instances...
Get-CimInstance -ClassName Win32_POTSModem |
# ...and output properties "Caption" and "DialType". The latter is defined
# by the hashtable in $DialType:
Select-Object -Property Caption, $DialType
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_POTSModem", look up the appropriate
enum definition for the property you would like to use instead.
#>
#region define enum with value-to-text translation:
Enum EnumDialType
{
Unknown = 0
Tone = 1
Pulse = 2
}
#endregion define enum
# get one instance:
$instance = Get-CimInstance -Class Win32_POTSModem | 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.DialType
#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 **DialType**
[EnumDialType]$rawValue
# get a comma-separated string:
[EnumDialType]$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 [EnumDialType]
#endregion
Enums must cover all possible values. If DialType 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.
DriverDate
Date of the modem driver.
Get-CimInstance -ClassName Win32_POTSModem | Select-Object -Property DeviceID, DriverDate
ErrorCleared
If TRUE, the error reported in LastErrorCode is now cleared.
Get-CimInstance -ClassName Win32_POTSModem | Select-Object -Property DeviceID, ErrorCleared
ErrorControlForced
Command string used to enable error correction control when establishing a connection. This increases the reliability of the connection.
Example: “+Q5S36=4S48=7”
Get-CimInstance -ClassName Win32_POTSModem | Select-Object -Property DeviceID, ErrorControlForced
ErrorControlInfo
Error correction characteristics of the modem.
ErrorControlInfo returns a numeric value. To translate it into a meaningful text, use any of the following approaches:
Use a PowerShell Hashtable
$ErrorControlInfo_map = @{
0 = 'Unknown'
1 = 'Other'
2 = 'No Error Correction'
3 = 'MNP 4'
4 = 'LAPM'
}
Use a switch statement
switch([int]$value)
{
0 {'Unknown'}
1 {'Other'}
2 {'No Error Correction'}
3 {'MNP 4'}
4 {'LAPM'}
default {"$value"}
}
Use Enum structure
Enum EnumErrorControlInfo
{
Unknown = 0
Other = 1
No_Error_Correction = 2
MNP_4 = 3
LAPM = 4
}
Examples
Use $ErrorControlInfo_map in a calculated property for Select-Object
<#
this example uses a hashtable to translate raw numeric values for
property "ErrorControlInfo" to friendly text
Note: to use other properties than "ErrorControlInfo", 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 "ErrorControlInfo"
# to translate other properties, use their translation table instead
$ErrorControlInfo_map = @{
0 = 'Unknown'
1 = 'Other'
2 = 'No Error Correction'
3 = 'MNP 4'
4 = 'LAPM'
}
#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 "ErrorControlInfo", 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:
#>
$ErrorControlInfo = @{
Name = 'ErrorControlInfo'
Expression = {
# property is an array, so process all values
$value = $_.ErrorControlInfo
$ErrorControlInfo_map[[int]$value]
}
}
#endregion define calculated property
# retrieve the instances, and output the properties "Caption" and "ErrorControlInfo". The latter
# is defined by the hashtable in $ErrorControlInfo:
Get-CimInstance -Class Win32_POTSModem | Select-Object -Property Caption, $ErrorControlInfo
# ...or dump content of property ErrorControlInfo:
$friendlyValues = Get-CimInstance -Class Win32_POTSModem |
Select-Object -Property $ErrorControlInfo |
Select-Object -ExpandProperty ErrorControlInfo
# output values
$friendlyValues
# output values as comma separated list
$friendlyValues -join ', '
# output values as bullet list
$friendlyValues | ForEach-Object { "- $_" }
Use $ErrorControlInfo_map to directly translate raw values from an instance
<#
this example uses a hashtable to manually translate raw numeric values
for property "Win32_POTSModem" to friendly text. This approach is ideal when
there is just one instance to work with.
Note: to use other properties than "Win32_POTSModem", 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_POTSModem"
# to translate other properties, use their translation table instead
$ErrorControlInfo_map = @{
0 = 'Unknown'
1 = 'Other'
2 = 'No Error Correction'
3 = 'MNP 4'
4 = 'LAPM'
}
#endregion define hashtable
# get one instance:
$instance = Get-CimInstance -Class Win32_POTSModem | 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.ErrorControlInfo
# translate raw value to friendly text:
$friendlyName = $ErrorControlInfo_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 "ErrorControlInfo" 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 "ErrorControlInfo", 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 "ErrorControlInfo", 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:
#>
$ErrorControlInfo = @{
Name = 'ErrorControlInfo'
Expression = {
# property is an array, so process all values
$value = $_.ErrorControlInfo
switch([int]$value)
{
0 {'Unknown'}
1 {'Other'}
2 {'No Error Correction'}
3 {'MNP 4'}
4 {'LAPM'}
default {"$value"}
}
}
}
#endregion define calculated property
# retrieve all instances...
Get-CimInstance -ClassName Win32_POTSModem |
# ...and output properties "Caption" and "ErrorControlInfo". The latter is defined
# by the hashtable in $ErrorControlInfo:
Select-Object -Property Caption, $ErrorControlInfo
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_POTSModem", look up the appropriate
enum definition for the property you would like to use instead.
#>
#region define enum with value-to-text translation:
Enum EnumErrorControlInfo
{
Unknown = 0
Other = 1
No_Error_Correction = 2
MNP_4 = 3
LAPM = 4
}
#endregion define enum
# get one instance:
$instance = Get-CimInstance -Class Win32_POTSModem | 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.ErrorControlInfo
#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 **ErrorControlInfo**
[EnumErrorControlInfo]$rawValue
# get a comma-separated string:
[EnumErrorControlInfo]$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 [EnumErrorControlInfo]
#endregion
Enums must cover all possible values. If ErrorControlInfo 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.
ErrorControlOff
Command string used to disable error control.
Example: “+Q6S36=3S48=128”
Get-CimInstance -ClassName Win32_POTSModem | Select-Object -Property DeviceID, ErrorControlOff
ErrorControlOn
Command string used to enable error control.
Example: “+Q5S36=7S48=7”
Get-CimInstance -ClassName Win32_POTSModem | Select-Object -Property DeviceID, ErrorControlOn
ErrorDescription
More information about the error recorded in LastErrorCode, and information on any corrective actions that may be taken.
Get-CimInstance -ClassName Win32_POTSModem | Select-Object -Property DeviceID, ErrorDescription
FlowControlHard
Command string used to enable hardware flow control. Flow control consists of signals sent between computers that verify that both computers are ready to transmit or receive data.
Example: “&K1”
Get-CimInstance -ClassName Win32_POTSModem | Select-Object -Property DeviceID, FlowControlHard
FlowControlOff
Command string used to disable flow control. Flow control consists of signals sent between computers that verify that both computers are ready to transmit or receive data.
Example: “&K0”
Get-CimInstance -ClassName Win32_POTSModem | Select-Object -Property DeviceID, FlowControlOff
FlowControlSoft
Command string used to enable software flow control. Flow control consists of signals sent between computers that verify that both computers are ready to transmit or receive data.
Example: “&K2”
Get-CimInstance -ClassName Win32_POTSModem | Select-Object -Property DeviceID, FlowControlSoft
InactivityScale
Multiplier used with the InactivityTimeout property to calculate the timeout period of a connection.
Get-CimInstance -ClassName Win32_POTSModem | Select-Object -Property DeviceID, InactivityScale
InactivityTimeout
Time limit (in seconds) for automatic disconnection of the phone line, if no data is exchanged. A value of 0 (zero) indicates that this feature is present but not enabled.
Get-CimInstance -ClassName Win32_POTSModem | Select-Object -Property DeviceID, InactivityTimeout
Index
Index number for this POTS modem.
Example: 0
Get-CimInstance -ClassName Win32_POTSModem | Select-Object -Property DeviceID, Index
IndexEx
The device instance ID for this POTS modem.
Example: “1&08”
Windows Server® 2012® R2, Windows® 8.1, Windows Server® 2012, Windows® 8, Windows Server® 2008® R2, Windows® 7, Windows Server® 2008 and Windows® Vista: This property is available beginning with Windows Server® 2016 and Windows® 10.
Get-CimInstance -ClassName Win32_POTSModem | Select-Object -Property DeviceID, IndexEx
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_POTSModem | Select-Object -Property DeviceID, InstallDate
LastErrorCode
Last error code reported by the logical device.
Get-CimInstance -ClassName Win32_POTSModem | Select-Object -Property DeviceID, LastErrorCode
MaxBaudRateToPhone
Maximum settable communication speed for accessing the phone system.
Get-CimInstance -ClassName Win32_POTSModem | Select-Object -Property DeviceID, MaxBaudRateToPhone
MaxBaudRateToSerialPort
Maximum settable communication speed to the COM port for an external modem. Enter 0 (zero) if not applicable.
Get-CimInstance -ClassName Win32_POTSModem | Select-Object -Property DeviceID, MaxBaudRateToSerialPort
MaxNumberOfPasswords
Number of passwords definable in the modem itself. If this feature is not supported, enter 0 (zero).
Get-CimInstance -ClassName Win32_POTSModem | Select-Object -Property DeviceID, MaxNumberOfPasswords
Model
Model of this POTS modem.
Example: “Sportster 56K External”
Get-CimInstance -ClassName Win32_POTSModem | Select-Object -Property DeviceID, Model
ModemInfPath
Path to this modem’s .inf file. This file contains initialization information for the modem and its driver.
Example: “C:\Windows\INF”
Get-CimInstance -ClassName Win32_POTSModem | Select-Object -Property DeviceID, ModemInfPath
ModemInfSection
Name of the section in the modem’s .inf file that contains information about the modem.
Get-CimInstance -ClassName Win32_POTSModem | Select-Object -Property DeviceID, ModemInfSection
ModulationBell
Command string used to instruct the modem to use Bell modulations for 300 and 1200 bps.
Example: “B1”
Get-CimInstance -ClassName Win32_POTSModem | Select-Object -Property DeviceID, ModulationBell
ModulationCCITT
Command string used to instruct the modem to use CCITT modulations for 300 and 1200 bps.
Example: “B0”
Get-CimInstance -ClassName Win32_POTSModem | Select-Object -Property DeviceID, ModulationCCITT
ModulationScheme
Modulation scheme of the modem.
ModulationScheme returns a numeric value. To translate it into a meaningful text, use any of the following approaches:
Use a PowerShell Hashtable
$ModulationScheme_map = @{
0 = 'Unknown'
1 = 'Other'
2 = 'Not Supported'
3 = 'Bell 103'
4 = 'Bell 212A'
5 = 'V.22bis'
6 = 'V.32'
7 = 'V.32bis'
8 = 'V.turbo'
9 = 'V.FC'
10 = 'V.34'
11 = 'V.34bis'
}
Use a switch statement
switch([int]$value)
{
0 {'Unknown'}
1 {'Other'}
2 {'Not Supported'}
3 {'Bell 103'}
4 {'Bell 212A'}
5 {'V.22bis'}
6 {'V.32'}
7 {'V.32bis'}
8 {'V.turbo'}
9 {'V.FC'}
10 {'V.34'}
11 {'V.34bis'}
default {"$value"}
}
Use Enum structure
Enum EnumModulationScheme
{
Unknown = 0
Other = 1
Not_Supported = 2
Bell_103 = 3
Bell_212A = 4
V22bis = 5
V32 = 6
V32bis = 7
Vturbo = 8
VFC = 9
V34 = 10
V34bis = 11
}
Examples
Use $ModulationScheme_map in a calculated property for Select-Object
<#
this example uses a hashtable to translate raw numeric values for
property "ModulationScheme" to friendly text
Note: to use other properties than "ModulationScheme", 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 "ModulationScheme"
# to translate other properties, use their translation table instead
$ModulationScheme_map = @{
0 = 'Unknown'
1 = 'Other'
2 = 'Not Supported'
3 = 'Bell 103'
4 = 'Bell 212A'
5 = 'V.22bis'
6 = 'V.32'
7 = 'V.32bis'
8 = 'V.turbo'
9 = 'V.FC'
10 = 'V.34'
11 = 'V.34bis'
}
#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 "ModulationScheme", 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:
#>
$ModulationScheme = @{
Name = 'ModulationScheme'
Expression = {
# property is an array, so process all values
$value = $_.ModulationScheme
$ModulationScheme_map[[int]$value]
}
}
#endregion define calculated property
# retrieve the instances, and output the properties "Caption" and "ModulationScheme". The latter
# is defined by the hashtable in $ModulationScheme:
Get-CimInstance -Class Win32_POTSModem | Select-Object -Property Caption, $ModulationScheme
# ...or dump content of property ModulationScheme:
$friendlyValues = Get-CimInstance -Class Win32_POTSModem |
Select-Object -Property $ModulationScheme |
Select-Object -ExpandProperty ModulationScheme
# output values
$friendlyValues
# output values as comma separated list
$friendlyValues -join ', '
# output values as bullet list
$friendlyValues | ForEach-Object { "- $_" }
Use $ModulationScheme_map to directly translate raw values from an instance
<#
this example uses a hashtable to manually translate raw numeric values
for property "Win32_POTSModem" to friendly text. This approach is ideal when
there is just one instance to work with.
Note: to use other properties than "Win32_POTSModem", 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_POTSModem"
# to translate other properties, use their translation table instead
$ModulationScheme_map = @{
0 = 'Unknown'
1 = 'Other'
2 = 'Not Supported'
3 = 'Bell 103'
4 = 'Bell 212A'
5 = 'V.22bis'
6 = 'V.32'
7 = 'V.32bis'
8 = 'V.turbo'
9 = 'V.FC'
10 = 'V.34'
11 = 'V.34bis'
}
#endregion define hashtable
# get one instance:
$instance = Get-CimInstance -Class Win32_POTSModem | 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.ModulationScheme
# translate raw value to friendly text:
$friendlyName = $ModulationScheme_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 "ModulationScheme" 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 "ModulationScheme", 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 "ModulationScheme", 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:
#>
$ModulationScheme = @{
Name = 'ModulationScheme'
Expression = {
# property is an array, so process all values
$value = $_.ModulationScheme
switch([int]$value)
{
0 {'Unknown'}
1 {'Other'}
2 {'Not Supported'}
3 {'Bell 103'}
4 {'Bell 212A'}
5 {'V.22bis'}
6 {'V.32'}
7 {'V.32bis'}
8 {'V.turbo'}
9 {'V.FC'}
10 {'V.34'}
11 {'V.34bis'}
default {"$value"}
}
}
}
#endregion define calculated property
# retrieve all instances...
Get-CimInstance -ClassName Win32_POTSModem |
# ...and output properties "Caption" and "ModulationScheme". The latter is defined
# by the hashtable in $ModulationScheme:
Select-Object -Property Caption, $ModulationScheme
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_POTSModem", look up the appropriate
enum definition for the property you would like to use instead.
#>
#region define enum with value-to-text translation:
Enum EnumModulationScheme
{
Unknown = 0
Other = 1
Not_Supported = 2
Bell_103 = 3
Bell_212A = 4
V22bis = 5
V32 = 6
V32bis = 7
Vturbo = 8
VFC = 9
V34 = 10
V34bis = 11
}
#endregion define enum
# get one instance:
$instance = Get-CimInstance -Class Win32_POTSModem | 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.ModulationScheme
#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 **ModulationScheme**
[EnumModulationScheme]$rawValue
# get a comma-separated string:
[EnumModulationScheme]$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 [EnumModulationScheme]
#endregion
Enums must cover all possible values. If ModulationScheme 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.
Name
Label by which the object is known. When subclassed, the property can be overridden to be a key property.
Get-CimInstance -ClassName Win32_POTSModem | Select-Object -Property DeviceID, Name
PNPDeviceID
Windows Plug and Play device identifier of the logical device.
Example: “*PNP030b”
Get-CimInstance -ClassName Win32_POTSModem | Select-Object -Property DeviceID, PNPDeviceID
PortSubClass
Definition of the port used for this modem.
(“00”)
Parallel Port
(“01”)
Serial Port
(“02”)
Modem
Get-CimInstance -ClassName Win32_POTSModem | Select-Object -Property DeviceID, PortSubClass
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_POTSModem | Select-Object -Property Caption, $PowerManagementCapabilities
# ...or dump content of property PowerManagementCapabilities:
$friendlyValues = Get-CimInstance -Class Win32_POTSModem |
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_POTSModem" to friendly text. This approach is ideal when there
is just one instance to work with.
Note: to use other properties than "Win32_POTSModem", 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_POTSModem"
# 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_POTSModem | 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_POTSModem |
# ...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_POTSModem", 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_POTSModem | 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_POTSModem | Select-Object -Property DeviceID, PowerManagementSupported
Prefix
Dialing prefix used to access an outside line.
Get-CimInstance -ClassName Win32_POTSModem | Select-Object -Property DeviceID, Prefix
Properties
List of all the properties (and their values) for this modem.
Get-CimInstance -ClassName Win32_POTSModem | Select-Object -Property DeviceID, Properties
ProviderName
Network path to the computer that provides the modem services.
Get-CimInstance -ClassName Win32_POTSModem | Select-Object -Property DeviceID, ProviderName
Pulse
Command string used to instruct the modem to use pulse mode for dialing. Pulse dialing is necessary for phone lines that are unable to handle tone dialing.
Example: “P”
Get-CimInstance -ClassName Win32_POTSModem | Select-Object -Property DeviceID, Pulse
Reset
Command string used to reset the modem for the next call.
Example: “AT&F”
Get-CimInstance -ClassName Win32_POTSModem | Select-Object -Property DeviceID, Reset
ResponsesKeyName
Response this modem might report to the operating system during the connection process. The first two characters specify the type of response. The second two characters specify information about the connection being made. The second two characters are used only for Negotiation Progress or Connect response codes. The next eight characters specify the modem-to-modem line speed negotiated in bits per second (bps). The characters represent a 32-bit unsigned long integer format (byte and word reversed). The last eight characters indicate that the modem is changing to a different port or Data Terminal Equipment (DTE) speed. Usually this field is not used because modems make connections at a locked port speed regardless of the modem-to-modem or Data Communications Equipment (DCE) speed.
Get-CimInstance -ClassName Win32_POTSModem | Select-Object -Property DeviceID, ResponsesKeyName
RingsBeforeAnswer
Number of rings before the modem answers an incoming call.
Get-CimInstance -ClassName Win32_POTSModem | Select-Object -Property DeviceID, RingsBeforeAnswer
SpeakerModeDial
Command string used to turn the modem speaker on after dialing a number, and turning the speaker off when a connection has been established.
Example: “M1”
Get-CimInstance -ClassName Win32_POTSModem | Select-Object -Property DeviceID, SpeakerModeDial
SpeakerModeOff
Command string used to turn the modem speaker off.
Example: “M0”
Get-CimInstance -ClassName Win32_POTSModem | Select-Object -Property DeviceID, SpeakerModeOff
SpeakerModeOn
Command string used to turn the modem speaker on.
Example: “M2”
Get-CimInstance -ClassName Win32_POTSModem | Select-Object -Property DeviceID, SpeakerModeOn
SpeakerModeSetup
Command string used to instruct the modem to turn the speaker on (until a connection is established).
Example: “M3”
Get-CimInstance -ClassName Win32_POTSModem | Select-Object -Property DeviceID, SpeakerModeSetup
SpeakerVolumeHigh
Command string used to set the modem speaker to the highest volume.
Example: “L3”
Get-CimInstance -ClassName Win32_POTSModem | Select-Object -Property DeviceID, SpeakerVolumeHigh
SpeakerVolumeInfo
Describes the volume level of the audible tones from the modem.
SpeakerVolumeInfo returns a numeric value. To translate it into a meaningful text, use any of the following approaches:
Use a PowerShell Hashtable
$SpeakerVolumeInfo_map = @{
0 = 'Unknown'
1 = 'Other'
2 = 'Not Supported'
3 = 'High'
4 = 'Medium'
5 = 'Low'
6 = 'Off'
7 = 'Auto'
}
Use a switch statement
switch([int]$value)
{
0 {'Unknown'}
1 {'Other'}
2 {'Not Supported'}
3 {'High'}
4 {'Medium'}
5 {'Low'}
6 {'Off'}
7 {'Auto'}
default {"$value"}
}
Use Enum structure
Enum EnumSpeakerVolumeInfo
{
Unknown = 0
Other = 1
Not_Supported = 2
High = 3
Medium = 4
Low = 5
Off = 6
Auto = 7
}
Examples
Use $SpeakerVolumeInfo_map in a calculated property for Select-Object
<#
this example uses a hashtable to translate raw numeric values for
property "SpeakerVolumeInfo" to friendly text
Note: to use other properties than "SpeakerVolumeInfo", 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 "SpeakerVolumeInfo"
# to translate other properties, use their translation table instead
$SpeakerVolumeInfo_map = @{
0 = 'Unknown'
1 = 'Other'
2 = 'Not Supported'
3 = 'High'
4 = 'Medium'
5 = 'Low'
6 = 'Off'
7 = 'Auto'
}
#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 "SpeakerVolumeInfo", 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:
#>
$SpeakerVolumeInfo = @{
Name = 'SpeakerVolumeInfo'
Expression = {
# property is an array, so process all values
$value = $_.SpeakerVolumeInfo
$SpeakerVolumeInfo_map[[int]$value]
}
}
#endregion define calculated property
# retrieve the instances, and output the properties "Caption" and "SpeakerVolumeInfo". The latter
# is defined by the hashtable in $SpeakerVolumeInfo:
Get-CimInstance -Class Win32_POTSModem | Select-Object -Property Caption, $SpeakerVolumeInfo
# ...or dump content of property SpeakerVolumeInfo:
$friendlyValues = Get-CimInstance -Class Win32_POTSModem |
Select-Object -Property $SpeakerVolumeInfo |
Select-Object -ExpandProperty SpeakerVolumeInfo
# output values
$friendlyValues
# output values as comma separated list
$friendlyValues -join ', '
# output values as bullet list
$friendlyValues | ForEach-Object { "- $_" }
Use $SpeakerVolumeInfo_map to directly translate raw values from an instance
<#
this example uses a hashtable to manually translate raw numeric values
for property "Win32_POTSModem" to friendly text. This approach is ideal when
there is just one instance to work with.
Note: to use other properties than "Win32_POTSModem", 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_POTSModem"
# to translate other properties, use their translation table instead
$SpeakerVolumeInfo_map = @{
0 = 'Unknown'
1 = 'Other'
2 = 'Not Supported'
3 = 'High'
4 = 'Medium'
5 = 'Low'
6 = 'Off'
7 = 'Auto'
}
#endregion define hashtable
# get one instance:
$instance = Get-CimInstance -Class Win32_POTSModem | 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.SpeakerVolumeInfo
# translate raw value to friendly text:
$friendlyName = $SpeakerVolumeInfo_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 "SpeakerVolumeInfo" 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 "SpeakerVolumeInfo", 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 "SpeakerVolumeInfo", 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:
#>
$SpeakerVolumeInfo = @{
Name = 'SpeakerVolumeInfo'
Expression = {
# property is an array, so process all values
$value = $_.SpeakerVolumeInfo
switch([int]$value)
{
0 {'Unknown'}
1 {'Other'}
2 {'Not Supported'}
3 {'High'}
4 {'Medium'}
5 {'Low'}
6 {'Off'}
7 {'Auto'}
default {"$value"}
}
}
}
#endregion define calculated property
# retrieve all instances...
Get-CimInstance -ClassName Win32_POTSModem |
# ...and output properties "Caption" and "SpeakerVolumeInfo". The latter is defined
# by the hashtable in $SpeakerVolumeInfo:
Select-Object -Property Caption, $SpeakerVolumeInfo
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_POTSModem", look up the appropriate
enum definition for the property you would like to use instead.
#>
#region define enum with value-to-text translation:
Enum EnumSpeakerVolumeInfo
{
Unknown = 0
Other = 1
Not_Supported = 2
High = 3
Medium = 4
Low = 5
Off = 6
Auto = 7
}
#endregion define enum
# get one instance:
$instance = Get-CimInstance -Class Win32_POTSModem | 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.SpeakerVolumeInfo
#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 **SpeakerVolumeInfo**
[EnumSpeakerVolumeInfo]$rawValue
# get a comma-separated string:
[EnumSpeakerVolumeInfo]$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 [EnumSpeakerVolumeInfo]
#endregion
Enums must cover all possible values. If SpeakerVolumeInfo 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.
SpeakerVolumeLow
Command string used to set the modem speaker to the lowest volume.
Example: “L1”
Get-CimInstance -ClassName Win32_POTSModem | Select-Object -Property DeviceID, SpeakerVolumeLow
SpeakerVolumeMed
Command string used to set the modem speaker to a medium volume.
Example: “L2”
Get-CimInstance -ClassName Win32_POTSModem | Select-Object -Property DeviceID, SpeakerVolumeMed
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_POTSModem | 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_POTSModem | Select-Object -Property Caption, $StatusInfo
# ...or dump content of property StatusInfo:
$friendlyValues = Get-CimInstance -Class Win32_POTSModem |
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_POTSModem" to friendly text. This approach is ideal when
there is just one instance to work with.
Note: to use other properties than "Win32_POTSModem", 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_POTSModem"
# 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_POTSModem | 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_POTSModem |
# ...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_POTSModem", 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_POTSModem | 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.
StringFormat
Type of characters used for text passed through the modem.
The values are:
ASCII string format (“ASCII string format”)
DBCS string format (“DBCS string format”)
UNICODE string format (“UNICODE string format”)
Get-CimInstance -ClassName Win32_POTSModem | Select-Object -Property DeviceID, StringFormat
SupportsCallback
If TRUE, the modem supports callback.
Get-CimInstance -ClassName Win32_POTSModem | Select-Object -Property DeviceID, SupportsCallback
SupportsSynchronousConnect
If TRUE, synchronous, as well as asynchronous, communication is supported.
Get-CimInstance -ClassName Win32_POTSModem | Select-Object -Property DeviceID, SupportsSynchronousConnect
SystemCreationClassName
Value of the scoping computer’s CreationClassName property.
Get-CimInstance -ClassName Win32_POTSModem | Select-Object -Property DeviceID, SystemCreationClassName
SystemName
Name of the scoping system.
Get-CimInstance -ClassName Win32_POTSModem | Select-Object -Property DeviceID, SystemName
Terminator
String that marks the end of a command string.
Example: “<cr”
Get-CimInstance -ClassName Win32_POTSModem | Select-Object -Property DeviceID, Terminator
TimeOfLastReset
Date and time the modem was last reset.
Get-CimInstance -ClassName Win32_POTSModem | Select-Object -Property DeviceID, TimeOfLastReset
Tone
Command string that instructs the modem to use tone mode for dialing. The phone line must support tone dialing.
Example: “T”
Get-CimInstance -ClassName Win32_POTSModem | Select-Object -Property DeviceID, Tone
VoiceSwitchFeature
Command strings used to activate the voice capabilities of a voice modem.
Example: “AT+V”
Get-CimInstance -ClassName Win32_POTSModem | Select-Object -Property DeviceID, VoiceSwitchFeature
Examples
List all instances of Win32_POTSModem
Get-CimInstance -ClassName Win32_POTSModem
Learn more about Get-CimInstance and the deprecated Get-WmiObject.
View all properties
Get-CimInstance -ClassName Win32_POTSModem -Property *
View key properties only
Get-CimInstance -ClassName Win32_POTSModem -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 = 'AnswerMode',
'AttachedTo',
'Availability',
'BlindOff',
'BlindOn',
'Caption',
'CompatibilityFlags',
'CompressionInfo',
'CompressionOff',
'CompressionOn',
'ConfigManagerErrorCode',
'ConfigManagerUserConfig',
'ConfigurationDialog',
'CountriesSupported',
'CountrySelected',
'CreationClassName',
'CurrentPasswords',
'DCB',
'Default',
'Description',
'DeviceID',
'DeviceLoader',
'DeviceType',
'DialType',
'DriverDate',
'ErrorCleared',
'ErrorControlForced',
'ErrorControlInfo',
'ErrorControlOff',
'ErrorControlOn',
'ErrorDescription',
'FlowControlHard',
'FlowControlOff',
'FlowControlSoft',
'InactivityScale',
'InactivityTimeout',
'Index',
'IndexEx',
'InstallDate',
'LastErrorCode',
'MaxBaudRateToPhone',
'MaxBaudRateToSerialPort',
'MaxNumberOfPasswords',
'Model',
'ModemInfPath',
'ModemInfSection',
'ModulationBell',
'ModulationCCITT',
'ModulationScheme',
'Name',
'PNPDeviceID',
'PortSubClass',
'PowerManagementCapabilities',
'PowerManagementSupported',
'Prefix',
'Properties',
'ProviderName',
'Pulse',
'Reset',
'ResponsesKeyName',
'RingsBeforeAnswer',
'SpeakerModeDial',
'SpeakerModeOff',
'SpeakerModeOn',
'SpeakerModeSetup',
'SpeakerVolumeHigh',
'SpeakerVolumeInfo',
'SpeakerVolumeLow',
'SpeakerVolumeMed',
'Status',
'StatusInfo',
'StringFormat',
'SupportsCallback',
'SupportsSynchronousConnect',
'SystemCreationClassName',
'SystemName',
'Terminator',
'TimeOfLastReset',
'Tone',
'VoiceSwitchFeature'
Get-CimInstance -ClassName Win32_POTSModem | 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_POTSModem -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_POTSModem -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 ModulationBell, CompatibilityFlags, ModemInfSection, SpeakerVolumeLow FROM Win32_POTSModem 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 ModulationBell, CompatibilityFlags, ModemInfSection, SpeakerVolumeLow FROM Win32_POTSModem WHERE Caption LIKE 'a%'" | Select-Object -Property ModulationBell, CompatibilityFlags, ModemInfSection, SpeakerVolumeLow
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_POTSModem -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_POTSModem -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_POTSModem, 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_POTSModem was introduced on clients with Windows Vista and on servers with Windows Server 2008.
Namespace
Win32_POTSModem 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_POTSModem 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