hetzner.hcloud.zone_rrset_info module – Gather infos about your Hetzner Cloud Zone RRSets.

Note

This module is part of the hetzner.hcloud collection (version 5.4.0).

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 hetzner.hcloud. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: hetzner.hcloud.zone_rrset_info.

Synopsis

Aliases: hcloud_zone_rrset_info

Requirements

The below requirements are needed on the host that executes this module.

  • python-dateutil >= 2.7.5

  • requests >=2.20

Parameters

Parameter

Comments

api_endpoint

aliases: endpoint

string

The API Endpoint for the Hetzner Cloud.

You can also set this option by using the HCLOUD_ENDPOINT environment variable.

Default: "https://api.hetzner.cloud/v1"

api_token

string / required

The API Token for the Hetzner Cloud.

You can also set this option by using the HCLOUD_TOKEN environment variable.

id

string

ID of the Zone RRSet you want to get.

label_selector

string

Label selector to filter the Zone RRSets you want to get.

name

string

Name of the Zone RRSets you want to get.

type

string

Type of the Zone RRSets you want to get.

zone

string / required

Name or ID of the parent Zone.

See Also

See also

Documentation for Hetzner Cloud API

Complete reference for the Hetzner Cloud API.

Examples

- name: Gather Zone RRSet infos
  hetzner.hcloud.zone_rrset_info:
  register: output
- name: Print the gathered infos
  debug:
    var: output.hcloud_zone_rrset_info

Return Values

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

Key

Description

hcloud_zone_rrset_info

list / elements=dictionary

Zone RRSet infos as list.

Returned: always

change_protection

boolean

Protect the Zone RRSet from changes (deletion and updates).

Returned: always

Sample: false

id

string

ID of the Zone RRSet.

Returned: always

Sample: "www/A"

labels

dictionary

User-defined labels (key-value pairs)

Returned: always

Sample: {"key": "value"}

name

string

Name of the Zone RRSet.

Returned: always

Sample: "www"

records

list / elements=dictionary

Record of the Zone RRSet.

Returned: always

comment

string

Comment of the Record.

Returned: always

Sample: "webserver 1"

value

string

Value of the Record.

Returned: always

Sample: "203.0.113.1"

ttl

integer

TTL of the Zone RRSet.

Returned: always

Sample: 10800

type

string

Mode of the Zone RRSet.

Returned: always

Sample: "A"

zone

integer

ID of the parent Zone.

Returned: always

Sample: 42

Authors

  • Jonas Lammler (@jooola)