community.dns.hetzner_dns_record_set_info module – Retrieve record sets in Hetzner DNS service
Note
This module is part of the community.dns collection (version 2.9.8).
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_set_info
.
New in community.dns 2.0.0
Synopsis
Retrieves DNS record sets 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 If |
|
Whether to treat numeric escape sequences ( The current default is Choices:
|
|
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 Choices:
|
|
The type of DNS record to retrieve. Required if 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:
|
|
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 |
See Also
See also
- community.dns.hetzner_dns_record_info
Retrieve records in Hetzner DNS service.
- community.dns.hetzner_dns_records inventory plugin
Create inventory from Hetzner DNS records.
Examples
- name: Retrieve the details for the A records of new.foo.com
community.dns.hetzner_dns_record_set_info:
zone: foo.com
record: new.foo.com
type: A
hetzner_token: access_token
register: rec
- name: Print the A record set
ansible.builtin.debug:
msg: "{{ rec.set }}"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The fetched record set. Is empty if record set does not exist. Returned: success and Sample: |
|
The record prefix. Returned: success Sample: |
|
The record name. Returned: success Sample: |
|
The TTL. If there are records in this set with different TTLs, the minimum of the TTLs will be presented here. Will return Returned: success Sample: |
|
If there are records with different TTL values in this set, this will be the list of TTLs appearing in the records. Every distinct TTL will appear once, and the TTLs are in ascending order. Returned: When there is more than one distinct TTL Sample: |
|
The DNS record type. Returned: success Sample: |
|
The DNS record set’s value. Returned: success Sample: |
|
The list of fetched record sets. Returned: success and Sample: |
|
The record prefix. Returned: success Sample: |
|
The record name. Returned: success Sample: |
|
The TTL. If there are records in this set with different TTLs, the minimum of the TTLs will be presented here. Will return Returned: success Sample: |
|
If there are records with different TTL values in this set, this will be the list of TTLs appearing in the records. Every distinct TTL will appear once, and the TTLs are in ascending order. Returned: When there is more than one distinct TTL Sample: |
|
The DNS record type. Returned: success Sample: |
|
The DNS record set’s value. Returned: success Sample: |
|
The ID of the zone. Returned: success Sample: |