community.hrobot.reset module – Reset 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.

New in community.hrobot 1.2.0

Synopsis

  • Reset a dedicated server with a software or hardware reset, or by requesting a manual reset.

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

reset_type

string / required

How to reset the server.

software is a software reset. This should be similar to pressing Ctrl+Alt+Del on the keyboard.

power is a hardware reset similar to pressing the Power button. An ACPI signal is sent, and if the server is configured correctly, this will trigger a regular shutdown.

hardware is a hardware reset similar to pressing the Restart button. The power is cycled for the server.

manual is a manual reset. This requests a technician to manually do the shutdown while looking at the screen output. Be careful and only use this when really necessary!

Note that not every server supports every reset method! You can query the supported reset methods by using the reset.type return value of the community.hrobot.reset_info module.

Choices:

  • "software"

  • "hardware"

  • "power"

  • "manual"

server_number

integer / required

The server number of the server to reset.

Attributes

Attribute

Support

Description

action_group

Action group: community.hrobot.robot

added in community.hrobot 1.6.0

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

check_mode

Support: full

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

diff_mode

Support: none

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

idempotent

Support: none

This module performs an action on every invocation.

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_info

Retrieve information on resetter.

Examples

---
- name: Send ACPI signal to server to request controlled shutdown
  community.hrobot.reset:
    hetzner_user: foo
    hetzner_password: bar
    server_number: 1234
    state: power

- name: Make sure that the server supports manual reset
  community.hrobot.reset:
    hetzner_user: foo
    hetzner_password: bar
    server_number: 1234
    reset_type: manual
  check_mode: true

- name: Request a manual reset (by a technican)
  community.hrobot.reset:
    hetzner_user: foo
    hetzner_password: bar
    server_number: 1234
    reset_type: manual

Authors

  • Felix Fontein (@felixfontein)