Модуль ansible.windows.win_group_membership – Управление членством в локальной группе Windows

Примечание

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

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

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

Для использования в плейбуке укажите: ansible.windows.win_group_membership.

Описание
Параметры
См. также
Примеры
Возвращаемые значения

Описание

Позволяет добавлять и удалять локальных, системных и доменных пользователей и доменных групп в локальную группу.

Параметры

Параметр	Комментарии
members список / элементы=строка / обязательно	Список членов, которых нужно добавить/удалить из группы. Принимает локальных пользователей как .\имя_пользователя и SERVERNAME\имя_пользователя. Принимает доменных пользователей и группы как DOMAIN\имя_пользователя и имя_пользователя@ДОМЕН. Принимает системных пользователей как NT AUTHORITY\имя_пользователя. Принимает все типы локальных, доменных и системных пользователей как имя_пользователя, отдавая предпочтение поиску в домене при наличии домена.
name строка / обязательно	Имя локальной группы, членство в которой нужно управлять.
state строка	Желаемое состояние членов в группе. Когда `state` равно `pure`, только указанные члены будут присутствовать, а все остальные существующие члены, не указанные в списке, будут удалены. Варианты: `"absent"` `"present"` ← (по умолчанию) `"pure"`

См. также

community.windows.win_domain_group: Создает, изменяет или удаляет доменные группы.
ansible.windows.win_domain_membership: Управление членством в домене/рабочей группе для хоста Windows.
ansible.windows.win_group: Добавление и удаление локальных групп.

Примеры

- name: Add a local and domain user to a local group
  ansible.windows.win_group_membership:
    name: Remote Desktop Users
    members:
      - NewLocalAdmin
      - DOMAIN\TestUser
    state: present

- name: Remove a domain group and service user from a local group
  ansible.windows.win_group_membership:
    name: Backup Operators
    members:
      - DOMAIN\TestGroup
      - NT AUTHORITY\SYSTEM
    state: absent

- name: Ensure only a domain user exists in a local group
  ansible.windows.win_group_membership:
    name: Remote Desktop Users
    members:
      - DOMAIN\TestUser
    state: pure

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

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

Ключ	Описание
added список / элементы=строка	Список членов, добавленных, когда `state` равно `present` или `pure`; пустой, если члены не добавлялись. Возвращается: успех и `state` равно `present` Пример: `["SERVERNAME\\NewLocalAdmin", "DOMAIN\\TestUser"]`
members список / элементы=строка	Список всех членов локальной группы после завершения; пустой, если группа не содержит членов. Возвращается: успех Пример: `["DOMAIN\\TestUser", "SERVERNAME\\NewLocalAdmin"]`
name строка	Имя целевой локальной группы. Возвращается: всегда Пример: `"Administrators"`
removed список / элементы=строка	Список членов, удаленных, когда `state` равно `absent` или `pure`; пустой, если члены не удалялись. Возвращается: успех и `state` равно `absent` Пример: `["DOMAIN\\TestGroup", "NT AUTHORITY\\SYSTEM"]`

Авторы

Andrew Saraceni (@andrewsaraceni)

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

© 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/ansible/windows/win_group_membership_module.html