dellemc.vxrail.dellemc_vxrail_certificates_update_scep_config (2.2.0) — module

Update automated renewal configurations of certificate through SCEP.

| "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 call POST /cluster/certificates/scep/config api to udpate automated renewal configurations of the VxRail Manager TLS certificate through SCEP

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  - name: Update automated renewal configurations of the certificate
    dellemc_vxrail_certificates_update_scep_config:
      vxmip: "{{ vxmip }}"
      vcadmin: "{{ vcadmin }}"
      vcpasswd: "{{ vcpasswd }}"
      caserver_url: "{{ vxmip }}"
      challenge_password: "{{ challenge_password }}"
      scep_on: true
      scep_renewal_interval_in_minutes: 180
      scep_days_before_expire: 30

Inputs

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

scep_on:
    description: Enable or disable the automated renewal
    required: true
    type: bool

timeout:
    default: 60
    description: Time out value for getting automated renewal configurations, the default
      value is 60 seconds
    required: false
    type: int

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

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

caserver_url:
    description: Certificate Authority server URL
    required: true
    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

challenge_password:
    description: Challenge password
    required: true
    type: str

scep_days_before_expire:
    description: Days to renew the certificate before expiration. Valid range is 14 -
      60.
    required: true
    type: int

scep_renewal_interval_in_minutes:
    description: Certificate validation frequency in minutes. Valid range is 60 - 1440.
    required: true
    type: int

Outputs

SCEP_CONFIG:
  description: automated renewal configurations
  returned: always
  sample: "{\n  \"scep_enabled\": true,\n  \"error_code\": null,\n  \"error_message\"\
    : null,\n  \"caserver_url\": \"http://<server IP>/certsrv/mscep/mscep.dll/pkiclient.exe\"\
    ,\n  \"scep_on\": true,\n  \"scep_renewal_interval_in_minutes\": 180,\n  \"scep_days_before_expire\"\
    : 30\n}"
  type: dict