community.general.idrac_redfish_command module – Manages Out-Of-Band controllers using iDRAC OEM Redfish APIs
Note
This module is part of the community.general collection (version 8.6.4).
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.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.
Aliases: remote_management.redfish.idrac_redfish_command
Parameters
Parameter |
Comments |
---|---|
Security token for authenticating to iDRAC. |
|
Base URI of iDRAC. |
|
Category to execute on iDRAC. |
|
List of commands to execute on iDRAC. |
|
Password for authenticating to iDRAC. |
|
ID of the System, Manager or Chassis to modify. |
|
Timeout in seconds for HTTP requests to iDRAC. Default: |
|
Username for authenticating to iDRAC. |
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: none |
Can run in |
|
Support: none |
Will return details on what has changed (or possibly needs changing in |
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 |
Description |
---|---|
Message with action result or error description Returned: always Sample: |
|
Dictionary containing command-specific response data from the action. Returned: on success Sample: |