ansible.windows.win_optional_feature module – Manage optional Windows features

Note

This module is part of the ansible.windows collection (version 1.12.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install ansible.windows.

To use it in a playbook, specify: ansible.windows.win_optional_feature.

Synopsis

  • Install or uninstall optional Windows features on non-Server Windows.

  • This module uses the Enable-WindowsOptionalFeature and Disable-WindowsOptionalFeature cmdlets.

Parameters

Parameter

Comments

include_parent

boolean

Whether to enable the parent feature and the parent’s dependencies.

Choices:

  • false ← (default)

  • true

name

list / elements=string / required

The name(s) of the feature to install.

This relates to FeatureName in the Powershell cmdlet.

To list all available features use the PowerShell command Get-WindowsOptionalFeature.

source

string

Specify a source to install the feature from.

Can either be {driveletter}:\sources\sxs or \\{IP}\share\sources\sxs.

state

string

Whether to ensure the feature is absent or present on the system.

Choices:

  • "absent"

  • "present" ← (default)

See Also

See also

chocolatey.chocolatey.win_chocolatey

The official documentation on the chocolatey.chocolatey.win_chocolatey module.

ansible.windows.win_feature

The official documentation on the ansible.windows.win_feature module.

ansible.windows.win_package

The official documentation on the ansible.windows.win_package module.

Examples

- name: Install .Net 3.5
  ansible.windows.win_optional_feature:
    name: NetFx3
    state: present

- name: Install .Net 3.5 from source
  ansible.windows.win_optional_feature:
    name: NetFx3
    source: \\share01\win10\sources\sxs
    state: present

- name: Install Microsoft Subsystem for Linux
  ansible.windows.win_optional_feature:
    name: Microsoft-Windows-Subsystem-Linux
    state: present
  register: wsl_status

- name: Reboot if installing Linux Subsytem as feature requires it
  ansible.windows.win_reboot:
  when: wsl_status.reboot_required

- name: Install multiple features in one task
  ansible.windows.win_optional_feature:
    name:
    - NetFx3
    - Microsoft-Windows-Subsystem-Linux
    state: present

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

reboot_required

boolean

True when the target server requires a reboot to complete updates

Returned: success

Sample: true

Authors

  • Carson Anderson (@rcanderson23)