New in version 2.7.
The below requirements are needed on the host that executes this module.
Parameter | Choices/Defaults | Comments |
---|---|---|
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.
In case
cryptography is used, the content is not written into a temporary file. It can still happen that it is written to disk by Ansible in the process of moving the module with its argument to the node where it is executed. |
|
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 ... . Any other tool creating private keys in PEM format can be used as well.Mutually exclusive with
account_key_content .Required if
account_key_content is not used.aliases: account_key |
|
account_uri
-
added in 2.7 |
If specified, assumes that the account URI is as given. If the account key does not match this account, or an account with this URI does not exist, the module fails.
|
|
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.
For Let's Encrypt, all staging endpoints can be found here: https://letsencrypt.org/docs/staging-environment/
For Let's Encrypt, the production directory URL for ACME v1 is https://acme-v01.api.letsencrypt.org/directory, and the production directory URL for ACME v2 is https://acme-v02.api.letsencrypt.org/directory.
Warning: So far, the module has only been tested against Let's Encrypt (staging and production) and against the Pebble testing server.
|
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.
|
select_crypto_backend
string
added in 2.7 |
|
Determines which crypto backend to use. The default choice is
auto , which tries to use cryptography if available, and falls back to openssl .If set to
openssl , will try to use the openssl binary.If set to
cryptography , will try to use the cryptography library. |
validate_certs
boolean
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. |
Note
cryptography
library is available (see Requirements for details), it will be used instead of the openssl
binary. This can be explicitly disabled or enabled with the select_crypto_backend
option. Note that using the openssl
binary will be slower and less secure, as private key contents always have to be stored on disk (see account_key_content
).- name: Check whether an account with the given account key exists
acme_account_facts:
account_key_src: /etc/pki/cert/private/account.key
register: account_data
- name: Verify that account exists
assert:
that:
- account_data.exists
- name: Print account URI
debug: var=account_data.account_uri
- name: Print account contacts
debug: var=account_data.account.contact
- name: Check whether the account exists and is accessible with the given account key
acme_account_facts:
account_key_content: "{{ acme_account_key }}"
account_uri: "{{ acme_account_uri }}"
register: account_data
- name: Verify that account exists
assert:
that:
- account_data.exists
- name: Print account contacts
debug: var=account_data.account.contact
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | |
---|---|---|---|
account
complex
|
if account exists |
The account information, as retrieved from the ACME server.
|
|
contact
list
|
always |
the challenge resource that must be created for validation
Sample:
['mailto:me@example.com', 'tel:00123456789']
|
|
orders
string
|
always |
a URL where a list of orders can be retrieved for this account
Sample:
https://example.ca/account/1/orders
|
|
status
string
|
always |
the account's status
Sample:
valid
|
|
account_uri
string
|
always |
ACME account URI, or None if account does not exist.
|
|
exists
boolean
|
always |
Whether the account exists.
|
Hint
If you notice any issues in this documentation you can edit this document to improve it.