Get Windows Optional Features

This object returns a list of the windows optional features and their installation status.

The Get Windows Optional Features object does not work on all operating systems due to restrictions in the installation capabilities of the features.

Privileges

Normal

Input Parameters

Name	Type	Required	Description
Feature name	String	Yes	The name of the optional feature. This is different from the display name of the feature. If uncertain, enter a partial name with a wildcard. To show all features, enter '*' .
Installation State	String	Yes	The installation state of the feature. 'Enabled' and 'Disabled' are the common sates. Other possible states are (depends on whether the feature is being installed or uninstalled): Disable Pending Disabled With Payload Removed Enable Pending Superseded

Name

Type

Required

Description

Feature name

String

Yes

The name of the optional feature.

This is different from the display name of the feature. If uncertain, enter a partial name with a wildcard. To show all features, enter '*' .

Installation State

String

Yes

The installation state of the feature.

'Enabled' and 'Disabled' are the common sates. Other possible states are (depends on whether the feature is being installed or uninstalled):

Disable Pending
Disabled With Payload Removed
Enable Pending
Superseded

Output Parameters

Name

Type

Description

Feature List

Collection

A list of the optional features returned by the object.

Item	Type	Example
FeatureName	String	NFS-Administration
State	String	Enabled
RestartNeeded	Boolean	True

Feature Count

Number

The number of features found with the search criteria used.

Feature name

String

The name of the optional feature.

This variable is only populated if there is one row returned. If there are multiple rows, use the array.

State

String

The installation state of the feature.

'Enabled' and 'Disabled' are the common sates. Other possible states are (depending if the feature is being installed or uninstalled):

Disable Pending
Disabled With Payload Removed
Enable Pending
Superseded

Restart Needed

String

Returns a value of True if a restart is needed after installation or uninstallation of the feature, and will return a value of False if no restart is needed.

Result

Number

Returns a success value of zero or any value other than zero to indicate failure.

Result String

String

Object execution error details.

Example Input Parameters

Name	Type	Required	Example
Feature name	String	Yes	NFS-Administration, NFS,
Installation State	String	Yes	Enabled