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

Примечание

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

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

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

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

Новая версия в dellemc.openmanage 5.5.0

Обзор
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

Этот модуль позволяет генерировать запросы на подпись сертификатов, импортировать и экспортировать сертификаты на 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 путь	Абсолютный путь к файлу сертификата, если команда — `import`. Путь к каталогу с правами записи, если команда — `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=пароль
idrac_port целое число	Порт iDRAC. По умолчанию: `443`
idrac_user строка	Имя пользователя iDRAC. Если имя пользователя не указано, используется переменная окружения `IDRAC_USERNAME`. Пример: export IDRAC_USERNAME=имя_пользователя
passphrase строка	Строка парольной фразы, если импортируемый сертификат защищен парольной фразой.
reset логический	Сбросить настройки iDRAC после операции с сертификатом. Применимо, когда команда — `import` или `reset`. Варианты: `false` `true` ← (по умолчанию)

END_OF_DOCUMENT_MARKER

resource_id string	Идентификатор ресурса Redfish.
ssl_key path добавлен в dellemc.openmanage 8.6.0	Абсолютный путь к файлу закрытого или SSL-ключа. Применима только когда command — `import` и certificate_type — `HTTPS`. Загрузка SSL-ключа на iDRAC поддерживается на версии прошивки 6.00.02.00 и выше.
timeout integer добавлен в dellemc.openmanage 5.0.0	Таймаут уровня сокета в секундах. По умолчанию: `30`
validate_certs boolean добавлен в dellemc.openmanage 5.0.0	Если `false`, сертификаты SSL не будут проверены. Настраивайте `false` только на контролируемых вами сайтах, где используются самозаверенные сертификаты. До версии сборки `5.0.0`, validate_certs по умолчанию `false`. Варианты: `false` `true` ← (по умолчанию)
wait integer	Максимальное время ожидания запуска iDRAC после сброса в секундах. Применима когда command — `import` или `reset` и reset — `true`. По умолчанию: `300`
x_auth_token string добавлен в 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 string	Путь к файлу csr или экспортированного сертификата. Возвращается: когда command — `export` или `generate_csr` Пример: `"/home/ansible/myfiles/cert.pem"`
error_info dictionary	Подробности 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 string	Статус операции конфигурации сертификата. Возвращается: всегда Пример: `"Successfully performed the 'generate_csr' certificate operation."`

Авторы

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

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

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