/ home / ansible / ansible.builtin / v2.8.17 / module / hcloud_floating_ip_facts

ansible.builtin.hcloud_floating_ip_facts (v2.8.17) — module

Gather facts about the Hetzner Cloud Floating IPs.

| "added in version" 2.8 of ansible.builtin"

Authors: Lukas Kaemmerling (@lkaemmerling)

preview | supported by community

Install Ansible via `pip`

Install with pip install ansible==2.8.17

Description

Gather facts about your Hetzner Cloud Floating IPs.

Requirements

hcloud-python >= 1.20.0

Usage examples

Scanned by Steampunk Spotter

- name: Gather hcloud Floating ip facts
  local_action:
    module: hcloud_floating_ip_facts

Scanned by Steampunk Spotter

- name: Print the gathered facts
  debug:
    var: ansible_facts.hcloud_floating_ip_facts

Inputs

    
id:
    description:
    - The ID of the Floating IP you want to get.
    type: int

endpoint:
    default: https://api.hetzner.cloud/v1
    description:
    - This is the API Endpoint for the Hetzner Cloud.
    type: str

api_token:
    description:
    - This is the API Token for the Hetzner Cloud.
    - You can also set this option by using the environment variable HCLOUD_TOKEN
    required: true
    type: str

label_selector:
    description:
    - The label selector for the Floating IP you want to get.
    type: str

Outputs

hcloud_floating_ip_facts:
  contains:
    description:
      description: Description of the Floating IP
      returned: always
      sample: Falkenstein DC 8
      type: str
    home_location:
      description: Location the Floating IP was created in
      returned: always
      sample: fsn1
      type: str
    id:
      description: Numeric identifier of the Floating IP
      returned: always
      sample: 1937415
      type: int
    ip:
      description: IP address of the Floating IP
      returned: always
      sample: 131.232.99.1
      type: str
    labels:
      description: User-defined labels (key-value pairs)
      returned: always
      type: dict
    server:
      description: Name of the server where the Floating IP is assigned to.
      returned: always
      sample: my-server
      type: str
    type:
      description: Type of the Floating IP
      returned: always
      sample: ipv4
      type: str
  description: The Floating ip facts as list
  returned: always
  type: complex

Install Ansible via pip