/ home / ansible / ansible.builtin / v2.9.25 / module / hcloud_location_info

ansible.builtin.hcloud_location_info (v2.9.25) — module

Gather infos about your Hetzner Cloud locations.

| "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.9.25

Description

Gather infos about your Hetzner Cloud locations.

This module was called C(hcloud_location_facts) before Ansible 2.9, returning C(ansible_facts) and C(hcloud_location_facts). Note that the M(hcloud_location_info) module no longer returns C(ansible_facts) and the value was renamed to C(hcloud_location_info)!

Requirements

hcloud-python >= 1.0.0

Usage examples

Scanned by Steampunk Spotter

- name: Gather hcloud location infos
  hcloud_location_info:
  register: output

Scanned by Steampunk Spotter

- name: Print the gathered infos
  debug:
    var: output

Inputs

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

name:
    description:
    - The name of the location you want to get.
    type: str

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.
    required: true
    type: str

Outputs

hcloud_location_info:
  contains:
    city:
      description: City of the location
      returned: always
      sample: Falkenstein
      type: str
    country:
      description: Country code of the location
      returned: always
      sample: DE
      type: str
    description:
      description: Detail description of the location
      returned: always
      sample: Falkenstein DC Park 1
      type: str
    id:
      description: Numeric identifier of the location
      returned: always
      sample: 1937415
      type: int
    name:
      description: Name of the location
      returned: always
      sample: fsn1
      type: str
  description: The location infos as list
  returned: always
  type: complex

Install Ansible via pip