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

Retrieve all DR groups in a MetroCluster IP configuration

Contributors
PDFs

GET /cluster/metrocluster/dr-groups

Introduced In: 9.8

Retrieves all the DR group in the MetroCluster over IP configuration.

Parameters

Name Type In Required Description

dr_pairs.partner.name

string

query

False

Filter by dr_pairs.partner.name

dr_pairs.partner.uuid

string

query

False

Filter by dr_pairs.partner.uuid

dr_pairs.node.name

string

query

False

Filter by dr_pairs.node.name

dr_pairs.node.uuid

string

query

False

Filter by dr_pairs.node.uuid

id

integer

query

False

Filter by id

partner_cluster.name

string

query

False

Filter by partner_cluster.name

partner_cluster.uuid

string

query

False

Filter by partner_cluster.uuid

fields

array[string]

query

False

Specify the fields to return.

max_records

integer

query

False

Limit the number of records returned.

return_records

boolean

query

False

The default is true for GET calls. When set to false, only the number of records is returned.

  • Default value: 1

return_timeout

integer

query

False

The number of seconds to allow the call to execute before returning. When iterating over a collection, the default is 15 seconds. ONTAP returns earlier if either max records or the end of the collection is reached.

  • Default value: 1

  • Max value: 120

  • Min value: 0

order_by

array[string]

query

False

Order results by specified fields and optional [asc

Response

Status: 200, Ok
Name Type Description

_links

_links

num_records

integer

Number of Records

records

array[metrocluster_dr_group]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "records": [
    {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "dr_pairs": [
        {
          "node": {
            "_links": {
              "self": {
                "href": "/api/resourcelink"
              }
            },
            "name": "node1",
            "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
          },
          "partner": {
            "_links": {
              "self": {
                "href": "/api/resourcelink"
              }
            },
            "name": "node1",
            "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
          }
        }
      ],
      "id": 0,
      "mccip_ports": [
        {
          "l3_config": {
            "ipv4_interface": {
              "address": "10.10.10.7",
              "gateway": "10.1.1.1",
              "netmask": "24"
            }
          },
          "name": "e1b",
          "node": {
            "_links": {
              "self": {
                "href": "/api/resourcelink"
              }
            },
            "name": "node1",
            "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
          },
          "uuid": "string",
          "vlan_id": "200"
        }
      ],
      "partner_cluster": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "cluster1",
        "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
      }
    }
  ]
}

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.

2427132

MetroCluster is not configured on this cluster.
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

next

href

self

href
Name Type Description

self

href

_links

Name Type Description

self

href

node

Local node of the DR Group.

Name Type Description

_links

_links

name

string

uuid

string

partner

Partner node of the DR Group.

Name Type Description

_links

_links

name

string

uuid

string

dr_pair

Name Type Description

node

node

Local node of the DR Group.

partner

partner

Partner node of the DR Group.

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.

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

_links

_links

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

partner_cluster

Partner cluster information.

Name Type Description

_links

_links

name

string

uuid

string

metrocluster_dr_group

DR group information.

Name Type Description

_links

self_link

dr_pairs

array[dr_pair]

id

integer

DR Group ID

mccip_ports

array[mccip_ports]

List of Port specifications.

partner_cluster

partner_cluster

Partner cluster information.

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.