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

Create the NFS configuration for an SVM

Contributors
PDFs

POST /protocols/nfs/services

Creates an NFS configuration for an SVM.

Required properties

  • svm.uuid or svm.name - Existing SVM for which to create the NFS configuration.

Default property values

If not specified in POST, the following default property values are assigned:

  • enabled - true

  • state - online

  • transport.udp_enabled - true

  • transport.tcp_enabled - true

  • protocol.v3_enabled - true

  • protocol.v4_id_domain - defaultv4iddomain.com

  • protocol.v4_enabled - false

  • protocol.v41_enabled - false

  • protocol.v40_features.acl_enabled - false

  • protocol.v40_features.read_delegation_enabled - false

  • protocol.v40_features.write_delegation_enabled - false

  • protocol.v41_features.acl_enabled - false

  • protocol.v41_features.read_delegation_enabled - false

  • protocol.v41_features.write_delegation_enabled - false

  • protocol.v41_features.pnfs_enabled - false

  • vstorage_enabled - false

  • vserver nfs create

Learn more

Request Body

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.
Example request 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "state": "online",
  "svm": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "svm1",
    "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
  }
}

Response

Status: 201, Created
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"
      }
    },
    "state": "online",
    "svm": {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "name": "svm1",
      "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
    }
  }
}

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

3276916

Vserver is not running

3276994

Kerberos must be disabled on all LIFs on Vserver before adding or removing AES encryption. Disable Kerberos on the LIF and try again

3277038

Cannot enable \"showmount\" feature because it requires an effective cluster version of Data ONTAP 8.3.0 or later

3277049

Cannot enable \"showmount\" feature on ID-Discard Vserver. Ensure that the Vserver is initialized and retry the command

3277052

NFSv4.x access to transitioned volumes in this Vserver could trigger conversion of non-Unicode directories to Unicode, which might impact data-serving performance. Before enabling NFSv4.x for this Vserver, refer to the Data and Configuration Transition Guide

3277069

Cannot disable TCP because the SnapDiff RPC server is in the \"on\" state

3277089

Attempting to create an NFS server using 64-bits for NFSv3 FSIDs and File IDs on Vserver. Older client software might not work with 64-bit identifiers

3277099

Domain name contains invalid characters or it is too short. Allowed characters are: alphabetical characters (A-Za-z), numeric characters (0-9), minus sign (-), and the period (.). The first character must be alphabetical or numeric, last character must not be a minus sign or a period. Minimum supported length: 2 characters, maximum of 256 characters
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

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.

_links

Name Type Description

next

href

self

href

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.