hetzner.hcloud.hcloud_datacenter_info – Gather info about the Hetzner Cloud datacenters.
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_datacenter_info
.
Synopsis
Gather info about your Hetzner Cloud datacenters.
This module was called
hcloud_datacenter_facts
before Ansible 2.9, returningansible_facts
andhcloud_datacenter_facts
. Note that the hetzner.hcloud.hcloud_datacenter_info module no longer returnsansible_facts
and the value was renamed tohcloud_datacenter_info
!
Requirements
The below requirements are needed on the host that executes this module.
hcloud-python >= 1.0.0
Parameters
Parameter |
Comments |
---|---|
This is the API Token for the Hetzner Cloud. |
|
This is the API Endpoint for the Hetzner Cloud. Default: “https://api.hetzner.cloud/v1” |
|
The ID of the datacenter you want to get. |
|
The name of the datacenter you want to get. |
See Also
See also
- Documentation for Hetzner Cloud API
Complete reference for the Hetzner Cloud API.
Examples
- name: Gather hcloud datacenter info
hcloud_datacenter_info:
register: output
- name: Print the gathered info
debug:
var: output
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The datacenter info as list This module was called Returned: always |
|
City of the location Returned: always Sample: “fsn1” |
|
Detail description of the datacenter Returned: always Sample: “Falkenstein DC 8” |
|
Numeric identifier of the datacenter Returned: always Sample: 1937415 |
|
Name of the location where the datacenter resides in Returned: always Sample: “fsn1” |
|
Name of the datacenter Returned: always Sample: “fsn1-dc8” |
Authors
Lukas Kaemmerling (@LKaemmerling)