community.dns.hetzner_dns_record – Add or delete a single record in Hetzner DNS service

Note

This plugin is part of the community.dns collection (version 2.0.3).

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.dns.

To use it in a playbook, specify: community.dns.hetzner_dns_record.

New in version 2.0.0: of community.dns

Synopsis

  • Creates and deletes single DNS records in Hetzner DNS service.

  • If you do not want to add/remove values, but replace values, you will be interested in modifying a record set and not a single record. This is in particular important when working with CNAME and SOA records. Use the community.dns.hetzner_dns_record_set module for working with record sets.

  • Records are matched by prefix / record name and value.

Parameters

Parameter Choices/Defaults Comments
hetzner_token
string / required
The token for the Hetzner API.
If not provided, will be read from the environment variable HETZNER_DNS_TOKEN.

aliases: api_token
prefix
string
The prefix of the DNS record.
This is the part of record before zone_name. For example, if the record to be modified is www.example.com for the zone example.com, the prefix is www. If the record in this example would be example.com, the prefix would be '' (empty string).
Exactly one of record and prefix must be specified.

aliases: name
record
string
The full DNS record to create or delete.
Exactly one of record and prefix must be specified.
state
string / required
    Choices:
  • present
  • absent
Specifies the state of the resource record.
ttl
integer
The TTL to give the new record, in seconds.
This is not used for record deletion.
txt_transformation
string
    Choices:
  • api
  • quoted
  • unquoted ←
Determines how TXT entry values are converted between the API and this module's input and output.
The value api means that values are returned from this module as they are returned from the API, and pushed to the API as they have been passed to this module. For idempotency checks, the input string will be compared to the strings returned by the API. The API might automatically transform some values, like splitting long values or adding quotes, which can cause problems with idempotency.
The value unquoted automatically transforms values so that you can pass in unquoted values, and the module will return unquoted values. If you pass in quoted values, they will be double-quoted.
The value quoted automatically transforms values so that you must use quoting for values that contain spaces, characters such as quotation marks and backslashes, and that are longer than 255 bytes. It also makes sure to return values from the API in a normalized encoding.
The default value, unquoted, ensures that you can work with values without having to care about how to correctly quote for DNS. Most users should use one of unquoted or quoted, but not api.
Note: the conversion code assumes UTF-8 encoding for values. If you need another encoding use txt_transformation=api and handle the encoding yourself.
type
string / required
    Choices:
  • A
  • AAAA
  • CAA
  • CNAME
  • DANE
  • DS
  • HINFO
  • MX
  • NS
  • RP
  • SOA
  • SRV
  • TLSA
  • TXT
The type of DNS record to create or delete.
value
string / required
The new value when creating a DNS record.
When deleting a record all values for the record must be specified or it will not be deleted.
zone_id
string
The ID of the DNS zone to modify.
Exactly one of zone_name and zone_id must be specified.
zone_name
string
The DNS zone to modify.
Exactly one of zone_name and zone_id must be specified.

aliases: zone

Notes

Note

  • Supports check_mode and --diff.

Examples

- name: Add a new.foo.com A record
  community.dns.hetzner_dns_record:
    state: present
    zone: foo.com
    record: new.foo.com
    type: A
    ttl: 7200
    value: 1.1.1.1
    hetzner_token: access_token

- name: Remove a new.foo.com A record
  community.dns.hosttech_dns_record_set:
    state: present
    zone_name: foo.com
    record: new.foo.com
    type: A
    ttl: 7200
    value: 2.2.2.2
    hetzner_token: access_token

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
zone_id
string
success
The ID of the zone.

Sample:
23


Authors