New in version 2.8.
The below requirements are needed on the host that executes this module.
Parameter | Choices/Defaults | Comments |
---|---|---|
api_token
string
/ required
|
This is the API Token for the Hetzner Cloud.
|
|
backups
boolean
|
|
Enable or disable Backups for the given Server.
|
datacenter
string
|
Datacenter of Server.
Required of no location is given and server does not exists.
|
|
endpoint
string
|
Default: "https://api.hetzner.cloud/v1"
|
This is the API Endpoint for the Hetzner Cloud.
|
force_upgrade
boolean
|
|
Force the upgrade of the server.
Power off the server if it is running on upgrade.
|
id
integer
|
The ID of the Hetzner Cloud server to manage.
Only required if no server name is given
|
|
image
string
|
Image the server should be created from.
Required if server does not exists.
|
|
labels
dictionary
|
User-defined labels (key-value pairs).
|
|
location
string
|
Location of Server.
Required if no datacenter is given and server does not exists.
|
|
name
string
|
The Name of the Hetzner Cloud server to manage.
Only required if no server id is given or a server does not exists.
|
|
server_type
string
|
The Server Type of the Hetzner Cloud server to manage.
Required if server does not exists.
|
|
ssh_keys
list
|
List of SSH key names
The key names correspond to the SSH keys configured for your Hetzner Cloud account access.
|
|
state
string
|
|
State of the server.
|
upgrade_disk
boolean
|
|
Resize the disk size, when resizing a server.
If you want to downgrade the server later, this value should be False.
|
user_data
string
|
User Data to be passed to the server on creation.
Only used if server does not exists.
|
|
volumes
list
|
List of Volumes IDs that should be attached to the server on server creation.
|
See also
- name: Create a basic server
hcloud_server:
name: my-server
server_type: cx11
image: ubuntu-18.04
state: present
- name: Create a basic server with ssh key
hcloud_server:
name: my-server
server_type: cx11
image: ubuntu-18.04
location: fsn1
ssh_keys:
- me@myorganisation
state: present
- name: Resize an existing server
hcloud_server:
name: my-server
server_type: cx21
keep_disk: yes
state: present
- name: Ensure the server is absent (remove if needed)
hcloud_server:
name: my-server
state: absent
- name: Ensure the server is started
hcloud_server:
name: my-server
state: started
- name: Ensure the server is stopped
hcloud_server:
name: my-server
state: stopped
- name: Ensure the server is restarted
hcloud_server:
name: my-server
state: restarted
- name: Ensure the server is rebuild
hcloud_server:
name: my-server
image: ubuntu-18.04
state: rebuild
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
hcloud_server
dictionary
|
Always |
The server instance
Sample:
{'status': 'running', 'datacenter': 'nbg1-dc3', 'labels': {}, 'name': 'mein-server-2', 'server_type': 'cx11', 'image': 'ubuntu-18.04', 'rescue_enabled': False, 'ipv4_address': '116.203.104.109', 'backup_window': None, 'location': 'nbg1', 'ipv6': '2a01:4f8:1c1c:c140::/64', 'id': 1937415}
|
Hint
If you notice any issues in this documentation you can edit this document to improve it.