On this page
hetzner.hcloud.hcloud_server_type_info – Gather infos about the Hetzner Cloud server types.
Note
This plugin is part of the hetzner.hcloud collection (version 1.6.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
.
To use it in a playbook, specify: hetzner.hcloud.hcloud_server_type_info
.
Synopsis
- Gather infos about your Hetzner Cloud server types.
- This module was called
hcloud_server_type_facts
before Ansible 2.9, returningansible_facts
andhcloud_server_type_facts
. Note that the hetzner.hcloud.hcloud_server_type_info module no longer returnsansible_facts
and the value was renamed tohcloud_server_type_info
!
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 server type you want to get.
|
|
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
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 | Returned | Description | |
---|---|---|---|
hcloud_server_type_info
complex
|
always |
The server type infos as list
|
|
cores
integer
|
always |
Number of cpu cores a server of this type will have
Sample:
1
|
|
cpu_type
string
|
always |
Type of cpu
Sample:
shared
|
|
description
string
|
always |
Detail description of the server type
Sample:
Falkenstein DC Park 1
|
|
disk
integer
|
always |
Disk size a server of this type will have in GB
Sample:
25
|
|
id
integer
|
always |
Numeric identifier of the server type
Sample:
1937415
|
|
memory
integer
|
always |
Memory a server of this type will have in GB
Sample:
1
|
|
name
string
|
always |
Name of the server type
Sample:
fsn1
|
|
storage_type
string
|
always |
Type of server boot drive
Sample:
local
|
Authors
- Lukas Kaemmerling (@LKaemmerling)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/hetzner/hcloud/hcloud_server_type_info_module.html