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_factsbefore Ansible 2.9, returningansible_factsandhcloud_datacenter_facts. Note that the hetzner.hcloud.hcloud_datacenter_info module no longer returnsansible_factsand 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 | 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 datacenter you want to get.
|
|
| name
string
|
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 | Returned | Description | |
|---|---|---|---|
| hcloud_datacenter_info
complex
|
always |
The datacenter info as list
This module was called hcloud_datacenter_facts before Ansible 2.9, returning ansible_facts and hcloud_datacenter_facts. Note that the hetzner.hcloud.hcloud_datacenter_info module no longer returns ansible_facts and the value was renamed to hcloud_datacenter_info!
|
|
| city
string
|
always |
City of the location
Sample:
fsn1
|
|
| description
string
|
always |
Detail description of the datacenter
Sample:
Falkenstein DC 8
|
|
| id
integer
|
always |
Numeric identifier of the datacenter
Sample:
1937415
|
|
| location
string
|
always |
Name of the location where the datacenter resides in
Sample:
fsn1
|
|
| name
string
|
always |
Name of the datacenter
Sample:
fsn1-dc8
|
|
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_datacenter_info_module.html