community.windows.win_iis_virtualdirectory – Configures a virtual directory in IIS
Note
This plugin is part of the community.windows collection (version 1.7.0).
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_virtualdirectory.
Synopsis
- Creates, Removes and configures a virtual directory in IIS.
Parameters
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| application
string
|
The application under which the virtual directory is created or exists.
|
|
| name
string / required
|
The name of the virtual directory to create or remove.
|
|
| 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).
|
See Also
See also
- community.windows.win_iis_webapplication
-
The official documentation on the community.windows.win_iis_webapplication module.
- community.windows.win_iis_webapppool
-
The official documentation on the community.windows.win_iis_webapppool module.
- community.windows.win_iis_webbinding
-
The official documentation on the community.windows.win_iis_webbinding module.
- community.windows.win_iis_website
-
The official documentation on the community.windows.win_iis_website module.
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)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/windows/win_iis_virtualdirectory_module.html