hetzner.hcloud.floating_ip_info module – Gather infos about the Hetzner Cloud Floating IPs.

Note

This module is part of the hetzner.hcloud collection (version 3.1.1).

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 hetzner.hcloud. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: hetzner.hcloud.floating_ip_info.

Synopsis

  • Gather facts about your Hetzner Cloud Floating IPs.

Aliases: hcloud_floating_ip_info

Requirements

The below requirements are needed on the host that executes this module.

  • python-dateutil >= 2.7.5

  • requests >=2.20

Parameters

Parameter

Comments

api_endpoint

aliases: endpoint

string

The API Endpoint for the Hetzner Cloud.

You can also set this option by using the HCLOUD_ENDPOINT environment variable.

Default: "https://api.hetzner.cloud/v1"

api_token

string / required

The API Token for the Hetzner Cloud.

You can also set this option by using the HCLOUD_TOKEN environment variable.

id

integer

The ID of the Floating IP you want to get.

The module will fail if the provided ID is invalid.

label_selector

string

The label selector for the Floating IP you want to get.

name

string

The name for the Floating IP you want to get.

See Also

See also

Documentation for Hetzner Cloud API

Complete reference for the Hetzner Cloud API.

Examples

- name: Gather hcloud Floating ip infos
  hetzner.hcloud.floating_ip_info:
  register: output
- name: Print the gathered infos
  debug:
    var: output

Return Values

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

Key

Description

hcloud_floating_ip_info

complex

The Floating ip infos as list

Returned: always

delete_protection

boolean

added in hetzner.hcloud 0.1.0

True if the Floating IP is protected for deletion

Returned: always

description

string

Description of the Floating IP

Returned: always

Sample: "Falkenstein DC 8"

home_location

string

Location the Floating IP was created in

Returned: always

Sample: "fsn1"

id

integer

Numeric identifier of the Floating IP

Returned: always

Sample: 1937415

ip

string

IP address of the Floating IP

Returned: always

Sample: "131.232.99.1"

labels

dictionary

User-defined labels (key-value pairs)

Returned: always

name

string

added in hetzner.hcloud 0.1.0

Name of the Floating IP

Returned: Always

Sample: "my-floating-ip"

server

string

Name of the server where the Floating IP is assigned to.

Returned: always

Sample: "my-server"

type

string

Type of the Floating IP

Returned: always

Sample: "ipv4"

Authors

  • Lukas Kaemmerling (@LKaemmerling)