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_username | нет | Имя пользователя для взаимодействия с AD. Если не указано, используется пользователь Ansible, с помощью которого выполняется вход. | ||
| ignore_protection | нет | нет |
| Игнорирует флаг ProtectedFromAccidentalDeletion при удалении или перемещении группы.Модуль завершится ошибкой, если требуется одно из этих действий, а значение установлено в «нет». |
| managed_by | нет | Значение, которое нужно назначить атрибуту LDAP managedBy. Это значение может иметь вид Distinguished Name, objectGUID, objectSid или sAMAccountName, см. примеры для получения дополнительной информации. | ||
| name | да | Имя группы для создания, изменения или удаления. Это значение может иметь вид Distinguished Name, objectGUID, objectSid или sAMAccountName, см. примеры для получения дополнительной информации. | ||
| organizational_unit | нет | Полный путь LDAP для создания или перемещения группы. Это должен быть путь к родительскому объекту для создания или перемещения группы. См. примеры для получения подробной информации о формировании этого пути. псевдонимы: ou, путь | ||
| protect | нет |
| Установит флаг ProtectedFromAccidentalDeletion в зависимости от этого значения.Этот флаг предотвращает удаление или перемещение группы в другой путь пользователем. | |
| scope | нет |
| Область действия группы. Если state=present и группа не существует, это значение должно быть задано. | |
| state | нет | present |
| Если state=present этот модуль обеспечит создание и соответствующую конфигурацию группы.Если state=absent этот модуль удалит группу, если она существует. |
Примеры
- 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
Возвращаемые значения
Общие возвращаемые значения описаны здесь Возвращаемые значения, следующие поля уникальны для этого модуля:
| имя | описание | возвращается | тип | пример |
|---|---|---|---|---|
| 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 | Идентификатор группы. | группа существует | строка | 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 |
Примечания
Примечание
- Этот модуль должен выполняться на узле, на котором установлен модуль ActiveDirectory PowerShell.
Состояние
Этот модуль помечен как бета-версия, что означает, что он не гарантирует обратной совместимости интерфейса.
Для получения помощи в разработке модулей, если вы так решите, прочитайте Справочная информация по сообществу и участие в разработке, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/win_domain_group_module.html