Docs4dev
Docs
ansible / 2.10 / collections / hetzner / hcloud / hcloud_floating_ip_info_module.html

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.2.1).

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 Choices/Defaults Comments
api_token
string / required
This is the API Token for the Hetzner Cloud.
endpoint
string
Default:
"https://api.hetzner.cloud/v1"
This is the API Endpoint for the Hetzner Cloud.
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 Returned Description
hcloud_floating_ip_info
complex
always
The Floating ip infos as list

delete_protection
boolean
added in 0.1.0 of hetzner.hcloud
always
True if the Floating IP is protected for deletion

description
string
always
Description of the Floating IP

Sample:
Falkenstein DC 8
home_location
string
always
Location the Floating IP was created in

Sample:
fsn1
id
integer
always
Numeric identifier of the Floating IP

Sample:
1937415
ip
string
always
IP address of the Floating IP

Sample:
131.232.99.1
labels
dictionary
always
User-defined labels (key-value pairs)

name
string
added in 0.1.0 of hetzner.hcloud
Always
Name of the Floating IP

Sample:
my-floating-ip
server
string
always
Name of the server where the Floating IP is assigned to.

Sample:
my-server
type
string
always
Type of the Floating IP

Sample:
ipv4


Authors

  • Lukas Kaemmerling (@LKaemmerling)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/hetzner/hcloud/hcloud_floating_ip_info_module.html