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_info.
New in version 1.2.0: of community.hrobot
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| full_info boolean |
| Whether to provide full information for every server. Setting this to true requires one REST call per server, which is slow and reduces your rate limit. Use with care.When server_number is specified, this option is set to true. |
| 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 | Limit result list to servers of this name. | |
| server_number integer | Limit result list to server with this number. |
- name: Query a list of all servers
community.hrobot.server_info:
hetzner_user: foo
hetzner_password: bar
register: result
- name: Query a specific server
community.hrobot.server_info:
hetzner_user: foo
hetzner_password: bar
server_number: 23
register: result
- name: Output data on specific server
ansible.builtin.debug:
msg: "Server name: {{ result.servers[0].server_name }}"
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description | ||
|---|---|---|---|---|
| servers list / elements=dictionary | success | List of servers matching the provided options. | ||
| cancelled boolean | success | Whether the server is cancelled. | ||
| cpanel boolean | when full_info=true | Flag of cPanel installation availability. Sample: True | ||
| dc string | success | The data center the server is located in. Sample: NBG1-DC1 | ||
| hot_swap boolean | when full_info=true | 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 | when full_info=true | Linked Storage Box ID. Sample: 12345 | ||
| paid_until string | success | The date until the server has been paid. Sample: 2018-08-04 | ||
| plesk boolean | when full_info=true | Flag of Plesk installation availability. Sample: True | ||
| product string | success | The server product name. Sample: EQ 8 | ||
| rescue boolean | when full_info=true | Whether the rescue system is available. | ||
| reset boolean | when full_info=true | 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 | when full_info=true | Flag of VNC installation availability. Sample: True | ||
| windows boolean | when full_info=true | Flag of Windows installation availability. Sample: True | ||
| wol boolean | when full_info=true | Flag of Wake On Lan availability. Sample: True | ||
© 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_info_module.html