W3cubDocs

/Ansible

dellemc.openmanage.idrac_server_powerstate role – Role to manage the different power states of the specified device

Note

This role is part of the dellemc.openmanage collection (version 9.12.3).

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 dellemc.openmanage.

To use it in a playbook, specify: dellemc.openmanage.idrac_server_powerstate.

Entry point main – Role to manage the different power states of the specified device

New in dellemc.openmanage 7.4.0

Synopsis

  • Role to manage the different power states of the specified device using iDRACs (iDRAC8 and iDRAC9 only) for Dell PowerEdge servers.

Parameters

Parameter

Comments

ca_path

path

The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for the validation.

hostname

string / required

iDRAC IP Address.

https_port

integer

iDRAC port.

Default: 443

https_timeout

integer

The HTTPS socket level timeout in seconds.

Default: 30

oem_reset_type

dictionary

added in dellemc.openmanage 9.5.0

This parameter initiates a complete Alternate Current (AC) power cycle of the server which is equivalent to disconnecting power cables using OEM API.

oem_reset_type is mutually exclusive with reset_type.

If the value of ‘final_power_state’ is not provided, the default value is ‘Off’.

password

string

iDRAC user password.

reset_type

string

This option resets the device.

ForceOff turns off the device immediately.

ForceOn turns on the device immediately.

ForceRestart turns off the device immediately, and then restarts the server.

GracefulRestart performs graceful shutdown of the device, and then restarts the device.

GracefulShutdown performs a graceful shutdown of the device, and then turns off the device.

Nmi sends a diagnostic interrupt to the device. This option is usually a nonmaskable interrupt (NMI) on x86 systems.

On turns on the device.

PowerCycle performs a power cycle on the device.

PushPowerButton simulates the pressing of a physical power button on the device.

reset_type is mutually exclusive with oem_reset_type.

When a power control operation is performed, which is not supported on the device, an error message is displayed with the list of operations that can be performed.

Choices:

  • "ForceOff"
  • "ForceOn"
  • "ForceRestart"
  • "GracefulRestart"
  • "GracefulShutdown"
  • "Nmi"
  • "On"
  • "PowerCycle"
  • "PushPowerButton"

resource_id

string

This option is the unique identifier of the device being managed. For example, https://<I(baseuri>/redfish/v1/Systems/<resource_id>).

This option is mandatory for base_uri with multiple devices.

To get the device details, use the API https://<I(baseuri>/redfish/v1/Systems) for reset_type operation and https://<I(baseuri>/redfish/v1/Chassis) for oem_reset_type operation.

username

string

iDRAC username.

validate_certs

boolean

If false, the SSL certificates will not be validated.

Configure false only on personally controlled sites where self-signed certificates are used.

Choices:

  • false
  • true ← (default)

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/dellemc/openmanage/idrac_server_powerstate_role.html