community.general.ilo_redfish_info (8.5.0) — module

Gathers server information through iLO using Redfish APIs

| "added in version" 4.2.0 of community.general"

Authors: Bhavya B (@bhavya06)

Install collection

Install with ansible-galaxy collection install community.general:==8.5.0


Add to requirements.yml

  collections:
    - name: community.general
      version: 8.5.0

Description

Builds Redfish URIs locally and sends them to iLO to get information back.

For use with HPE iLO operations that require Redfish OEM extensions.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  - name: Get iLO Sessions
    community.general.ilo_redfish_info:
      category: Sessions
      command: GetiLOSessions
      baseuri: "{{ baseuri }}"
      username: "{{ username }}"
      password: "{{ password }}"
    register: result_sessions

Inputs

    
baseuri:
    description:
    - Base URI of iLO.
    required: true
    type: str

command:
    description:
    - List of commands to execute on iLO.
    elements: str
    required: true
    type: list

timeout:
    default: 10
    description:
    - Timeout in seconds for HTTP requests to iLO.
    type: int

category:
    description:
    - List of categories to execute on iLO.
    elements: str
    required: true
    type: list

password:
    description:
    - Password for authenticating to iLO.
    type: str

username:
    description:
    - Username for authenticating to iLO.
    type: str

auth_token:
    description:
    - Security token for authenticating to iLO.
    type: str

Outputs

ilo_redfish_info:
  contains:
    GetiLOSessions:
      contains:
        msg:
          contains:
            Description:
              description: Provides a description of the resource.
              type: str
            Id:
              description: The sessionId.
              type: str
            Name:
              description: The name of the resource.
              type: str
            UserName:
              description: Name to use to log in to the management processor.
              type: str
          description: Information of all active iLO sessions.
          elements: dict
          type: list
        ret:
          description: Check variable to see if the information was successfully retrieved.
          type: bool
      description: Returns the iLO session msg and whether the function executed successfully.
      type: dict
  description: Returns iLO sessions.
  returned: always
  type: dict