community.general.ilo_redfish_command (8.5.0) — module

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 remote OOB controllers to perform an action.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

  - name: Wait for iLO Reboot Completion
    community.general.ilo_redfish_command:
      category: Systems
      command: WaitforiLORebootCompletion
      baseuri: "{{ baseuri }}"
      username: "{{ username }}"
      password: "{{ password }}"

Inputs

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

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

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

category:
    choices:
    - Systems
    description:
    - Category to execute on OOB controller.
    required: true
    type: str

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

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

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

Outputs

ilo_redfish_command:
  contains:
    WaitforiLORebootCompletion:
      contains:
        msg:
          description: Status of the operation performed on the iLO.
          type: str
        ret:
          description: Return True/False based on whether the operation was performed
            successfully.
          type: bool
      description: Returns the output msg and whether the function executed successfully.
      type: dict
  description: Returns the status of the operation performed on the iLO.
  returned: always
  type: dict