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

Retrieve NFS configuration for SVMs

PDFs

GET /protocols/nfs/services

Retrieves the NFS configuration of SVMs.

  • vserver nfs show

  • vserver nfs status

Learn more

Parameters

Name Type In Required Description

vstorage_enabled

boolean

query

False

Filter by vstorage_enabled

svm.uuid

string

query

False

Filter by svm.uuid

svm.name

string

query

False

Filter by svm.name

protocol.v41_features.write_delegation_enabled

boolean

query

False

Filter by protocol.v41_features.write_delegation_enabled

protocol.v41_features.acl_enabled

boolean

query

False

Filter by protocol.v41_features.acl_enabled

protocol.v41_features.read_delegation_enabled

boolean

query

False

Filter by protocol.v41_features.read_delegation_enabled

protocol.v41_features.pnfs_enabled

boolean

query

False

Filter by protocol.v41_features.pnfs_enabled

protocol.v40_enabled

boolean

query

False

Filter by protocol.v40_enabled

protocol.v41_enabled

boolean

query

False

Filter by protocol.v41_enabled

protocol.v4_id_domain

string

query

False

Filter by protocol.v4_id_domain

protocol.v40_features.acl_enabled

boolean

query

False

Filter by protocol.v40_features.acl_enabled

protocol.v40_features.write_delegation_enabled

boolean

query

False

Filter by protocol.v40_features.write_delegation_enabled

protocol.v40_features.read_delegation_enabled

boolean

query

False

Filter by protocol.v40_features.read_delegation_enabled

protocol.v3_enabled

boolean

query

False

Filter by protocol.v3_enabled

transport.udp_enabled

boolean

query

False

Filter by transport.udp_enabled

transport.tcp_enabled

boolean

query

False

Filter by transport.tcp_enabled

state

string

query

False

Filter by state

enabled

boolean

query

False

Filter by enabled

fields

array[string]

query

False

Specify the fields to return.

max_records

integer

query

False

Limit the number of records returned.

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.

return_records

boolean

query

False

The default is true for GET calls. When set to false, only the number of records is returned.

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 NFS Server Records

records

array[nfs_service]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "records": [
    {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "protocol": {
        "v4_id_domain": "string"
      },
      "state": "string",
      "svm": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "svm1",
        "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
      }
    }
  ]
}

Error

Status: Default, Error
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

v40_features

Name Type Description

acl_enabled

boolean

Specifies whether NFSv4.0 ACLs is enabled.

read_delegation_enabled

boolean

Specifies whether NFSv4.0 Read Delegation is enabled.

write_delegation_enabled

boolean

Specifies whether NFSv4.0 Write Delegation is enabled.

v41_features

Name Type Description

acl_enabled

boolean

Specifies whether NFSv4.1 ACLs is enabled.

pnfs_enabled

boolean

Specifies whether NFSv4.1 Parallel NFS is enabled.

read_delegation_enabled

boolean

Specifies whether NFSv4.1 Read Delegation is enabled.

write_delegation_enabled

boolean

Specifies whether NFSv4.1 Write Delegation is enabled.

protocol

Name Type Description

v3_enabled

boolean

Specifies whether NFSv3 protocol is enabled.

v40_enabled

boolean

Specifies whether NFSv4.0 protocol is enabled.

v40_features

v40_features

v41_enabled

boolean

Specifies whether NFSv4.1 protocol is enabled.

v41_features

v41_features

v4_id_domain

string

Specifies the domain portion of the string form of user and group names as defined by the NFSv4 protocol.

svm

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.

transport

Name Type Description

tcp_enabled

boolean

Specifies whether TCP transports are enabled on the server.

udp_enabled

boolean

Specifies whether UDP transports are enabled on the server.

nfs_service

Name Type Description

_links

_links

enabled

boolean

Specifies if the NFS service is administratively enabled.

protocol

protocol

state

string

Specifies the state of the NFS service on the SVM. The following values are supported: * online - NFS server is ready to accept client requests. * offline - NFS server is not ready to accept client requests.

svm

svm

SVM, applies only to SVM-scoped objects.

transport

transport

vstorage_enabled

boolean

Specifies whether VMware vstorage feature is enabled.

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.