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

Note

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

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.location_info.

Synopsis

  • Gather infos about your Hetzner Cloud locations.

Aliases: hcloud_location_info

Requirements

The below requirements are needed on the host that executes this module.

  • python-dateutil >= 2.7.5

  • requests >=2.20

Parameters

Parameter

Comments

api_endpoint

aliases: endpoint

string

The API Endpoint for the Hetzner Cloud.

You can also set this option by using the HCLOUD_ENDPOINT environment variable.

Default: "https://api.hetzner.cloud/v1"

api_token

string / required

The API Token for the Hetzner Cloud.

You can also set this option by using the HCLOUD_TOKEN environment variable.

id

integer

The ID of the location you want to get.

The module will fail if the provided ID is invalid.

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