Note
This plugin is part of the community.hrobot collection (version 1.2.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 community.hrobot.
To use it in a playbook, specify: community.hrobot.failover_ip.
| 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 |
| 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
Hetzner’s documentation on failover IPs.
Retrieve information on failover IPs.
- 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
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. |
© 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/community/hrobot/failover_ip_module.html