community.dns.hetzner_dns_zone_info module – Retrieve zone information 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_zone_info
.
New in community.dns 2.0.0
Synopsis
Retrieves zone information in Hetzner DNS service.
Parameters
Parameter |
Comments |
---|---|
The token for the Hetzner API. If not provided, will be read from the environment variable |
|
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 details for foo.com zone
community.dns.hetzner_dns_zone_info:
zone: foo.com
hetzner_token: access_token
register: rec
- name: Retrieve details for zone 23
community.dns.hetzner_dns_zone_info:
zone_id: 23
hetzner_token: access_token
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The ID of the zone. Returned: success Sample: |
|
Extra information returned by the API. Returned: success |
|
The time when the zone was created. Returned: success Sample: |
|
Indicates whether the zone is a secondary DNS zone. Returned: success Sample: |
|
Unknown. Returned: success |
|
List of nameservers during import. Returned: success |
|
The time the zone was last modified. Returned: success Sample: |
|
List of nameservers the zone should have for using Hetzner’s DNS. Returned: success |
|
Owner of the zone. Returned: success |
|
Unknown. Returned: success Sample: |
|
Zone’s permissions. Returned: success |
|
Unknown. Returned: success |
|
Number of records associated to this zone. Returned: success Sample: |
|
Unknown. Returned: success |
|
Status of the zone. Can be one of Returned: success Sample: |
|
TTL of zone. Returned: success Sample: |
|
Shape of the TXT record that has to be set to verify a zone. If name and token are empty, no TXT record needs to be set. Returned: success Sample: |
|
The TXT record’s name. Returned: success |
|
The TXT record’s content. Returned: success |
|
Time when zone was verified. Returned: success Sample: |
|
The name of the zone. Returned: success Sample: |