Documentation

win_feature - Installs and uninstalls Windows Features on Windows Server

New in version 1.7.

Synopsis

  • Installs or uninstalls Windows Roles or Features on Windows Server. This module uses the Add/Remove-WindowsFeature Cmdlets on Windows 2008 and Install/Uninstall-WindowsFeature Cmdlets on Windows 2012, which are not available on client os machines.

Options

parameter required default choices comments
include_management_tools
 no
  • True
  • False
Adds the corresponding management tools to the specified feature.
Not supported in Windows 2008. If present when using Windows 2008 this option will be ignored.
include_sub_features
 no
  • True
  • False
Adds all subfeatures of the specified feature
name
 yes
Names of roles or features to install as a single feature or a comma-separated list of features
restart
 no
  • True
  • False
Restarts the computer automatically when installation is complete, if restarting is required by the roles or features installed.
DEPRECATED in Ansible 2.4, as unmanaged reboots cause numerous issues under Ansible. Check the reboot_required return value from this module to determine if a reboot is necessary, and if so, use the win_reboot action to perform it.
source
(added in 2.1)
 no
  • {driveletter}:\sources\sxs
  • {IP}\Share\sources\sxs
Specify a source to install the feature from.
Not supported in Windows 2008. If present when using Windows 2008 this option will be ignored.
state
 no present
  • present
  • absent
State of the features or roles on the system

Examples

- name: Install IIS (Web-Server only)
  win_feature:
    name: Web-Server
    state: present

- name: Install IIS (Web-Server and Web-Common-Http)
  win_feature:
    name: Web-Server,Web-Common-Http
    state: present

- name: Install NET-Framework-Core from file
  win_feature:
    name: NET-Framework-Core
    source: C:\Temp\iso\sources\sxs
    state: present

- name: Install IIS Web-Server with sub features and management tools
  win_feature:
    name: Web-Server
    state: present
    include_sub_features: True
    include_management_tools: True
  register: win_feature

- name: reboot if installing Web-Server feature requires it
  win_reboot:
  when: win_feature.reboot_required

Return Values

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

name description returned type sample
exitcode
The stringified exit code from the feature installation/removal command
 always string Success
feature_result
List of features that were installed or removed
 success complex None
contains:
name description returned type sample
display_name
Feature display name
 always string Telnet Client
restart_needed
DEPRECATED in Ansible 2.4 (refer to reboot_required instead). True when the target server requires a reboot as a result of installing or removing this feature
 always boolean True
success
If the feature installation or removal was successful
 always boolean True
skip_reason
The reason a feature installation or removal was skipped
 always string NotSkipped
message
Any messages returned from the feature subsystem that occurred during installation or removal of this feature
 always list of strings []
id
A list of KB article IDs that apply to the update
 always int 44
reboot_required
True when the target server requires a reboot as a result of installing or removing this feature
 always boolean True
reboot_required
True when the target server requires a reboot to complete updates (no further updates can be installed until after a reboot)
 success boolean True
restart_needed
DEPRECATED in Ansible 2.4 (refer to reboot_required instead). True when the target server requires a reboot to complete updates (no further updates can be installed until after a reboot)
 success boolean True


Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.