dellemc.openmanage.idrac_reset – Reset iDRAC
Note
This plugin is part of the dellemc.openmanage collection (version 3.6.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
- python >= 2.7.5
Parameters
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| idrac_ip
string / required
|
iDRAC IP Address.
|
|
| idrac_password
string / required
|
iDRAC user password.
aliases: idrac_pwd |
|
| idrac_port
integer
|
Default:
443
|
iDRAC port.
|
| idrac_user
string / required
|
iDRAC username.
|
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
Return Values
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| error_info
dictionary
|
on HTTP error |
Details of the 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
|
always |
Status of the iDRAC reset operation.
Sample:
Successfully performed iDRAC reset.
|
| reset_status
dictionary
|
always |
Details of iDRAC reset operation.
Sample:
{'idracreset': {'Data': {'StatusCode': 204}, 'Message': 'none', 'Status': 'Success', 'StatusCode': 204, 'retval': True}}
|
Authors
- Felix Stephen (@felixs88)
- Anooja Vardhineni (@anooja-vardhineni)
© 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/dellemc/openmanage/idrac_reset_module.html