Retrieve software or firmware download status
Obtains the current status of software or firmware downloads to monitor the progress and ensure successful updates within your system.
HTTP method and endpoint
GET /cluster/software/download
Introduced in
ONTAP 9.7
Usage notes
Retrieves the software or firmware download status.
Related ONTAP commands
-
cluster image package check-download-progress
Learn more
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
fields |
array[string] |
query |
False |
Specify the fields to return. |
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.
|
Response
Status: 200, Ok
| Name | Type | Description |
|---|---|---|
code |
integer |
Code corresponds to download message |
message |
string |
Download progress details |
state |
string |
Download status of the package |
Example response
{
"code": 10551496,
"message": "Package download in progress",
"state": "success"
}
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
error_arguments
| Name | Type | Description |
|---|---|---|
code |
string |
Argument code |
message |
string |
Message argument |
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. |