community / community.general / 6.6.8 / module / redfish_info Manages Out-Of-Band controllers using Redfish APIs Authors: Jose Delarosa (@jose-delarosa)community.general.redfish_info (6.6.8) — module
Install with ansible-galaxy collection install community.general:==6.6.8
collections: - name: community.general version: 6.6.8
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(community.general.redfish_info) module no longer returns C(ansible_facts)!
- name: Get CPU inventory community.general.redfish_info: category: Systems command: GetCpuInventory baseuri: "{{ baseuri }}" username: "{{ username }}" password: "{{ password }}" register: result
- name: Print fetched information ansible.builtin.debug: msg: "{{ result.redfish_facts.cpu.entries | to_nice_json }}"
- name: Get CPU model community.general.redfish_info: category: Systems command: GetCpuInventory baseuri: "{{ baseuri }}" username: "{{ username }}" password: "{{ password }}" register: result
- name: Print fetched information ansible.builtin.debug: msg: "{{ result.redfish_facts.cpu.entries.0.Model }}"
- name: Get memory inventory community.general.redfish_info: category: Systems command: GetMemoryInventory baseuri: "{{ baseuri }}" username: "{{ username }}" password: "{{ password }}" register: result
- name: Get fan inventory with a timeout of 20 seconds community.general.redfish_info: category: Chassis command: GetFanInventory baseuri: "{{ baseuri }}" username: "{{ username }}" password: "{{ password }}" timeout: 20 register: result
- name: Get Virtual Media information community.general.redfish_info: category: Manager command: GetVirtualMedia baseuri: "{{ baseuri }}" username: "{{ username }}" password: "{{ password }}" register: result
- name: Print fetched information ansible.builtin.debug: msg: "{{ result.redfish_facts.virtual_media.entries | to_nice_json }}"
- name: Get Virtual Media information from Systems community.general.redfish_info: category: Systems command: GetVirtualMedia baseuri: "{{ baseuri }}" username: "{{ username }}" password: "{{ password }}" register: result
- name: Print fetched information ansible.builtin.debug: msg: "{{ result.redfish_facts.virtual_media.entries | to_nice_json }}"
- name: Get Volume Inventory community.general.redfish_info: category: Systems command: GetVolumeInventory baseuri: "{{ baseuri }}" username: "{{ username }}" password: "{{ password }}" register: result
- name: Print fetched information ansible.builtin.debug: msg: "{{ result.redfish_facts.volume.entries | to_nice_json }}"
- name: Get Session information community.general.redfish_info: category: Sessions command: GetSessions baseuri: "{{ baseuri }}" username: "{{ username }}" password: "{{ password }}" register: result
- name: Print fetched information ansible.builtin.debug: msg: "{{ result.redfish_facts.session.entries | to_nice_json }}"
- name: Get default inventory information community.general.redfish_info: baseuri: "{{ baseuri }}" username: "{{ username }}" password: "{{ password }}" register: result
- name: Print fetched information ansible.builtin.debug: msg: "{{ result.redfish_facts | to_nice_json }}"
- name: Get several inventories community.general.redfish_info: category: Systems command: GetNicInventory,GetBiosAttributes baseuri: "{{ baseuri }}" username: "{{ username }}" password: "{{ password }}"
- name: Get default system inventory and user information community.general.redfish_info: category: Systems,Accounts baseuri: "{{ baseuri }}" username: "{{ username }}" password: "{{ password }}"
- name: Get default system, user and firmware information community.general.redfish_info: category: ["Systems", "Accounts", "Update"] baseuri: "{{ baseuri }}" username: "{{ username }}" password: "{{ password }}"
- name: Get Manager NIC inventory information community.general.redfish_info: category: Manager command: GetManagerNicInventory baseuri: "{{ baseuri }}" username: "{{ username }}" password: "{{ password }}"
- name: Get boot override information community.general.redfish_info: category: Systems command: GetBootOverride baseuri: "{{ baseuri }}" username: "{{ username }}" password: "{{ password }}"
- name: Get chassis inventory community.general.redfish_info: category: Chassis command: GetChassisInventory baseuri: "{{ baseuri }}" username: "{{ username }}" password: "{{ password }}"
- name: Get all information available in the Manager category community.general.redfish_info: category: Manager command: all baseuri: "{{ baseuri }}" username: "{{ username }}" password: "{{ password }}"
- name: Get firmware update capability information community.general.redfish_info: category: Update command: GetFirmwareUpdateCapabilities baseuri: "{{ baseuri }}" username: "{{ username }}" password: "{{ password }}"
- name: Get firmware inventory community.general.redfish_info: category: Update command: GetFirmwareInventory baseuri: "{{ baseuri }}" username: "{{ username }}" password: "{{ password }}"
- name: Get software inventory community.general.redfish_info: category: Update command: GetSoftwareInventory baseuri: "{{ baseuri }}" username: "{{ username }}" password: "{{ password }}"
- name: Get the status of an update operation community.general.redfish_info: category: Update command: GetUpdateStatus baseuri: "{{ baseuri }}" username: "{{ username }}" password: "{{ password }}" update_handle: /redfish/v1/TaskService/TaskMonitors/735
- name: Get Manager Services community.general.redfish_info: category: Manager command: GetNetworkProtocols baseuri: "{{ baseuri }}" username: "{{ username }}" password: "{{ password }}"
- name: Get all information available in all categories community.general.redfish_info: category: all command: all baseuri: "{{ baseuri }}" username: "{{ username }}" password: "{{ password }}"
- name: Get system health report community.general.redfish_info: category: Systems command: GetHealthReport baseuri: "{{ baseuri }}" username: "{{ username }}" password: "{{ password }}"
- name: Get chassis health report community.general.redfish_info: category: Chassis command: GetHealthReport baseuri: "{{ baseuri }}" username: "{{ username }}" password: "{{ password }}"
- name: Get manager health report community.general.redfish_info: category: Manager command: GetHealthReport baseuri: "{{ baseuri }}" username: "{{ username }}" password: "{{ password }}"
- name: Get manager Redfish Host Interface inventory community.general.redfish_info: category: Manager command: GetHostInterfaces baseuri: "{{ baseuri }}" username: "{{ username }}" password: "{{ password }}"
- name: Get Manager Inventory community.general.redfish_info: category: Manager command: GetManagerInventory baseuri: "{{ baseuri }}" username: "{{ username }}" password: "{{ password }}"
- name: Get HPE Thermal Config community.general.redfish_info: category: Chassis command: GetHPEThermalConfig baseuri: "{{ baseuri }}" username: "{{ username }}" password: "{{ password }}"
- name: Get HPE Fan Percent Minimum community.general.redfish_info: category: Chassis command: GetHPEFanPercentMin 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. elements: str required: false type: list timeout: default: 10 description: - Timeout in seconds for HTTP requests to OOB controller. type: int category: default: - Systems description: - List of categories to execute on OOB controller. elements: str required: false type: list password: description: - Password for authenticating to OOB controller. type: str username: description: - Username for authenticating to OOB controller. type: str auth_token: description: - Security token for authenticating to OOB controller. type: str version_added: 2.3.0 version_added_collection: community.general update_handle: description: - Handle to check the status of an update in progress. required: false type: str version_added: 6.1.0 version_added_collection: community.general
result: description: different results depending on task returned: always sample: List of CPUs on system type: dict