community.dns.hetzner_dns_zone_info (2.8.3) — module

Install collection

Install with ansible-galaxy collection install community.dns:==2.8.3

Add to requirements.yml

  collections:
    - name: community.dns
      version: 2.8.3

Description

Retrieves zone information in Hetzner DNS service.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Retrieve details for foo.com zone
  community.dns.hetzner_dns_zone_info:
    zone: foo.com
    hetzner_token: access_token
  register: rec

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Retrieve details for zone 23
  community.dns.hetzner_dns_zone_info:
    zone_id: 23
    hetzner_token: access_token

Inputs

    
zone_id:
    description:
    - The ID of the DNS zone to query.
    - Exactly one of O(zone_name) and O(zone_id) must be specified.
    type: str
    version_added: 0.2.0
    version_added_collection: community.dns

zone_name:
    aliases:
    - zone
    description:
    - The DNS zone to query.
    - Exactly one of O(zone_name) and O(zone_id) must be specified.
    type: str

hetzner_token:
    aliases:
    - api_token
    description:
    - The token for the Hetzner API.
    - If not provided, will be read from the environment variable E(HETZNER_DNS_TOKEN).
    required: true
    type: str

Outputs

zone_id:
  description: The ID of the zone.
  returned: success
  sample: 23
  type: str
zone_info:
  contains:
    created:
      description:
      - The time when the zone was created.
      sample: '2021-07-15T19:23:58Z'
      type: str
    is_secondary_dns:
      description:
      - Indicates whether the zone is a secondary DNS zone.
      sample: true
      type: bool
    legacy_dns_host:
      description:
      - Unknown.
      type: str
    legacy_ns:
      description:
      - List of nameservers during import.
      elements: str
      type: list
    modified:
      description:
      - The time the zone was last modified.
      sample: '2021-07-15T19:23:58Z'
      type: str
    ns:
      description:
      - List of nameservers the zone should have for using Hetzner's DNS.
      elements: str
      type: list
    owner:
      description:
      - Owner of the zone.
      type: str
    paused:
      description:
      - Unknown.
      sample: true
      type: bool
    permission:
      description:
      - Zone's permissions.
      type: str
    project:
      description:
      - Unknown.
      type: str
    records_count:
      description:
      - Number of records associated to this zone.
      sample: 0
      type: int
    registrar:
      description:
      - Unknown.
      type: str
    status:
      description:
      - Status of the zone.
      - Can be one of V(verified), V(failed) and V(pending).
      sample: verified
      type: str
    ttl:
      description:
      - TTL of zone.
      sample: 0
      type: int
    txt_verification:
      contains:
        name:
          description:
          - The TXT record's name.
          type: str
        token:
          description:
          - The TXT record's content.
          type: str
      description:
      - 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.
      sample:
        name: ''
        token: ''
      type: dict
    verified:
      description:
      - Time when zone was verified.
      sample: '2021-07-15T19:23:58Z'
      type: str
  description:
  - Extra information returned by the API.
  returned: success
  type: dict
zone_name:
  description: The name of the zone.
  returned: success
  sample: example.com
  type: int