dellemc.openmanage.idrac_reset module – Reset iDRAC

Note

This module is part of the dellemc.openmanage collection (version 5.4.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 dellemc.openmanage.

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

New in version 2.1.0: of dellemc.openmanage

Synopsis

  • This module resets iDRAC.

  • iDRAC is not accessible for some time after running this module. It is recommended to wait for some time, before trying to connect to iDRAC.

Requirements

The below requirements are needed on the host that executes this module.

  • omsdk >= 1.2.488

  • python >= 3.8.6

Parameters

Parameter

Comments

ca_path

path

added in 5.0.0 of dellemc.openmanage

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

idrac_ip

string / required

iDRAC IP Address.

idrac_password

aliases: idrac_pwd

string / required

iDRAC user password.

idrac_port

integer

iDRAC port.

Default: 443

idrac_user

string / required

iDRAC username.

timeout

integer

added in 5.0.0 of dellemc.openmanage

The socket level timeout in seconds.

Default: 30

validate_certs

boolean

added in 5.0.0 of dellemc.openmanage

If False, the SSL certificates will not be validated.

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

Prior to collection version 5.0.0, the validate_certs is False by default.

Choices:

  • no

  • yes ← (default)

Notes

Note

  • Run this module from a system that has direct access to DellEMC iDRAC.

  • This module supports check_mode.

Examples

---
- name: Reset iDRAC
  dellemc.openmanage.idrac_reset:
       idrac_ip: "192.168.0.1"
       idrac_user: "user_name"
       idrac_password: "user_password"
       idrac_port: 443
       ca_path: "/path/to/ca_cert.pem"

Return Values

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

Key

Description

error_info

dictionary

Details of the HTTP Error.

Returned: on HTTP error

Sample: {“error”: {“@Message.ExtendedInfo”: [{“Message”: “Unable to process the request because an error occurred.”, “MessageArgs”: [], “MessageId”: “GEN1234”, “RelatedProperties”: [], “Resolution”: “Retry the operation. If the issue persists, contact your system administrator.”, “Severity”: “Critical”}], “code”: “Base.1.0.GeneralError”, “message”: “A general error has occurred. See ExtendedInfo for more information.”}}

msg

string

Status of the iDRAC reset operation.

Returned: always

Sample: “Successfully performed iDRAC reset.”

reset_status

dictionary

Details of iDRAC reset operation.

Returned: always

Sample: {“idracreset”: {“Data”: {“StatusCode”: 204}, “Message”: “none”, “Status”: “Success”, “StatusCode”: 204, “retval”: true}}

Authors

  • Felix Stephen (@felixs88)

  • Anooja Vardhineni (@anooja-vardhineni)