community.crypto.acme_dns_persist_record_parse filter – Parse a DNS record for ACME dns-persist-01 challenges

Note

This filter plugin is part of the community.crypto collection (version 3.3.0).

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.

To use it in a playbook, specify: community.crypto.acme_dns_persist_record_parse.

New in community.crypto 3.2.0

Synopsis

  • Parse the content for a ACME dns-persist-01 DNS TXT record _validation-persist.<domain>.

  • This filter conforms to the acme-dns-persist draft 01. Note that the supported draft version can change at any time, and changes will only be considered breaking once the draft reached RFC status.

Input

This describes the input of the filter, the value before | community.crypto.acme_dns_persist_record_parse.

Parameter

Comments

Input

string / required

The DNS TXT record entry.

See Also

See also

community.crypto.acme_certificate

Create SSL/TLS certificates with the ACME protocol.

community.crypto.acme_certificate_order_create

Create an ACME v2 order.

community.crypto.acme_certificate_order_validate

Validate authorizations of an ACME v2 order.

Examples

---
- name: Create _validation-persist.<domain> TXT record contents
  ansible.builtin.debug:
    msg: "{{ record | community.crypto.acme_dns_persist_record_parse }}"
  var:
    record: >-
      letsencrypt.org;
      accounturi=https://acme-v02.api.letsencrypt.org/acme/acct/1234;
      policy=wildcard;
      persistUntil=1774813004

- name: Create _validation-persist.<domain> TXT record for example.com
  community.dns.hetzner_dns_record_set:
    prefix: _validation-persist
    zone_name: example.com
    value:
      - >-
        {{
          'letsencrypt.org' | community.crypto.acme_dns_persist_record(
            account_uri='https://acme-v02.api.letsencrypt.org/acme/acct/4321',
            persist_until='20190331202428Z',
          )
        }}

Return Value

Key

Description

Return value

dictionary

The content for the _validation-persist.<domain> TXT record.

Returned: success

account_uri

string

The ACME account URI.

Returned: success

issuer_domain_name

string

The issuer domain name.

Returned: success

Sample: "letsencrypt.org"

persist_until

string

Until when the record is valid.

This is a UNIX timestamp, that is the number of seconds since January 1st, 1970, in UTC.

Is null if persistUntil is not present.

Returned: success

persist_until_str

string

A ASN.1 string representation of _value.persist_until.

Is null if persistUntil is not present.

Returned: success

policy

string

The validation scope.

Is null if not present.

Returned: success

Authors

  • Felix Fontein (@felixfontein)