community.windows.win_mapped_drive – Настройка сетевых дисков для пользователей

Примечание

Этот плагин входит в сборку community.windows (версия 1.2.0).

Для его установки используйте: ansible-galaxy collection install community.windows.

Для использования в книге задач укажите: community.windows.win_mapped_drive.

Обзор
Параметры
Примечания
См. также
Примеры

Обзор

Позволяет изменять сопоставленные сетевые диски для отдельных пользователей.
Также поддерживает WebDAV-точки в формате UNC.

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
letter строка / обязательно		Буква сетевого пути для сопоставления. Эта буква не должна уже использоваться в Windows.
password строка		Пароль для `username` при проверке начального подключения. Он никогда не сохраняется с сопоставленным диском. Используйте модуль community.windows.win_credential для сохранения имени пользователя и пароля для хоста.
path путь		UNC-путь для сопоставления диска. Если указан WebDAV-путь, он должен быть в формате UNC-пути `\\hostname\path` , а не URL. Подробнее см. примеры. Для указания `https` WebDAV-пути добавьте `@SSL` после имени хоста. Для указания пользовательского порта WebDAV добавьте `@<port num>` после `@SSL` или части имени хоста в UNC-пути, например, `\\server@SSL@1234` или `\\server@1234`. Требуется, если `state=present`. Если `state=absent` и path не задан, модуль удалит сопоставленный диск независимо от целевого объекта. Если `state=absent` и path задан, модуль выдаст ошибку, если путь не совпадает с целевым объектом сопоставленного диска.
state строка	Варианты: absent present ←	Если `present` будет гарантировать существование сопоставленного диска. Если `absent` будет гарантировать отсутствие сопоставленного диска.
username строка		Имя пользователя, используемое при проверке начального подключения. Он никогда не сохраняется с сопоставленным диском. Используйте модуль community.windows.win_credential для сохранения имени пользователя и пароля для хоста. Требуется, если для сопоставленного диска требуется аутентификация с пользовательскими учетными данными и использование функции become или CredSSP невозможно. Если используется become или CredSSP, любые сохраненные учетные данные с community.windows.win_credential будут автоматически использованы вместо этого.

Примечания

Примечание

Этот модуль нельзя использовать для доступа к сопоставленному диску в другой задаче Ansible. Доступ к дискам, сопоставленным с помощью этого модуля, возможен только при интерактивном входе в систему пользователем через консоль или RDP.
Рекомендуется запускать этот модуль с функцией become или CredSSP, если удаленный путь требует аутентификации.
При использовании become или CredSSP задача получит доступ к любым локальным учетным данным, сохранённым в хранилище пользователя.
Если become или CredSSP недоступны, можно использовать параметры username и password для первоначальной аутентификации, но они не сохраняются.
Для сопоставления WebDAV-путей необходимо установить клиент WebDAV. Он установлен по умолчанию в настольных версиях Windows, но хосты Windows Server должны установить функцию WebDAV-Redirector, используя ansible.windows.win_feature.

См. также

community.windows.win_credential: Официальная документация по модулю community.windows.win_credential.

Примеры

- name: Create a mapped drive under Z
  community.windows.win_mapped_drive:
    letter: Z
    path: \\domain\appdata\accounting

- name: Delete any mapped drives under Z
  community.windows.win_mapped_drive:
    letter: Z
    state: absent

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

- name: Create mapped drive with credentials and save the username and password
  block:
  - name: Save the network credentials required for the mapped drive
    community.windows.win_credential:
      name: server
      type: domain_password
      username: username@DOMAIN
      secret: Password01
      state: present

  - name: Create a mapped drive that requires authentication
    community.windows.win_mapped_drive:
      letter: M
      path: \\SERVER\C$
      state: present
  vars:
    # become is required to save and retrieve the credentials in the tasks
    ansible_become: yes
    ansible_become_method: runas
    ansible_become_user: '{{ ansible_user }}'
    ansible_become_pass: '{{ ansible_password }}'

- name: Create mapped drive with credentials that do not persist on the next logon
  community.windows.win_mapped_drive:
    letter: M
    path: \\SERVER\C$
    state: present
    username: '{{ ansible_user }}'
    password: '{{ ansible_password }}'

# This should only be required for Windows Server OS'
- name: Ensure WebDAV client feature is installed
  ansible.windows.win_feature:
    name: WebDAV-Redirector
    state: present
  register: webdav_feature

- name: Reboot after installing WebDAV client feature
  ansible.windows.win_reboot:
  when: webdav_feature.reboot_required

- name: Map the HTTPS WebDAV location
  community.windows.win_mapped_drive:
    letter: W
    path: \\live.sysinternals.com@SSL\tools  # https://live.sysinternals.com/tools
    state: present

Авторы

Jordan Borean (@jborean93)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/windows/win_mapped_drive_module.html