Users Guide
Table Of Contents
- Dell EMC OpenManage Ansible Modules Version 4.0.0 User’s Guide
- Contents
- Overview
- Getting Started
- Modules for iDRAC
- How OpenManage Ansible Modules work with iDRAC
- Running your first iDRAC Playbook
- Updating Firmware
- Configuring PowerEdge Servers
- Deploying operating system
- Server Inventory
- Server administration tasks
- Storage controller
- Modules for OpenManage Enterprise (OME)
- How OpenManage Ansible Modules work with OME
- Running your first OME Playbook
- Manage Devices
- Manage device configuration templates
- Template Service
- Manage the device firmware
- Manage jobs
- Manage users
- Manage identity pool
- Manage application settings
- Manage network configuration
- Manage fabrics
- Manage Profiles
- Device discovery
- Manage Chassis
- Manage Active Directory service and user groups
- Diagnostics
- Modules for Redfish APIs
- Deprecated modules
Table 60. redfish_firmware (continued)
Parameter Required Default Choices Comments
firmware_repo/
component.exe
transfer_protocol False HTTP HTTP, HTTPS, FTP,
NSF, CIFS, FTP, OEM,
SCP, SFTP, or TFTP
● Protocol used
to transfer the
firmware image file.
● Applicable for URI-
based update.
NOTE: Dell
PowerEdge servers
support transfer
protocols only
through HTTP-
based shares.
Return values
msg:
description: Overall status of the firmware update task.
returned: always
type: str
sample: Successfully submitted the firmware update task.
task:
description: Returns ID and URI of the created task.
returned: success
type: dict
sample: {
"id": "JID_XXXXXXXXXXXX",
"uri": "/redfish/v1/TaskService/Tasks/JID_XXXXXXXXXXXX"
}
error_info:
type: dict
description: Details of a http error.
returned: on http error
sample: {
"error": {
"@Message.ExtendedInfo": [
{
"Message": "Unable to complete the operation because the JSON data
format entered is invalid.",
"Resolution": "Do the following and the retry the operation:
1) Enter the correct JSON data format and retry the operation.
2) Make sure that no syntax error is present in JSON data format.
3) Make sure that a duplicate key is not present in JSON data
format.",
"Severity": "Critical"
},
{
"Message": "The request body submitted was malformed JSON and
could not be parsed by the receiving service.",
"Resolution": "Ensure that the request body is valid JSON and
resubmit the request.",
"Severity": "Critical"
}
],
"code": "Base.1.2.GeneralError",
"message": "A general error has occurred. See ExtendedInfo for more
information."
}
}
Modules for Redfish APIs
173