a10_pki_acme_cert
Synopsis
ACME Certificate enrollment object
Parameters
Parameters |
Choices/Defaults |
Comment |
|---|---|---|
state str/required |
[‘noop’, ‘present’, ‘absent’] |
State of the object to be created. |
ansible_host str/required |
Host for AXAPI authentication |
|
ansible_username str/required |
Username for AXAPI authentication |
|
ansible_password str/required |
Password for AXAPI authentication |
|
ansible_port int/required |
Port for AXAPI authentication |
|
a10_device_context_id int |
[‘1-8’] |
Device ID for aVCS configuration |
a10_partition str |
Destination/target partition for object/command |
|
name str/required |
Specify Certificate name to be enrolled |
|
url str |
ACME directory URL. By default, use Let’s encrypt as CA server |
|
staging_url str |
ACME staging directory URL. By default, use Let’s encrypt as CA server |
|
domain str |
Main domain you want to issue the cert for. CA will verify whether you control this domain |
|
san_domain str |
Subject-alternate-name dns(s) for your cert, sperated by / |
|
enroll bool |
Initiates enrollment with CA. Due to CA rate limit, A10 strongly recommend you set ‘run-with-staging-server’ during test |
|
force bool |
Ignore the next renewal time and force to renew cert |
|
staging bool |
Run ACME operation with staging server. Due to CA rate limit, A10 strongly recommends you set this during test |
|
log_level int |
Level for logging output of ACME commands(default 1 and detailed 2, including debug messages) |
|
renew_before bool |
Specify interval before certificate expiry to renew the certificate |
|
renew_before_type str |
‘hour’= Number of hours before cert expiry; ‘day’= Number of days before cert expiry; ‘week’= Number of weeks before cert expiry; ‘month’= Number of months before cert expiry(1 month=30 days); |
|
renew_before_value int |
Value of renewal period |
|
renew_every bool |
Specify periodic interval in which to renew the certificate |
|
minute int |
Periodic interval in minutes |
|
renew_every_type str |
‘hour’= Periodic interval in hours; ‘day’= Periodic interval in days; ‘week’= Periodic interval in weeks; ‘month’= Periodic interval in months(1 month=30 days); |
|
renew_every_value int |
Value of renewal period |
|
cert_type bool |
Specify the type of certificate |
|
rsa_type bool |
RSA certificate (default) |
|
ecdsa_type bool |
ECDSA certificate |
|
rsa_key_length str |
‘2048’= Key size 2048 bits(default); ‘3072’= Key size 3072 bits; ‘4096’= Key size 4096 bits; ‘8192’= Key size 8192 bits; |
|
ec_key_length str |
‘256’= Key size 256 bits; ‘384’= Key size 384 bits(default); |
|
str |
A valid email address for your ACME account. CA uses this email to send you expiration or other notices |
|
vrid int |
Specify ha VRRP-A vrid. It is used to sync http-01 challenge token |
|
eab_key_id str |
The key identifier for ACME External Account Binding |
|
eab_hmac_key bool |
The HMAC key for ACME External Account Binding |
|
secret_string str |
The HMAC key for ACME External Account Binding |
|
encrypted str |
Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED secret string) |
|
uuid str |
uuid of the object |
|
user_tag str |
Customized tag |
Examples
Return Values
- modified_values (changed, dict, )
Values modified (or potential changes if using check_mode) as a result of task operation
- axapi_calls (always, list, )
Sequential list of AXAPI calls made by the task
- endpoint (, str, [‘/axapi/v3/slb/virtual_server’, ‘/axapi/v3/file/ssl-cert’])
The AXAPI endpoint being accessed.
- http_method (, str, [‘POST’, ‘GET’])
HTTP method being used by the primary task to interact with the AXAPI endpoint.
- request_body (, complex, )
Params used to query the AXAPI
- response_body (, complex, )
Response from the AXAPI
Status
This module is not guaranteed to have a backwards compatible interface. [preview]
This module is maintained by community.