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

Примечание

Этот модуль входит в коллекцию community.windows (версия 2.3.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: 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 строка	Если `present` будет гарантировать существование сопоставленного диска. Если `absent` будет гарантировать, что сопоставленный диск не существует. Варианты: `"absent"` `"present"` ← (по умолчанию)
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: Управление учетными данными Windows в диспетчере учетных данных.

Примеры

- 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: true
    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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/windows/win_mapped_drive_module.html