community.hrobot.failover_ip_info module – Retrieve information on Hetzner’s failover IPs

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

Synopsis

  • Retrieve information on Hetzner’s failover IPs.

Parameters

Parameter

Comments

failover_ip

string / required

The failover IP address.

hetzner_password

string / required

The password for the Robot web-service user.

hetzner_user

string / required

The username for the Robot web-service user.

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

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

This action does not modify state.

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

diff_mode

Support: N/A

This action does not modify state.

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

idempotent

Support: full

This action does not modify state.

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.

See Also

See also

Failover IP documentation

Hetzner’s documentation on failover IPs.

community.hrobot.failover_ip

Manage failover IPs.

Examples

---
- name: Get value of failover IP 1.2.3.4
  community.hrobot.failover_ip_info:
    hetzner_user: foo
    hetzner_password: bar
    failover_ip: 1.2.3.4
    value: 5.6.7.8
  register: result

- name: Print value of failover IP 1.2.3.4 in case it is routed
  ansible.builtin.debug:
    msg: "1.2.3.4 routes to {{ result.value }}"
  when: result.state == 'routed'

Return Values

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

Key

Description

failover_ip

string

The failover IP.

Returned: success

Sample: "1.2.3.4"

failover_netmask

string

The netmask for the failover IP.

Returned: success

Sample: "255.255.255.255"

server_ip

string

The main IP of the server this failover IP is associated to.

This is not the server the failover IP is routed to.

Returned: success

server_number

integer

The number of the server this failover IP is associated to.

This is not the server the failover IP is routed to.

Returned: success

state

string

Will be routed or unrouted.

Returned: success

value

string

The value of the failover IP.

Will be none if the IP is unrouted.

Returned: success

Authors

  • Felix Fontein (@felixfontein)