W3cubDocs

/Ansible

hetzner.hcloud.hcloud_rdns – Create and manage reverse DNS entries on the Hetzner Cloud.

Note

This plugin is part of the hetzner.hcloud collection (version 1.6.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.

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

Synopsis

  • Create, update and delete reverse DNS entries on the Hetzner Cloud.

Requirements

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

  • hcloud-python >= 1.0.0
  • hcloud-python >= 1.3.0

Parameters

Parameter Choices/Defaults Comments
api_token
string / required
This is the API Token for the Hetzner Cloud.
dns_ptr
string
The DNS address the ip_address should resolve to.
Omit the param to reset the reverse DNS entry to the default value.
endpoint
string
Default:
"https://api.hetzner.cloud/v1"
This is the API Endpoint for the Hetzner Cloud.
floating_ip
string
The name of the Hetzner Cloud Floating IP you want to add the reverse DNS entry to.
ip_address
string / required
The IP address that should point to dns_ptr.
load_balancer
string
The name of the Hetzner Cloud Load Balancer you want to add the reverse DNS entry to.
server
string
The name of the Hetzner Cloud server you want to add the reverse DNS entry to.
state
string
    Choices:
  • absent
  • present ←
State of the reverse DNS entry.

See Also

See also

Documentation for Hetzner Cloud API

Complete reference for the Hetzner Cloud API.

Examples

- name: Create a reverse DNS entry for a server
  hcloud_rdns:
    server: my-server
    ip_address: 123.123.123.123
    dns_ptr: example.com
    state: present

- name: Create a reverse DNS entry for a Floating IP
  hcloud_rdns:
    floating_ip: my-floating-ip
    ip_address: 123.123.123.123
    dns_ptr: example.com
    state: present

- name: Create a reverse DNS entry for a Load Balancer
  hcloud_rdns:
    load_balancer: my-load-balancer
    ip_address: 123.123.123.123
    dns_ptr: example.com
    state: present

- name: Ensure the reverse DNS entry is absent (remove if needed)
  hcloud_rdns:
    server: my-server
    ip_address: 123.123.123.123
    dns_ptr: example.com
    state: absent

Return Values

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

Key Returned Description
hcloud_rdns
complex
always
The reverse DNS entry
dns_ptr
string
always
The DNS that resolves to the IP

Sample:
example.com
floating_ip
string
always
Name of the Floating IP

Sample:
my-floating-ip
ip_address
string
always
The IP address that point to the DNS ptr

Sample:
123.123.123.123
load_balancer
string
always
Name of the Load Balancer

Sample:
my-load-balancer
server
string
always
Name of the server

Sample:
my-server


Authors

  • Lukas Kaemmerling (@lkaemmerling)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/hetzner/hcloud/hcloud_rdns_module.html