community.general.ilo_redfish_info module – Gathers server information through iLO using Redfish APIs
Note
This module is part of the community.general collection (version 9.4.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.ilo_redfish_info
.
New in community.general 4.2.0
Synopsis
Builds Redfish URIs locally and sends them to iLO to get information back.
For use with HPE iLO operations that require Redfish OEM extensions.
Parameters
Parameter |
Comments |
---|---|
Security token for authenticating to iLO. |
|
Base URI of iLO. |
|
List of categories to execute on iLO. |
|
List of commands to execute on iLO. |
|
Password for authenticating to iLO. |
|
Timeout in seconds for HTTP requests to iLO. Default: |
|
Username for authenticating to iLO. |
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: full This action does not modify state. |
Can run in |
|
Support: N/A This action does not modify state. |
Will return details on what has changed (or possibly needs changing in |
Examples
- name: Get iLO Sessions
community.general.ilo_redfish_info:
category: Sessions
command: GetiLOSessions
baseuri: "{{ baseuri }}"
username: "{{ username }}"
password: "{{ password }}"
register: result_sessions
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Returns iLO sessions. Returned: always |
|
Returns the iLO session msg and whether the function executed successfully. Returned: success |
|
Information of all active iLO sessions. Returned: success |
|
Provides a description of the resource. Returned: success |
|
The sessionId. Returned: success |
|
The name of the resource. Returned: success |
|
Name to use to log in to the management processor. Returned: success |
|
Check variable to see if the information was successfully retrieved. Returned: success |