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

• Synopsis
• Parameters
• Examples
• Return Values
• Status
• Maintenance
  • Author

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: [u'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
user required		User for authentication with OOB controller

Examples

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

- name: Get fan inventory
  redfish_facts:
    category: Chassis
    command: GetFanInventory
    baseuri: "{{ baseuri }}"
    user: "{{ user }}"
    password: "{{ password }}"

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

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

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

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

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

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

Return Values

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

Key	Returned	Description
result dict	always	different results depending on task Sample: List of CPUs on system

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Maintenance

This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by the Ansible Community, see here.

Author

• Jose Delarosa (github: jose-delarosa)