community.general.wdc_redfish_info module – Manages WDC UltraStar Data102 Out-Of-Band controllers using Redfish APIs
Note
This module is part of the community.general collection (version 5.8.3).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install community.general
.
To use it in a playbook, specify: community.general.wdc_redfish_info
.
New in community.general 5.4.0
Synopsis
Builds Redfish URIs locally and sends them to remote OOB controllers to get information back.
Parameters
Parameter |
Comments |
---|---|
Security token for authentication with OOB controller. |
|
Base URI of OOB controller. Must include this or ioms. |
|
Category to execute on OOB controller. |
|
List of commands to execute on OOB controller. |
|
List of IOM FQDNs for the enclosure. Must include this or baseuri. |
|
Password for authentication with OOB controller. |
|
Timeout in seconds for URL requests to OOB controller. Default: |
|
User for authentication with OOB controller. |
Notes
Note
In the inventory, you can specify baseuri or ioms. See the EXAMPLES section.
ioms is a list of FQDNs for the enclosure’s IOMs.
Examples
- name: Get Simple Update Status with individual IOMs specified
community.general.wdc_redfish_info:
category: Update
command: SimpleUpdateStatus
ioms:
- iom1.wdc.com
- iom2.wdc.com
username: "{{ username }}"
password: "{{ password }}"
register: result
- name: Print fetched information
ansible.builtin.debug:
msg: "{{ result.redfish_facts.simple_update_status.entries | to_nice_json }}"
- name: Get Simple Update Status with baseuri specified
community.general.wdc_redfish_info:
category: Update
command: SimpleUpdateStatus
baseuri: "iom1.wdc.com"
username: "{{ username }}"
password: "{{ password }}"
register: result
- name: Print fetched information
ansible.builtin.debug:
msg: "{{ result.redfish_facts.simple_update_status.entries | to_nice_json }}"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Firmware update status description. Returned: always Sample: |
|
Numeric error code for firmware update status. Non-zero indicates an error condition. Returned: always Sample: |
|
Estimated number of minutes remaining in firmware update operation. Returned: always Sample: |
|
Firmware update status code. Returned: always Sample: |
Collection links
Issue Tracker Repository (Sources) Submit a bug report Request a feature Communication