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

Initiate a switchover, heal, or switchback operation

PDFs

PATCH /cluster/metrocluster

Introduced In: 9.8

Initiates a switchover or switchback operation.

Parameters

Name Type In Required Description

action

string

query

False

Action to perform on the MetroCluster.

  • enum: ["switchover", "negotiated_switchover", "negotiated_switchover_simulate", "switchback", "switchback_simulate"]

return_timeout

integer

query

False

Timeout in seconds for the call.

return_records

boolean

query

False

The default is false. If set to true, the records are returned.

  • Default value:

return_timeout

integer

query

False

The number of seconds to allow the call to execute before returning. When doing a POST, PATCH, or DELETE operation on a single record, the default is 0 seconds. This means that if an asynchronous operation is started, the server immediately returns HTTP code 202 (Accepted) along with a link to the job. If a non-zero value is specified for POST, PATCH, or DELETE operations, ONTAP waits that length of time to see if the job completes so it can return something other than 202.

  • Default value: 0

  • Max value: 120

  • Min value: 0

Response

Status: 202, Accepted
Name Type Description

job

job_link
Example response 
{
  "job": {
    "uuid": "string"
  }
}

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

2425734

An internal error occurred. Wait a few minutes, and try the operation again. For further assistance, contact technical support.

Definitions

See Definitions

href

Name Type Description

href

string

_links

Name Type Description

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.