community.hrobot.server – Update server information
Note
This plugin is part of the community.hrobot collection (version 1.2.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 community.hrobot.
To use it in a playbook, specify: community.hrobot.server.
New in version 1.2.0: of community.hrobot
Synopsis
- Allows to update server information.
- Right now the API only supports updating the server’s name.
Parameters
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| hetzner_password
string / required
|
The password for the Robot webservice user.
|
|
| hetzner_user
string / required
|
The username for the Robot webservice user.
|
|
| server_name
string
|
The server's name.
If this option is not provided, it will not be adjusted.
|
|
| server_number
integer / required
|
The server number of the server to update.
|
Examples
- name: Set server's name to foo.example.com
community.hrobot.server:
hetzner_user: foo
hetzner_password: bar
server_number: 123
server_name: foo.example.com
Return Values
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description | ||
|---|---|---|---|---|
| server
dictionary
|
success |
Information on the server.
|
||
| cancelled
boolean
|
success |
Whether the server is cancelled.
|
||
| cpanel
boolean
|
success |
Flag of cPanel installation availability.
Sample:
True
|
||
| dc
string
|
success |
The data center the server is located in.
Sample:
NBG1-DC1
|
||
| hot_swap
boolean
|
success |
Flag of Hot Swap availability.
Sample:
True
|
||
| ip
list / elements=string
|
success |
List of assigned single IP addresses.
Sample:
['123.123.123.123']
|
||
| linked_storagebox
integer
|
success |
Linked Storage Box ID.
Sample:
12345
|
||
| paid_until
string
|
success |
The date until the server has been paid.
Sample:
2018-08-04
|
||
| plesk
boolean
|
success |
Flag of Plesk installation availability.
Sample:
True
|
||
| product
string
|
success |
The server product name.
Sample:
EQ 8
|
||
| rescue
boolean
|
success |
Whether the rescue system is available.
|
||
| reset
boolean
|
success |
Whether the server can be automatically reset.
Sample:
True
|
||
| server_ip
string
|
success |
The server's main IP address.
Sample:
123.123.123.123
|
||
| server_ipv6_net
string
|
success |
The server's main IPv6 network address.
Sample:
2a01:f48:111:4221::
|
||
| server_name
string
|
success |
The user-defined server's name.
Sample:
server1
|
||
| server_number
integer
|
success |
The server's numeric ID.
Sample:
321
|
||
| status
string
|
success |
Server status.
Can only return: ready, in process
Sample:
ready
|
||
| subnet
list / elements=string
|
success |
List of assigned subnets.
Sample:
[{'ip': '2a01:4f8:111:4221::', 'mask': 64}]
|
||
| ip
string
|
success |
The first IP in the subnet.
Sample:
2a01:4f8:111:4221::
|
||
| mask
string
|
success |
The masks bitlength.
Sample:
64
|
||
| traffic
string
|
success |
Free traffic quota.
unlimited in case of unlimited traffic.
Sample:
5 TB
|
||
| vnc
boolean
|
success |
Flag of VNC installation availability.
Sample:
True
|
||
| windows
boolean
|
success |
Flag of Windows installation availability.
Sample:
True
|
||
| wol
boolean
|
success |
Flag of Wake On Lan availability.
Sample:
True
|
||
Authors
- Felix Fontein (@felixfontein)
© 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/community/hrobot/server_module.html