community.hrobot.reset_info module – Query information on the resetter of a dedicated server

Note

This module is part of the community.hrobot collection (version 2.5.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.reset_info.

New in community.hrobot 2.2.0

Synopsis

  • Query information on the resetter of a dedicated server.

Parameters

Parameter

Comments

hetzner_password

string / required

The password for the Robot web-service user.

hetzner_user

string / required

The username for the Robot web-service user.

rate_limit_retry_timeout

integer

added in community.hrobot 2.1.0

Timeout (in seconds) for waiting when rate limit exceeded errors are returned.

Set to 0 to not retry.

Set to a negative value like -1 to retry forever.

Default: -1

server_number

integer / required

The server number of the server to query its resetter.

Attributes

Attribute

Support

Description

action_group

Action group: community.hrobot.robot

Use group/community.hrobot.robot in module_defaults to set defaults for this module.

check_mode

Support: full

This action does not modify state.

Can run in check_mode and return changed status prediction without modifying target.

diff_mode

Support: N/A

This action does not modify state.

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

idempotent

Support: full

This action does not modify state.

When run twice in a row outside check mode, with the same arguments, the second invocation indicates no change.

This assumes that the system controlled/queried by the module has not changed in a relevant way.

See Also

See also

community.hrobot.reset

Reset dedicated server.

Examples

---
- name: Query resetter information for server 1234
  community.hrobot.reset_info:
    hetzner_user: foo
    hetzner_password: bar
    server_number: 1234
  register: result

- name: Show reset methods
  ansible.builtin.debug:
    msg: "{{ result.reset.type }}"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

reset

dictionary

Information on the server’s resetter.

Returned: success

operating_status

string

The server’s operating status.

Returned: success

Sample: "not supported"

server_ip

string

The primary IPv4 address of the server.

Returned: success

Sample: "123.123.123.123"

server_ipv6_net

string

The primary IPv6 network of the server.

Returned: success

Sample: "2a01:4f8:111:4221::"

server_number

integer

The server’s ID.

Returned: success

Sample: 321

type

list / elements=string

The reset types supported by the resetter.

Can be used for the reset_type option of the community.hrobot.reset module.

Returned: success

Can only return:

  • "software"

  • "hardware"

  • "power"

  • "manual"

Sample: ["software", "hardware", "manual"]

Authors

  • Felix Fontein (@felixfontein)