community.hrobot.failover_ip_info module – Retrieve information on Hetzner’s failover IPs
Note
This module is part of the community.hrobot collection (version 1.6.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_info
.
Synopsis
Retrieve information on Hetzner’s failover IPs.
Parameters
Parameter |
Comments |
---|---|
The failover IP address. |
|
The password for the Robot webservice user. |
|
The username for the Robot webservice user. |
Attributes
Attribute |
Support |
Description |
---|---|---|
Action group: community.hrobot.robot added in community.hrobot 1.6.0 |
Use |
|
Support: full This action does not modify state. |
Can run in |
|
Support: N/A This action does not modify state. |
Will return details on what has changed (or possibly needs changing in |
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 |
---|---|
The failover IP. Returned: success Sample: |
|
The netmask for the failover IP. Returned: success Sample: |
|
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 |
|
The number of the server this failover IP is associated to. This is not the server the failover IP is routed to. Returned: success |
|
Will be Returned: success |
|
The value of the failover IP. Will be Returned: success |
Collection links
Issue Tracker Repository (Sources) Submit a bug report Request a feature Communication