community.dns.hetzner_dns_record_info module – Retrieve records in Hetzner DNS service
Note
This module is part of the community.dns collection (version 2.4.2).
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_info
.
New in community.dns 2.0.0
Synopsis
Retrieves DNS records in Hetzner DNS service.
Parameters
Parameter |
Comments |
---|---|
The token for the Hetzner API. If not provided, will be read from the environment variable |
|
The prefix of the DNS record. This is the part of record before zone_name. For example, if the record to be modified is If what is |
|
The full DNS record to retrieve. If what is |
|
Determines how TXT entry values are converted between the API and this module’s input and output. The value The value The value The default value, Note: the conversion code assumes UTF-8 encoding for values. If you need another encoding use txt_transformation=api and handle the encoding yourself. Choices:
|
|
The type of DNS record to retrieve. Required if what is Choices:
|
|
Describes whether to fetch a single record and type combination, all types for a record, or all records. By default, a single record and type combination is fetched. Note that the return value structure depends on this option. Choices:
|
|
The ID of the DNS zone to modify. Exactly one of zone_name and zone_id must be specified. |
|
The DNS zone to modify. Exactly one of zone and zone_id must be specified. |
Attributes
Attribute |
Support |
Description |
---|---|---|
Action group: community.dns.hetzner added in community.dns 2.4.0 |
Use |
|
Support: full This action does not modify state. |
Can run in |
|
Support: N/A This action does not modify state. |
Will return details on what has changed (or possibly needs changing in |
Examples
- name: Retrieve the details for the A records of new.foo.com
community.dns.hetzner_dns_record_info:
zone: foo.com
record: new.foo.com
type: A
hetzner_token: access_token
register: rec
- name: Print the A records
ansible.builtin.debug:
msg: "{{ rec.records }}"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The list of fetched records. Returned: success and what is not Sample: |
|
Extra information on records. Returned: success Sample: |
|
The record prefix. Returned: success Sample: |
|
The record name. Returned: success Sample: |
|
The TTL. Will return Returned: success Sample: |
|
The DNS record type. Returned: success Sample: |
|
The DNS record’s value. Returned: success Sample: |
|
The ID of the zone. Returned: success Sample: |
Collection links
Issue Tracker Repository (Sources) Submit a bug report Request a feature Communication