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 10.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 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 |
Comments |
---|---|
Security token for authenticating to iDRAC. |
|
Base URI of iDRAC. |
|
PEM formatted file that contains a CA certificate to be used for validation. Only used if |
|
Category to execute on iDRAC. |
|
TLS/SSL Ciphers to use for the request. When a list is provided, all ciphers are joined in order with See the OpenSSL Cipher List Format for more details. The available ciphers is dependent on the Python and OpenSSL/LibreSSL versions. |
|
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. |
|
If Set this to Choices:
|
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: |