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 bool |
| Проигнорирует флаг ProtectedFromAccidentalDeletion, при удалении или перемещении группы.Модуль завершится ошибкой, если одно из этих действий необходимо выполнить, а это значение установлено в no. |
| managed_by | Значение, которое будет назначено атрибуту LDAP managedBy. Это значение может быть в форматах Distinguished Name, objectGUID, objectSid или sAMAccountName, см. примеры для получения более подробной информации. | |
| name обязательно | Имя группы для создания, изменения или удаления. Это значение может быть в форматах Distinguished Name, objectGUID, objectSid или sAMAccountName, см. примеры для получения более подробной информации. | |
| organizational_unit | Полный путь LDAP для создания или перемещения группы. Это должен быть путь к родительскому объекту для создания или перемещения группы. См. примеры для получения информации о формировании этого пути. псевдонимы: ou, path | |
| protect bool |
| Установит флаг 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: yes
- 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 dict | группа существует и атрибуты установлены при вызове модуля | Пользовательские атрибуты, которые были заданы модулем. Это не все пользовательские атрибуты, а только те, что были заданы модулем. Пример: {'mail': 'helpdesk@ansible.com', 'wWWHomePage': 'www.ansible.com'} |
| canonical_name строка | группа существует | Каноническое имя группы. Пример: ansible.local/groups/Cow |
| category строка | группа существует | Значение типа группы, например "Безопасность" или "Распределения". Пример: Безопасность |
| description строка | группа существует | Описание группы. Пример: Описание группы |
| display_name строка | группа существует | Отображаемое имя группы. Пример: Пользователи, подключающиеся через RDP |
| distinguished_name строка | группа существует | Полное имя группы в формате 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 строка | группа существует | Имя группы. Пример: Корова |
| protected_from_accidental_deletion bool | группа существует | Защищена ли группа от случайного удаления. Пример: True |
| sid строка | группа существует | Идентификатор безопасности (SID) группы. Пример: S-1-5-21-2171456218-3732823212-122182344-1189 |
Статус
Этот модуль помечен как превью, это означает, что его интерфейс не гарантирует обратную совместимость.
Техническое обслуживание
Этот модуль помечен как сообщество, это означает, что он поддерживается сообществом Ansible. Подробнее см. Техническое обслуживание и поддержка модулей.
Список других модулей, поддерживаемых сообществом Ansible, см. здесь.
Автор
- 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.6/modules/win_domain_group_module.html