Модуль dellemc.openmanage.ome_domain_user_groups — создание, изменение или удаление группы пользователей Active Directory/LDAP в OpenManage Enterprise и OpenManage Enterprise Modular

Примечание

Этот модуль входит в коллекцию dellemc.openmanage (версия 10.0.2).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install dellemc.openmanage. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать его в playbook, укажите: dellemc.openmanage.ome_domain_user_groups.

Добавлено в dellemc.openmanage 4.0.0

Краткое описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

Этот модуль позволяет создавать, изменять или удалять группу пользователей Active Directory/LDAP в OpenManage Enterprise и OpenManage Enterprise Modular.

Требования

На хосте, выполняющем этот модуль, должны быть установлены следующие компоненты.

python >= 3.9.6

Параметры

Параметр	Комментарии
ca_path путь добавлено в dellemc.openmanage 5.0.0	Файл Privacy Enhanced Mail (PEM), содержащий сертификат CA, используемый для проверки.
directory_id целое число	Идентификатор Active Directory/LDAP. directory_id и directory_name являются взаимоисключающими.
directory_name строка	Имя каталога, заданное при добавлении Active Directory/LDAP. directory_name и directory_id являются взаимоисключающими.
directory_type строка	Тип учетной записи. Варианты: `"AD"` ← (по умолчанию) `"LDAP"`
domain_password строка	Пароль домена Active Directory/LDAP.
domain_username строка	Имя пользователя домена Active Directory/LDAP. Пример: username@domain или domain\username.
group_name строка / обязательный	Имя группы пользователей Active Directory/LDAP, которую требуется импортировать или удалить. Примеры имен групп пользователей: Administrator, Account Operators или Access Control Assistance Operator. Значение group_name не учитывает регистр.
hostname строка / обязательный	IP-адрес или имя хоста OpenManage Enterprise либо OpenManage Enterprise Modular.
password строка	Пароль OpenManage Enterprise или OpenManage Enterprise Modular. Если пароль не указан, используется переменная среды `OME_PASSWORD`. Пример: export OME_PASSWORD=password
port целое число	HTTPS-порт OpenManage Enterprise или OpenManage Enterprise Modular. По умолчанию: `443`
role строка	Роли и привилегии, назначаемые импортируемой группе пользователей Active Directory/LDAP. Роли OpenManage Enterprise Modular: CHASSIS ADMINISTRATOR, COMPUTE MANAGER, STORAGE MANAGER, FABRIC MANAGER, VIEWER. Роли OpenManage Enterprise: ADMINISTRATOR, DEVICE MANAGER, VIEWER. Значение role не учитывает регистр.
state строка	`present` импортирует или изменяет группу пользователей Active Directory/LDAP. `absent` удаляет существующую группу пользователей Active Directory/LDAP. Варианты: `"present"` ← (по умолчанию) `"absent"`
timeout целое число добавлено в dellemc.openmanage 5.0.0	Тайм-аут на уровне сокета в секундах. По умолчанию: `30`
username строка	Имя пользователя OpenManage Enterprise или OpenManage Enterprise Modular. Если имя пользователя не указано, используется переменная среды `OME_USERNAME`. Пример: export OME_USERNAME=username
validate_certs логический добавлено в dellemc.openmanage 5.0.0	Если `false`, SSL-сертификаты не будут проверяться. Настраивайте `false` только на контролируемых вами сайтах, где используются самоподписанные сертификаты. В версиях коллекции до `5.0.0` значение validate_certs по умолчанию — `false`. Варианты: `false` `true` ← (по умолчанию)
x_auth_token строка добавлено в dellemc.openmanage 9.3.0	Токен аутентификации. Если x_auth_token не указан, используется переменная среды `OME_X_AUTH_TOKEN`. Пример: export OME_X_AUTH_TOKEN=x_auth_token

Примечания

Примечание

Этот модуль поддерживает check_mode и идемпотентность.
Запускайте этот модуль в системе, имеющей прямой доступ к OpenManage Enterprise или OpenManage Enterprise Modular.

Примеры

---
- name: Create Active Directory user group
  dellemc.openmanage.ome_domain_user_groups:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    state: present
    group_name: account operators
    directory_name: directory_name
    role: administrator
    domain_username: username@domain
    domain_password: domain_password

- name: Update Active Directory user group
  dellemc.openmanage.ome_domain_user_groups:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    state: present
    group_name: account operators
    role: viewer

- name: Delete active directory user group
  dellemc.openmanage.ome_domain_user_groups:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    state: absent
    group_name: administrators

- name: Import LDAP directory group.
  dellemc.openmanage.ome_domain_user_groups:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    directory_type: LDAP
    state: present
    group_name: account operators
    directory_name: directory_name
    role: administrator
    domain_username: username@domain
    domain_password: domain_password

- name: Remove LDAP directory group.
  dellemc.openmanage.ome_domain_user_groups:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    state: absent
    group_name: account operators

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже приведены поля, уникальные для этого модуля:

Ключ	Описание
domain_user_status словарь	Сведения об операции с пользователем домена, если state имеет значение `present`. Возвращается: если state имеет значение `present`. Пример: `{"Description": null, "DirectoryServiceId": 16097, "Enabled": true, "Id": "16617", "IsBuiltin": false, "IsVisible": true, "Locked": false, "Name": "Account Operators", "ObjectGuid": "a491859c-031e-42a3-ae5e-0ab148ecf1d6", "ObjectSid": null, "Oem": null, "Password": null, "PlainTextPassword": null, "RoleId": "16", "UserName": "Account Operators", "UserTypeId": 2}`
error_info словарь	Сведения об ошибке HTTP. Возвращается: при ошибке HTTP Пример: `{"error": {"@Message.ExtendedInfo": [{"Message": "Unable to process the request because an error occurred.", "MessageArgs": [], "MessageId": "GEN1234", "RelatedProperties": [], "Resolution": "Retry the operation. If the issue persists, contact your system administrator.", "Severity": "Critical"}], "code": "Base.1.0.GeneralError", "message": "A general error has occurred. See ExtendedInfo for more information."}}`
msg строка	Общий статус операции с группой пользователей Active Directory/LDAP. Возвращается: всегда Пример: `"Successfully imported the Active Directory/LDAP user group."`

Авторы

Felix Stephen (@felixs88)
Abhishek Sinha (@Abhishek-Dell)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/dellemc/openmanage/ome_domain_user_groups_module.html