hetzner.hcloud.hcloud_location_info module – Gather infos about your Hetzner Cloud locations.

Note

This module is part of the hetzner.hcloud collection (version 1.8.2).

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. You need further requirements to be able to use this module, see Requirements for details.

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

Synopsis

  • Gather infos about your Hetzner Cloud locations.

  • This module was called hcloud_location_facts before Ansible 2.9, returning ansible_facts and hcloud_location_facts. Note that the hetzner.hcloud.hcloud_location_info module no longer returns ansible_facts and the value was renamed to hcloud_location_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 location you want to get.

name

string

The name of the location you want to get.

See Also

See also

Documentation for Hetzner Cloud API

Complete reference for the Hetzner Cloud API.

Examples

- name: Gather hcloud location infos
  hcloud_location_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_location_info

complex

The location infos as list

Returned: always

city

string

City of the location

Returned: always

Sample: "Falkenstein"

country

string

Country code of the location

Returned: always

Sample: "DE"

description

string

Detail description of the location

Returned: always

Sample: "Falkenstein DC Park 1"

id

integer

Numeric identifier of the location

Returned: always

Sample: 1937415

name

string

Name of the location

Returned: always

Sample: "fsn1"

Authors

  • Lukas Kaemmerling (@LKaemmerling)