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

Set up a MetroCluster configuration

PDFs

POST /cluster/metrocluster

Introduced In: 9.8

Sets up a MetroCluster.

Required properties

  • partner_cluster.name

  • dr_pairs

  • mediator.*

Learn more

  • metrocluster configuration-settings dr-group create

  • metrocluster configuration-settings interface create

  • metrocluster configuration-settings connection connect

  • metrocluster configuration-settings mediator add

  • storage aggregate create

  • storage aggregate mirror

  • metrocluster configure

Parameters

Name Type In Required Description

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

return_records

boolean

query

False

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

  • Default value:

Request Body

Name Type Description

dr_pairs

array[dr_pairs]

DR Pairs to create as part of a MetroCluster configure.

enabled

boolean

local

local

mediator

mediator

Mediator information

partner_cluster

partner_cluster

Partner cluster information.

remote

remote
Example request 
{
  "dr_pairs": [
    {
      "node": {
        "name": "nodeA"
      },
      "partner": {
        "name": "nodeB"
      }
    }
  ],
  "local": {
    "cluster": {
      "name": "cluster1",
      "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
    },
    "configuration_state": "string",
    "mode": "string"
  },
  "mediator": {
    "ip_address": "10.10.10.7",
    "password": "mypassword",
    "peer_cluster": {
      "name": "cluster2",
      "uuid": "ebe27c49-1adf-4496-8335-ab862aebebf2"
    },
    "port": "31784",
    "reachable": 1,
    "user": "myusername",
    "uuid": "string"
  },
  "partner_cluster": {
    "name": "cluster2"
  },
  "remote": {
    "cluster": {
      "name": "cluster1",
      "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
    },
    "configuration_state": "string",
    "mode": "string"
  }
}

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

node

Local node of the DR Group.

Name Type Description

name

string

Name of the node.

partner

Partner node of the DR Group.

Name Type Description

name

string

Name of the node.

dr_pairs

Name Type Description

node

node

Local node of the DR Group.

partner

partner

Partner node of the DR Group.

_links

cluster

Name Type Description

name

string

uuid

string

local

Name Type Description

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.

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

ip_address

string

The IP address of the mediator.

password

string

The password used to connect to the REST server on the mediator.

peer_cluster

peer_cluster

The peer cluster that the mediator service is used for.

port

integer

The REST server's port number on the mediator.

reachable

boolean

Indicates the connectivity status of the mediator.

user

string

The username used to connect to the REST server on the mediator.

uuid

string

The unique identifier for the mediator service.

partner_cluster

Partner cluster information.

Name Type Description

name

string

Name of the partner cluster.

remote

Name Type Description

cluster

cluster

configuration_state

string

Indicates the state of the remote cluster configuration.

mode

string

Specifies the mode of operation of the remote cluster.

metrocluster

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

Name Type Description

dr_pairs

array[dr_pairs]

DR Pairs to create as part of a MetroCluster configure.

enabled

boolean

local

local

mediator

mediator

Mediator information

partner_cluster

partner_cluster

Partner cluster information.

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

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.