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

Note

This plugin is part of the hetzner.hcloud collection (version 1.6.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.

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 Choices/Defaults Comments
api_token
string / required
This is the API Token for the Hetzner Cloud.
endpoint
string
Default:
"https://api.hetzner.cloud/v1"
This is the API Endpoint for the Hetzner Cloud.
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 Returned Description
hcloud_location_info
complex
always
The location infos as list

city
string
always
City of the location

Sample:
Falkenstein
country
string
always
Country code of the location

Sample:
DE
description
string
always
Detail description of the location

Sample:
Falkenstein DC Park 1
id
integer
always
Numeric identifier of the location

Sample:
1937415
name
string
always
Name of the location

Sample:
fsn1


Authors

  • Lukas Kaemmerling (@LKaemmerling)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/hetzner/hcloud/hcloud_location_info_module.html