модуль dellemc.openmanage.idrac_certificates — Настройка сертификатов для iDRAC

Примечание

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

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

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

Чтобы использовать модуль в плейбуке, укажите: dellemc.openmanage.idrac_certificates.

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

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

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

Этот модуль позволяет создавать запросы на подпись сертификата (CSR), импортировать и экспортировать сертификаты на iDRAC.

Требования

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

python >= 3.9.6

Параметры

Параметр	Комментарии
ca_path путь добавлено в dellemc.openmanage 5.0.0	Файл Privacy Enhanced Mail (PEM), содержащий сертификат CA для проверки.
cert_params словарь	Параметры сертификата для создания запроса на подпись.
common_name строка / обязательный	Общее имя сертификата.
country_code строка / обязательный	Код страны, в которой находится организация, запрашивающая сертификацию.
email_address строка	Адрес электронной почты, связанный с CSR.
locality_name строка / обязательный	Город или другое место, в котором находится организация, запрашивающая сертификацию.
organization_name строка / обязательный	Название организации.
organization_unit строка / обязательный	Название подразделения организации. Например, название отдела.
state_name строка / обязательный	Штат или регион, в котором находится организация, запрашивающая сертификацию.
subject_alt_name список / элементы=строка	Альтернативные доменные имена, связанные с запросом. По умолчанию: `[]`
certificate_path путь	Абсолютный путь к файлу сертификата, если command имеет значение `import`. Путь к каталогу с правами на запись, если command имеет значение `generate_csr` или `export`.
certificate_type строка	Тип сертификата iDRAC. `HTTPS` Самоподписанный SSL-сертификат Dell. `CA` SSL-сертификат, подписанный центром сертификации (CA). `CUSTOMCERTIFICATE` Пользовательский сертификат PKCS12 и закрытый ключ. Экспорт пользовательского сертификата поддерживается только в версии микропрограммы iDRAC 7.00.00.00 и выше. `CSC` Пользовательский подписанный SSL-сертификат. `CLIENT_TRUST_CERTIFICATE` Доверенный сертификат клиента. Допустимые значения: `"HTTPS"` ← (по умолчанию) `"CA"` `"CUSTOMCERTIFICATE"` `"CSC"` `"CLIENT_TRUST_CERTIFICATE"`
command строка	`generate_csr` — создать CSR. Для этого требуются cert_params и certificate_path. Применимо только для `HTTPS` `import` — импортировать файл сертификата. Для этого требуется certificate_path. `export` — экспортировать сертификат. Для этого требуется certificate_path. `reset` — восстановить настройки сертификата по умолчанию. Применимо только для `HTTPS`. Допустимые значения: `"import"` `"export"` `"generate_csr"` ← (по умолчанию) `"reset"`
idrac_ip строка / обязательный	IP-адрес iDRAC.
idrac_password псевдонимы: idrac_pwd строка	Пароль пользователя iDRAC. Если пароль не указан, используется переменная среды `IDRAC_PASSWORD`. Пример: export IDRAC_PASSWORD=password
idrac_port целое число	Порт iDRAC. По умолчанию: `443`
idrac_user строка	Имя пользователя iDRAC. Если имя пользователя не указано, используется переменная среды `IDRAC_USERNAME`. Пример: export IDRAC_USERNAME=username
passphrase строка	Парольная фраза, если импортируемый сертификат защищен парольной фразой.
reset логическое значение	Перезагрузить iDRAC после операции с сертификатом. Применимо, если command имеет значение `import` или `reset`. Допустимые значения: `false` `true` ← (по умолчанию)
resource_id строка	Идентификатор ресурса Redfish.
ssl_key путь добавлено в dellemc.openmanage 8.6.0	Абсолютный путь к файлу закрытого ключа или SSL-ключа. Применимо, только если command имеет значение `import`, а certificate_type — `HTTPS`. Загрузка SSL-ключа в iDRAC поддерживается в версии микропрограммы 6.00.02.00 и выше.
timeout целое число добавлено в dellemc.openmanage 5.0.0	Тайм-аут на уровне сокета в секундах. По умолчанию: `30`
validate_certs логическое значение добавлено в dellemc.openmanage 5.0.0	Если указано `false`, SSL-сертификаты не будут проверяться. Настраивайте `false` только в сетях под личным контролем, где используются самоподписанные сертификаты. В версиях коллекции до `5.0.0` параметр validate_certs по умолчанию имеет значение `false`. Допустимые значения: `false` `true` ← (по умолчанию)
wait целое число	Максимальное время ожидания запуска iDRAC после перезагрузки в секундах. Применимо, если command имеет значение `import` или `reset`, а reset — `true`. По умолчанию: `600`
x_auth_token строка добавлено в dellemc.openmanage 9.3.0	Токен аутентификации. Если x_auth_token не указан, используется переменная среды `IDRAC_X_AUTH_TOKEN`. Пример: export IDRAC_X_AUTH_TOKEN=x_auth_token

