Skip to main content
REST API reference

Initiate a switchover, heal, or switchback operation

PDFs

PATCH /cluster/metrocluster

Introduced In: 9.8

Initiates a switchover, heal or switchback operation.

  • metrocluster switchover

  • metrocluster switchback

  • metrocluster heal

  • metrocluster modify

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", "heal_aggregates", "heal_root_aggregates"]

encryption_enabled

boolean

query

False

Specifies if encryption for NVLog and storage traffic is enabled.

  • Introduced in: 9.16

dr_group_id

integer

query

False

DR group ID.

  • Introduced in: 9.16

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: 1

  • Max value: 120

  • Min value: 0

Request Body

Name Type Description

configuration_type

string

Displays the MetroCluster configuration type.

encryption_enabled

boolean

Indicates if the encryption for NVLog and storage traffic is enabled.

local

local

remote

remote
Example request 
{
  "configuration_type": "string",
  "local": {
    "automatic_uso_failure_domain": "string",
    "cluster": {
      "name": "cluster1",
      "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
    },
    "configuration_state": "string",
    "mode": "string"
  },
  "remote": {
    "automatic_uso_failure_domain": "string",
    "cluster": {
      "name": "cluster1",
      "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
    },
    "configuration_state": "string",
    "mode": "string"
  }
}

Response

Status: 200, Ok
Name Type Description

job

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

Response

Status: 202, Accepted

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

2424873

Failed to validate the node and cluster components before the "action" operation.

2425138

Switchover cannot be performed in the current DR mode. Run "metrocluster show" to view the DR mode of the local cluster, and run "switchover" only in one of the following situations: 1. The DR mode of the local cluster is "normal". 2. The DR mode of the local cluster is "partial-switchover".

2425333

Heal DR data aggregates cannot be performed in the current DR mode. Run "metrocluster show" and "metrocluster node show" to view the DR mode of the local cluster and the DR mode of the local nodes respectively, and run "heal aggregates" only in one of the following situations: 1. The DR mode of the local cluster is "switchover", and the DR mode of all local nodes is "switchover completed". 2. The DR mode of at least one local node is "heal aggrs failed".

2425335

Heal DR root aggregates cannot be performed in the current DR mode. Run "metrocluster node show" to view the DR mode of the local nodes, and run "heal root-aggregates" only in one of the following situations: 1. The DR mode of all local nodes is "heal aggrs completed". 2. The DR mode of at least one local node is "heal roots failed".

2425734

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

2427558

This MetroCluster operation cannot be run because another "action" operation is currently in progress. Run "metrocluster operation history show -job-id id -instance" to view the status of the currently running operation.

Also see the table of common errors in the Response body overview section of this documentation.

Definitions

See Definitions

href

Name Type Description

href

string

_links

node

Local node of the DR Group.

Name Type Description

name

string

uuid

string

partner

Partner node of the DR Group.

Name Type Description

name

string

uuid

string

dr_pairs

Name Type Description

node

node

Local node of the DR Group.

partner

partner

Partner node of the DR Group.

cluster

Name Type Description

name

string

uuid

string

local

Name Type Description

automatic_uso_failure_domain

string

This parameter specifies the configuration of automatic switchover. The valid values for the parameter are ':' cluster':' triggers an unplanned switchover if all nodes in a DR cluster are down. dr_group':' triggers an unplanned switchover if both nodes of a DR group are down. disabled':' automatic switchover is disabled. If the cluster is not reachable due to errors, the parameter value will be set to not_reachable. This value is read only. If the cluster configuration is unknown, the parameter value will be set to unknown and the value is read only.

cluster

cluster

configuration_state

string

Indicates the state of the local cluster configuration.

mode

string

Specifies the mode of operation of the local cluster.

partner_cluster_reachable

boolean

Specifies whether the partner cluster is reachable from the local cluster.

periodic_check_enabled

boolean

Indicates whether or not a periodic check is enabled on the local cluster.

ipv4_interface

Object to setup an interface along with its default router.

Name Type Description

address

string

IPv4 or IPv6 address

gateway

string

The IPv4 or IPv6 address of the default router.

netmask

string

Input as netmask length (16) or IPv4 mask (255.255.0.0). For IPv6, the default value is 64 with a valid range of 1 to 127. Output is always the netmask length.

l3_config

Name Type Description

ipv4_interface

ipv4_interface

Object to setup an interface along with its default router.

node

Node information

Name Type Description

name

string

uuid

string

mccip_ports

Port configuration specification. l3_config information is only needed when configuring a MetroCluster IP for use in a layer 3 network.

Name Type Description

l3_config

l3_config

name

string

Port name

node

node

Node information

uuid

string

Port UUID

vlan_id

integer

VLAN ID

dr_group

DR group reference.

Name Type Description

id

integer

DR Group ID

peer_cluster

The peer cluster that the mediator service is used for.

Name Type Description

name

string

uuid

string

mediator

Mediator information

Name Type Description

dr_group

dr_group

DR group reference.

local_mediator_connectivity

string

Indicates the mediator connectivity status of the local cluster. Possible values are connected, unreachable, unusable and down-high-latency. This field is only applicable to the mediators in SnapMirror active sync configuration.

peer_mediator_connectivity

string

Indicates the mediator connectivity status of the peer cluster. Possible values are connected, unreachable, unknown and down-high-latency.

reachable

boolean

Indicates the connectivity status of the mediator.

strict_cert_validation

boolean

Indicates if strict validation of certificates is performed while making REST API calls to the mediator. This field is only applicable to the ONTAP Cloud Mediator.

  • Default value: 1

  • example: true

  • Introduced in: 9.17

  • x-nullable: true

use_http_proxy_local

boolean

Indicates if the local cluster should use an http-proxy server while making REST API calls to the mediator. This field is only applicable to the ONTAP cloud mediator.

  • Default value: 1

  • example: true

  • Introduced in: 9.17

  • x-nullable: true

use_http_proxy_remote

boolean

Indicates if the remote cluster should use an http-proxy server while making REST API calls to the mediator. This field is only applicable to the ONTAP cloud mediator.

  • Default value: 1

  • example: true

  • Introduced in: 9.17

  • writeOnly: 1

  • x-nullable: true

uuid

string

The unique identifier for the mediator service.

partner_cluster

Partner cluster information.

Name Type Description

name

string

uuid

string

remote

Name Type Description

automatic_uso_failure_domain

string

This parameter specifies the configuration of automatic switchover. The valid values for the parameter are ':' cluster':' triggers an unplanned switchover if all nodes in a DR cluster are down. dr_group':' triggers an unplanned switchover if both nodes of a DR group are down. disabled':' automatic switchover is disabled. If the cluster is not reachable due to errors, the parameter value will be set to not_reachable. This value is read only. If the cluster configuration is unknown, the parameter value will be set to unknown and the value is read only.

cluster

cluster

configuration_state

string

Indicates the state of the remote cluster configuration.

mode

string

Specifies the mode of operation of the remote cluster.

periodic_check_enabled

boolean

Indicates whether or not a periodic check is enabled on the remote cluster.

metrocluster

Holds MetroCluster status and configuration parameters for the local and remote clusters. REST: /api/cluster/metrocluster

Name Type Description

configuration_type

string

Displays the MetroCluster configuration type.

encryption_enabled

boolean

Indicates if the encryption for NVLog and storage traffic is enabled.

local

local

remote

remote
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

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.