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, к которому нужно подключиться. Может быть в формате 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, путь | |
| protect булево |
| Установит флаг ProtectedFromAccidentalDeletion в зависимости от этого значения.Этот флаг предотвращает удаление или перемещение группы в другой путь пользователем. |
| scope строка |
| Область действия группы. Если state=present, и группа не существует, то это значение должно быть установлено. |
| state строка |
| Если state=present, этот модуль обеспечит создание и соответствующую настройку группы.Если state=absent, этот модуль удалит группу, если она существует. |
Примечания
Примечание
- Это должно выполняться на узле, на котором установлен модуль Active Directory PowerShell.
См. также
См. также
- win_domain – Обеспечивает существование домена Windows
- Официальная документация по модулю win_domain.
- win_domain_controller – Управление состоянием контроллера домена/сервера-члена для узла Windows
- Официальная документация по модулю win_domain_controller.
- win_domain_computer – Управление компьютерами в Active Directory
- Официальная документация по модулю win_domain_computer.
- win_domain_membership – Управление членством в домене/рабочей группе для узла Windows
- Официальная документация по модулю win_domain_membership.
- win_domain_user – Управление учётными записями пользователей Windows Active Directory
- Официальная документация по модулю win_domain_user.
- win_group – Добавление и удаление локальных групп
- Официальная документация по модулю win_group.
- win_group_membership – Управление членством в локальных группах Windows
- Официальная документация по модулю win_group_membership.
Примеры
- 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 doesn'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 словарь | Группа существует и атрибуты установлены при вызове модуля | Пользовательские атрибуты, установленные модулем. Это не все пользовательские атрибуты, а только те, которые были установлены модулем. Пример: {'mail': 'helpdesk@ansible.com', 'wWWHomePage': 'www.ansible.com'} |
| canonical_name строка | Группа существует | Каноническое имя группы. Пример: ansible.local/groups/Cow |
| category строка | Группа существует | Значение типа группы, например, "Безопасность" или "Дистрибуция". Пример: Безопасность |
| created логическое значение | всегда | Была ли создана группа Пример: True |
| 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 логическое значение | Группа существует | Защищена ли группа от случайного удаления. Пример: True |
| sid строка | Группа существует | Идентификатор безопасности (SID) группы. Пример: S-1-5-21-2171456218-3732823212-122182344-1189 |
Статус
- Данный модуль не гарантирует обратной совместимости. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- 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.9/modules/win_domain_group_module.html