REST API reference
Cluster software endpoint overview
Suggest changes
PDFs
Overview
You can use the ONTAP cluster software API to retrieve and display relevant information about a software profile, software packages collection, software history collection, and firmware packages collection. This API retrieves the information about all software packages present in the cluster, or a specific software package, or firmware upgrade status.
You can use the POST request to download a software package/firmware from an HTTP or FTP server. The PATCH request provides the option to upgrade the cluster software version. Select the validate_only field to validate the package before triggering the update. Set the version field to trigger the installation of the package in the cluster. You can pause, resume, or cancel any ongoing software upgrade by selecting action. You can use the DELETE request to remove a specific software package present in the cluster.
Examples
Retrieving software profile information
The following example shows how to retrieve software and firmware profile information. You can check the validation results after selecting the validate_only field. Upgrade progress information is available after an upgrade has started.
# The API:
/api/cluster/software
# The call:
curl -X GET "https://<mgmt-ip>/api/cluster/software?return_timeout=15" -H "accept: application/hal+json"
# The response:
{
"validation_results": [
{
"update_check": "NFS mounts",
"status": "warning",
"issue": {
"message": "Use NFS hard mounts, if possible.",
}
,
"action": {
"message": "Use NFS hard mounts, if possible.",
}
}
],
"version": "9.5.0",
"pending_version": "9.6.0",
"nodes": [
{
"node": "Node 1",
"version": "9.5.0",
"firmware": {
"cluster_fw_progress": [
{
"job": {
"uuid": "5a21663c-a9a0-11ea-af9a-005056bb44d7",
"_links": {
"self": {
"href": "/api/cluster/jobs/5a21663c-a9a0-11ea-af9a-005056bb44d7"
}
}
},
"zip_file_name": "abc.zip",
"update_type": "automatic_update",
"update_state": [
{
"worker_node": {
"name": "Node 1",
"uuid": "fcd40f70-f531-11eb-b235-005056bb3497"
},
"status": "failed",
"attempts": 3,
"message": "Cannot open the local staging zip file.",
"code": 2228325
},
{
"worker_node": {
"name": "Node 2",
"uuid": "fcd40f70-f531-11eb-b235-005056bb3498"
},
"status": "complete",
"attempts": 3,
"message": "Success",
"code": 0
}
]
},
{
"job": {
"uuid": "5a21663c-a9a0-11ea-af9a-005056bb44d7",
"_links": {
"self": {
"href": "/api/cluster/jobs/5a21663c-a9a0-11ea-af9a-005056bb44d7"
}
}
},
"zip_file_name": "xyz.zip",
"update_type": "manual_update",
"update_state": [
{
"worker_node": {
"name": "Node 1",
"uuid": "fcd40f70-f531-11eb-b235-005056bb3497"
},
"status": "failed",
"attempts": 3,
"message": "Cannot open the local staging zip file.",
"code": 2228325
},
{
"worker_node": {
"name": "Node 2",
"uuid": "fcd40f70-f531-11eb-b235-005056bb3498"
},
"status": "complete",
"attempts": 3,
"message": "Success",
"code": 0
}
]
}
],
"disk": {
"num_waiting_download": 0,
"total_completion_estimate": 0,
"average_duration_per_disk": 120,
"update_status": "idle"
},
"shelf": {
"update_status": "idle",
"in_progress_count": 2
},
"dqp": {
"revision": "20200117",
"version": "3.17",
"file_name": "qual_devices_v2",
"record_count": {
"drive": 680,
"alias": 200,
"device": 29,
"system": 3
}
},
"sp_bmc": {
"fw_type": "SP",
"image": " primary",
"status": "installed",
"is_current": true,
"running_version": "1.2.3.4",
"autoupdate": false,
"last_update_status": "passed",
"start_time": "2018-05-21T09:53:04+05:30",
"percent_done": 100,
"end_time": "2018-05-21T09:53:04+05:30",
"in_progress": false
}
}
}
],
"metrocluster": {
"progress_summary": {
"message": "Update paused by user"
},
"progress_details": {
"message": "Installing software image on cluster \"sti70-vsim-ucs165n_siteA\"."
},
"clusters": [
{
"name": "sti70-vsim-ucs165n_siteA",
"uuid": "720f046c-4b13-11e9-9c34-005056ac5626",
"estimated_duration": 3480,
"elapsed_duration": 0,
"state": "waiting"
},
]
},
"state": "in_progress",
"start_time": "2018-05-21T09:53:04+05:30",
"end_time": "2018-05-21T11:53:04+05:30",
"estimated_time": 5220,
"elapsed_time": 2140,
"update_details": [
{
"phase": "Data ONTAP updates",
"state": "in_progress",
"estimated_duration": 4620,
"elapsed_duration": 29,
"node": {
"name": "sti70-vsim-ucs165n"
}
}
],
"status_details": [
{
"name": "do-download-job",
"state": "completed",
"issue": {
"message": "Image update complete",
"code": 0
},
"start_time": "2018-05-21T09:53:04+05:30",
"end_time": "2018-05-21T11:53:04+05:30",
"node": {
"name": "sti70-vsim-ucs165n"
}
}
],
"_links": {
"self": {
"href": "/api/cluster/software/"
}
}
}
Upgrading the software version
The following example shows how to upgrade cluster software. Set the version field to trigger the installation of the package. You can select the validate_only field to validate the package before the installation starts. Setting skip_warning as true ignores the validation warning before the installation starts. Setting the action field performs a pause, resume, or cancel' operation on an ongoing upgrade. An upgrade can only be resumed if it is in the paused state. Setting stabilize_minutes allows each node a specified amount of time to stabilize after a reboot; the default is 8 minutes. If show_validation_details` is set to "true", all validation details will be shown in the output.
You can start the upgrade process at the cluster level. There are no options available to start the upgrade for a specific node or HA pair.
1. Validating the package and verifying the validation results
The following example shows how to validate a cluster software package. You must validate the package before the software upgrade. Set the validate_only field to true to start the validation. You can check for validation results in the GET /cluster/software endpoint.
# The API:
/api/cluster/software
# The call:
curl -X PATCH "https://<mgmt_ip>/api/cluster/software?validate_only=true" -H "accept: application/json" -H "Content-Type: application/hal+json" -d '{ "version": "9.5.0"}'
# The response:
{
"job": {
"uuid": "f587d316-5feb-11e8-b0e0-005056956dfc",
"_links": {
"self": {
"href": "/api/cluster/jobs/f587d316-5feb-11e8-b0e0-005056956dfc"
}
}
}
}
The call to validate the software cluster version returns the job UUID, including a HAL link to retrieve details about the job. The job object includes a state field and a message to indicate the progress of the job. When the job is complete and the application is fully created, the message indicates success and the state field of the job is set to success.
# The API:
/api/cluster/jobs/{uuid}
# The call:
curl -X GET "https://<mgmt-ip>/api/cluster/jobs/f587d316-5feb-11e8-b0e0-005056956dfc" -H "accept: application/hal+json"
# The response:
{
"uuid": "f587d316-5feb-11e8-b0e0-005056956dfc",
"description": "PATCH /api/cluster/software",
"state": "success",
"message": "success",
"code": 0,
"_links": {
"self": {
"href": "/api/cluster/jobs/f587d316-5feb-11e8-b0e0-005056956dfc"
}
}
}
You can check for validation results in the GET /cluster/software endpoint. The following example shows how to check the validation warnings and errors after setting the validate_only field to true.
# The API:
/api/cluster/software
# The call:
curl -X GET "https://<mgmt-ip>/api/cluster/software" -H "accept: application/hal+json"
# The response:
{
"version": "9.7.0",
"validation_results": [
{
"update_check": "High Availability status",
"status": "error",
"issue": {
"message": "Cluster HA is not configured in the cluster. Storage failover is not enabled on node \"node1\", \"node2\".",
},
"action": {
"message": "Check cluster HA configuration. Check storage failover status."
}
},
{
"update_check": "Manual checks",
"status": "warning",
"issue" : {
"message": "Manual validation checks need to be performed. Refer to the Upgrade Advisor Plan or the \"What should I verify before I upgrade with or without Upgrade Advisor\" section in the \"Upgrade ONTAP\" documentation for the remaining validation checks that need to be performed before update. Failing to do so can result in an update failure or an I/O disruption."
},
"action": {
"message": "Refer to the Upgrade Advisor Plan or the \"What should I verify before I upgrade with or without Upgrade Advisor\" section in the \"Upgrade ONTAP\" documentation for the remaining validation checks that need to be performed before update."
}
}
],
"nodes": [
{
"node": "sti70-vsim-ucs165n",
"version": "9.5.0",
"firmware": {
"cluster_fw_progress": [
{
"job": {
"uuid": "5a21663c-a9a0-11ea-af9a-005056bb44d7",
"_links": {
"self": {
"href": "/api/cluster/jobs/5a21663c-a9a0-11ea-af9a-005056bb44d7"
}
}
},
"zip_file_name": "abc.zip",
"update_type": "automatic_update",
"update_state": [
{
"worker_node": {
"name": "Node 1",
"uuid": "fcd40f70-f531-11eb-b235-005056bb3498"
},
"status": "failed",
"attempts": 3,
"message": "Cannot open the local staging zip file.",
"code": 2228325
},
{
"worker_node": {
"name": "Node 2",
"uuid": "fcd40f70-f531-11eb-b235-005056bb3498"
},
"status": "complete",
"attempts": 3,
"message": "Success",
"code": 0
}
]
},
{
"job": {
"uuid": "5a21663c-a9a0-11ea-af9a-005056bb44d7",
"_links": {
"self": {
"href": "/api/cluster/jobs/5a21663c-a9a0-11ea-af9a-005056bb44d7"
}
}
},
"zip_file_name": "xyz.zip",
"update_type": "automatic_update",
"update_state": [
{
"worker_node": {
"name": "Node 1",
"uuid": "fcd40f70-f531-11eb-b235-005056bb3498"
},
"status": "failed",
"attempts": 3,
"message": "Cannot open the local staging zip file.",
"code": 2228325
},
{
"worker_node": {
"name": "Node 2",
"uuid": "fcd40f70-f531-11eb-b235-005056bb3498"
},
"status": "complete",
"attempts": 3,
"message": "Success",
"code": 0
}
]
}
],
"disk": {
"num_waiting_download": 0,
"total_completion_estimate": 0,
"average_duration_per_disk": 120,
"update_status": "idle"
},
"shelf": {
"update_status": "idle",
"in_progress_count": 2
},
"dqp": {
"revision": "20200117",
"version": "3.17",
"file_name": "qual_devices_v2",
"record_count": {
"drive": 680,
"alias": 200,
"device": 29,
"system": 3
}
},
"sp_bmc": {
"fw_type": "SP",
"image": " primary",
"status": "installed",
"is_current": true,
"running_version": "1.2.3.4",
"autoupdate": false,
"last_update_status": "passed",
"start_time": "2018-05-21T09:53:04+05:30",
"percent_done": 100,
"end_time": "2018-05-21T09:53:04+05:30",
"in_progress": false
}
}
}
],
"state": "failed",
"elapsed_duration": 56,
"estimated_duration": 600,
"_links": {
"self": {
"href": "/api/cluster/software"
}
}
}
2. Updating the cluster
The following example shows how to initiate a cluster software upgrade. You must validate the package before the software upgrade starts. Set the skip_warnings field to true to skip validation warnings and start the software package upgrade. You can specify the stabilize_minutes value between 1 to 60 minutes. Setting stabilize_minutes allows each node a specified amount of time to stabilize after a reboot; the default is 8 minutes. If the value of show_validation_details is set to "true", then all validation details will be shown in the output.
# The API:
/api/cluster/software
# The call:
curl -X PATCH "https://<mgmt_ip>/api/cluster/software?skip_warnings=true" -H "accept: application/json" -H "Content-Type: application/hal+json" -d '{ "version": "9.5.0"}'
# The response:
{
"job": {
"uuid": "f587d316-5feb-11e8-b0e0-005056956dfc",
"_links": {
"self": {
"href": "/api/cluster/jobs/f587d316-5feb-11e8-b0e0-005056956dfc"
}
}
}
}
The call to update the software cluster version returns the job UUID, including a HAL link to retrieve details about the job. The job object includes a state field and a message to indicate the progress of the job. When the job is complete and the application is fully created, the message indicates success and the state field of the job is set to success.
# The API:
/api/cluster/jobs/{uuid}
# The call:
curl -X GET "https://<mgmt-ip>/api/cluster/jobs/f587d316-5feb-11e8-b0e0-005056956dfc" -H "accept: application/hal+json"
# The response:
{
"uuid": "f587d316-5feb-11e8-b0e0-005056956dfc",
"description": "PATCH /api/cluster/software",
"state": "success",
"message": "success",
"code": 0,
"_links": {
"self": {
"href": "/api/cluster/jobs/f587d316-5feb-11e8-b0e0-005056956dfc"
}
}
}
You can check the update progress information in the GET /cluster/software endpoint. The following example shows how to check the progress of an update after setting the skip_warnings field to true. Each node's object also includes information about the firmware update status on the node.
# The API:
/api/cluster/software
# The call:
curl -X GET "https://<mgmt-ip>/api/cluster/software" -H "accept: application/hal+json"
# The response:
{
"version": "9.7.0",
"validation_results": [
{
"update_check": "Manual checks",
"status": "warning",
"issue" : {
"message": "Manual validation checks need to be performed. Refer to the Upgrade Advisor Plan or the \"What should I verify before I upgrade with or without Upgrade Advisor\" section in the \"Upgrade ONTAP\" documentation for the remaining validation checks that need to be performed before update. Failing to do so can result in an update failure or an I/O disruption."
},
"action": {
"message": "Refer to the Upgrade Advisor Plan or the \"What should I verify before I upgrade with or without Upgrade Advisor\" section in the \"Upgrade ONTAP\" documentation for the remaining validation checks that need to be performed before update."
}
}
],
"nodes": [
{
"node": "sti70-vsim-ucs165n",
"version": "9.5.0",
"firmware": {
"cluster_fw_progress": [
{
"job": {
"uuid": "5a21663c-a9a0-11ea-af9a-005056bb44d7",
"_links": {
"self": {
"href": "/api/cluster/jobs/5a21663c-a9a0-11ea-af9a-005056bb44d7"
}
}
},
"zip_file_name": "abc.zip",
"update_type": "automated_update",
"update_state": [
{
"worker_node": {
"name": "Node 3",
"uuid": "fcd40f70-f531-11eb-b235-005056bb3497"
},
"status": "failed",
"attempts": 3,
"message": "Cannot open the local staging zip file.",
"code": 2228325
},
{
"worker_node": {
"name": "Node 4",
"uuid": "fcd40f70-f531-11eb-b235-005056bb3498"
},
"status": "complete",
"attempts": 3,
"message": "Success",
"code": 0
}
]
},
{
"job": {
"uuid": "5a21663c-a9a0-11ea-af9a-005056bb44d7",
"_links": {
"self": {
"href": "/api/cluster/jobs/5a21663c-a9a0-11ea-af9a-005056bb44d7"
}
}
},
"zip_file_name": "xyz.zip",
"update_type": "automated_update",
"update_state": [
{
"worker_node": {
"name": "Node 1",
"uuid": "fcd40f70-f531-11eb-b235-005056bb3497"
},
"status": "failed",
"attempts": 3,
"message": "Cannot open the local staging zip file.",
"code": 2228325
},
{
"worker_node": {
"name": "Node 2",
"uuid": "fcd40f70-f531-11eb-b235-005056bb3497"
},
"status": "complete",
"attempts": 3,
"message": "Success",
"code": 0
}
]
}
],
"disk": {
"num_waiting_download": 0,
"total_completion_estimate": 0,
"average_duration_per_disk": 120,
"update_status": "idle"
},
"shelf": {
"update_status": "idle",
"in_progress_count": 2
},
"dqp": {
"revision": "20200117",
"version": "3.17",
"file_name": "qual_devices_v2",
"record_count": {
"drive": 680,
"alias": 200,
"device": 29,
"system": 3
}
},
"sp_bmc": {
"fw_type": "SP",
"image": " primary",
"status": "installed",
"is_current": true,
"running_version": "1.2.3.4",
"autoupdate": false,
"last_update_status": "passed",
"start_time": "2018-05-21T09:53:04+05:30",
"percent_done": 100,
"end_time": "2018-05-21T09:53:04+05:30",
"in_progress": false
}
}
}
],
"pending_version": "9.7.0",
"state": "in_progress",
"elapsed_duration": 63,
"estimated_duration": 5220,
"status_details": [
{
"name": "do-download-job",
"status": "running",
"issue": {
"message": "Installing software image.",
"code": 10551400
},
"start_time": "2019-01-14T23:12:14+05:30",
"end_time": "2019-01-14T23:12:14+05:30",
"node": {
"name": "node1"
}
},
{
"name": "do-download-job",
"status": "running",
"issue": {
"message": "Installing software image.",
"code": 10551400
},
"start_time": "2019-01-14T23:12:14+05:30",
"end_time": "2019-01-14T23:12:14+05:30",
"node": {
"name": "node2"
}
}
],
"update_details": [
{
"phase": "Data ONTAP updates",
"status": "in-progress",
"estimated_duration": 4620,
"elapsed_duration": 10,
"node": {
"name": "node1"
}
},
{
"phase": "Data ONTAP updates",
"status": "in-progress",
"estimated_duration": 4620,
"elapsed_duration": 10,
"node": {
"name": "node2"
}
}
],
"_links": {
"self": {
"href": "/api/cluster/software"
}
}
}
In the case of a post update check failure, the details are available under the heading "post_update_checks" in the GET /cluster/software endpoint. The following example shows how to check the progress of an update after a post update check has failed. Each node's object also includes information about the firmware update status on the node.
# The API:
/api/cluster/software
# The call:
curl -X GET "https://<mgmt-ip>/api/cluster/software" -H "accept: application/hal+json"
# The response:
{
"version": "9.7.0",
"validation_results": [
{
"update_check": "Manual checks",
"status": "warning",
"issue" : {
"message": "Manual validation checks need to be performed. Refer to the Upgrade Advisor Plan or the \"What should I verify before I upgrade with or without Upgrade Advisor\" section in the \"Upgrade ONTAP\" documentation for the remaining validation checks that need to be performed before update. Failing to do so can result in an update failure or an I/O disruption."
},
"action": {
"message": "Refer to the Upgrade Advisor Plan or the \"What should I verify before I upgrade with or without Upgrade Advisor\" section in the \"Upgrade ONTAP\" documentation for the remaining validation checks that need to be performed before update."
}
}
],
"nodes": [
{
"node": "sti70-vsim-ucs165n",
"version": "9.5.0",
"firmware": {
"cluster_fw_progress": [
{
"job": {
"uuid": "5a21663c-a9a0-11ea-af9a-005056bb44d7",
"_links": {
"self": {
"href": "/api/cluster/jobs/5a21663c-a9a0-11ea-af9a-005056bb44d7"
}
}
},
"zip_file_name": "abc.zip",
"update_type": "automated_update",
"update_state": [
{
"worker_node": {
"name": "Node 1",
"uuid": "fcd40f70-f531-11eb-b235-005056bb3497"
},
"status": "working",
"attempts": 3,
"message": "<message catalog text>",
"code": 3
},
{
"worker_node": {
"name": "Node 2",
"uuid": "fcd40f70-f531-11eb-b235-005056bb3497"
},
"status": "completed",
"attempts": 3,
"message": "Error message",
"code": 0
}
]
},
{
"job": {
"uuid": "5a21663c-a9a0-11ea-af9a-005056bb44d7",
"_links": {
"self": {
"href": "/api/cluster/jobs/5a21663c-a9a0-11ea-af9a-005056bb44d7"
}
}
},
"zip_file_name": "xyz.zip",
"update_type": "automated_update",
"update_state": [
{
"worker_node": {
"name": "Node 1",
"uuid": "fcd40f70-f531-11eb-b235-005056bb3497"
},
"status": "completed",
"attempts": 1,
"message": "Error message",
"code": 0
},
{
"worker_node": {
"name": "Node 2",
"uuid": "fcd40f70-f531-11eb-b235-005056bb3497"
},
"status": "completed",
"attempts": "3",
"message": "Error message",
"code": 0
}
]
}
],
"disk": {
"num_waiting_download": 0,
"total_completion_estimate": 0,
"average_duration_per_disk": 120,
"update_status": "idle"
},
"shelf": {
"update_status": "idle",
"in_progress_count": 2
},
"dqp": {
"revision": "20200117",
"version": "3.17",
"file_name": "qual_devices_v2",
"record_count": {
"drive": 680,
"alias": 200,
"device": 29,
"system": 3
}
},
"sp_bmc": {
"fw_type": "SP",
"image": " primary",
"status": "installed",
"is_current": "true",
"running_version": "1.2.3.4",
"autoupdate": "false",
"last_update_status": "passed",
"start_time": "2018-05-21T09:53:04+05:30",
"percent_done": 100,
"end_time": "2018-05-21T09:53:04+05:30",
"in_progress": "yes"
}
}
}
],
"pending_version": "9.7.0",
"state": "in_progress",
"elapsed_duration": 63,
"estimated_duration": 5220,
"status_details": [
{
"name": "do-download-job",
"status": "completed",
"issue": {
"message": "Image update complete.",
"code": 0
},
"start_time": "2019-01-14T23:12:14+05:30",
"end_time": "2019-01-14T23:12:14+05:30",
"node": {
"name": "node1"
}
},
{
"name": "do-download-job",
"status": "completed",
"issue": {
"message": "Image update complete.",
"code": 0
},
"start_time": "2019-01-14T23:12:14+05:30",
"end_time": "2019-01-14T23:12:14+05:30",
"node": {
"name": "node2"
}
}
],
"update_details": [
{
"phase": "Data ONTAP updates",
"status": "completed",
"estimated_duration": 4620,
"elapsed_duration": 3120,
"node": {
"name": "node1"
}
},
{
"phase": "Data ONTAP updates",
"status": "completed",
"estimated_duration": 4620,
"elapsed_duration": 3210,
"node": {
"name": "node2"
}
},
{
"phase": "Post-update checks",
"status": "paused_on_error",
"estimated_duration": 600,
"elapsed_duration": 10,
"node": {
"name": "node2"
}
}
],
"post_update_checks": [
{
"update_check": "Aggregate Health Status",
"status": "error",
"issue": {
"message": "Not all aggregates are online"
},
"action": {
"message": "Ensure all aggregates are online."
}
},
{
"update_check": "HA Health Status",
"status": "error",
"issue": {
"message": "Storage failover is not enabled on nodes of the cluster."
},
"action": {
"message": "Ensure storage failover is enabled on all nodes of the cluster."
}
}
],
"_links": {
"self": {
"href": "/api/cluster/software"
}
}
}
3. Pausing, resuming or canceling an upgrade
The following example shows how to pause an ongoing cluster software package upgrade. Set the action field to pause, resume, or cancel to pause, resume or cancel the upgrade respectively. Not all update operations support these actions. An update can only be resumed if it is in the paused state.
# The API:
/api/cluster/software
# The call:
curl -X PATCH "https://<mgmt_ip>/api/cluster/software?action=pause" -H "accept: application/json" -H "Content-Type: application/hal+json" -d '{ "version": "9.5.0"}'
# The response:
{
"job": {
"uuid": "f587d316-5feb-11e8-b0e0-005056956dfc",
"_links": {
"self": {
"href": "/api/cluster/jobs/f587d316-5feb-11e8-b0e0-005056956dfc"
}
}
}
}
The call to update the software cluster version and/or firmware version returns the job UUID, including a HAL link to retrieve details about the job. The job object includes a state field and a message to indicate the progress of the job. When the job is complete and the application is fully created, the message indicates success and the state field of the job is set to success.
# The API:
/api/cluster/jobs/{uuid}
# The call:
curl -X GET "https://<mgmt-ip>/api/cluster/jobs/f587d316-5feb-11e8-b0e0-005056956dfc" -H "accept: application/hal+json"
# The response:
{
"uuid": "f587d316-5feb-11e8-b0e0-005056956dfc",
"description": "PATCH /api/cluster/software",
"state": "success",
"message": "success",
"code": 0,
"_links": {
"self": {
"href": "/api/cluster/jobs/f587d316-5feb-11e8-b0e0-005056956dfc"
}
}
}
You can check the progress of the upgrade in the GET /cluster/software endpoint. The following example shows how to check the progress of the pause upgrade state after setting the action field to pause.
# The API:
/api/cluster/software
# The call:
curl -X GET "https://<mgmt-ip>/api/cluster/software" -H "accept: application/hal+json"
# The response:
{
"version": "9.7.0",
"va