dellemc.openmanage.ome_application_certificate модуль — Этот модуль позволяет сгенерировать CSR и загрузить сертификат

Примечание

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

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

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

Чтобы использовать его в книге задач, укажите: dellemc.openmanage.ome_application_certificate.

Новый в dellemc.openmanage 2.1.0

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

Описание

Этот модуль позволяет сгенерировать новый запрос на подпись сертификата (CSR) и загрузить сертификат в OpenManage Enterprise.

Требования

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

python >= 3.9.6

Параметры

Параметр	Комментарии
business_name строка	Название компании, выпустившей сертификат. Этот параметр применим для `generate_csr`.
ca_path путь добавлен в dellemc.openmanage 5.0.0	Файл Privacy Enhanced Mail (PEM) содержащий сертификат CA, используемый для проверки.
command строка	`generate_csr` позволяет сгенерировать CSR. `upload` загружает сертификат в OpenManage Enterprise. `upload_cert_chain` загружает цепочку сертификатов в OpenManage Enterprise. Выбираемые значения: `"generate_csr"` ← (по умолчанию) `"upload"` `"upload_cert_chain"`
country строка	Страна, в которой находится организация-эмитент. Этот параметр применим для `generate_csr`.
country_state строка	Регион, в котором находится организация-эмитент. Этот параметр применим для `generate_csr`.
department_name строка	Название отдела, выпустившего сертификат. Этот параметр применим для `generate_csr`.
distinguished_name строка	Имя организации-эмитента сертификата. Этот параметр применим для `generate_csr`.
email строка	Электронная почта организации-эмитента. Этот параметр применим для `generate_csr`.
hostname строка / обязательно	IP-адрес или имя хоста OpenManage Enterprise или OpenManage Enterprise Modular.
locality строка	Адрес организации-эмитента сертификата. Этот параметр применим для `generate_csr`.
password строка	Пароль OpenManage Enterprise или OpenManage Enterprise Modular. Если пароль не указан, используется переменная окружения `OME_PASSWORD`. Пример: export OME_PASSWORD=пароль
port целое число	Порт HTTPS OpenManage Enterprise или OpenManage Enterprise Modular. По умолчанию: `443`
subject_alternative_names строка добавлен в dellemc.openmanage 8.1.0	Требуемое альтернативное имя субъекта для генерации запроса на подписание сертификата. Поддерживает до 4 значений, разделенных запятыми, начиная с первичного, вторичного, третичного и четвертичного значений.
timeout целое число добавлен в dellemc.openmanage 5.0.0	Таймаут уровня сокета в секундах. По умолчанию: `30`
upload_file строка	Локальный путь к файлу сертификата, который необходимо загрузить. Этот параметр применим для `upload` и `upload_cert_chain`. После загрузки сертификата доступ к OpenManage Enterprise будет недоступен в течение нескольких секунд. Форматы файла сертификата: .crt, .cer, .ca-bundle, .p7b, .der и .pem.
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.

Примеры

---
- name: Generate a certificate signing request
  dellemc.openmanage.ome_application_certificate:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    command: "generate_csr"
    distinguished_name: "hostname.com"
    department_name: "Remote Access Group"
    business_name: "Dell Inc."
    locality: "Round Rock"
    country_state: "Texas"
    country: "US"
    email: "support@dell.com"

- name: Generate a certificate signing request with subject alternative names
  dellemc.openmanage.ome_application_certificate:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    command: "generate_csr"
    distinguished_name: "hostname.com"
    subject_alternative_names: "hostname1.chassis.com,hostname2.chassis.com"
    department_name: "Remote Access Group"
    business_name: "Dell Inc."
    locality: "Round Rock"
    country_state: "Texas"
    country: "US"
    email: "support@dell.com"

- name: Upload the certificate
  dellemc.openmanage.ome_application_certificate:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    command: "upload"
    upload_file: "/path/certificate.cer"

- name: Upload the certificate chain
  dellemc.openmanage.ome_application_certificate:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    command: "upload_cert_chain"
    upload_file: "/path/certificate_chain.p7b"

END_OF_DOCUMENT_MARKER

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

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

Ключ	Описание
csr_status словарь	Подробная информация о сгенерированном сертификате. Возвращается: при успехе Пример: `{"CertificateData": "-----BEGIN CERTIFICATE REQUEST-----GHFSUEKLELE af3u4h2rkdkfjasczjfefhkrr/frjrfrjfrxnvzklf/nbcvxmzvndlskmcvbmzkdk kafhaksksvklhfdjtrhhffgeth/tashdrfstkm@kdjFGD/sdlefrujjfvvsfeikdf yeufghdkatbavfdomehtdnske/tahndfavdtdfgeikjlagmdfbandfvfcrfgdtwxc qwgfrteyupojmnsbajdkdbfs/ujdfgthedsygtamnsuhakmanfuarweyuiwruefjr etwuwurefefgfgurkjkdmbvfmvfvfk==-----END CERTIFICATE REQUEST-----"}`
error_info словарь	Подробная информация об ошибке HTTP. Возвращается: при ошибке HTTP Пример: `{"error": {"@Message.ExtendedInfo": [{"Message": "Unable to upload the certificate because the certificate file provided is invalid.", "MessageArgs": [], "MessageId": "CSEC9002", "RelatedProperties": [], "Resolution": "Make sure the CA certificate and private key are correct and retry the operation.", "Severity": "Critical"}], "code": "Base.1.0.GeneralError", "message": "A general error has occurred. See ExtendedInfo for more information."}}`
msg строка	Общий статус запроса на подпись сертификата. Возвращается: всегда Пример: `"Successfully generated certificate signing request."`

Авторы

Felix Stephen (@felixs88)
Kritika Bhateja (@Kritika-Bhateja-03)
Jennifer John (@Jennifer-John)
Abhishek Sinha (@ABHISHEK-SINHA10)
Saksham Nautiyal (@Saksham-Nautiyal)

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

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