hetzner.hcloud.datacenter_info module – Gather info about the Hetzner Cloud datacenters.
Note
This module is part of the hetzner.hcloud collection (version 3.1.1).
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.datacenter_info
.
Synopsis
Gather info about your Hetzner Cloud datacenters.
Aliases: hcloud_datacenter_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 |
---|---|
The API Endpoint for the Hetzner Cloud. You can also set this option by using the Default: |
|
The API Token for the Hetzner Cloud. You can also set this option by using the |
|
The ID of the datacenter you want to get. The module will fail if the provided ID is invalid. |
|
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
hetzner.hcloud.datacenter_info:
register: output
- name: Print the gathered info
debug:
var: output
- name: List available server_types in a datacenter
block:
- name: Gather a hcloud datacenter
hetzner.hcloud.datacenter_info:
name: fsn1-dc14
register: output
- name: Gather a hcloud datacenter available server_types
hetzner.hcloud.server_type_info:
id: "{{ item }}"
loop: "{{ output.hcloud_datacenter_info[0].server_types.available }}"
register: available_server_types
- name: Print a hcloud datacenter available server_types
ansible.builtin.debug:
var: available_server_types.results | map(attribute='hcloud_server_type_info')
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The datacenter info as list Returned: always |
|
City of the location Returned: always Sample: |
|
Detail description of the datacenter Returned: always Sample: |
|
Numeric identifier of the datacenter Returned: always Sample: |
|
Name of the location where the datacenter resides in Returned: always Sample: |
|
Name of the datacenter Returned: always Sample: |
|
The Server types the Datacenter can handle Returned: always |
|
IDs of Server types that are supported and for which the Datacenter has enough resources left Returned: always Sample: |
|
IDs of Server types that are supported and for which the Datacenter has enough resources left Returned: always Sample: |
|
IDs of Server types that are supported in the Datacenter Returned: always Sample: |