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.7.11
|
Default:
10
|
Timeout in seconds for URL requests to 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 with a timeout of 20 seconds redfish_facts: category: Chassis command: GetFanInventory baseuri: "{{ baseuri }}" user: "{{ user }}" password: "{{ password }}" timeout: 20 - 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
dictionary
|
always |
different results depending on task
Sample:
List of CPUs on system
|
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors
- Jose Delarosa (github: 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.7/modules/redfish_facts_module.html