hcloud_floating_ip_facts – Gather facts about the Hetzner Cloud Floating IPs

From Get docs
Ansible/docs/2.8/modules/hcloud floating ip facts module


hcloud_floating_ip_facts – Gather facts about the Hetzner Cloud Floating IPs

New in version 2.8.


Synopsis

  • Gather facts about your Hetzner Cloud Floating IPs.

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:

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 facts
  local_action:
    module: hcloud_floating_ip_facts
- name: Print the gathered facts
  debug:
    var: ansible_facts.hcloud_floating_ip_facts

Return Values

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

Key Returned Description

hcloud_floating_ip_facts

complex

always

The Floating ip facts as list


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)


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




Status

Authors

  • Lukas Kaemmerling (@lkaemmerling)

Hint

If you notice any issues in this documentation you can edit this document to improve it.


© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/hcloud_floating_ip_facts_module.html