Represents the status of the optional features that are present on the operating system.
Methods
Win32_OptionalFeature has no methods.
Properties
Win32_OptionalFeature returns 6 properties:
'Caption','Description','InstallDate','InstallState','Name','Status'
Unless explicitly marked as writeable, all properties are read-only.
Caption
An optional feature display name.
Description
A textual description of the object.
InstallDate
Indicates when the object was installed. Lack of a value does not indicate that the object is not installed.
InstallState
Identifies the state of the optional feature. The following states are possible:
InstallState returns a numeric value. To translate it into a meaningful text, use any of the following approaches:
Use a PowerShell Hashtable
$InstallState_map = @{
1 = 'Enabled'
2 = 'Disabled'
3 = 'Absent'
4 = 'Unknown'
}
Use a switch statement
switch([int]$value)
{
1 {'Enabled'}
2 {'Disabled'}
3 {'Absent'}
4 {'Unknown'}
default {"$value"}
}
Use Enum structure
Enum EnumInstallState
{
Enabled = 1
Disabled = 2
Absent = 3
Unknown = 4
}
Examples
Use $InstallState_map in a calculated property for Select-Object
<#
this example uses a hashtable to translate raw numeric values for
property "InstallState" to friendly text
Note: to use other properties than "InstallState", 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 "InstallState"
# to translate other properties, use their translation table instead
$InstallState_map = @{
1 = 'Enabled'
2 = 'Disabled'
3 = 'Absent'
4 = 'Unknown'
}
#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 "InstallState", 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:
#>
$InstallState = @{
Name = 'InstallState'
Expression = {
# property is an array, so process all values
$value = $_.InstallState)
$InstallState_map[[int]$value]
}
}
#endregion define calculated property
# retrieve the instances, and output the properties "Caption" and "InstallState". The latter
# is defined by the hashtable in $InstallState:
Get-CimInstance -Class Win32_OptionalFeature | Select-Object -Property Caption, $InstallState
# ...or dump content of property InstallState:
$friendlyValues = Get-CimInstance -Class Win32_OptionalFeature |
Select-Object -Property $InstallState |
Select-Object -ExpandProperty InstallState
# output values
$friendlyValues
# output values as comma separated list
$friendlyValues -join ', '
# output values as bullet list
$friendlyValues | ForEach-Object { "- $_" }
Use $InstallState_map to directly translate raw values from an instance
<#
this example uses a hashtable to manually translate raw numeric values
for property "Win32_OptionalFeature" to friendly text. This approach is ideal when
there is just one instance to work with.
Note: to use other properties than "Win32_OptionalFeature", 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_OptionalFeature"
# to translate other properties, use their translation table instead
$InstallState_map = @{
1 = 'Enabled'
2 = 'Disabled'
3 = 'Absent'
4 = 'Unknown'
}
#endregion define hashtable
# get one instance:
$instance = Get-CimInstance -Class Win32_OptionalFeature | 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.InstallState
# translate raw value to friendly text:
$friendlyName = $InstallState_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 "InstallState" 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 "InstallState", 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 "InstallState", 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:
#>
$InstallState = @{
Name = 'InstallState'
Expression = {
# property is an array, so process all values
$value = $_.BiosCharacteristics
switch([int]$value)
{
1 {'Enabled'}
2 {'Disabled'}
3 {'Absent'}
4 {'Unknown'}
default {"$value"}
}
}
}
#endregion define calculated property
# retrieve all instances...
Get-CimInstance -ClassName Win32_OptionalFeature |
# ...and output properties "Caption" and "InstallState". The latter is defined
# by the hashtable in $InstallState:
Select-Object -Property Caption, $InstallState
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_OptionalFeature", look up the appropriate
enum definition for the property you would like to use instead.
#>
#region define enum with value-to-text translation:
Enum EnumInstallState
{
Enabled = 1
Disabled = 2
Absent = 3
Unknown = 4
}
#endregion define enum
# get one instance:
$instance = Get-CimInstance -Class Win32_OptionalFeature | 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.InstallState
#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 **InstallState**
[EnumInstallState]$rawValue
# get a comma-separated string:
[EnumInstallState]$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 [EnumInstallState]
#endregion
Enums must cover all possible values. If InstallState 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
KEY PROPERTY STRING MAX 260 CHAR
Represents the name of the optional feature.
Status
String that indicates the current status of the object. Operational and non-operational status can be defined. Operational status can include “OK”, “Degraded”, and “Pred Fail”. “Pred Fail” indicates that an element is functioning properly, but is predicting a failure (for example, a SMART-enabled hard disk drive).
Non-operational status can include “Error”, “Starting”, “Stopping”, and “Service”. “Service” can apply during disk mirror-resilvering, reloading a user permissions list, or other administrative work. Not all such work is online, but the managed element is neither “OK” nor in one of the other states.
Values include the following:
OK (“OK”)
Error (“Error”)
Degraded (“Degraded”)
Unknown (“Unknown”)
Pred Fail (“Pred Fail”)
Starting (“Starting”)
Stopping (“Stopping”)
Service (“Service”)
Stressed (“Stressed”)
NonRecover (“NonRecover”)
No Contact (“No Contact”)
Lost Comm (“Lost Comm”)
Examples
List all instances of Win32_OptionalFeature
Get-CimInstance -ClassName Win32_OptionalFeature
Learn more about Get-CimInstance
and the deprecated Get-WmiObject
.
View all properties
Get-CimInstance -ClassName Win32_OptionalFeature -Property *
View key properties only
Get-CimInstance -ClassName Win32_OptionalFeature -Property *
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 = 'Caption',
'Description',
'InstallDate',
'InstallState',
'Name',
'Status'
Get-CimInstance -ClassName Win32_OptionalFeature | 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_OptionalFeature -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_OptionalFeature -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 InstallDate, Status, InstallState, Description FROM Win32_OptionalFeature WHERE Caption LIKE 'a%'"
Any property you did not specify is still present but empty. You might need to use Select-Object to remove all unwanted properties:
Get-CimInstance -Query "SELECT InstallDate, Status, InstallState, Description FROM Win32_OptionalFeature WHERE Caption LIKE 'a%'" | Select-Object -Property InstallDate, Status, InstallState, Description
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_OptionalFeature -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_OptionalFeature -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.
More Examples
Visit the Example Page for more examples.
Requirements
To use Win32_OptionalFeature, 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_OptionalFeature was introduced on clients with Windows 7 and on servers with Windows Server 2008 R2.
Namespace
Win32_OptionalFeature 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_OptionalFeature 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