win_domain_group - создаёт, изменяет или удаляет группы домена
Новая версия с 2.4.
Обзор
- Создаёт, изменяет или удаляет группы в Active Directory.
- Для локальных групп используйте модуль win_group.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| attributes | Словарь пользовательских атрибутов LDAP для настройки группы. Может использоваться для настройки пользовательских атрибутов, которые не доступны как параметры модуля, например mail. Примеры форматирования этого параметра см. в примерах. | |
| category |
| Категория группы, это значение для атрибута LDAP groupType. Если создаётся новая группа, по умолчанию будет использовано security. |
| description | Значение для атрибута LDAP description. | |
| display_name | Значение для атрибута LDAP displayName. | |
| domain_password | Пароль для username. | |
| domain_server (добавлено в 2.5) | Указывает экземпляр служб Active Directory Domain Services для подключения. Может быть в формате FQDN или NetBIOS-имени. Если не указано, значение основано на домене компьютера, на котором выполняется PowerShell. | |
| domain_username | Имя пользователя для взаимодействия с AD. Если не задано, используется пользователь, с которым Ansible вошёл в систему. | |
| ignore_protection |
| Игнорирует флаг ProtectedFromAccidentalDeletion, при удалении или перемещении группы.Модуль завершится ошибкой, если необходимо выполнить одно из этих действий, а значение равно no. |
| managed_by | Значение для атрибута LDAP managedBy. Это значение может быть в форматах Distinguished Name, objectGUID, objectSid или sAMAccountName, см. примеры для получения дополнительной информации. | |
| name обязательно | Имя группы для создания, изменения или удаления. Это значение может быть в форматах Distinguished Name, objectGUID, objectSid или sAMAccountName, см. примеры для получения дополнительной информации. | |
| organizational_unit | Полный путь LDAP для создания или перемещения группы. Должен быть путь к родительскому объекту для создания или перемещения группы. См. примеры для получения подробностей о формировании этого пути. псевдонимы: ou, path | |
| protect |
| Установит флаг ProtectedFromAccidentalDeletion в зависимости от этого значения.Этот флаг предотвращает удаление или перемещение группы в другой путь пользователем. |
| scope |
| Диапазон действия группы. Если state=present и группа не существует, это значение должно быть задано. |
| state |
| Если state=present, этот модуль обеспечит создание и настройку группы в соответствии с требованиями.Если state=absent, этот модуль удалит группу, если она существует. |
Примечания
Примечание
- Этот модуль должен выполняться на хосте с установленным модулем ActiveDirectory PowerShell.
Примеры
- name: ensure the group Cow exists using sAMAccountName
win_domain_group:
name: Cow
scope: global
path: OU=groups,DC=ansible,DC=local
- name: ensure the group Cow does't exist using the Distinguished Name
win_domain_group:
name: CN=Cow,OU=groups,DC=ansible,DC=local
state: absent
- name: delete group ignoring the protection flag
win_domain_group:
name: Cow
state: absent
ignore_protection: yes
- name: create group with delete protection enabled and custom attributes
win_domain_group:
name: Ansible Users
scope: domainlocal
category: security
attributes:
mail: helpdesk@ansible.com
wWWHomePage: www.ansible.com
ignore_protection: yes
- name: change the OU of a group using the SID and ignore the protection flag
win_domain_group:
name: S-1-5-21-2171456218-3732823212-122182344-1189
scope: global
organizational_unit: OU=groups,DC=ansible,DC=local
ignore_protection: True
- name: add managed_by user
win_domain_group:
name: Group Name Here
managed_by: Domain Admins
- name: add group and specify the AD domain services to use for the create
win_domain_group:
name: Test Group
domain_username: user@CORP.ANSIBLE.COM
domain_password: Password01!
domain_server: corp-DC12.corp.ansible.com
scope: domainlocal
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| attributes словарь | группа существует и атрибуты установлены при вызове модуля | Пользовательские атрибуты, которые были установлены модулем. Это не все пользовательские атрибуты, а только те, которые были установлены модулем. Пример: {'mail': 'helpdesk@ansible.com', 'wWWHomePage': 'www.ansible.com'} |
| canonical_name строка | группа существует | Каноническое имя группы. Пример: ansible.local/groups/Cow |
| category строка | группа существует | Значение типа группы, например "Безопасность" или "Распределение". Пример: Безопасность |
| description строка | группа существует | Описание группы. Пример: Описание группы |
| display_name строка | группа существует | Отображаемое имя группы. Пример: Пользователи, подключающиеся через RDP |
| distinguished_name строка | группа существует | Полное имя различения группы. Пример: CN=Cow,OU=groups,DC=ansible,DC=local |
| group_scope строка | группа существует | Значение области действия группы. Пример: Универсальный |
| guid строка | группа существует | Идентификатор GUID группы. Пример: 512a9adb-3fc0-4a26-9df0-e6ea1740cf45 |
| managed_by строка | группа существует | Полное имя различения объекта AD, заданного в атрибуте managedBy. Пример: CN=Domain Admins,CN=Users,DC=ansible,DC=local |
| name строка | группа существует | Имя группы. Пример: Cow |
| protected_from_accidental_deletion логический | группа существует | Защищена ли группа от случайного удаления. Пример: True |
| sid строка | группа существует | Идентификатор безопасности группы. Пример: S-1-5-21-2171456218-3732823212-122182344-1189 |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантирует обратную совместимость.
Автор
- Jordan Borean (@jborean93)
Подсказка
Если вы заметите какие-либо проблемы в этом руководстве, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/modules/win_domain_group_module.html
