hetzner.hcloud.server_info module – Gather infos about your Hetzner Cloud servers.

Note

This module is part of the hetzner.hcloud collection (version 4.2.2).

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.server_info.

Synopsis

  • Gather infos about your Hetzner Cloud servers.

Aliases: hcloud_server_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

api_endpoint

aliases: endpoint

string

The API Endpoint for the Hetzner Cloud.

You can also set this option by using the HCLOUD_ENDPOINT environment variable.

Default: "https://api.hetzner.cloud/v1"

api_token

string / required

The API Token for the Hetzner Cloud.

You can also set this option by using the HCLOUD_TOKEN environment variable.

id

integer

The ID of the server you want to get.

The module will fail if the provided ID is invalid.

label_selector

string

The label selector for the server 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 infos
  hetzner.hcloud.server_info:
  register: output

- name: Print the gathered infos
  debug:
    var: output.hcloud_server_info

Return Values

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

Key

Description

hcloud_server_info

complex

The server infos as list

Returned: always

backup_window

boolean

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

Returned: always

Sample: "22-02"

created

string

Point in time when the Server was created (in ISO-8601 format)

Returned: always

Sample: "2023-11-06T13:36:56+00:00"

datacenter

string

Name of the datacenter of the server

Returned: always

Sample: "fsn1-dc14"

delete_protection

boolean

added in hetzner.hcloud 0.1.0

True if server is protected for deletion

Returned: always

Sample: false

id

integer

Numeric identifier of the server

Returned: always

Sample: 1937415

ipv4_address

string

Public IPv4 address of the server

Returned: always

Sample: "116.203.104.109"

ipv6

string

IPv6 network of the server

Returned: always

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

labels

dictionary

User-defined labels (key-value pairs)

Returned: always

location

string

Name of the location of the server

Returned: always

Sample: "fsn1"

name

string

Name of the server

Returned: always

Sample: "my-server"

placement_group

string

added in hetzner.hcloud 1.5.0

Placement Group of the server

Returned: always

Sample: "4711"

private_networks

list / elements=string

List of private networks the server is attached to (name)

Returned: always

Sample: ["my-network", "another-network"]

private_networks_info

list / elements=dictionary

List of private networks the server is attached to (dict with name and ip)

Returned: always

Sample: [{"ip": "192.168.1.1", "name": "my-network"}, {"ip": "10.185.50.40", "name": "another-network"}]

rebuild_protection

boolean

added in hetzner.hcloud 0.1.0

True if server is protected for rebuild

Returned: always

Sample: false

rescue_enabled

boolean

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

Returned: always

Sample: false

server_type

string

Name of the server type of the server

Returned: always

Sample: "cx22"

status

string

Status of the server

Returned: always

Sample: "running"

Authors

  • Lukas Kaemmerling (@LKaemmerling)