Skip to main content

Update SVM peer permissions

Contributors
PDFs

PATCH /svm/peer-permissions/{cluster_peer.uuid}/{svm.uuid}

Introduced In: 9.6

Updates the SVM peer permissions.

  • vserver peer permission modify

Example

Updates an SVM peer permission.

PATCH "/api/svm/peer-permissions/d3268a74-ee76-11e8-a9bb-005056ac6dc9/8f467b93-f2f1-11e8-9027-005056ac81fc" '{"applications":["flexcache"]}'

Learn more

Parameters

Name Type In Required Description

cluster_peer.uuid

string

path

True

Peer cluster UUID

  • Introduced in: 9.7

svm.uuid

string

path

True

SVM UUID

Request Body

Name Type Description

_links

_links

applications

array[string]

A list of applications for an SVM peer relationship.

cluster_peer

cluster_peer

Peer cluster details

svm

svm

Local SVM permitted for peer relationship. To create peer permissions for all SVMs, specify the SVM name as "*".
Example request 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "applications": [
    "snapmirror",
    "flexcache"
  ],
  "cluster_peer": {
    "_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"
  }
}

Response

Status: 200, Ok
Name Type Description

_links

_links

applications

array[string]

A list of applications for an SVM peer relationship.

cluster_peer

cluster_peer

Peer cluster details

svm

svm

Local SVM permitted for peer relationship. To create peer permissions for all SVMs, specify the SVM name as "*".
Example response 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "applications": [
    "snapmirror",
    "flexcache"
  ],
  "cluster_peer": {
    "_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"
  }
}

Error

Status: Default

ONTAP Error Response Codes

Error codes Description

26345572

{field} is a required field.

26345574

Failed to find the SVM or volume name with UUID.

9896059

SVM peer permission does not exist.
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

_links

Name Type Description

self

href

cluster_peer

Peer cluster details

Name Type Description

_links

_links

name

string

uuid

string

svm

Local SVM permitted for peer relationship. To create peer permissions for all SVMs, specify the SVM name as "*".

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.

svm_peer_permission

Manage SVM peer permissions.

Name Type Description

_links

_links

applications

array[string]

A list of applications for an SVM peer relationship.

cluster_peer

cluster_peer

Peer cluster details

svm

svm

Local SVM permitted for peer relationship. To create peer permissions for all SVMs, specify the SVM name as "*".

error_arguments

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.