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.7.3).

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
Parameters
Attributes
Examples
Return Values

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
auth_token string added in community.general 2.3.0	Security token for authenticating to iDRAC.
baseuri string / required	Base URI of iDRAC.
ca_path path added in community.general 10.6.0	PEM formatted file that contains a CA certificate to be used for validation. Only used if `validate_certs=true`.
category string / required	Category to execute on iDRAC.
ciphers list / elements=string added in community.general 10.6.0	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.
command list / elements=string / required	List of commands to execute on iDRAC.
password string	Password for authenticating to iDRAC.
resource_id string added in community.general 0.2.0	ID of the System, Manager or Chassis to modify.
timeout integer	Timeout in seconds for HTTP requests to iDRAC. Default: `10`
username string	Username for authenticating to iDRAC.
validate_certs boolean added in community.general 10.6.0	If `false`, TLS/SSL certificates will not be validated. Set this to `true` to enable certificate checking. Should be used together with `ca_path`. Choices: `false` ← (default) `true`

Attributes

Attribute	Support	Description
check_mode	Support: none	Can run in `check_mode` and return changed status prediction without modifying target.
diff_mode	Support: none	Will return details on what has changed (or possibly needs changing in `check_mode`), when in diff mode.

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
msg string	Message with action result or error description. Returned: always Sample: `"Action was successful"`
return_values dictionary added in community.general 6.6.0	Dictionary containing command-specific response data from the action. Returned: on success Sample: `{"job_id": "/redfish/v1/Managers/iDRAC.Embedded.1/Jobs/JID_471269252011"}`

Authors

Jose Delarosa (@jose-delarosa)

Collection links

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/idrac_redfish_command_module.html