community.windows.win_iis_virtualdirectory (2.2.0) — module

Configures a virtual directory in IIS

Authors: Henrik Wallström (@henrikwallstrom)

Install collection

Install with ansible-galaxy collection install community.windows:==2.2.0


Add to requirements.yml

  collections:
    - name: community.windows
      version: 2.2.0

Description

Creates, Removes and configures a virtual directory in IIS.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Remove a virtual directory if it exists
  community.windows.win_iis_virtualdirectory:
    name: somedirectory
    site: somesite
    state: absent
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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

Inputs

    
name:
    description:
    - The name of the virtual directory to create or remove.
    required: true
    type: str

site:
    description:
    - The site name under which the virtual directory is created or exists.
    required: true
    type: str

state:
    choices:
    - absent
    - present
    default: present
    description:
    - Whether to add or remove the specified virtual directory.
    - Removing will remove the virtual directory and all under it (Recursively).
    type: str

password:
    description:
    - The password associated with I(username).
    - Required when I(connect_as) is set to C(specific_user).
    type: str
    version_added: 1.9.0
    version_added_collection: community.windows

username:
    description:
    - Specifies the user name of an account that can access configuration files and content
      for the virtual directory.
    - Required when I(connect_as) is set to C(specific_user).
    type: str
    version_added: 1.9.0
    version_added_collection: community.windows

connect_as:
    choices:
    - pass_through
    - specific_user
    description:
    - The type of authentication to use for the virtual directory. Either C(pass_through)
      or C(specific_user)
    - If C(pass_through), IIS will use the identity of the user or application pool identity
      to access the physical path.
    - If C(specific_user), IIS will use the credentials provided in I(username) and I(password)
      to access the physical path.
    type: str
    version_added: 1.9.0
    version_added_collection: community.windows

application:
    description:
    - The application under which the virtual directory is created or exists.
    type: str

physical_path:
    description:
    - The physical path to the folder in which the new virtual directory is created.
    - The specified folder must already exist.
    type: str

See also