Set up a MetroCluster configuration

Required properties

partner_cluster.name
dr_pairs

Recommended optional properties

mediator.*
mccip_ports

Learn more

DOC /cluster/metrocluster

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

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

Request Body

Name	Type	Description
dr_pairs	array[dr_pairs]	DR Pairs to create as part of a MetroCluster configure.
local	local
mccip_ports	array[mccip_ports]	List of Port specifications.
mediator	mediator	Mediator information
partner_cluster	partner_cluster	Partner cluster information.
remote	remote

Name

Type

Description

dr_pairs

array[dr_pairs]

DR Pairs to create as part of a MetroCluster configure.

local

mccip_ports

array[mccip_ports]

List of Port specifications.

mediator

Mediator information

partner_cluster

Partner cluster information.

remote

Example request

{
  "dr_pairs": [
    {
      "node": {
        "name": "node1",
        "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
      },
      "partner": {
        "name": "node1",
        "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
      }
    }
  ],
  "local": {
    "cluster": {
      "name": "cluster1",
      "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
    },
    "configuration_state": "string",
    "mode": "string"
  },
  "mccip_ports": [
    {
      "l3_config": {
        "ipv4_interface": {
          "address": "10.10.10.7",
          "gateway": "10.1.1.1",
          "netmask": "24"
        }
      },
      "name": "e1b",
      "node": {
        "name": "node1",
        "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
      },
      "uuid": "string",
      "vlan_id": 200
    }
  ],
  "mediator": {
    "ca_certificate": "string",
    "dr_group": {
      "id": 0
    },
    "ip_address": "10.10.10.7",
    "password": "mypassword",
    "peer_cluster": {
      "name": "cluster2",
      "uuid": "ebe27c49-1adf-4496-8335-ab862aebebf2"
    },
    "peer_mediator_connectivity": "connected",
    "port": 31784,
    "reachable": 1,
    "user": "myusername",
    "uuid": "string"
  },
  "partner_cluster": {
    "name": "cluster1",
    "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
  },
  "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

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.
2432832	Required environment variables are not set.
2432833	Operation is already running.
2432834	MetroCluster is already configured.
2432835	Operation not supported.
2432836	There are not enough disks in Pool1. Wait a few minutes, and try the operation again. For further assistance, contact technical support.
2432839	Required parameters not set.
2432840	Configuring DR Groups
2432841	Generating IP addresses
2432843	Running Aggregate Recommender
2432844	Checking remote storage pool
2432845	Mirroring aggregates
2432846	Configuring MetroCluster and DR mirroring
2432848	Setting up MetroCluster
2432849	MetroCluster setup is complete
2432851	Minimum number of required data aggregates for MetroCluster configuration are still not mirrored. Wait a few minutes, and try the operation again. For further assistance, contact technical support.

Definitions

See Definitions

href

Name	Type	Description
href	string

Name

Type

Description

href

string

self_link

_links

node

Local node of the DR Group.

Name	Type	Description
name	string
uuid	string

Name

Type

Description

name

string

uuid

string

partner

Partner node of the DR Group.

Name	Type	Description
name	string
uuid	string

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.

Name

Type

Description

node

Local node of the DR Group.

partner

Partner node of the DR Group.

cluster

Name	Type	Description
name	string
uuid	string

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.

Name

Type

Description

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 netmask length.

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 netmask length.

l3_config

Name	Type	Description
ipv4_interface	ipv4_interface	Object to setup an interface along with its default router.

Name

Type

Description

ipv4_interface

Object to setup an interface along with its default router.

node

Node information

Name	Type	Description
name	string
uuid	string

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

Name

Type

Description

l3_config

name

string

Port name

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

Name

Type

Description

id

integer

DR Group ID

peer_cluster

The peer cluster that the mediator service is used for.

Name	Type	Description
_links	_links
name	string
uuid	string

Name

Type

Description

_links

name

string

uuid

string

mediator

Mediator information

Name	Type	Description
ca_certificate	string	CA certificate for ONTAP Mediator. This is optional if the certificate is already installed. x-ntap-createOnly: true Introduced in: 9.8
dr_group	dr_group	DR group reference.
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.
peer_mediator_connectivity	string	Indicates the mediator connectivity status of the peer cluster. Possible values are connected, unreachable, unknown.
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.

Name

Type

Description

ca_certificate

string

CA certificate for ONTAP Mediator. This is optional if the certificate is already installed.

x-ntap-createOnly: true
Introduced in: 9.8

dr_group

DR group reference.

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

The peer cluster that the mediator service is used for.

peer_mediator_connectivity

string

Indicates the mediator connectivity status of the peer cluster. Possible values are connected, unreachable, unknown.

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
uuid	string

Name

Type

Description

name

string

uuid

string

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.
periodic_check_enabled	boolean	Indicates whether or not a periodic check is enabled on the remote cluster.

Name

Type

Description

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
dr_pairs	array[dr_pairs]	DR Pairs to create as part of a MetroCluster configure.
local	local
mccip_ports	array[mccip_ports]	List of Port specifications.
mediator	mediator	Mediator information
partner_cluster	partner_cluster	Partner cluster information.
remote	remote

Name

Type

Description

dr_pairs

array[dr_pairs]

DR Pairs to create as part of a MetroCluster configure.

local

mccip_ports

array[mccip_ports]

List of Port specifications.

mediator

Mediator information

partner_cluster

Partner cluster information.

remote

job_link

Name	Type	Description
uuid	string	The UUID of the asynchronous job that is triggered by a POST, PATCH, or DELETE operation.

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

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.

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.

Set up a MetroCluster configuration

Creating your file...

Required properties

Recommended optional properties

Learn more

Related ONTAP commands

Parameters

Request Body

Response

Error

Definitions