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

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

auth_token

string

Security token for authenticating to iLO.

baseuri

string / required

Base URI of iLO.

category

list / elements=string / required

List of categories to execute on iLO.

command

list / elements=string / required

List of commands to execute on iLO.

password

string

Password for authenticating to iLO.

timeout

integer

Timeout in seconds for HTTP requests to iLO.

Default: 10

username

string

Username for authenticating to iLO.

Attributes

Attribute

Support

Description

check_mode

Support: full

This action does not modify state.

Can run in check_mode and return changed status prediction without modifying target.

diff_mode

Support: N/A

This action does not modify state.

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

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

ilo_redfish_info

dictionary

Returns iLO sessions.

Returned: always

GetiLOSessions

dictionary

Returns the iLO session msg and whether the function executed successfully.

Returned: success

msg

list / elements=dictionary

Information of all active iLO sessions.

Returned: success

Description

string

Provides a description of the resource.

Returned: success

Id

string

The sessionId.

Returned: success

Name

string

The name of the resource.

Returned: success

UserName

string

Name to use to log in to the management processor.

Returned: success

ret

boolean

Check variable to see if the information was successfully retrieved.

Returned: success

Authors

  • Bhavya B (@bhavya06)