W3cubDocs

/Ansible

hetzner.hcloud.server_type_info module – Gather infos about the Hetzner Cloud server types.

Note

This module is part of the hetzner.hcloud collection (version 4.3.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. 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_type_info.

Synopsis

  • Gather infos about your Hetzner Cloud server types.

Aliases: hcloud_server_type_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 type you want to get.

The module will fail if the provided ID is invalid.

name

string

The name of the server type 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 type infos
  hetzner.hcloud.server_type_info:
  register: output

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

Return Values

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

Key

Description

hcloud_server_type_info

complex

The server type infos as list

Returned: always

architecture

string

Architecture of cpu

Returned: always

Sample: "x86"

cores

integer

Number of cpu cores a server of this type will have

Returned: always

Sample: 1

cpu_type

string

Type of cpu

Returned: always

Sample: "shared"

deprecation

dictionary

Describes if, when & how the resources was deprecated. If this field is set to None the resource is not deprecated. If it has a value, it is considered deprecated.

Returned: success

announced

string

Date of when the deprecation was announced.

Returned: success

Sample: "2021-11-09T09:00:00+00:00"

unavailable_after

string

After the time in this field, the resource will not be available from the general listing endpoint of the resource type, and it can not be used in new resources. For example, if this is an image, you can not create new servers with this image after the mentioned date.

Returned: success

Sample: "2021-12-01T00:00:00+00:00"

description

string

Detail description of the server type

Returned: always

Sample: "Falkenstein DC Park 1"

disk

integer

Disk size a server of this type will have in GB

Returned: always

Sample: 25

id

integer

Numeric identifier of the server type

Returned: always

Sample: 1937415

included_traffic

integer

Free traffic per month in bytes Deprecated: This field is deprecated and will be set to None on 5 August 2024. See https://docs.hetzner.cloud/changelog#2024-07-25-cloud-api-returns-traffic-information-in-different-format.

Returned: always

Sample: 21990232555520

memory

integer

Memory a server of this type will have in GB

Returned: always

Sample: 1

name

string

Name of the server type

Returned: always

Sample: "fsn1"

storage_type

string

Type of server boot drive

Returned: always

Sample: "local"

Authors

  • Lukas Kaemmerling (@LKaemmerling)

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/hetzner/hcloud/server_type_info_module.html