community.general.wdc_redfish_command module – Manages WDC UltraStar Data102 Out-Of-Band controllers using Redfish APIs
Note
This module is part of the community.general collection (version 9.5.0).
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_command
.
New in community.general 5.4.0
Synopsis
Builds Redfish URIs locally and sends them to remote OOB controllers to perform an action.
Manages OOB controller firmware. For example, Firmware Activate, Update and Activate.
Parameters
Parameter |
Comments |
---|---|
Security token for authentication with OOB controller. |
|
Base URI of OOB controller. Must include this or |
|
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 |
|
Password for authentication with OOB controller. |
|
ID of the component to modify, such as |
|
Timeout in seconds for URL requests to OOB controller. Default: |
|
The credentials for retrieving the update image. |
|
The password for retrieving the update image. |
|
The username for retrieving the update image. |
|
The URI of the image for the update. |
|
User for authentication with OOB controller. |
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: full |
Can run in |
|
Support: none |
Will return details on what has changed (or possibly needs changing in |
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: Firmware Activate (required after SimpleUpdate to apply the new firmware)
community.general.wdc_redfish_command:
category: Update
command: FWActivate
ioms: "{{ ioms }}"
username: "{{ username }}"
password: "{{ password }}"
- name: Firmware Activate with individual IOMs specified
community.general.wdc_redfish_command:
category: Update
command: FWActivate
ioms:
- iom1.wdc.com
- iom2.wdc.com
username: "{{ username }}"
password: "{{ password }}"
- name: Firmware Activate with baseuri specified
community.general.wdc_redfish_command:
category: Update
command: FWActivate
baseuri: "iom1.wdc.com"
username: "{{ username }}"
password: "{{ password }}"
- name: Update and Activate (orchestrates firmware update and activation with a single command)
community.general.wdc_redfish_command:
category: Update
command: UpdateAndActivate
ioms: "{{ ioms }}"
username: "{{ username }}"
password: "{{ password }}"
update_image_uri: "{{ update_image_uri }}"
update_creds:
username: operator
password: supersecretpwd
- name: Turn on enclosure indicator LED
community.general.wdc_redfish_command:
category: Chassis
resource_id: Enclosure
command: IndicatorLedOn
username: "{{ username }}"
password: "{{ password }}"
- name: Turn off IOM A indicator LED
community.general.wdc_redfish_command:
category: Chassis
resource_id: IOModuleAFRU
command: IndicatorLedOff
username: "{{ username }}"
password: "{{ password }}"
- name: Turn on Power Supply B indicator LED
community.general.wdc_redfish_command:
category: Chassis
resource_id: PowerSupplyBFRU
command: IndicatorLedOn
username: "{{ username }}"
password: "{{ password }}"
- name: Turn on External Fan 3 indicator LED
community.general.wdc_redfish_command:
category: Chassis
resource_id: FanExternalFRU3
command: IndicatorLedOn
username: "{{ username }}"
password: "{{ password }}"
- name: Turn on Internal Fan indicator LED
community.general.wdc_redfish_command:
category: Chassis
resource_id: FanInternalFRU
command: IndicatorLedOn
username: "{{ username }}"
password: "{{ password }}"
- name: Set chassis to Low Power Mode
community.general.wdc_redfish_command:
category: Chassis
resource_id: Enclosure
command: PowerModeLow
- name: Set chassis to Normal Power Mode
community.general.wdc_redfish_command:
category: Chassis
resource_id: Enclosure
command: PowerModeNormal
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Message with action result or error description Returned: always Sample: |