hcloud_server_facts – Gather facts about your Hetzner Cloud servers

From Get docs
Ansible/docs/2.8/modules/hcloud server facts module


hcloud_server_facts – Gather facts about your Hetzner Cloud servers

New in version 2.8.


Synopsis

  • Gather facts about your Hetzner Cloud servers.

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:

This is the API Endpoint for the Hetzner Cloud.

id

integer

The ID of the server you want to get.

label_selector

string

The label selector for the servery you want to get.

name

string

The name of the server you want to get.



See Also

See also

Documentation for Hetzner Cloud API
Complete reference for the Hetzner Cloud API.


Examples

- name: Gather hcloud server facts
  local_action:
    module: hcloud_server_facts

- name: Print the gathered facts
  debug:
    var: ansible_facts.hcloud_server_facts

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description

hcloud_server_facts

complex

always

The server facts as list


backup_window

boolean

always

Time window (UTC) in which the backup will run, or null if the backups are not enabled


Sample:

22-02

datacenter

string

always

Name of the datacenter of the server


Sample:

fsn1-dc14

id

integer

always

Numeric identifier of the server


Sample:

1937415

ipv4_address

string

always

Public IPv4 address of the server


Sample:

116.203.104.109

ipv6

string

always

IPv6 network of the server


Sample:

2a01:4f8:1c1c:c140::/64

labels

dictionary

always

User-defined labels (key-value pairs)


location

string

always

Name of the location of the server


Sample:

fsn1

name

string

always

Name of the server


Sample:

my-server

rescue_enabled

boolean

always

True if rescue mode is enabled, Server will then boot into rescue system on next reboot


server_type

string

always

Name of the server type of the server


Sample:

cx11

status

string

always

Status of the server


Sample:

running




Status

Authors

  • Lukas Kaemmerling (@lkaemmerling)

Hint

If you notice any issues in this documentation you can edit this document to improve it.


© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/hcloud_server_facts_module.html