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

Примечание

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

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

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

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

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

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

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

Параметры

Параметр	Комментарии
members list / elements=string / обязательный	Список участников, которые должны присутствовать в группе или отсутствовать в ней. Локальные пользователи указываются в формате .\username или SERVERNAME\username. Пользователи и группы домена указываются в формате DOMAIN\username или username@DOMAIN. Пользователи служб указываются в формате NT AUTHORITY\username. Для локальных пользователей, пользователей домена и пользователей служб можно указать только имя пользователя; если компьютер входит в домен, приоритет будет отдан поиску в домене.
name string / обязательный	Имя локальной группы, членством в которой нужно управлять.
state string	Требуемое состояние участников группы. Если `state` равно `pure`, в группе останутся только указанные участники, а все прочие участники будут удалены. Варианты: `"absent"` `"present"` ← (по умолчанию) `"pure"`

См. также

community.windows.win_domain_group: Официальная документация по модулю community.windows.win_domain_group.
ansible.windows.win_domain_membership: Официальная документация по модулю ansible.windows.win_domain_membership.
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 list / elements=string	Список участников, добавленных, когда `state` равно `present` или `pure`; если участники не добавлялись, список пуст. Возвращается: при успешном выполнении и если `state` равно `present` Пример: `["SERVERNAME\\NewLocalAdmin", "DOMAIN\\TestUser"]`
members list / elements=string	Список всех участников локальной группы после завершения выполнения; если в группе нет участников, список пуст. Возвращается: при успешном выполнении Пример: `["DOMAIN\\TestUser", "SERVERNAME\\NewLocalAdmin"]`
name string	Имя целевой локальной группы. Возвращается: всегда Пример: `"Administrators"`
removed list / elements=string	Список участников, удалённых, когда `state` равно `absent` или `pure`; если участники не удалялись, список пуст. Возвращается: при успешном выполнении и если `state` равно `absent` Пример: `["DOMAIN\\TestGroup", "NT AUTHORITY\\SYSTEM"]`

Авторы

Andrew Saraceni (@andrewsaraceni)

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

© 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_group_membership_module.html