Модуль dellemc.openmanage.ome_template_identity_pool – Прикрепление или открепление пула удостоверений к запрошенному шаблону в OpenManage Enterprise

Примечание

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

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

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

Для использования в playbook укажите: dellemc.openmanage.ome_template_identity_pool.

Новое в dellemc.openmanage 2.0.0

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

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

Этот модуль позволяет: - Прикрепить пул удостоверений к запрошенному шаблону в OpenManage Enterprise. - Открепить пул удостоверений от запрошенного шаблона в OpenManage Enterprise.

Требования

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

python >= 3.9.6

Параметры

Параметр	Комментарии
ca_path путь добавлено в dellemc.openmanage 5.0.0	Файл Privacy Enhanced Mail (PEM), содержащий сертификат CA, который будет использоваться для проверки.
hostname строка / обязательно	IP-адрес или имя хоста OpenManage Enterprise или OpenManage Enterprise Modular.
identity_pool_name строка	Имя пула удостоверений. - Для прикрепления пула удостоверений к шаблону укажите имя пула удостоверений. - Этот параметр не применим при откреплении пула удостоверений от шаблона.
password строка	Пароль OpenManage Enterprise или OpenManage Enterprise Modular. Если пароль не указан, используется переменная среды `OME_PASSWORD`. Пример: export OME_PASSWORD=password
port целое число	HTTPS-порт OpenManage Enterprise или OpenManage Enterprise Modular. Значение по умолчанию: `443`
template_name строка / обязательно	Имя шаблона, к которому прикрепляется или открепляется пул удостоверений.
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

Примечания

Примечание

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

Примеры

---
- name: Attach an identity pool to a template
  dellemc.openmanage.ome_template_identity_pool:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    template_name: template_name
    identity_pool_name: identity_pool_name

- name: Detach an identity pool from a template
  dellemc.openmanage.ome_template_identity_pool:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    template_name: template_name

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

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

Ключ	Описание
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 строка	Общий статус пула удостоверений операции прикрепления или открепления. Возвращается: всегда Пример: `"Successfully attached identity pool to template."`

Ключ

Описание

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

строка

Общий статус пула удостоверений операции прикрепления или открепления.

Возвращается: всегда

Пример: "Successfully attached identity pool to template."

Авторы

Felix Stephen (@felixs88)

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

© 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_template_identity_pool_module.html