community.general.hetzner_failover_ip (1.3.14) — module

Install collection

Install with ansible-galaxy collection install community.general:==1.3.14

Add to requirements.yml

  collections:
    - name: community.general
      version: 1.3.14

Description

Manage Hetzner's failover IPs.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Inputs

    
state:
    choices:
    - routed
    - unrouted
    default: routed
    description:
    - Defines whether the IP will be routed or not.
    - If set to C(routed), I(value) must be specified.
    type: str

value:
    description:
    - The new value for the failover IP address.
    - Required when setting I(state) to C(routed).
    type: str

timeout:
    default: 180
    description:
    - 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.
    type: int

failover_ip:
    description: The failover IP address.
    required: true
    type: str

hetzner_user:
    description: The username for the Robot webservice user.
    required: true
    type: str

hetzner_password:
    description: The password for the Robot webservice user.
    required: true
    type: str

Outputs

state:
  description:
  - Will be C(routed) or C(unrouted).
  returned: success
  type: str
value:
  description:
  - The value of the failover IP.
  - Will be C(none) if the IP is unrouted.
  returned: success
  type: str

See also

• Failover IP documentation: Hetzner's documentation on failover IPs. link
• community.general.hetzner_failover_ip_info : Retrieve information on failover IPs.