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.
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
    restart: True
    include_sub_features: True
    include_management_tools: True

Status

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

Support

This module is community maintained without core committer oversight.

For more information on what this means please read Module Support

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