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

From Get docs
Ansible/docs/2.10/collections/community/hrobot/failover ip info module


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

Note

This plugin is part of the community.hrobot collection (version 1.1.0).

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 Choices/Defaults Comments

failover_ip

string / required

The failover IP address.

hetzner_password

string / required

The password for the Robot webservice user.

hetzner_user

string / required

The username for the Robot webservice user.



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 Returned Description

failover_ip

string

success

The failover IP.


Sample:

1.2.3.4

failover_netmask

string

success

The netmask for the failover IP.


Sample:

255.255.255.255

server_ip

string

success

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

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


server_number

integer

success

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

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


state

string

success

Will be routed or unrouted.


value

string

success

The value of the failover IP.

Will be none if the IP is unrouted.





Authors

  • Felix Fontein (@felixfontein)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/hrobot/failover_ip_info_module.html