ansible.windows.win_group_membership – Управление членством в локальной группе Windows
Примечание
Этот плагин входит в состав коллекции ansible.windows (версия 1.3.0).
Для его установки используйте: ansible-galaxy collection install ansible.windows.
Чтобы использовать его в книге задач, укажите: ansible.windows.win_group_membership.
Описание
- Позволяет добавлять и удалять локальных, системных и доменных пользователей и доменных групп из локальной группы.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| members список / элементы=строка / обязательный | Список пользователей, которые должны быть добавлены/удалены из группы. Принимает локальных пользователей в формате .\имя_пользователя и SERVERNAME\имя_пользователя. Принимает доменных пользователей и группы в формате DOMAIN\имя_пользователя и имя_пользователя@DOMAIN. Принимает системных пользователей в формате NT AUTHORITY\имя_пользователя. Принимает все типы локальных, доменных и системных пользователей в формате имя_пользователя, отдавая предпочтение доменным поискам, если выполняется в домене. | |
| name строка / обязательный | Имя локальной группы, членство в которой нужно управлять. | |
| state строка |
| Желаемое состояние членов группы. Когда state равно 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
-
Официальная документация модуля 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
| Список добавленных членов, когда state равно present или pure; пусто, если члены не были добавлены.Пример: ['SERVERNAME\\NewLocalAdmin', 'DOMAIN\\TestUser'] |
| members список / элементы=строка | успех | Список всех членов локальной группы по завершении; пусто, если группа не содержит членов. Пример: ['DOMAIN\\TestUser', 'SERVERNAME\\NewLocalAdmin'] |
| name строка | всегда | Имя целевой локальной группы. Пример: Administrators |
| removed список / элементы=строка | успех и state равно absent
| Список удаленных членов, когда state равно absent или pure; пусто, если члены не были удалены.Пример: ['DOMAIN\\TestGroup', 'NT AUTHORITY\\SYSTEM'] |
Авторы
- Andrew Saraceni (@andrewsaraceni)
© 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/ansible/windows/win_group_membership_module.html