community.hrobot.reverse_dns module – Set or remove reverse DNS entry for IP

Note

This module is part of the community.hrobot collection (version 2.5.2).

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.hrobot.

To use it in a playbook, specify: community.hrobot.reverse_dns.

New in community.hrobot 1.2.0

Synopsis

  • Allows to set, update or remove a reverse DNS entry for an IP address.

Parameters

Parameter

Comments

hetzner_password

string / required

The password for the Robot web-service user.

hetzner_user

string / required

The username for the Robot web-service user.

ip

string / required

The IP address to set or remove a reverse DNS entry for.

rate_limit_retry_timeout

integer

added in community.hrobot 2.1.0

Timeout (in seconds) for waiting when rate limit exceeded errors are returned.

Set to 0 to not retry.

Set to a negative value like -1 to retry forever.

Default: -1

state

string

Whether to set or update (present) or delete (absent) the reverse DNS entry for ip.

Choices:

  • "present" ← (default)

  • "absent"

value

string

The reverse DNS entry for ip.

Required if state=present.

Attributes

Attribute

Support

Description

action_group

Action group: community.hrobot.robot

added in community.hrobot 1.6.0

Use group/community.hrobot.robot in module_defaults to set defaults for this module.

check_mode

Support: full

Can run in check_mode and return changed status prediction without modifying target.

diff_mode

Support: none

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

idempotent

Support: full

When run twice in a row outside check mode, with the same arguments, the second invocation indicates no change.

This assumes that the system controlled/queried by the module has not changed in a relevant way.

Notes

Note

  • For the main IPv4 address of a server, deleting it actually sets it to a default hostname like static.X.Y.Z.W.clients.your-server.de. This substitution (delete is replaced by changing to this value) is done automatically by the API and results in the module not being idempotent in this case.

Examples

---
- name: Set reverse DNS entry for 1.2.3.4
  community.hrobot.reverse_dns:
    hetzner_user: foo
    hetzner_password: bar
    ip: 1.2.3.4
    value: foo.example.com

- name: Remove reverse DNS entry for 2a01:f48:111:4221::1
  community.hrobot.reverse_dns:
    hetzner_user: foo
    hetzner_password: bar
    ip: 2a01:f48:111:4221::1
    state: absent

Authors

  • Felix Fontein (@felixfontein)