cm_ssl_certificate_create – Manages certificate and/or key on the Central Manager.¶
New in version 1.0.0.
Parameters¶
| Parameter | Choices/Defaults | Configuration | Comments |
|---|---|---|---|
|
common_name
string
|
Specifies the common name of the certificate.
This option is required when creating a certificate.
|
||
|
country
string
|
Specifies the country.
|
||
|
division
string
|
Specifies the division.
|
||
|
duration_in_days
integer
|
Specifies the duration of the certificate in days.
This option is required when creating a certificate.
|
||
|
email
string
|
Specifies the email.
|
||
|
issuer
string
|
|
Specifies the issuer of the certificate.
When no value is provided during create, the default value is
Self. |
|
|
key_curve_name
string
|
Specifies the key curve name of the certificate.
This option is only available when the key type is set to
ECDSA.When no value is provided during create and the key_type is set to
ECDSA, the default value is prime256v1. |
||
|
key_passphrase
string
|
Specifies the key passphrase of the certificate.
This option is only available when the key security type is set to
Password. |
||
|
key_security_type
string
|
|
Specifies the key security type of the certificate.
When no value is provided during create, the default value is
Password. |
|
|
key_size
integer
|
Specifies the key size of the certificate.
This option is only available when the key type is set to
RSA.When no value is provided during create and the key_type is set to
RSA, the default value is 2048. |
||
|
key_type
string
|
|
Specifies the key type of the certificate.
When no value is provided during create, the default value is
RSA. |
|
|
locality
string
|
Specifies the locality.
|
||
|
name
string
/ required
|
Specifies the name of the certificate/key or the certificate, key pair.
|
||
|
organization
string
|
Specifies the organization.
|
||
|
province
string
|
Specifies the province.
|
||
|
state
string
|
|
When
present, ensures the key and/or cert is created/renewed on the Central Manager.When
absent, ensures the key and/or cert is removed from the the Central Manager. |
|
|
subject_alternative_name
string
|
Specifies the subject alternative name of the certificate.
|
||
|
update_passphrase
boolean
|
|
Specifies whether to update the passphrase of the certificate.
This option must be provided and set to
true when the user wants to update the key passphrase. |
Return Values¶
The following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
|
common_name
string
|
changed |
Specifies the common name of the certificate.
Sample:
example.com
|
|
country
string
|
changed |
Specifies the country.
Sample:
IN
|
|
division
string
|
changed |
Specifies the division.
Sample:
Dev
|
|
duration_in_days
integer
|
changed |
Specifies the duration of the certificate in days.
Sample:
365
|
|
email
string
|
changed |
Specifies the email.
Sample:
user@fx.com
|
|
issuer
string
|
changed |
Specifies the issuer of the certificate/key pair.
Sample:
Self
|
|
key_curve_name
string
|
changed |
Specifies the key curve name of the certificate. Only available when the key type is set to
ECDSA.Sample:
prime256v1
|
|
key_security_type
string
|
changed |
Specifies the key security type of the certificate.
Sample:
Password
|
|
key_size
integer
|
changed |
Specifies the key size of the certificate. Only available when the key type is set to
RSA.Sample:
2048
|
|
key_type
string
|
changed |
Specifies the key type of the certificate.
Sample:
RSA
|
|
name
string
|
changed |
The name of the certificate/key pair.
Sample:
testcert
|
|
organization
string
|
changed |
Specifies the organization.
Sample:
FX
|
|
province
string
|
changed |
Specifies the province/state.
Sample:
Hyderabad
|
|
subject_alternative_name
string
|
changed |
Specifies the subject alternative name of the certificate.
Sample:
DNS:example.com
|