Note
This module is part of the community.crypto collection (version 2.26.5).
You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install community.crypto. You need further requirements to be able to use this module, see Requirements for details.
To use it in a playbook, specify: community.crypto.acme_certificate_order_create.
New in community.crypto 2.24.0
http-01, dns-01 and tls-alpn-01 challenges.order_uri of this module.http-01 that means creating the necessary challenge file on the destination webserver. For dns-01 the necessary dns record has to be created. For tls-alpn-01 the necessary certificate has to be created and served. It is not the responsibility of this module to perform these steps.The below requirements are needed on the host that executes this module.
Parameter | Comments |
|---|---|
account_key_content string | Content of the ACME account RSA or Elliptic Curve key. For Elliptic Curve keys only the following curves are supported: Mutually exclusive with Required if 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 |
account_key_passphrase string added in community.crypto 1.6.0 | Phassphrase to use to decode the account key. Note: this is not supported by the |
account_key_src aliases: account_key path | Path to a file containing the ACME account RSA or Elliptic Curve key. For Elliptic Curve keys only the following curves are supported: Private keys can be created with the community.crypto.openssl_privatekey or community.crypto.openssl_privatekey_pipe modules. If the requisite (cryptography) is not available, keys can also be created directly with the Mutually exclusive with Required if |
account_uri string | 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 string / required | The ACME directory to use. This is the entry point URL to access the ACME 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 Buypass, all endpoints can be found here: https://community.buypass.com/t/63d4ay/buypass-go-ssl-endpoints. For Let’s Encrypt, the production directory URL for ACME v2 is https://acme-v02.api.letsencrypt.org/directory. For Buypass, the production directory URL for ACME v2 and v1 is https://api.buypass.com/acme/directory. For ZeroSSL, the production directory URL for ACME v2 is https://acme.zerossl.com/v2/DV90. For Sectigo, the production directory URL for ACME v2 is https://acme-qa.secure.trust-provider.com/v2/DV. For HARICA, the production directory URL for ACME v2 is https://acme.harica.gr/XXX/directory with XXX being specific to your account. The notes for this module contain a list of ACME services this module has been tested against. |
acme_version integer / required | The ACME version of the endpoint. Must be The value Choices:
|
csr path | File containing the CSR for the new certificate. Can be created with community.crypto.openssl_csr. 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 account key. This is a bad idea from a security point of view, and the CA should not accept the CSR. The ACME server should return an error in this case. Precisely one of |
csr_content string | Content of the CSR for the new certificate. Can be created with community.crypto.openssl_csr_pipe. 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 account key. This is a bad idea from a security point of view, and the CA should not accept the CSR. The ACME server should return an error in this case. Precisely one of |
deactivate_authzs boolean | Deactivate authentication objects (authz) 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. Choices:
|
order_creation_error_strategy string | Selects the error handling strategy for ACME protocol errors if creating a new ACME order fails. Choices:
|
order_creation_max_retries integer | Depending on the strategy selected in Default: |
profile string | Chose a specific profile for certificate selection. The available profiles depend on the CA. See a blog post by Let’s Encrypt and draft-aaron-acme-profiles-00 for more information. |
replaces_cert_id string | If provided, will request the order to replace the certificate identified by this certificate ID according to Section 5 of RFC 9773. This certificate ID must be computed as specified in Section 4.1 of RFC 9773. It is returned as return value ACME servers might refuse to create new orders that indicate to replace a certificate for which an active replacement order already exists. This can happen if this module is used to create an order, and then the playbook/role fails in case the challenges cannot be set up. If the playbook/role does not record the order data to continue with the existing order, but tries to create a new one on the next run, creating the new order might fail. If If |
request_timeout integer added in community.crypto 2.3.0 | The time Ansible should wait for a response from the ACME API. This timeout is applied to all HTTP(S) requests (HEAD, GET, POST). Default: |
select_crypto_backend string | Determines which crypto backend to use. The default choice is If set to If set to Choices:
|
validate_certs boolean | Whether calls to the ACME directory will validate TLS certificates. Warning: Should only ever be set to Choices:
|
Attribute | Support | Description |
|---|---|---|
action_group | Action groups: community.crypto.acme, acme | Use |
check_mode | Support: none | Can run in |
diff_mode | Support: none | Will return details on what has changed (or possibly needs changing in |
idempotent | Support: none | When run twice in a row outside check mode, with the same arguments, the second invocation indicates no change. This assumes that the system controlled/queried by the module has not changed in a relevant way. |
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).See also
Validate pending authorizations of an ACME order.
Finalize an ACME order after satisfying the challenges.
Obtain information for an ACME order.
Deactivate all authorizations (authz) of an ACME order, effectively deactivating the order itself.
Determine whether a certificate should be renewed.
Documentation for the Let’s Encrypt Certification Authority. Provides useful information for example on rate limits.
Documentation for the Buypass Certification Authority. Provides useful information for example on rate limits.
The specification of the ACME protocol (RFC 8555).
The specification of the tls-alpn-01 challenge (RFC 8737).
Helps preparing tls-alpn-01 challenges.
Can be used to create private keys (both for certificates and accounts).
Can be used to create private keys without writing it to disk (both for certificates and accounts).
Can be used to create a Certificate Signing Request (CSR).
Can be used to create a Certificate Signing Request (CSR) without writing it to disk.
Allows to create, modify or delete an ACME account.
Allows to debug problems.
---
### Example with HTTP-01 challenge ###
- name: Create a challenge for sample.com using a account key from a variable
community.crypto.acme_certificate_order_create:
account_key_content: "{{ account_private_key }}"
csr: /etc/pki/cert/csr/sample.com.csr
register: sample_com_challenge
# Alternative first step:
- name: Create a challenge for sample.com using a account key from Hashi Vault
community.crypto.acme_certificate_order_create:
account_key_content: >-
{{ lookup('community.hashi_vault.hashi_vault', 'secret=secret/account_private_key:value') }}
csr: /etc/pki/cert/csr/sample.com.csr
register: sample_com_challenge
# Alternative first step:
- name: Create a challenge for sample.com using a account key file
community.crypto.acme_certificate_order_create:
account_key_src: /etc/pki/cert/private/account.key
csr_content: "{{ lookup('file', '/etc/pki/cert/csr/sample.com.csr') }}"
register: sample_com_challenge
# Perform the necessary steps to fulfill the challenge. For example:
#
# - name: Copy http-01 challenges
# ansible.builtin.copy:
# dest: /var/www/{{ item.identifier }}/{{ item.challenges['http-01'].resource }}
# content: "{{ item.challenges['http-01'].resource_value }}"
# loop: "{{ sample_com_challenge.challenge_data }}"
# when: "'http-01' in item.challenges"
- name: Let the challenge be validated
community.crypto.acme_certificate_order_validate:
account_key_src: /etc/pki/cert/private/account.key
order_uri: "{{ sample_com_challenge.order_uri }}"
challenge: http-01
- name: Retrieve the cert and intermediate certificate
community.crypto.acme_certificate_order_finalize:
account_key_src: /etc/pki/cert/private/account.key
csr: /etc/pki/cert/csr/sample.com.csr
order_uri: "{{ sample_com_challenge.order_uri }}"
cert_dest: /etc/httpd/ssl/sample.com.crt
fullchain_dest: /etc/httpd/ssl/sample.com-fullchain.crt
chain_dest: /etc/httpd/ssl/sample.com-intermediate.crt
---
### Example with DNS challenge against production ACME server ###
- name: Create a challenge for sample.com using a account key file.
community.crypto.acme_certificate_order_create:
acme_directory: https://acme-v01.api.letsencrypt.org/directory
acme_version: 2
account_key_src: /etc/pki/cert/private/account.key
csr: /etc/pki/cert/csr/sample.com.csr
register: sample_com_challenge
# Perform the necessary steps to fulfill the challenge. For example:
#
# - name: Create DNS records for dns-01 challenges
# community.aws.route53:
# zone: sample.com
# record: "{{ item.key }}"
# type: TXT
# ttl: 60
# state: present
# wait: true
# # Note: item.value is a list of TXT entries, and route53
# # requires every entry to be enclosed in quotes
# value: "{{ item.value | map('community.dns.quote_txt', always_quote=true) | list }}"
# loop: "{{ sample_com_challenge.challenge_data_dns | dict2items }}"
- name: Let the challenge be validated
community.crypto.acme_certificate_order_validate:
acme_directory: https://acme-v01.api.letsencrypt.org/directory
acme_version: 2
account_key_src: /etc/pki/cert/private/account.key
order_uri: "{{ sample_com_challenge.order_uri }}"
challenge: dns-01
- name: Retrieve the cert and intermediate certificate
community.crypto.acme_certificate_order_finalize:
acme_directory: https://acme-v01.api.letsencrypt.org/directory
acme_version: 2
account_key_src: /etc/pki/cert/private/account.key
csr: /etc/pki/cert/csr/sample.com.csr
order_uri: "{{ sample_com_challenge.order_uri }}"
cert_dest: /etc/httpd/ssl/sample.com.crt
fullchain_dest: /etc/httpd/ssl/sample.com-fullchain.crt
chain_dest: /etc/httpd/ssl/sample.com-intermediate.crt
Common return values are documented here, the following are the fields unique to this module:
Key | Description |
|---|---|
account_uri string | ACME account URI. Returned: success |
challenge_data list / elements=dictionary | For every identifier, provides the challenge information. Only challenges which are not yet valid are returned. Returned: changed |
|
challenges dictionary |
Information for different challenge types supported for this identifier. Returned: success |
|
dns-01 dictionary |
Information for A DNS TXT record needs to be created with the record name Returned: if the identifier supports |
|
record string |
The full DNS record’s name for the challenge. Returned: success Sample: |
|
resource string |
Always contains the string Returned: success Sample: |
|
resource_value string |
The value the resource has to produce for the validation. Returned: success Sample: |
|
http-01 dictionary |
Information for The server needs to make the path Returned: if the identifier supports |
|
resource string |
The path the value has to be provided under. Returned: success Sample: |
|
resource_value string |
The value the resource has to produce for the validation. Returned: success Sample: |
|
tls-alpn-01 dictionary |
Information for A certificate needs to be created for the DNS name See https://www.rfc-editor.org/rfc/rfc8737.html#section-3 for details. Returned: if the identifier supports |
|
resource string |
The DNS name for DNS identifiers, and the reverse DNS mapping (RFC1034, RFC3596) for IP addresses. Returned: success Sample: |
|
resource_original string |
The original identifier including type identifier. Returned: success Sample: |
|
resource_value string |
The value the resource has to produce for the validation. Note: this return value contains a Base64 encoded version of the correct binary blob which has to be put into the acmeValidation X.509 extension; see https://www.rfc-editor.org/rfc/rfc8737.html#section-3 for details. To do this, you might need the ansible.builtin.b64decode Jinja filter to extract the binary blob from this return value. Returned: success Sample: |
|
identifier string |
The identifier for this challenge. Returned: success Sample: |
|
identifier_type string |
The identifier’s type.
Returned: success Can only return:
Sample: |
challenge_data_dns dictionary | List of TXT values per DNS record for Only challenges which are not yet valid are returned. Returned: success |
order_uri string | ACME order URI. Returned: success |
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/crypto/acme_certificate_order_create_module.html