community.general.idrac_redfish_command – Manages Out-Of-Band controllers using iDRAC OEM Redfish APIs
Note
This plugin is part of the community.general collection (version 1.3.2).
To install it use: ansible-galaxy collection install community.general.
To use it in a playbook, specify: community.general.idrac_redfish_command.
Synopsis
- Builds Redfish URIs locally and sends them to remote OOB controllers to perform an action.
- For use with Dell iDRAC operations that require Redfish OEM extensions
Parameters
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| baseuri
string / required
|
Base URI of OOB controller
|
|
| category
string / required
|
Category to execute on OOB controller
|
|
| command
list / elements=string / required
|
List of commands to execute on OOB controller
|
|
| password
string / required
|
Password for authentication with OOB controller
|
|
| resource_id
string
added in 0.2.0 of community.general
|
The ID of the System, Manager or Chassis to modify
|
|
| timeout
integer
|
Default:
10
|
Timeout in seconds for URL requests to OOB controller
|
| username
string / required
|
User for authentication with OOB controller
|
Examples
- name: Create BIOS configuration job (schedule BIOS setting update)
community.general.idrac_redfish_command:
category: Systems
command: CreateBiosConfigJob
resource_id: System.Embedded.1
baseuri: "{{ baseuri }}"
username: "{{ username }}"
password: "{{ password }}"
Return Values
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| msg
string
|
always |
Message with action result or error description
Sample:
Action was successful
|
Authors
- Jose Delarosa (@jose-delarosa)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/general/idrac_redfish_command_module.html