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

Retrieve SVM peer permissions

Contributors
PDFs

GET /svm/peer-permissions

Introduced In: 9.6

Retrieves the list of SVM peer permissions.

  • vserver peer permission show

Examples

The following examples show how to retrieve a collection of SVM peer permissions based on a query.

  1. Retrieves a list of SVM peer permissions of a specific local SVM

 GET "/api/svm/peer-permissions/?svm.name=VS1"

  1. Retrieves a list of SVM peer permissions of a specific cluster peer

 GET "/api/svm/peer-permissions/?cluster_peer.name=cluster2"

Learn more

Parameters

Name Type In Required Description

svm.uuid

string

query

False

Filter by svm.uuid

svm.name

string

query

False

Filter by svm.name

applications

string

query

False

Filter by applications

cluster_peer.uuid

string

query

False

Filter by cluster_peer.uuid

cluster_peer.name

string

query

False

Filter by cluster_peer.name

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[svm_peer_permission]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "records": [
    {
      "_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

26345574

Failed to find the SVM or volume name with UUID.
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

_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 relation. To create peer permissions for all SVMs, specify the SVM name as "*".

Name Type Description

_links

_links

name

string

The name of the SVM.

uuid

string

The unique identifier of the SVM.

svm_peer_permission

Manage SVM peer permissions.

Name Type Description

_links

_links

applications

array[string]

A list of applications for an SVM peer relation.

cluster_peer

cluster_peer

Peer cluster details

svm

svm

Local SVM permitted for peer relation. 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

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.