Примечания

Примечание

Операции с сертификатами поддерживаются в версии микропрограммы iDRAC 6.10.80.00 и выше.
Запускайте этот модуль в системе, имеющей прямой доступ к Dell iDRAC.
Этот модуль поддерживает check_mode.
Этот модуль поддерживает адреса IPv4 и IPv6.

Примеры

---
- name: Generate HTTPS certificate signing request
  dellemc.openmanage.idrac_certificates:
    idrac_ip: "192.168.0.1"
    idrac_user: "user_name"
    idrac_password: "user_password"
    ca_path: "/path/to/ca_cert.pem"
    command: "generate_csr"
    certificate_type: "HTTPS"
    certificate_path: "/home/omam/mycerts"
    cert_params:
      common_name: "sample.domain.com"
      organization_unit: "OrgUnit"
      locality_name: "Bangalore"
      state_name: "Karnataka"
      country_code: "IN"
      email_address: "admin@domain.com"
      organization_name: "OrgName"
      subject_alt_name:
        - 192.198.2.1

- name: Import a HTTPS certificate.
  dellemc.openmanage.idrac_certificates:
    idrac_ip: "192.168.0.1"
    idrac_user: "user_name"
    idrac_password: "user_password"
    ca_path: "/path/to/ca_cert.pem"
    command: "import"
    certificate_type: "HTTPS"
    certificate_path: "/path/to/cert.pem"

- name: Import an HTTPS certificate along with its private key.
  dellemc.openmanage.idrac_certificates:
    idrac_ip: "192.168.0.1"
    idrac_user: "user_name"
    idrac_password: "user_password"
    ca_path: "/path/to/ca_cert.pem"
    command: "import"
    certificate_type: "HTTPS"
    certificate_path: "/path/to/cert.pem"
    ssl_key: "/path/to/private_key.pem"

- name: Export a HTTPS certificate.
  dellemc.openmanage.idrac_certificates:
    idrac_ip: "192.168.0.1"
    idrac_user: "user_name"
    idrac_password: "user_password"
    ca_path: "/path/to/ca_cert.pem"
    command: "export"
    certificate_type: "HTTPS"
    certificate_path: "/home/omam/mycert_dir"

- name: Import a CSC certificate.
  dellemc.openmanage.idrac_certificates:
    idrac_ip: "192.168.0.1"
    idrac_user: "user_name"
    idrac_password: "user_password"
    ca_path: "/path/to/ca_cert.pem"
    command: "import"
    certificate_type: "CSC"
    certificate_path: "/path/to/cert.pem"

- name: Import a custom certificate with a passphrase.
  dellemc.openmanage.idrac_certificates:
    idrac_ip: "192.168.0.1"
    idrac_user: "user_name"
    idrac_password: "user_password"
    command: "import"
    certificate_type: "CUSTOMCERTIFICATE"
    certificate_path: "/path/to/idrac_cert.p12"
    passphrase: "cert_passphrase"
    reset: false

- name: Export a Client trust certificate.
  dellemc.openmanage.idrac_certificates:
    idrac_ip: "192.168.0.1"
    idrac_user: "user_name"
    idrac_password: "user_password"
    ca_path: "/path/to/ca_cert.pem"
    command: "export"
    certificate_type: "CLIENT_TRUST_CERTIFICATE"
    certificate_path: "/home/omam/mycert_dir"

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

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

Ключ	Описание
certificate_path строка	Путь к файлу CSR или экспортированного сертификата Возвращается: если command имеет значение `export` или `generate_csr` Пример: `"/home/ansible/myfiles/cert.pem"`
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 performed the 'generate_csr' certificate operation."`

Авторы

Jagadeesh N V(@jagadeeshnv)
Rajshekar P(@rajshekarp87)
Kristian Lamb V(@kristian_lamb)

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

© 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/idrac_certificates_module.html