Retrieve history details for firmware update requests
Retrieves detailed historical records of firmware update requests for your cluster. Use this information to analyze update trends, troubleshoot issues, and verify system integrity over time.
HTTP method and endpoint
GET /cluster/firmware/history
Introduced in
ONTAP 9.8
Usage notes
Retrieves the history details for firmware update requests.
Learn more
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
end_time |
string |
query |
False |
Filter by end_time |
start_time |
string |
query |
False |
Filter by start_time |
update_status.worker.state |
string |
query |
False |
Filter by update_status.worker.state |
update_status.worker.node.name |
string |
query |
False |
Filter by update_status.worker.node.name |
update_status.worker.node.uuid |
string |
query |
False |
Filter by update_status.worker.node.uuid |
update_status.worker.error.message |
string |
query |
False |
Filter by update_status.worker.error.message |
update_status.worker.error.code |
integer |
query |
False |
Filter by update_status.worker.error.code |
job.uuid |
string |
query |
False |
Filter by job.uuid |
node.name |
string |
query |
False |
Filter by node.name |
node.uuid |
string |
query |
False |
Filter by node.uuid |
fw_file_name |
string |
query |
False |
Filter by fw_file_name |
fw_update_state |
string |
query |
False |
Filter by fw_update_state |
fields |
array[string] |
query |
False |
Specify the fields to return. |
max_records |
integer |
query |
False |
Limit the number of records returned. |
return_records |
boolean |
query |
False |
The default is true for GET calls. When set to false, only the number of records is returned.
|
return_timeout |
integer |
query |
False |
The number of seconds to allow the call to execute before returning. When iterating over a collection, the default is 15 seconds. ONTAP returns earlier if either max records or the end of the collection is reached.
|
order_by |
array[string] |
query |
False |
Order results by specified fields and optional [asc |
Response
Status: 200, Ok
| Name | Type | Description |
|---|---|---|
_links |
||
num_records |
integer |
Number of records |
records |
array[firmware_history] |
Example response
{
"_links": {
"next": {
"href": "/api/resourcelink"
},
"self": {
"href": "/api/resourcelink"
}
},
"num_records": 1,
"records": [
{
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"end_time": "2019-02-02 19:00:00 +0000",
"fw_file_name": "all_disk_fw.zip",
"fw_update_state": "string",
"job": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"uuid": "string"
},
"node": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "node1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"start_time": "2019-02-02 19:00:00 +0000",
"update_status": [
{
"worker": {
"error": {
"code": 2228325,
"message": "Cannot open local staging ZIP file disk_firmware.zip"
},
"node": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "node1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"state": "waiting_to_retry"
}
}
]
}
]
}
Error
Status: Default, Error
| Name | Type | Description |
|---|---|---|
error |
Example error
{
"error": {
"arguments": [
{
"code": "string",
"message": "string"
}
],
"code": "4",
"message": "entry doesn't exist",
"target": "uuid"
}
}
Definitions
See Definitions
href
| Name | Type | Description |
|---|---|---|
href |
string |
_links
| Name | Type | Description |
|---|---|---|
next |
||
self |
_links
| Name | Type | Description |
|---|---|---|
self |
job_link
| Name | Type | Description |
|---|---|---|
_links |
||
uuid |
string |
The UUID of the asynchronous job that is triggered by a POST, PATCH, or DELETE operation. |
node
| Name | Type | Description |
|---|---|---|
_links |
||
name |
string |
|
uuid |
string |
firmware_history_update_state_error
| Name | Type | Description |
|---|---|---|
code |
integer |
Code corresponding to the status message. |
message |
string |
Error message returned when a firmware update job fails. |
worker
| Name | Type | Description |
|---|---|---|
error |
||
node |
||
state |
string |
The state of each worker that a node is controlling. |
firmware_history_update_state
| Name | Type | Description |
|---|---|---|
worker |
firmware_history
| Name | Type | Description |
|---|---|---|
_links |
||
end_time |
string |
End time of this update request. |
fw_file_name |
string |
Name of the firmware file. |
fw_update_state |
string |
|
job |
||
node |
||
start_time |
string |
Start time of this update request. |
update_status |
error_arguments
| Name | Type | Description |
|---|---|---|
code |
string |
Argument code |
message |
string |
Message argument |
returned_error
| Name | Type | Description |
|---|---|---|
arguments |
array[error_arguments] |
Message arguments |
code |
string |
Error code |
message |
string |
Error message |
target |
string |
The target parameter that caused the error. |