Модуль ansible.windows.win_share — управление общими ресурсами Windows

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install ansible.windows. Для использования этого модуля могут потребоваться дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать его в плейбуке, укажите: ansible.windows.win_share.

Краткое описание
Требования
Параметры
Примеры
Возвращаемые значения

Краткое описание

Добавление, изменение или удаление общего ресурса Windows и настройка его разрешений.

Следующие требования должны быть выполнены на узле, на котором выполняется этот модуль.

Поскольку в этом модуле используются более новые командлеты, например New-SmbShare, он может выполняться только в Windows 8 / Windows 2012 или более новых версиях.
Это связано с зависимостью от поставщика WMI MSFT_SmbShare https://msdn.microsoft.com/en-us/library/hh830471, который появился только в этих выпусках Windows.

Параметры

Параметр	Комментарии
caching_mode string	Задаёт CachingMode для этого общего ресурса. Допустимые значения: `"BranchCache"` `"Documents"` `"Manual"` ← (по умолчанию) `"None"` `"Programs"` `"Unknown"`
change string	Список пользователей, которым следует предоставить права на чтение и запись для общего ресурса; разделяйте значения запятыми.
deny string	Список пользователей, которым не следует предоставлять доступ независимо от подразумеваемых разрешений для общего ресурса; разделяйте значения запятыми.
description string	Описание общего ресурса.
encrypt boolean	Определяет, следует ли шифровать трафик к общему ресурсу. Допустимые значения: `false` ← (по умолчанию) `true`
full string	Список пользователей, которым следует предоставить полный доступ к общему ресурсу; разделяйте значения запятыми.
list boolean	Определяет, разрешать или запрещать просмотр списка файлов, если у пользователя нет разрешений на общий ресурс. Также называется перечислением на основе доступа (Access-Based Enumeration). Допустимые значения: `false` ← (по умолчанию) `true`
name string / обязательный	Имя общего ресурса.
path path / обязательный	Каталог общего ресурса.
read string	Список пользователей, которым следует предоставить права на чтение общего ресурса; разделяйте значения запятыми.
rule_action string	Определяет, добавлять или задавать (заменять) записи управления доступом. Допустимые значения: `"set"` ← (по умолчанию) `"add"`
scope_name string добавлено в ansible.windows 2.2.0	Задаёт имя области действия общего ресурса. Используется с ресурсами файлового сервера кластера аварийного переключения Windows Server. Если задано это значение, path должен находиться на общем томе или диске кластера.
state string	Определяет, следует ли добавить `present` или удалить `absent` указанный общий ресурс. Допустимые значения: `"absent"` `"present"` ← (по умолчанию)

Примеры

- name: Add secret share
  ansible.windows.win_share:
    name: internal
    description: top secret share
    path: C:\shares\internal
    list: false
    full: Administrators,CEO
    read: HR-Global
    deny: HR-External

- name: Add public company share
  ansible.windows.win_share:
    name: company
    description: top secret share
    path: C:\shares\company
    list: true
    full: Administrators,CEO
    read: Global

- name: Add failover cluster role share
  ansible.windows.win_share:
    name: backups
    scope_name: FCMSSQL01
    description: SQL Backups
    path: E:\sqlbackup
    list: true
    full: svc.mssql
    read: Global

- name: Remove previously added share
  ansible.windows.win_share:
    name: internal
    state: absent

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:

Ключ	Описание
actions list / элементы=string	Список командлетов действий, выполненных модулем. Возвращается: success Пример: `["New-SmbShare -Name share -Path C:\\temp"]`

Авторы

Hans-Joachim Kliemeck (@h0nIg)
David Baumann (@daBONDi)
Shachaf Goldstein (@Shachaf92)
Joe Zollo (@zollo)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/ansible/windows/win_share_module.html