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

Примечание

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

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

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

Чтобы использовать его в книге задач, укажите: 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. Пример: имя_пользователя@домен или домен\имя_пользователя.
group_name строка / обязательно	Имя группы пользователей Active Directory/LDAP, которое необходимо импортировать или удалить. Примеры имен групп пользователей: Администраторы или Операторы учетных записей или Операторы поддержки доступа. Значение group_name нечувствительно к регистру.
hostname строка / обязательно	IP-адрес или имя хоста OpenManage Enterprise или OpenManage Enterprise Modular.
password строка	Пароль OpenManage Enterprise или OpenManage Enterprise Modular. Если пароль не указан, используется переменная среды `OME_PASSWORD`. Пример: export OME_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=имя_пользователя
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

END_OF_DOCUMENT_MARKER

Значения возврата

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

Ключ	Описание
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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/dellemc/openmanage/ome_domain_user_groups_module.html