community.hrobot.server module – Update server information
Note
This module is part of the community.hrobot collection (version 2.0.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 community.hrobot
.
To use it in a playbook, specify: community.hrobot.server
.
New in community.hrobot 1.2.0
Synopsis
Allows to update server information.
Right now the API only supports updating the server’s name.
Parameters
Parameter |
Comments |
---|---|
The password for the Robot web-service user. |
|
The username for the Robot web-service user. |
|
The server’s name. If this option is not provided, it will not be adjusted. |
|
The server number of the server to update. |
Attributes
Attribute |
Support |
Description |
---|---|---|
Action group: community.hrobot.robot added in community.hrobot 1.6.0 |
Use |
|
Support: full |
Can run in |
|
Support: none |
Will return details on what has changed (or possibly needs changing in |
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 |
Description |
---|---|
Information on the server. Returned: success |
|
Whether the server is cancelled. Returned: success Sample: |
|
Flag of cPanel installation availability. Returned: success Sample: |
|
The data center the server is located in. Returned: success Sample: |
|
Flag of Hot Swap availability. Returned: success Sample: |
|
List of assigned single IP addresses. Returned: success Sample: |
|
Linked Storage Box ID. Returned: success Sample: |
|
The date until the server has been paid. Returned: success Sample: |
|
Flag of Plesk installation availability. Returned: success Sample: |
|
The server product name. Returned: success Sample: |
|
Whether the rescue system is available. Returned: success Sample: |
|
Whether the server can be automatically reset. Returned: success Sample: |
|
The server’s main IP address. Returned: success Sample: |
|
The server’s main IPv6 network address. Returned: success Sample: |
|
The user-defined server’s name. Returned: success Sample: |
|
The server’s numeric ID. Returned: success Sample: |
|
Server status. Returned: success Can only return:
Sample: |
|
List of assigned subnets. Returned: success Sample: |
|
The first IP in the subnet. Returned: success Sample: |
|
The masks bitlength. Returned: success Sample: |
|
Free traffic quota.
Returned: success Sample: |
|
Flag of VNC installation availability. Returned: success Sample: |
|
Flag of Windows installation availability. Returned: success Sample: |
|
Flag of Wake On Lan availability. Returned: success Sample: |