/ home / ansible / ansible.builtin / v2.8.20 / module / redfish_facts

ansible.builtin.redfish_facts (v2.8.20) — module

Manages Out-Of-Band controllers using Redfish APIs

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

Authors: Jose Delarosa (@jose-delarosa)

preview | supported by community

Install Ansible via `pip`

Install with pip install ansible==2.8.20

Description

Builds Redfish URIs locally and sends them to remote OOB controllers to get information back.

Information retrieved is placed in a location specified by the user.

Usage examples

Scanned by Steampunk Spotter

  - name: Get CPU inventory
    redfish_facts:
      category: Systems
      command: GetCpuInventory
      baseuri: "{{ baseuri }}"
      username: "{{ username }}"
      password: "{{ password }}"

Scanned by Steampunk Spotter

  - debug:
      msg: "{{ redfish_facts.cpu.entries | to_nice_json }}"

Scanned by Steampunk Spotter

  - name: Get CPU model
    redfish_facts:
      category: Systems
      command: GetCpuInventory
      baseuri: "{{ baseuri }}"
      username: "{{ username }}"
      password: "{{ password }}"

Scanned by Steampunk Spotter

  - debug:
      msg: "{{ redfish_facts.cpu.entries.0.Model }}"

Scanned by Steampunk Spotter

  - name: Get memory inventory
    redfish_facts:
      category: Systems
      command: GetMemoryInventory
      baseuri: "{{ baseuri }}"
      username: "{{ username }}"
      password: "{{ password }}"

Scanned by Steampunk Spotter

  - name: Get fan inventory with a timeout of 20 seconds
    redfish_facts:
      category: Chassis
      command: GetFanInventory
      baseuri: "{{ baseuri }}"
      username: "{{ username }}"
      password: "{{ password }}"
      timeout: 20

Scanned by Steampunk Spotter

  - name: Get default inventory information
    redfish_facts:
      baseuri: "{{ baseuri }}"
      username: "{{ username }}"
      password: "{{ password }}"

Scanned by Steampunk Spotter

  - debug:
      msg: "{{ redfish_facts | to_nice_json }}"

Scanned by Steampunk Spotter

  - name: Get several inventories
    redfish_facts:
      category: Systems
      command: GetNicInventory,GetBiosAttributes
      baseuri: "{{ baseuri }}"
      username: "{{ username }}"
      password: "{{ password }}"

Scanned by Steampunk Spotter

  - name: Get default system inventory and user information
    redfish_facts:
      category: Systems,Accounts
      baseuri: "{{ baseuri }}"
      username: "{{ username }}"
      password: "{{ password }}"

Scanned by Steampunk Spotter

  - name: Get default system, user and firmware information
    redfish_facts:
      category: ["Systems", "Accounts", "Update"]
      baseuri: "{{ baseuri }}"
      username: "{{ username }}"
      password: "{{ password }}"

Scanned by Steampunk Spotter

  - name: Get Manager NIC inventory information
    redfish_facts:
      category: Manager
      command: GetManagerNicInventory
      baseuri: "{{ baseuri }}"
      username: "{{ username }}"
      password: "{{ password }}"

Scanned by Steampunk Spotter

  - name: Get all information available in the Manager category
    redfish_facts:
      category: Manager
      command: all
      baseuri: "{{ baseuri }}"
      username: "{{ username }}"
      password: "{{ password }}"

Scanned by Steampunk Spotter

  - name: Get all information available in all categories
    redfish_facts:
      category: all
      command: all
      baseuri: "{{ baseuri }}"
      username: "{{ username }}"
      password: "{{ password }}"

Inputs

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

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

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:
    default:
    - Systems
    description:
    - List of categories to execute on OOB controller
    required: false

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

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

Outputs

result:
  description: different results depending on task
  returned: always
  sample: List of CPUs on system
  type: dict

Install Ansible via pip

Description

Usage examples

Inputs

Outputs

Install Ansible via `pip`