ansible.builtin.redfish_config (v2.9.27) — module

Install Ansible via pip

Install with pip install ansible==2.9.27

Description

Builds Redfish URIs locally and sends them to remote OOB controllers to set or update a configuration attribute.

Manages BIOS configuration settings.

Manages OOB controller configuration settings.

Usage examples

Scanned by Steampunk Spotter

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

  - name: Set BootMode to UEFI
    redfish_config:
      category: Systems
      command: SetBiosAttributes
      bios_attribute_name: BootMode
      bios_attribute_value: Uefi
      baseuri: "{{ baseuri }}"
      username: "{{ username }}"
      password: "{{ password }}"

Scanned by Steampunk Spotter

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

  - name: Set BootMode to Legacy BIOS
    redfish_config:
      category: Systems
      command: SetBiosAttributes
      bios_attribute_name: BootMode
      bios_attribute_value: Bios
      baseuri: "{{ baseuri }}"
      username: "{{ username }}"
      password: "{{ password }}"

Scanned by Steampunk Spotter

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

  - name: Enable PXE Boot for NIC1
    redfish_config:
      category: Systems
      command: SetBiosAttributes
      bios_attribute_name: PxeDev1EnDis
      bios_attribute_value: Enabled
      baseuri: "{{ baseuri }}"
      username: "{{ username }}"
      password: "{{ password }}"

Scanned by Steampunk Spotter

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

  - name: Set BIOS default settings with a timeout of 20 seconds
    redfish_config:
      category: Systems
      command: SetBiosDefaultSettings
      baseuri: "{{ baseuri }}"
      username: "{{ username }}"
      password: "{{ password }}"
      timeout: 20

Inputs

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

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

timeout:
    default: 10
    description:
    - Timeout in seconds for URL requests to OOB controller
    type: int
    version_added: '2.8'
    version_added_collection: ansible.builtin

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

password:
    description:
    - Password for authentication with OOB controller
    required: true
    type: str

username:
    description:
    - User for authentication with OOB controller
    required: true
    type: str
    version_added: '2.8'
    version_added_collection: ansible.builtin

bios_attribute_name:
    default: 'null'
    description:
    - name of BIOS attribute to update
    required: false
    type: str
    version_added: '2.8'
    version_added_collection: ansible.builtin

bios_attribute_value:
    default: 'null'
    description:
    - value of BIOS attribute to update
    required: false
    type: raw
    version_added: '2.8'
    version_added_collection: ansible.builtin

Outputs

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