You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

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

Note

This plugin is part of the hetzner.hcloud 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 hetzner.hcloud.

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

Synopsis

• Gather facts about your Hetzner Cloud Floating IPs.

• This module was called hcloud_floating_ip_facts before Ansible 2.9, returning ansible_facts and hcloud_floating_ip_facts. Note that the hetzner.hcloud.hcloud_floating_ip_info module no longer returns ansible_facts and the value was renamed to hcloud_floating_ip_info!

Requirements

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

• hcloud-python >= 1.0.0

Parameters

Parameter	Comments
api_token string / required	This is the API Token for the Hetzner Cloud.
endpoint string	This is the API Endpoint for the Hetzner Cloud. Default: “https://api.hetzner.cloud/v1”
id integer	The ID of the Floating IP you want to get.
label_selector string	The label selector 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
  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 0.1.0 of hetzner.hcloud	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 0.1.0 of hetzner.hcloud	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)