Update an SVM peer relationship

vserver peer modify

Examples

The following examples show how to update an SVM peer relationship. The input parameter 'name' refers to the local name of the peer SVM.

Accepts an SVM peer relationship

 PATCH "/api/svm/peers/d3268a74-ee76-11e8-a9bb-005056ac6dc9" '{"state":"peered"}'

Updates the local name of an SVM peer relationship

 PATCH "/api/svm/peers/d3268a74-ee76-11e8-a9bb-005056ac6dc9" '{"name":"vs2"}'

Suspends an SVM peer relationship using force flag

 PATCH "/api/svm/peers/d3268a74-ee76-11e8-a9bb-005056ac6dc9" '{"state":"suspended", "force": "true"}'

Learn more

DOC /svm/peers

Parameters

Name	Type	In	Required	Description
uuid	string	path	True	SVM peer relationship UUID Introduced in: 9.7
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

Name

Type

In

Required

Description

uuid

string

path

True

SVM peer relationship UUID

Introduced in: 9.7

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
_links	_links
applications	array[string]	A list of applications for an SVM peer relationship.
force	boolean	Use this to suspend, resume or delete the SVM peer relationship even if the remote cluster is not accessible due to, for example, network connectivity issues.
name	string	A peer SVM alias name to avoid a name conflict on the local cluster.
peer	peer	Details for a peer SVM object.
state	string	SVM peering state. To accept a pending SVM peer request, PATCH the state to "peered". To reject a pending SVM peer request, PATCH the state to "rejected". To suspend a peered SVM peer relationship, PATCH the state to "suspended". To resume a suspended SVM peer relationship, PATCH the state to "peered". The states "initiated", "pending", and "initializing" are system-generated and cannot be used for PATCH.
svm	svm	Local SVM details
uuid	string	SVM peer relationship UUID

Name

Type

Description

_links

applications

array[string]

A list of applications for an SVM peer relationship.

force

boolean

Use this to suspend, resume or delete the SVM peer relationship even if the remote cluster is not accessible due to, for example, network connectivity issues.

name

string

A peer SVM alias name to avoid a name conflict on the local cluster.

peer

Details for a peer SVM object.

state

string

SVM peering state. To accept a pending SVM peer request, PATCH the state to "peered". To reject a pending SVM peer request, PATCH the state to "rejected". To suspend a peered SVM peer relationship, PATCH the state to "suspended". To resume a suspended SVM peer relationship, PATCH the state to "peered". The states "initiated", "pending", and "initializing" are system-generated and cannot be used for PATCH.

svm

Local SVM details

uuid

string

SVM peer relationship UUID

Example request

{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "applications": [
    "snapmirror",
    "lun_copy"
  ],
  "name": "string",
  "peer": {
    "cluster": {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "name": "cluster2",
      "uuid": "ebe27c49-1adf-4496-8335-ab862aebebf2"
    },
    "svm": {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "name": "svm1",
      "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
    }
  },
  "state": "peered",
  "svm": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "svm1",
    "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
  },
  "uuid": "string"
}

Response

Status: 200, Ok

Response

Status: 202, Accepted

Error

Status: Default

ONTAP Error Response Codes

Error codes	Description
13434889	Internal error. Wait and retry.
26345575	The specified peer cluster name and peer cluster UUID do not match.
26345576	Given peer state is invalid.
26345577	One of the following is required: applications, state, or name.
26345578	Internal error. Unable to retrieve local or peer SVM name.
26345579	The specified field is invalid.
26345581	Peer cluster name could not be retrieved or validated.
9896077	The peer relationship is in use by FlexCache. View the FlexCache relationships, delete them and retry the operation.
9896088	System generated a name for the peer SVM because of a naming conflict. Use the name property to uniquely identify the peer SVM alias name.

Name	Type	Description
error	returned_error

Name

Type

Description

error

returned_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

Name

Type

Description

href

string

_links

Name	Type	Description
self	href

Name

Type

Description

self

href

cluster

Name	Type	Description
_links	_links
name	string
uuid	string

Name

Type

Description

_links

name

string

uuid

string

svm

SVM, applies only to SVM-scoped objects.

Name	Type	Description
_links	_links
name	string	The name of the SVM. This field cannot be specified in a PATCH method.
uuid	string	The unique identifier of the SVM. This field cannot be specified in a PATCH method.

Name

Type

Description

_links

name

string

The name of the SVM. This field cannot be specified in a PATCH method.

uuid

string

The unique identifier of the SVM. This field cannot be specified in a PATCH method.

peer

Details for a peer SVM object.

Name	Type	Description
cluster	cluster
svm	svm	SVM, applies only to SVM-scoped objects.

Name

Type

Description

cluster

svm

SVM, applies only to SVM-scoped objects.

svm

Local SVM details

Name	Type	Description
_links	_links
name	string	The name of the SVM. This field cannot be specified in a PATCH method.
uuid	string	The unique identifier of the SVM. This field cannot be specified in a PATCH method.

Name

Type

Description

_links

name

string

The name of the SVM. This field cannot be specified in a PATCH method.

uuid

string

The unique identifier of the SVM. This field cannot be specified in a PATCH method.

svm_peer

An SVM peer relationship object.

Name	Type	Description
_links	_links
applications	array[string]	A list of applications for an SVM peer relationship.
force	boolean	Use this to suspend, resume or delete the SVM peer relationship even if the remote cluster is not accessible due to, for example, network connectivity issues.
name	string	A peer SVM alias name to avoid a name conflict on the local cluster.
peer	peer	Details for a peer SVM object.
state	string	SVM peering state. To accept a pending SVM peer request, PATCH the state to "peered". To reject a pending SVM peer request, PATCH the state to "rejected". To suspend a peered SVM peer relationship, PATCH the state to "suspended". To resume a suspended SVM peer relationship, PATCH the state to "peered". The states "initiated", "pending", and "initializing" are system-generated and cannot be used for PATCH.
svm	svm	Local SVM details
uuid	string	SVM peer relationship UUID

Name

Type

Description

_links

applications

array[string]

A list of applications for an SVM peer relationship.

force

boolean

Use this to suspend, resume or delete the SVM peer relationship even if the remote cluster is not accessible due to, for example, network connectivity issues.

name

string

A peer SVM alias name to avoid a name conflict on the local cluster.

peer

Details for a peer SVM object.

state

string

SVM peering state. To accept a pending SVM peer request, PATCH the state to "peered". To reject a pending SVM peer request, PATCH the state to "rejected". To suspend a peered SVM peer relationship, PATCH the state to "suspended". To resume a suspended SVM peer relationship, PATCH the state to "peered". The states "initiated", "pending", and "initializing" are system-generated and cannot be used for PATCH.

svm

Local SVM details

uuid

string

SVM peer relationship UUID

error_arguments

Name	Type	Description
code	string	Argument code
message	string	Message argument

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.

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.

Update an SVM peer relationship

Creating your file...

Related ONTAP commands

Examples

Learn more

Parameters

Request Body

Response

Response

Error

Definitions