community.general.ilo_redfish_config (8.5.0) — module

Sets or updates configuration attributes on HPE iLO with Redfish OEM extensions

| "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 set or update a configuration attribute.

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: Disable WINS Registration
    community.general.ilo_redfish_config:
      category: Manager
      command: SetWINSReg
      baseuri: 15.X.X.X
      username: Admin
      password: Testpass123
      attribute_name: WINSRegistration
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  - name: Set Time Zone
    community.general.ilo_redfish_config:
      category: Manager
      command: SetTimeZone
      baseuri: 15.X.X.X
      username: Admin
      password: Testpass123
      attribute_name: TimeZone
      attribute_value: Chennai
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  - name: Set NTP Servers
    community.general.ilo_redfish_config:
      category: Manager
      command: SetNTPServers
      baseuri: 15.X.X.X
      username: Admin
      password: Testpass123
      attribute_name: StaticNTPServers
      attribute_value: X.X.X.X

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:
    choices:
    - Manager
    description:
    - Command category to execute on iLO.
    required: true
    type: str

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

attribute_name:
    description:
    - Name of the attribute to be configured.
    required: true
    type: str

attribute_value:
    description:
    - Value of the attribute to be configured.
    required: false
    type: str

Outputs

msg:
  description: Message with action result or error description
  returned: always
  sample: Action was successful
  type: str