community.windows.win_domain_group – Создаёт, изменяет или удаляет группы домена

Примечание

Этот плагин входит в коллекцию community.windows (версия 1.2.0).

Для его установки используйте: ansible-galaxy collection install community.windows.

Чтобы использовать его в книге задач, укажите: community.windows.win_domain_group.

Обзор
Параметры
Примечания
См. также
Примеры
Возвращаемые значения

Обзор

Создаёт, изменяет или удаляет группы в Active Directory.
Для локальных групп используйте модуль ansible.windows.win_group вместо этого.

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
attributes словарь		Словарь пользовательских атрибутов LDAP для группы. Это может использоваться для установки пользовательских атрибутов, которые не представлены как параметры модуля, например, `mail`. Примеры форматирования этого параметра см. ниже.
category строка	Варианты: distribution security	Категория группы, это значение для атрибута LDAP `groupType`. Если создаётся новая группа, то по умолчанию используется `security`.
description строка		Значение, которое будет назначено атрибуту LDAP `description`.
display_name строка		Значение, которое будет назначено атрибуту LDAP `displayName`.
domain_password строка		Пароль для `username`.
domain_server строка		Указывает экземпляр 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, путь
protect логическое	Варианты: нет да	Установит флаг `ProtectedFromAccidentalDeletion` в зависимости от этого значения. Этот флаг предотвращает удаление или перемещение пользователя в другой путь.
scope строка	Варианты: domainlocal global universal	Область действия группы. Если `state=present` и группа не существует, то это необходимо указать.
state строка	Варианты: absent present ←	Если `state=present` этот модуль обеспечит создание группы и её соответствующую настройку. Если `state=absent` этот модуль удалит группу, если она существует

Примечания

Примечание

Этот модуль должен выполняться на узле с установленным модулем ActiveDirectory PowerShell.

См. также

ansible.windows.win_domain: Официальная документация по модулю ansible.windows.win_domain.
ansible.windows.win_domain_controller: Официальная документация по модулю ansible.windows.win_domain_controller.
community.windows.win_domain_computer: Официальная документация по модулю community.windows.win_domain_computer.
ansible.windows.win_domain_membership: Официальная документация по модулю ansible.windows.win_domain_membership.
community.windows.win_domain_user: Официальная документация по модулю community.windows.win_domain_user.
ansible.windows.win_group: Официальная документация по модулю ansible.windows.win_group.
ansible.windows.win_group_membership: Официальная документация по модулю ansible.windows.win_group_membership.

Примеры

- name: Ensure the group Cow exists using sAMAccountName
  community.windows.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
  community.windows.win_domain_group:
    name: CN=Cow,OU=groups,DC=ansible,DC=local
    state: absent

- name: Delete group ignoring the protection flag
  community.windows.win_domain_group:
    name: Cow
    state: absent
    ignore_protection: yes

- name: Create group with delete protection enabled and custom attributes
  community.windows.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
  community.windows.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
  community.windows.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
  community.windows.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 строка	группа существует	Полное доменное имя группы. Пример: CN=Cow,OU=groups,DC=ansible,DC=local
group_scope строка	группа существует	Сфера действия группы. Пример: Универсальная
guid строка	группа существует	Идентификатор группы. Пример: 512a9adb-3fc0-4a26-9df0-e6ea1740cf45
managed_by строка	группа существует	Полное доменное имя объекта Active Directory, установленного в атрибуте 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.10/collections/community/windows/win_domain_group_module.html