hcloud_datacenter_facts – Gather facts about the Hetzner Cloud datacenters¶
New in version 2.8.
Synopsis¶
Gather facts about your Hetzner Cloud datacenters.
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 facts
local_action:
module: hcloud_datacenter_facts
- name: Print the gathered facts
debug:
var: ansible_facts.hcloud_datacenter_facts
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description | |
|---|---|---|---|
|
hcloud_datacenter_facts
complex
|
always |
The datacenter facts as list
|
|
|
city
string
|
always |
City of the location
Sample:
fsn1
|
|
|
description
string
|
always |
Detail description of the location
Sample:
Falkenstein DC 8
|
|
|
id
integer
|
always |
Numeric identifier of the location
Sample:
1937415
|
|
|
location
string
|
always |
Name of the location where the datacenter resides in
Sample:
fsn1
|
|
|
name
string
|
always |
Name of the location
Sample:
fsn1-dc8
|
|
Status¶
This module is not guaranteed to have a backwards compatible interface. [preview]
This module is maintained by the Ansible Community. [community]