redfish_facts – Manages Out-Of-Band controllers using Redfish APIs

From Get docs
Ansible/docs/2.8/modules/redfish facts module


redfish_facts – Manages Out-Of-Band controllers using Redfish APIs

New in version 2.7.


Synopsis

  • 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.

Parameters

Parameter Choices/Defaults Comments

baseuri

- / required

Base URI of OOB controller

category

-

Default:

["Systems"]

List of categories to execute on OOB controller

command

-

List of commands to execute on OOB controller

password

- / required

Password for authentication with OOB controller

timeout

integer

added in 2.8

Default:

10

Timeout in seconds for URL requests to OOB controller

username

- / required

added in 2.8

User for authentication with OOB controller



Examples

- name: Get CPU inventory
  redfish_facts:
    category: Systems
    command: GetCpuInventory
    baseuri: "{{ baseuri }}"
    username: "{{ username }}"
    password: "{{ password }}"
- debug:
    msg: "{{ redfish_facts.cpu.entries | to_nice_json }}"

- name: Get CPU model
  redfish_facts:
    category: Systems
    command: GetCpuInventory
    baseuri: "{{ baseuri }}"
    username: "{{ username }}"
    password: "{{ password }}"
- debug:
    msg: "{{ redfish_facts.cpu.entries.0.Model }}"

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

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

- name: Get default inventory information
  redfish_facts:
    baseuri: "{{ baseuri }}"
    username: "{{ username }}"
    password: "{{ password }}"
- debug:
    msg: "{{ redfish_facts | to_nice_json }}"

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

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

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

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

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

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

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description

result

dictionary

always

different results depending on task


Sample:

List of CPUs on system




Status

Authors

  • Jose Delarosa (@jose-delarosa)

Hint

If you notice any issues in this documentation you can edit this document to improve it.


© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/redfish_facts_module.html