Documentation

win_iis_website - Configures a IIS Web site

New in version 2.0.

Synopsis

  • Creates, Removes and configures a IIS Web site.

Parameters

Parameter Choices/Defaults Comments
application_pool
The application pool in which the new site executes.
hostname
The host header to bind to / use for the new site.
ip
The IP address to bind to / use for the new site.
name
required
Names of web site.
parameters
Custom site Parameters from string where properties are separated by a pipe and property name/values by colon Ex. "foo:1|bar:2"
physical_path
The physical path on the remote host to use for the new site.
The specified folder must already exist.
port
The port to bind to / use for the new site.
site_id
(added in 2.1)
Explicitly set the IIS numeric ID for a site.
Note that this value cannot be changed after the website has been created.
ssl
Enables HTTPS binding on the site..
state
    Choices:
  • absent
  • started
  • stopped
  • restarted
State of the web site

Examples

# Start a website

- name: Acme IIS site
  win_iis_website:
    name: Acme
    state: started
    port: 80
    ip: 127.0.0.1
    hostname: acme.local
    application_pool: acme
    physical_path: C:\sites\acme
    parameters: logfile.directory:C:\sites\logs
  register: website

# Remove Default Web Site and the standard port 80 binding
- name: Remove Default Web Site
  win_iis_website:
    name: "Default Web Site"
    state: absent

# Some commandline examples:

# This return information about an existing host
# $ ansible -i vagrant-inventory -m win_iis_website -a "name='Default Web Site'" window
# host | success >> {
#     "changed": false,
#     "site": {
#         "ApplicationPool": "DefaultAppPool",
#         "Bindings": [
#             "*:80:"
#         ],
#         "ID": 1,
#         "Name": "Default Web Site",
#         "PhysicalPath": "%SystemDrive%\\inetpub\\wwwroot",
#         "State": "Stopped"
#     }
# }

# This stops an existing site.
# $ ansible -i hosts -m win_iis_website -a "name='Default Web Site' state=stopped" host

# This creates a new site.
# $ ansible -i hosts -m win_iis_website -a "name=acme physical_path=C:\\sites\\acme" host

# Change logfile.
# $ ansible -i hosts -m win_iis_website -a "name=acme physical_path=C:\\sites\\acme" host

Status

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

Maintenance

This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by the Ansible Community, see here.

Author

  • Henrik Wallström

Hint

If you notice any issues in this documentation you can edit this document to improve it.