Retrieve software installation requests history details
Retrieves the history details for software installation requests to review past installation activities and understand changes made to the system.
HTTP method and endpoint
GET /cluster/software/history
Introduced in
ONTAP 9.6
Related ONTAP commands
-
cluster image show-update-history
Learn more
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
end_time |
string |
query |
False |
Filter by end_time
|
state |
string |
query |
False |
Filter by state
|
node.uuid |
string |
query |
False |
Filter by node.uuid
|
node.name |
string |
query |
False |
Filter by node.name
|
to_version |
string |
query |
False |
Filter by to_version
|
from_version |
string |
query |
False |
Filter by from_version
|
start_time |
string |
query |
False |
Filter by start_time
|
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[software_history] |
Example response
{
"_links": {
"next": {
"href": "/api/resourcelink"
},
"self": {
"href": "/api/resourcelink"
}
},
"num_records": 1,
"records": [
{
"end_time": "2019-02-02 15:00:00 -0500",
"from_version": "ONTAP_X1",
"node": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "node1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"start_time": "2019-02-02 14:00:00 -0500",
"state": "successful",
"to_version": "ONTAP_X2"
}
]
}
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 |
node
| Name | Type | Description |
|---|---|---|
_links |
||
name |
string |
|
uuid |
string |
software_history
| Name | Type | Description |
|---|---|---|
end_time |
string |
Completion time of this installation request. |
from_version |
string |
Previous version of node
|
node |
||
start_time |
string |
Start time of this installation request. |
state |
string |
Status of this installation request. |
to_version |
string |
Updated version of node
|
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. |