cm_ssl_certificate_import – Manages certificate, key and PKCS12 on the Central Manager.

New in version 1.0.0.

Synopsis

  • Manages certificate, key and PKCS12 on the Central Manager.

Parameters

Parameter Choices/Defaults Configuration Comments
cert
path
The path to the certificate or PKCS12 file.
key
path
The path to the key file.
key_passphrase
string
The passphrase for the key file.
name
string / required
The name of the key and/or cert combination.
pkcs12_passphrase
string
The passphrase for the PKCS12 cert file. It must be provided when importing a PKCS12 cert.
state
string
    Choices:
  • present ←
  • absent
When present, ensures the key and/or cert is uploaded to the Central Manager.
When absent, ensures the key and/or cert is removed from the the Central Manager.
type
string
    Choices:
  • PKCS12
  • PEM
The type of the certificate.
update_cert
boolean
    Choices:
  • no ←
  • yes
Whether to update the certificate on the Central Manager.
Set it to yes when updating an existing certificate.
Not required when creating a new certificate.
update_key
boolean
    Choices:
  • no ←
  • yes
Whether to update the key on the Central Manager.
Set it to yes when updating an existing key.
Not required when creating a new key.

Return Values

The following are the fields unique to this module:

Key Returned Description
cert
string
changed
The path to the cert file.

Sample:
/path/to/cert
key
string
changed
The path to the key file.

Sample:
/path/to/key
name
string
changed
The name of the key and/or cert combination.

Sample:
testcert
type
string
changed
The type of the certificate.

Sample:
PEM


Status

Authors

  • Rohit Upadhyay (@rupadhyay)
  • Ravinder Reddy (@RavinderReddyF5)
  • Wojciech Wypior (@wojtek0806)