/ home / ansible / ansible.builtin / v2.7.9 / module / redfish_config

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

Manages Out-Of-Band controllers using Redfish APIs

| "added in version" 2.7 of ansible.builtin"

Authors: Jose Delarosa (github: jose-delarosa)

preview | supported by community

Install Ansible via `pip`

Install with pip install ansible==2.7.9

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

  - name: Set BootMode to UEFI
    redfish_config:
      category: Systems
      command: SetBiosAttributes
      bios_attr_name: BootMode
      bios_attr_value: Uefi
      baseuri: "{{ baseuri }}"
      user: "{{ user }}"
      password: "{{ password }}"

Scanned by Steampunk Spotter

  - name: Set BootMode to Legacy BIOS
    redfish_config:
      category: Systems
      command: SetBiosAttributes
      bios_attr_name: BootMode
      bios_attr_value: Bios
      baseuri: "{{ baseuri }}"
      user: "{{ user }}"
      password: "{{ password }}"

Scanned by Steampunk Spotter

  - name: Enable PXE Boot for NIC1
    redfish_config:
      category: Systems
      command: SetBiosAttributes
      bios_attr_name: PxeDev1EnDis
      bios_attr_value: Enabled
      baseuri: "{{ baseuri }}"
      user: "{{ user }}"
      password: "{{ password }}"

Scanned by Steampunk Spotter

  - name: Set BIOS default settings
    redfish_config:
      category: Systems
      command: SetBiosDefaultSettings
      baseuri: "{{ baseuri }}"
      user: "{{ user }}"
      password: "{{ password }}"

Scanned by Steampunk Spotter

  - name: Enable NTP in the OOB Controller
    redfish_config:
      category: Manager
      command: SetManagerAttributes
      mgr_attr_name: NTPConfigGroup.1.NTPEnable
      mgr_attr_value: Enabled
      baseuri: "{{ baseuri }}"
      user: "{{ user}}"
      password: "{{ password }}"

Scanned by Steampunk Spotter

  - name: Set NTP server 1 to {{ ntpserver1 }} in the OOB Controller
    redfish_config:
      category: Manager
      command: SetManagerAttributes
      mgr_attr_name: NTPConfigGroup.1.NTP1
      mgr_attr_value: "{{ ntpserver1 }}"
      baseuri: "{{ baseuri }}"
      user: "{{ user}}"
      password: "{{ password }}"

Scanned by Steampunk Spotter

  - name: Set Timezone to {{ timezone }} in the OOB Controller
    redfish_config:
      category: Manager
      command: SetManagerAttributes
      mgr_attr_name: Time.1.Timezone
      mgr_attr_value: "{{ timezone }}"
      baseuri: "{{ baseuri }}"
      user: "{{ user}}"
      password: "{{ password }}"

Inputs

    
user:
    description:
    - User for authentication with OOB controller
    required: true

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

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

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

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

mgr_attr_name:
    default: 'null'
    description:
    - name of Manager attribute to update
    required: false

bios_attr_name:
    default: 'null'
    description:
    - name of BIOS attribute to update
    required: false

mgr_attr_value:
    default: 'null'
    description:
    - value of Manager attribute to update
    required: false

bios_attr_value:
    default: 'null'
    description:
    - value of BIOS attribute to update
    required: false

Outputs

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

Install Ansible via pip

Description

Usage examples

Inputs

Outputs

Install Ansible via `pip`