Parameter |
Choices/Defaults |
Comments |
account_email
|
|
The email address associated with this account.
It will be used for certificate expiration warnings.
|
account_key_content
(added in 2.5) |
|
Content of the ACME account RSA or Elliptic Curve key.
Mutually exclusive with account_key_src .
Required if account_key_src is not used.
Warning: the content will be written into a temporary file, which will be deleted by Ansible when the module completes. Since this is an important private key — it can be used to change the account key, or to revoke your certificates without knowing their private keys —, this might not be acceptable.
|
account_key_src
|
|
Path to a file containing the ACME account RSA or Elliptic Curve key.
RSA keys can be created with openssl rsa ... . Elliptic curve keys can be created with openssl ecparam -genkey ... .
Mutually exclusive with account_key_content .
Required if account_key_content is not used.
aliases: account_key
|
acme_directory
|
Default:
"https://acme-staging.api.letsencrypt.org/directory"
|
The ACME directory to use. This is the entry point URL to access CA server API.
For safety reasons the default is set to the Let's Encrypt staging server (for the ACME v1 protocol). This will create technically correct, but untrusted certificates.
|
acme_version
(added in 2.5) |
|
The ACME version of the endpoint.
Must be 1 for the classic Let's Encrypt ACME endpoint, or 2 for the new standardized ACME v2 endpoint.
|
agreement
|
|
URI to a terms of service document you agree to when using the ACME v1 service at acme_directory .
Default is latest gathered from acme_directory URL.
This option will only be used when acme_version is 1.
|
chain_dest
(added in 2.5) |
|
If specified, the intermediate certificate will be written to this file.
aliases: chain
|
challenge
|
Choices:
http-01 ←
- dns-01
|
The challenge to be performed.
|
csr
required |
|
File containing the CSR for the new certificate.
Can be created with openssl req ... .
The CSR may contain multiple Subject Alternate Names, but each one will lead to an individual challenge that must be fulfilled for the CSR to be signed.
Note: the private key used to create the CSR must not be the the account key. This is a bad idea from a security point of view, and the CA should not accept the CSR. Let's Encrypt will return an error in this case.
aliases: src
|
data
|
|
The data to validate ongoing challenges. This must be specified for the second run of the module only.
The value that must be used here will be provided by a previous use of this module. See the examples for more details.
Note: the data option was marked as no_log up to Ansible 2.5. From Ansible 2.6 on, it is no longer marked this way as it causes error messages to be come unusable, and data does not contain any information which can be used without having access to the account key or which are not public anyway.
|
deactivate_authzs
bool
(added in 2.6) |
|
Deactivate authentication objects (authz) after issuing a certificate, or when issuing the certificate failed.
Authentication objects are bound to an account key and remain valid for a certain amount of time, and can be used to issue certificates without having to re-authenticate the domain. This can be a security concern.
|
dest
|
|
The destination file for the certificate.
Required if fullchain_dest is not specified.
aliases: cert
|
force
bool
(added in 2.6) |
|
Enforces the execution of the challenge and validation, even if an existing certificate is still valid.
This is especially helpful when having an updated CSR e.g. with additional domains for which a new certificate is desired.
|
fullchain_dest
(added in 2.5) |
|
The destination file for the full chain (i.e. certificate followed by chain of intermediate certificates).
Required if dest is not specified.
aliases: fullchain
|
modify_account
bool
(added in 2.6) |
|
Boolean indicating whether the module should create the account if necessary, and update its contact data.
Set to no if you want to use acme_account to manage your account instead, and to avoid accidental creation of a new account using an old key if you changed the account key with acme_account .
If set to no , terms_agreed and account_email are ignored.
|
remaining_days
|
Default:
10
|
The number of days the certificate must have left being valid. If cert_days < remaining_days , then it will be renewed. If the certificate is not renewed, module return values will not include challenge_data .
|
terms_agreed
bool
(added in 2.5) |
|
Boolean indicating whether you agree to the terms of service document.
ACME servers can require this to be true.
This option will only be used when acme_version is not 1.
|
validate_certs
bool
(added in 2.5) |
|
Whether calls to the ACME directory will validate TLS certificates.
Warning: Should only ever be set to no for testing purposes, for example when testing against a local Pebble server.
|