Ansible Collections Documentation

community.windows.win_iis_virtualdirectory module – Configures a virtual directory in IIS

Note

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

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_virtualdirectory.

Synopsis 

Creates, Removes and configures a virtual directory in IIS.

Parameters 

Parameter	Comments
application string	The application under which the virtual directory is created or exists.
connect_as string added in community.windows 1.9.0	The type of authentication to use for the virtual directory. Either `pass_through` or `specific_user` If `pass_through`, IIS will use the identity of the user or application pool identity to access the physical path. If `specific_user`, IIS will use the credentials provided in username and password to access the physical path. Choices: `"pass_through"` `"specific_user"`
name string / required	The name of the virtual directory to create or remove.
password string added in community.windows 1.9.0	The password associated with username. Required when connect_as is set to `specific_user`.
physical_path string	The physical path to the folder in which the new virtual directory is created. The specified folder must already exist.
site string / required	The site name under which the virtual directory is created or exists.
state string	Whether to add or remove the specified virtual directory. Removing will remove the virtual directory and all under it (Recursively). Choices: `"absent"` `"present"` ← (default)
username string added in community.windows 1.9.0	Specifies the user name of an account that can access configuration files and content for the virtual directory. Required when connect_as is set to `specific_user`.

See Also 

See also

community.windows.win_iis_webapplication: Configures IIS web applications.
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: Create a virtual directory if it does not exist
  community.windows.win_iis_virtualdirectory:
    name: somedirectory
    site: somesite
    state: present
    physical_path: C:\virtualdirectory\some

- name: Remove a virtual directory if it exists
  community.windows.win_iis_virtualdirectory:
    name: somedirectory
    site: somesite
    state: absent

- name: Create a virtual directory on an application if it does not exist
  community.windows.win_iis_virtualdirectory:
    name: somedirectory
    site: somesite
    application: someapp
    state: present
    physical_path: C:\virtualdirectory\some

Authors

Henrik Wallström (@henrikwallstrom)

Collection links