community.hrobot.failover_ip – Manage Hetzner’s failover IPs

From Get docs
Ansible/docs/2.11/collections/community/hrobot/failover ip module


community.hrobot.failover_ip – Manage 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.


Synopsis

  • Manage 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.

state

string

  • routed

  • unrouted

Defines whether the IP will be routed or not.

If set to routed, value must be specified.

timeout

integer

Default:

180

Timeout to use when routing or unrouting the failover IP.

Note that the API call returns when the failover IP has been successfully routed to the new address, respectively successfully unrouted.

value

string

The new value for the failover IP address.

Required when setting state to routed.



See Also

See also

Failover IP documentation
Hetzner’s documentation on failover IPs.
community.hrobot.failover_ip_info
Retrieve information on failover IPs.


Examples

- name: Set value of failover IP 1.2.3.4 to 5.6.7.8
  community.hrobot.failover_ip:
    hetzner_user: foo
    hetzner_password: bar
    failover_ip: 1.2.3.4
    value: 5.6.7.8

- name: Set value of failover IP 1.2.3.4 to unrouted
  community.hrobot.failover_ip:
    hetzner_user: foo
    hetzner_password: bar
    failover_ip: 1.2.3.4
    state: unrouted

Return Values

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

Key Returned Description

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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/hrobot/failover_ip_module.html