dellemc.vxrail.dellemc_vxrail_certificate_update (2.2.0) — module

Update the VxRail Manager certificate

| "added in version" 1.4.0 of dellemc.vxrail"

Authors: VxRail Development Team(@VxRailDevTeam) <ansible.team@dell.com>

Install collection

Install with ansible-galaxy collection install dellemc.vxrail:==2.2.0


Add to requirements.yml

  collections:
    - name: dellemc.vxrail
      version: 2.2.0

Description

This module will update the VxRail Manager certificate

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  - name: Update the VxRail Manager certificate
    dellemc_vxrail_certificate_update:
        vxmip: "{{ vxmip }}"
        vcadmin: "{{ vcadmin }}"
        vcpasswd: "{{ vcpasswd }}"
        cert: "{{ cert }}"
        root_cert_chain: "{{ root_cert_chain }}"
        private_key: "{{ private_key }}"
        password: "{{ password }}"
        vc_admin_account: "{{ vc_admin_account }}"
        vc_admin_password: "{{ vc_admin_password }}"
        timeout: "{{timeout}}"
        api_version_number: "{{api_version_number}}"

Inputs

    
cert:
    description: Content of the new certificate in PEM format. Each line should be followed
      by an escape character "\n".
    required: true
    type: str

vxmip:
    description: The IP address of the VxRail Manager System
    required: true
    type: str

timeout:
    default: 600
    description: Time out value for getting update status, the default value is 600 seconds
    required: false
    type: int

vcadmin:
    description: Administrative account of the vCenter Server the VxRail Manager is registered
      to
    required: true
    type: str

password:
    description: Password for the new .pfx file
    required: false
    type: str

vcpasswd:
    description: The password for the administrator account provided in vcadmin
    required: true
    type: str

private_key:
    description: Contents of the private key in PEM format. Only an RSA private key is
      allowed. The private key can be omitted if the provided certificate is issued based
      on the CSR generated by /v1/certificates/csr.
    required: false
    type: str

root_cert_chain:
    description: Contents of the certificate chain in PEM format. The root CA certificate
      comes first, followed by the intermediate CA certificates (if any).
    elements: str
    required: true
    type: list

vc_admin_account:
    description: VC admin account for invoke VC API to send the new root cert to VC trust
      store
    required: false
    type: str

vc_admin_password:
    description: VC admin password for invoke VC API to send the new root cert to VC trust
      store
    required: false
    type: str

api_version_number:
    description: A specific version number to use for the API call. If not included, will
      use the highest version by default
    required: false
    type: int

Outputs

certificate_update_information:
  description: certificate update status summary
  returned: always
  sample: "{\n   \"request_id\": \"9e27ae96-33a2-47f0-89a7-dbd4376db1b6\",\n   \"\
    status\": \"COMPLETED\"\n}"
  type: dict
changed:
  description: Whether or not the resource has changed.
  returned: always
  type: bool