Skip to main content
A newer release of this product is available.

Update the cluster software version

Contributors
PDFs

PATCH /cluster/software

Upgrades the cluster software version. Setting version triggers the installation of the package to start. To validate the package for installation but not perform the installation, use the validate_only field on request. Important note:

  • Setting 'version' triggers the package installation.

  • To validate the package for installation but not perform the installation, use the validate_only field on the request.

Required properties

  • version - Software version to be installed on the cluster

  • validate_only - Required to validate a software package before an upgrade

  • skip_warnings - Used to skip validation warnings when starting a software upgrade

  • action - Used to pause, resume, or cancel an ongoing software upgrade

  • cluster image validate

  • cluster image update

  • cluster image pause-update

  • cluster image resume-update

  • cluster image cancel-update

Learn more

Parameters

Name Type In Required Description

validate_only

boolean

query

False

Validate the operation and its parameters, without actually performing the operation.

skip_warnings

boolean

query

False

Ignore warnings and proceed with the install.

action

string

query

False

Requests an upgrade to pause, resume, or cancel. Note that not all upgrades support these actions. An upgrade can only be resumed if it is in the paused state. When a request to cancel an upgrade is successful, the upgrade state changes to either success or failure.

  • enum: ["pause", "resume", "cancel"]

Request Body

Name Type Description

_links

_links

action

string

User triggered action to apply to the install operation

elapsed_duration

integer

Elapsed time during the upgrade or validation operation

estimated_duration

integer

Estimated time remaining until completion of the upgrade or validation operation.

metrocluster

metrocluster

nodes

array[software_node_reference]

List of nodes and active versions.

pending_version

string

Version being installed on the system.

  • example: ONTAP_X_1

  • readOnly: 1

state

string

Operational state of the upgrade

status_details

array[software_status_details_reference]

Display status details.

update_details

array[software_update_details_reference]

Display update procress details.

validation_results

array[software_validation_reference]

List of validation warnings, errors, and advice.

version

string

Version of ONTAP installed and currently active on the system. During PATCH, using the 'validate_only' parameter on the request executes pre-checks, but does not perform the full installation.

  • example: ONTAP_X
Example request 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "action": "pause",
  "elapsed_duration": 2140,
  "estimated_duration": 5220,
  "metrocluster": {
    "clusters": {
      "elapsed_duration": 2140,
      "estimated_duration": 3480,
      "name": "cluster_A",
      "state": "in_progress"
    },
    "progress_details": "Switchover in progress.",
    "progress_summary": "MetroCluster updated successfully."
  },
  "nodes": {
    "name": "node1",
    "version": "ONTAP_X"
  },
  "pending_version": "ONTAP_X_1",
  "state": "completed",
  "status_details": {
    "action": "string",
    "end_time": "2019-02-02 19:00:00 UTC",
    "message": "Post-update checks successful",
    "name": "initialize",
    "node": {
      "name": "node1"
    },
    "start_time": "2019-02-02 19:00:00 UTC",
    "state": "failed"
  },
  "update_details": {
    "elapsed_duration": 2100,
    "estimated_duration": 4620,
    "node": {
      "name": "node1"
    },
    "phase": "Pre-update checks",
    "state": "failed"
  },
  "validation_results": {
    "action": "string",
    "message": "string",
    "status": "warning",
    "update_check": "nfs_mounts"
  },
  "version": "ONTAP_X"
}

Response

Status: 202, Accepted
Name Type Description

job

job_link
Example response 
{
  "job": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "uuid": "string"
  }
}

Error

Status: Default, Error
Name Type Description

error

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

self

href

software_mcc_reference

Name Type Description

elapsed_duration

integer

Elapsed duration of update time (in seconds) in MetroCluster.

estimated_duration

integer

Estimated duration of update time (in seconds) in MetroCluster.

name

string

Name of the site in MetroCluster.

state

Upgrade state of MetroCluster.

metrocluster

Name Type Description

clusters

array[software_mcc_reference]

List of MetroCluster sites, statuses, and active versions.

progress_details

string

MetroCluster update progress details.

progress_summary

string

MetroCluster update progress summary.

software_node_reference

Name Type Description

name

string

Name of the node.

version

string

ONTAP version of the node.

  • example: ONTAP_X

  • readOnly: 1

node

Name Type Description

name

string

Name of the node to be retrieved for status details.

software_status_details_reference

Name Type Description

action

string

Corrective action to be taken to resolve the status error.

end_time

string

End time for each status phase.

message

string

Detailed message of the phase details.

name

string

Name of the phase to be retrieved for status details.

node

node

start_time

string

Start time for each status phase.

state

string

Status of the phase

node

Name Type Description

name

string

Name of the node to be retrieved for update details.

software_update_details_reference

Name Type Description

elapsed_duration

integer

Elapsed duration for each update phase

estimated_duration

integer

Estimated duration for each update phase

node

node

phase

string

Phase details

state

string

State of the update phase

software_validation_reference

Name Type Description

action

string

Corrective action to resolve errors or warnings for update checks.

message

string

Details of the error or warning encountered by the update check.

status

string

Status of this update check.

update_check

string

Name of the update check to be validated.

software_reference

Name Type Description

_links

_links

action

string

User triggered action to apply to the install operation

elapsed_duration

integer

Elapsed time during the upgrade or validation operation

estimated_duration

integer

Estimated time remaining until completion of the upgrade or validation operation.

metrocluster

metrocluster

nodes

array[software_node_reference]

List of nodes and active versions.

pending_version

string

Version being installed on the system.

  • example: ONTAP_X_1

  • readOnly: 1

state

string

Operational state of the upgrade

status_details

array[software_status_details_reference]

Display status details.

update_details

array[software_update_details_reference]

Display update procress details.

validation_results

array[software_validation_reference]

List of validation warnings, errors, and advice.

version

string

Version of ONTAP installed and currently active on the system. During PATCH, using the 'validate_only' parameter on the request executes pre-checks, but does not perform the full installation.

  • example: ONTAP_X
Name Type Description

_links

_links

uuid

string

The UUID of the asynchronous job that is triggered by a POST, PATCH, or DELETE operation.

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.