ansible.builtin.win_mapped_drive (v2.5.15) — module

Install Ansible via pip

Install with pip install ansible==2.5.15

Description

Allows you to modify mapped network drives for individual users.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: create a mapped drive under Z
  win_mapped_drive:
    letter: Z
    path: \\domain\appdata\accounting

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: delete any mapped drives under Z
  win_mapped_drive:
    letter: Z
    state: absent

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: only delete the mapped drive Z if the paths match (error is thrown otherwise)
  win_mapped_drive:
    letter: Z
    path: \\domain\appdata\accounting
    state: absent

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: create mapped drive with local credentials
  win_mapped_drive:
    letter: M
    path: \\SERVER\c$
    username: SERVER\Administrator
    password: Password

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: create mapped drive with domain credentials
  win_mapped_drive:
    letter: M
    path: \\domain\appdata\it
    username: DOMAIN\IT
    password: Password

Inputs

    
path:
    description:
    - The UNC path to map the drive to.
    - This is required if C(state=present).
    - If C(state=absent) and path is not set, the module will delete the mapped drive
      regardless of the target.
    - If C(state=absent) and the path is set, the module will throw an error if path does
      not match the target of the mapped drive.

state:
    choices:
    - absent
    - present
    default: present
    description:
    - If C(state=present) will ensure the mapped drive exists.
    - If C(state=absent) will ensure the mapped drive does not exist.

letter:
    description:
    - The letter of the network path to map to.
    - This letter must not already be in use with Windows.
    required: true

password:
    description:
    - The password for C(username).

username:
    description:
    - Credentials to map the drive with.
    - The username MUST include the domain or servername like SERVER\user, see the example
      for more information.