Skip to main content
REST API reference

Retrieve export policies

PDFs

GET /protocols/nfs/export-policies

Introduced In: 9.6

Retrieves export policies.

  • vserver export-policy show

  • vserver export-policy rule show

Learn more

Parameters

Name Type In Required Description

rules.superuser

string

query

False

Filter by rules.superuser

rules.index

integer

query

False

Filter by rules.index

rules.allow_device_creation

boolean

query

False

Filter by rules.allow_device_creation

  • Introduced in: 9.9

rules.allow_suid

boolean

query

False

Filter by rules.allow_suid

  • Introduced in: 9.9

rules.rw_rule

string

query

False

Filter by rules.rw_rule

rules.clients.match

string

query

False

Filter by rules.clients.match

rules.chown_mode

string

query

False

Filter by rules.chown_mode

  • Introduced in: 9.9

rules.anonymous_user

string

query

False

Filter by rules.anonymous_user

rules.ntfs_unix_security

string

query

False

Filter by rules.ntfs_unix_security

  • Introduced in: 9.9

rules.ro_rule

string

query

False

Filter by rules.ro_rule

rules.protocols

string

query

False

Filter by rules.protocols

id

integer

query

False

Filter by id

name

string

query

False

Filter by name

  • maxLength: 256

svm.name

string

query

False

Filter by svm.name

svm.uuid

string

query

False

Filter by svm.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

The number of export policy records

records

array[export_policy]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "num_records": 1,
  "records": [
    {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "id": 0,
      "name": "string",
      "rules": [
        {
          "_links": {
            "self": {
              "href": "/api/resourcelink"
            }
          },
          "anonymous_user": "string",
          "chown_mode": "string",
          "clients": [
            {
              "match": "0.0.0.0/0"
            }
          ],
          "ntfs_unix_security": "string",
          "protocols": [
            "string"
          ],
          "ro_rule": [
            "string"
          ],
          "rw_rule": [
            "string"
          ],
          "superuser": [
            "string"
          ]
        }
      ],
      "svm": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "svm1",
        "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
      }
    }
  ]
}

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

262197

The value provided is invalid for the field

2621462

The specified SVM name does not exist

2621519

SVM name is invalid. The SVM name must begin with a letter or an underscore. If the SVM is of type "sync-source", the maximum supported length is 41. Otherwise, the maximum supported length is 47

2621643

The specified SVM name is too long

2621685

SVM name length cannot be zero

2621706

The specified SVM UUID is incorrect for the specified SVM name

6691623

User is not authorized
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

next

href

self

href

_links

Name Type Description

self

href

export_clients

Name Type Description

match

string

Client Match Hostname, IP Address, Netgroup, or Domain. You can specify the match as a string value in any of the following formats:

  • As a hostname; for instance, host1

  • As an IPv4 address; for instance, 10.1.12.24

  • As an IPv6 address; for instance, fd20:8b1e:b255:4071::100:1

  • As an IPv4 address with a subnet mask expressed as a number of bits; for instance, 10.1.12.0/24

  • As an IPv6 address with a subnet mask expressed as a number of bits; for instance, fd20:8b1e:b255:4071::/64

  • As an IPv4 address with a network mask; for instance, 10.1.16.0/255.255.255.0

  • As a netgroup, with the netgroup name preceded by the @ character; for instance, @eng

  • As a domain name preceded by the . character; for instance, .example.com

export_rules

Name Type Description

_links

_links

allow_device_creation

boolean

Specifies whether or not device creation is allowed.

allow_suid

boolean

Specifies whether or not SetUID bits in SETATTR Op is to be honored.

anonymous_user

string

User ID To Which Anonymous Users Are Mapped.

chown_mode

string

Specifies who is authorized to change the ownership mode of a file.

clients

array[export_clients]

Array of client matches

index

integer

Index of the rule within the export policy.

ntfs_unix_security

string

NTFS export UNIX security options.

protocols

array[string]

ro_rule

array[string]

Authentication flavors that the read-only access rule governs

rw_rule

array[string]

Authentication flavors that the read/write access rule governs

superuser

array[string]

Authentication flavors that the superuser security type governs

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.

export_policy

Name Type Description

_links

_links

id

integer

Export Policy ID

name

string

Export Policy Name

rules

array[export_rules]

Rules of the Export Policy.

svm

svm

SVM, applies only to SVM-scoped objects.

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.