dellemc.openmanage.ome_application_certificate (2.1.5) — module

Install collection

Install with ansible-galaxy collection install dellemc.openmanage:==2.1.5

Add to requirements.yml

  collections:
    - name: dellemc.openmanage
      version: 2.1.5

Description

This module allows the generation a new certificate signing request (CSR) and to upload the certificate on OpenManage Enterprise.

Requirements

• python >= 2.7.5

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

---
- name: Generate a certificate signing request.
  dellemc.openmanage.ome_application_certificate:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    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"

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Inputs

    
port:
    default: 443
    description: Target HTTPS port.
    type: int

email:
    description: Email associated with the issuer. This option is applicable for C(generate_csr).
    type: str

command:
    choices:
    - generate_csr
    - upload
    default: generate_csr
    description: C(generate_csr) allows the generation of a CSR and C(upload) uploads
      the certificate.
    type: str

country:
    description: Country in which the issuer resides. This option is applicable for C(generate_csr).
    type: str

hostname:
    description: Target IP address or hostname.
    required: true
    type: str

locality:
    description: Local address of the issuer of the certificate. This option is applicable
      for C(generate_csr).
    type: str

password:
    description: Target user password.
    required: true
    type: str

username:
    description: Target username.
    required: true
    type: str

upload_file:
    description: Local path of the certificate file to be uploaded. This option is applicable
      for C(upload). Once the certificate is uploaded, OpenManage Enterprise cannot be
      accessed for a few seconds.
    type: str

business_name:
    description: Name of the business that issued the certificate. This option is applicable
      for C(generate_csr).
    type: str

country_state:
    description: State in which the issuer resides. This option is applicable for C(generate_csr).
    type: str

department_name:
    description: Name of the department that issued the certificate. This option is applicable
      for C(generate_csr).
    type: str

distinguished_name:
    description: Name of the certificate issuer. This option is applicable for C(generate_csr).
    type: str

Outputs

csr_status:
  description: details of the generated certificate.
  returned: on success
  sample:
    CertificateData: '-----BEGIN CERTIFICATE REQUEST-----GHFSUEKLELE af3u4h2rkdkfjasczjfefhkrr/frjrfrjfrxnvzklf/nbcvxmzvndlskmcvbmzkdk
      kafhaksksvklhfdjtrhhffgeth/tashdrfstkm@kdjFGD/sdlefrujjfvvsfeikdf yeufghdkatbavfdomehtdnske/tahndfavdtdfgeikjlagmdfbandfvfcrfgdtwxc
      qwgfrteyupojmnsbajdkdbfs/ujdfgthedsygtamnsuhakmanfuarweyuiwruefjr etwuwurefefgfgurkjkdmbvfmvfvfk==-----END
      CERTIFICATE REQUEST-----'
  type: dict
error_info:
  description: Details of the HTTP error.
  returned: on HTTP error
  sample:
    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.
  type: dict
msg:
  description: Overall status of the certificate signing request.
  returned: always
  sample: Successfully generated certificate signing request.
  type: str