Skip to content

Latest commit

 

History

History
279 lines (246 loc) · 10.8 KB

community.windows.win_iis_webapplication_module.rst

File metadata and controls

279 lines (246 loc) · 10.8 KB
Raw

community.windows.win_iis_webapplication

Configures IIS web applications

Synopsis

  • Creates, removes, and configures IIS web applications.

Parameters

Parameter Choices/Defaults 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
    Choices:
  • pass_through
  • specific_user
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.
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
    Choices:
  • absent
  • present ←
State of the web application.
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

.. seealso::

   :ref:`community.windows.win_iis_virtualdirectory_module`
      The official documentation on the **community.windows.win_iis_virtualdirectory** module.
   :ref:`community.windows.win_iis_webapppool_module`
      The official documentation on the **community.windows.win_iis_webapppool** module.
   :ref:`community.windows.win_iis_webbinding_module`
      The official documentation on the **community.windows.win_iis_webbinding** module.
   :ref:`community.windows.win_iis_website_module`
      The official documentation on the **community.windows.win_iis_website** module.

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 Returned Description
application_pool
string
success
The used/implemented application_pool value.

Sample:
DefaultAppPool
connect_as
string
when the application exists
How IIS will try to authenticate to the physical_path.

Sample:
specific_user
physical_path
string
success
The used/implemented physical_path value.

Sample:
C:\apps\acme\api


Status

Authors

  • Henrik Wallström (@henrikwallstrom)