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

Update a cluster peer instance

Contributors
PDFs

PATCH /cluster/peers/{uuid}

Updates a cluster peer instance.

Learn more

Parameters

Name Type In Required Description

uuid

string

path

True

Cluster peer relationship UUID

Request Body

Name Type Description

_links

_links

authentication

authentication

encryption

encryption

initial_allowed_svms

array[initial_allowed_svms]

The local SVMs allowed to peer with the peer cluster's SVMs. This list can be modified until the remote cluster accepts this cluster peering relationship.

ipspace

ipspace

The IPspace of the local intercluster LIFs

local_network

local_network

Cluster peering requires an intercluster LIF on each local node. These can be optionally created by specifying a list of IP addresses corresponding to each node.

name

string

Optional name for the cluster peer relationship. By default it is the name of the remote cluster.

remote

remote

status

status

uuid

string

UUID of the cluster peer relationship. For anonymous cluster peer offers, the UUID will change when the remote cluster accepts the relationship.
Example request 
{
  "_links": {
    "interfaces": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "authentication": {
    "expiry_time": "P1DT2H3M4S or '2017-01-25T11:20:13Z'",
    "in_use": "string",
    "passphrase": "string",
    "state": "string"
  },
  "encryption": {
    "proposed": "string",
    "state": "string"
  },
  "initial_allowed_svms": [
    {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "name": "svm1",
      "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
    }
  ],
  "ipspace": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "exchange",
    "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
  },
  "local_network": {
    "broadcast_domain": "bd1",
    "gateway": "10.1.1.1",
    "interfaces": [
      {
        "ip_address": "10.10.10.7"
      }
    ],
    "netmask": "255.255.0.0"
  },
  "name": "cluster2",
  "remote": {
    "ip_addresses": [
      "10.10.10.7"
    ],
    "name": "cluster2",
    "serial_number": "4048820-60-9"
  },
  "status": {
    "state": "available",
    "update_time": "2017-01-25 11:20:13 UTC"
  },
  "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
}

Response

Status: 200, Ok
Name Type Description

_links

_links

authentication

authentication

ip_address

string

IPv4 or IPv6 address

name

string

Optional name for the cluster peer relationship. By default it is the name of the remote cluster, or a temporary name may be autogenerated for anonymous cluster peer offers.
Example response 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "authentication": {
    "expiry_time": "2017-01-25 11:20:13 UTC",
    "passphrase": "string"
  },
  "ip_address": "10.10.10.7",
  "name": "cluster2"
}

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

4656070

The encryption protocol is meaningful only with authenticated cluster peer relationships.

4656072

The name must conform to the same rules as a cluster name.

4656073

Changing the encryption state requires the refreshing of the authentication passphrase.

4656076

Cluster peer modify was attempted mismatched IPv4 and IPv6 addresses.

4656075

Cannot specify encryption: this operation requires an ECV of Data ONTAP 9.6.0 or later.

4656084

Passphrase can only be modified with an authenticated cluster peer relationship.

4656082

Specify either a passphrase or "-generate-passphrase".

4656083

Cannot auto-generate a passphrase when "generate-passphrase" is false. Modifying a passphrase using an auto-generated passphrase requires "generate-passphrase" be true.

4656081

The remote IP address list is empty.

4656092

Cluster peer modify was attempted with a host name that did not resolve to an IPv4 or IPv6 address.

4655058

Expiration time cannot be more than 7 days in the future.

4653261

Error finding IPspace.

4656095

The address family of the specified peer addresses is not valid in this IPspace. Use /api/network/interfaces/ to verify that required LIFs are present and operational on each cluster node.
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

interfaces

href

self

href

authentication

Name Type Description

expiry_time

string

The time when the passphrase will expire, in ISO 8601 duration format or date and time format. The default is 1 hour.

generate_passphrase

boolean

Auto generate a passphrase when true.

in_use

string

passphrase

string

A password to authenticate the cluster peer relationship.

state

string

encryption

Name Type Description

proposed

string

state

string

_links

Name Type Description

self

href

initial_allowed_svms

SVM, applies only to SVM-scoped objects.

Name Type Description

_links

_links

name

string

The name of the SVM.

uuid

string

The unique identifier of the SVM.

ipspace

The IPspace of the local intercluster LIFs

Name Type Description

_links

_links

name

string

IPspace name

uuid

string

IPspace UUID

interfaces

Name Type Description

ip_address

string

IPv4 or IPv6 address

local_network

Cluster peering requires an intercluster LIF on each local node. These can be optionally created by specifying a list of IP addresses corresponding to each node.

Name Type Description

broadcast_domain

string

Broadcast domain that is in use within the IPspace.

gateway

string

The IPv4 or IPv6 address of the default router.

interfaces

array[interfaces]

netmask

string

IPv4 mask or netmask length.

remote

Name Type Description

ip_addresses

array[string]

The IPv4 addresses, IPv6 addresses, or hostnames of the peers.

name

string

The name of the remote cluster.

serial_number

string

The serial number of the remote cluster.

status

Name Type Description

state

string

update_time

string

The last time the state was updated.

cluster_peer

Name Type Description

_links

_links

authentication

authentication

encryption

encryption

initial_allowed_svms

array[initial_allowed_svms]

The local SVMs allowed to peer with the peer cluster's SVMs. This list can be modified until the remote cluster accepts this cluster peering relationship.

ipspace

ipspace

The IPspace of the local intercluster LIFs

local_network

local_network

Cluster peering requires an intercluster LIF on each local node. These can be optionally created by specifying a list of IP addresses corresponding to each node.

name

string

Optional name for the cluster peer relationship. By default it is the name of the remote cluster.

remote

remote

status

status

uuid

string

UUID of the cluster peer relationship. For anonymous cluster peer offers, the UUID will change when the remote cluster accepts the relationship.

authentication

Name Type Description

expiry_time

string

The date and time the passphrase will expire. The default expiry time is one hour.

passphrase

string

A password to authenticate the cluster peer relationship.

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.