ansible / ansible.builtin / v2.9.23 / module / redfish_info Manages Out-Of-Band controllers using Redfish APIs | "added in version" 2.7 of ansible.builtin" Authors: Jose Delarosa (@jose-delarosa) preview | supported by communityansible.builtin.redfish_info (v2.9.23) — module
pip
Install with pip install ansible==2.9.23
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.
This module was called C(redfish_facts) before Ansible 2.9, returning C(ansible_facts). Note that the M(redfish_info) module no longer returns C(ansible_facts)!
- name: Get CPU inventory redfish_info: category: Systems command: GetCpuInventory baseuri: "{{ baseuri }}" username: "{{ username }}" password: "{{ password }}" register: result
- debug: msg: "{{ result.redfish_facts.cpu.entries | to_nice_json }}"
- name: Get CPU model redfish_info: category: Systems command: GetCpuInventory baseuri: "{{ baseuri }}" username: "{{ username }}" password: "{{ password }}" register: result
- debug: msg: "{{ result.redfish_facts.cpu.entries.0.Model }}"
- name: Get memory inventory redfish_info: category: Systems command: GetMemoryInventory baseuri: "{{ baseuri }}" username: "{{ username }}" password: "{{ password }}" register: result
- name: Get fan inventory with a timeout of 20 seconds redfish_info: category: Chassis command: GetFanInventory baseuri: "{{ baseuri }}" username: "{{ username }}" password: "{{ password }}" timeout: 20 register: result
- name: Get Virtual Media information redfish_info: category: Manager command: GetVirtualMedia baseuri: "{{ baseuri }}" username: "{{ username }}" password: "{{ password }}" register: result
- debug: msg: "{{ result.redfish_facts.virtual_media.entries | to_nice_json }}"
- name: Get Volume Inventory redfish_info: category: Systems command: GetVolumeInventory baseuri: "{{ baseuri }}" username: "{{ username }}" password: "{{ password }}" register: result
- debug: msg: "{{ result.redfish_facts.volume.entries | to_nice_json }}"
- name: Get Session information redfish_info: category: Sessions command: GetSessions baseuri: "{{ baseuri }}" username: "{{ username }}" password: "{{ password }}" register: result
- debug: msg: "{{ result.redfish_facts.session.entries | to_nice_json }}"
- name: Get default inventory information redfish_info: baseuri: "{{ baseuri }}" username: "{{ username }}" password: "{{ password }}" register: result
- debug: msg: "{{ result.redfish_facts | to_nice_json }}"
- name: Get several inventories redfish_info: category: Systems command: GetNicInventory,GetBiosAttributes baseuri: "{{ baseuri }}" username: "{{ username }}" password: "{{ password }}"
- name: Get default system inventory and user information redfish_info: category: Systems,Accounts baseuri: "{{ baseuri }}" username: "{{ username }}" password: "{{ password }}"
- name: Get default system, user and firmware information redfish_info: category: ["Systems", "Accounts", "Update"] baseuri: "{{ baseuri }}" username: "{{ username }}" password: "{{ password }}"
- name: Get Manager NIC inventory information redfish_info: category: Manager command: GetManagerNicInventory baseuri: "{{ baseuri }}" username: "{{ username }}" password: "{{ password }}"
- name: Get boot override information redfish_info: category: Systems command: GetBootOverride baseuri: "{{ baseuri }}" username: "{{ username }}" password: "{{ password }}"
- name: Get chassis inventory redfish_info: category: Chassis command: GetChassisInventory baseuri: "{{ baseuri }}" username: "{{ username }}" password: "{{ password }}"
- name: Get all information available in the Manager category redfish_info: category: Manager command: all baseuri: "{{ baseuri }}" username: "{{ username }}" password: "{{ password }}"
- name: Get firmware update capability information redfish_info: category: Update command: GetFirmwareUpdateCapabilities baseuri: "{{ baseuri }}" username: "{{ username }}" password: "{{ password }}"
- name: Get all information available in all categories redfish_info: category: all command: all baseuri: "{{ baseuri }}" username: "{{ username }}" password: "{{ password }}"
baseuri: description: - Base URI of OOB controller required: true type: str command: description: - List of commands to execute on OOB controller required: false type: list 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 type: list password: description: - Password for authentication with OOB controller required: true type: str username: description: - User for authentication with OOB controller required: true type: str version_added: '2.8' version_added_collection: ansible.builtin
result: description: different results depending on task returned: always sample: List of CPUs on system type: dict