dellemc.openmanage.ome_application_certificate module – This module allows to generate a CSR and upload the certificate
Note
This module is part of the dellemc.openmanage collection (version 9.8.0).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install dellemc.openmanage.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: dellemc.openmanage.ome_application_certificate.
New in dellemc.openmanage 2.1.0
Synopsis
This module allows the generation a new certificate signing request (CSR) and to upload the certificate on OpenManage Enterprise.
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.9.6
Parameters
Parameter |
Comments |
|---|---|
Name of the business that issued the certificate. This option is applicable for |
|
The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for the validation. |
|
Choices:
|
|
Country in which the issuer resides. This option is applicable for |
|
State in which the issuer resides. This option is applicable for |
|
Name of the department that issued the certificate. This option is applicable for |
|
Name of the certificate issuer. This option is applicable for |
|
Email associated with the issuer. This option is applicable for |
|
OpenManage Enterprise or OpenManage Enterprise Modular IP address or hostname. |
|
Local address of the issuer of the certificate. This option is applicable for |
|
OpenManage Enterprise or OpenManage Enterprise Modular password. If the password is not provided, then the environment variable Example: export OME_PASSWORD=password |
|
OpenManage Enterprise or OpenManage Enterprise Modular HTTPS port. Default: |
|
Subject alternative name required for the certificate signing request generation. Supports up to 4 comma separated values starting from primary, secondary, Tertiary and Quaternary values. |
|
The socket level timeout in seconds. Default: |
|
Local path of the certificate file to be uploaded. This option is applicable for |
|
OpenManage Enterprise or OpenManage Enterprise Modular username. If the username is not provided, then the environment variable Example: export OME_USERNAME=username |
|
If Configure Prior to collection version Choices:
|
|
Authentication token. If the x_auth_token is not provided, then the environment variable Example: export OME_X_AUTH_TOKEN=x_auth_token |
Notes
Note
If a certificate is uploaded, which is identical to an already existing certificate, it is accepted by the module.
This module does not support
check_mode.
Examples
---
- 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"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Details of the generated certificate. Returned: on success Sample: |
|
Details of the HTTP error. Returned: on HTTP error Sample: |
|
Overall status of the certificate signing request. Returned: always Sample: |