You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

community.general.ilo_redfish_command module – Manages Out-Of-Band controllers using Redfish APIs

Note

This module is part of the community.general collection (version 6.6.2).

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.ilo_redfish_command.

New in community.general 6.6.0

Synopsis

• Builds Redfish URIs locally and sends them to remote OOB controllers to perform an action.

Parameters

Parameter	Comments
auth_token string	Security token for authenticating to iLO.
baseuri string / required	Base URI of OOB controller.
category string / required	Category to execute on OOB controller. Choices: "Systems"
command list / elements=string / required	List of commands to execute on OOB controller.
password string	Password for authenticating to iLO.
timeout integer	Timeout in seconds for HTTP requests to iLO. Default: 60
username string	Username for authenticating to iLO.

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: Wait for iLO Reboot Completion
  community.general.ilo_redfish_command:
    category: Systems
    command: WaitforiLORebootCompletion
    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
ilo_redfish_command dictionary	Returns the status of the operation performed on the iLO. Returned: always
WaitforiLORebootCompletion dictionary	Returns the output msg and whether the function executed successfully. Returned: success
msg string	Status of the operation performed on the iLO. Returned: success
ret boolean	Return True/False based on whether the operation was performed succesfully. Returned: success

Authors

• Varni H P (@varini-hp)

Collection links

Issue Tracker Repository (Sources) Submit a bug report Request a feature Communication