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

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 Choices/Defaults Comments
auth_token
string
added in 2.3.0 of community.general
Security token for authentication with OOB controller
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
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
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–2021 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