You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

community.windows.win_iis_webapplication module – Configures IIS web applications

Note

This module is part of the community.windows collection (version 1.11.1).

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 community.windows.

To use it in a playbook, specify: community.windows.win_iis_webapplication.

Synopsis

• Creates, removes, and configures IIS web applications.

Parameters

Parameter	Comments
application_pool string	The application pool in which the new site executes. If not specified, the application pool of the current website will be used.
connect_as string	The type of authentication to use for this application. Either pass_through or specific_user If pass_through, IIS will use the identity of the user or application pool identity to access the file system or network. If specific_user, IIS will use the credentials provided in username and password to access the file system or network. Choices: "pass_through" "specific_user"
name string / required	Name of the web application.
password string	The password associated with username. Required when connect_as is set to specific_user.
physical_path string	The physical path on the remote host to use for the new application. The specified folder must already exist.
site string / required	Name of the site on which the application is created.
state string	State of the web application. Choices: "absent" "present" ← (default)
username string	Specifies the user name of an account that can access configuration files and content for this application. Required when connect_as is set to specific_user.

See Also

See also

community.windows.win_iis_virtualdirectory

Configures a virtual directory in IIS.

community.windows.win_iis_webapppool

Configure IIS Web Application Pools.

community.windows.win_iis_webbinding

Configures a IIS Web site binding.

community.windows.win_iis_website

Configures a IIS Web site.

Examples

- name: Add ACME webapplication on IIS.
  community.windows.win_iis_webapplication:
    name: api
    site: acme
    state: present
    physical_path: C:\apps\acme\api

Return Values

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

Key	Description
application_pool string	The used/implemented application_pool value. Returned: success Sample: "DefaultAppPool"
connect_as string	How IIS will try to authenticate to the physical_path. Returned: when the application exists Sample: "specific_user"
physical_path string	The used/implemented physical_path value. Returned: success Sample: "C:\\apps\\acme\\api"

Authors

• Henrik Wallström (@henrikwallstrom)

Collection links

Issue Tracker Repository (Sources) Communication