dellemc.openmanage.ome_application_certificate 模块 – 此模块允许生成 CSR 并上传证书

注意

此模块是 dellemc.openmanage 集合 (版本 9.9.0) 的一部分。

如果您使用的是 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install dellemc.openmanage。您需要其他要求才能使用此模块，请参阅要求了解详细信息。

要在 playbook 中使用它，请指定：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 中添加	包含用于验证的 CA 证书的隐私增强邮件 (PEM) 文件。
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 字符串 / 必需	OpenManage Enterprise 或 OpenManage Enterprise Modular 的 IP 地址或主机名。
locality 字符串	证书签发者的本地地址。此选项适用于 `generate_csr`。
password 字符串	OpenManage Enterprise 或 OpenManage Enterprise Modular 密码。如果未提供密码，则使用环境变量 `OME_PASSWORD`。示例：export OME_PASSWORD=password
port 整数	OpenManage Enterprise 或 OpenManage Enterprise Modular 的 HTTPS 端口。默认值： `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=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: "[email protected]"

- 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: "[email protected]"

- 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"

返回值 

常见的返回值已在此处记录，以下是此模块特有的字段

键	描述
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)