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

Create an NFS configuration for an SVM

Contributors
PDFs

POST /protocols/nfs/services

Introduced In: 9.6

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.v3_64bit_identifiers_enabled - false

  • protocol.v4_id_domain - defaultv4iddomain.com

  • protocol.v4_64bit_identifiers_enabled - true

  • 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

  • rquota_enabled - false

  • showmount_enabled - true

  • auth_sys_extended_groups_enabled - false

  • extended_groups_limit - 32

  • positive_cached_credential_ttl - 7200000

  • vserver nfs create

Learn more

Parameters

Name Type In Required Description

return_records

boolean

query

False

The default is false. If set to true, the records are returned.

  • Default value:

Request Body

Name Type Description

_links

_links

auth_sys_extended_groups_enabled

boolean

Specifies whether or not extended groups support over AUTH_SYS is enabled.

enabled

boolean

Specifies if the NFS service is administratively enabled.

extended_groups_limit

integer

Specifies the maximum auxillary groups supported over AUTH_SYS and RPCSEC_GSS.

metric

metric

Historical performance numbers, such as IOPS latency and throughput, for SVM-NFS protocol.

positive_cached_credential_ttl

integer

Specifies the time to live value (in msecs) of a positive cached credential

protocol

protocol

rquota_enabled

boolean

Specifies whether or not the remote quota feature is enabled.

showmount_enabled

boolean

Specifies whether or not the showmount feature is enabled.

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.

statistics

statistics

Realtime performance numbers, such as IOPS latency and throughput, for SVM-NFS protocol.

svm

svm

transport

transport

vstorage_enabled

boolean

Specifies whether or not the VMware vstorage feature is enabled.
Example request 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "extended_groups_limit": "32",
  "metric": {
    "v3": {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "duration": "PT15S",
      "iops": {
        "read": "200",
        "total": "1000",
        "write": "100"
      },
      "latency": {
        "read": "200",
        "total": "1000",
        "write": "100"
      },
      "status": "ok",
      "throughput": {
        "read": "200",
        "total": "1000",
        "write": "100"
      },
      "timestamp": "2017-01-25T11:20:13Z"
    },
    "v4": {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "duration": "PT15S",
      "iops": {
        "read": "200",
        "total": "1000",
        "write": "100"
      },
      "latency": {
        "read": "200",
        "total": "1000",
        "write": "100"
      },
      "status": "ok",
      "throughput": {
        "read": "200",
        "total": "1000",
        "write": "100"
      },
      "timestamp": "2017-01-25T11:20:13Z"
    },
    "v41": {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "duration": "PT15S",
      "iops": {
        "read": "200",
        "total": "1000",
        "write": "100"
      },
      "latency": {
        "read": "200",
        "total": "1000",
        "write": "100"
      },
      "status": "ok",
      "throughput": {
        "read": "200",
        "total": "1000",
        "write": "100"
      },
      "timestamp": "2017-01-25T11:20:13Z"
    }
  },
  "positive_cached_credential_ttl": "7200000",
  "protocol": {
    "v4_id_domain": "string"
  },
  "state": "string",
  "statistics": {
    "v3": {
      "iops_raw": {
        "read": "200",
        "total": "1000",
        "write": "100"
      },
      "latency_raw": {
        "read": "200",
        "total": "1000",
        "write": "100"
      },
      "status": "ok",
      "throughput_raw": {
        "read": "200",
        "total": "1000",
        "write": "100"
      },
      "timestamp": "2017-01-25T11:20:13Z"
    },
    "v4": {
      "iops_raw": {
        "read": "200",
        "total": "1000",
        "write": "100"
      },
      "latency_raw": {
        "read": "200",
        "total": "1000",
        "write": "100"
      },
      "status": "ok",
      "throughput_raw": {
        "read": "200",
        "total": "1000",
        "write": "100"
      },
      "timestamp": "2017-01-25T11:20:13Z"
    },
    "v41": {
      "iops_raw": {
        "read": "200",
        "total": "1000",
        "write": "100"
      },
      "latency_raw": {
        "read": "200",
        "total": "1000",
        "write": "100"
      },
      "status": "ok",
      "throughput_raw": {
        "read": "200",
        "total": "1000",
        "write": "100"
      },
      "timestamp": "2017-01-25T11:20:13Z"
    }
  },
  "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"
        }
      },
      "extended_groups_limit": "32",
      "metric": {
        "v3": {
          "_links": {
            "self": {
              "href": "/api/resourcelink"
            }
          },
          "duration": "PT15S",
          "iops": {
            "read": "200",
            "total": "1000",
            "write": "100"
          },
          "latency": {
            "read": "200",
            "total": "1000",
            "write": "100"
          },
          "status": "ok",
          "throughput": {
            "read": "200",
            "total": "1000",
            "write": "100"
          },
          "timestamp": "2017-01-25T11:20:13Z"
        },
        "v4": {
          "_links": {
            "self": {
              "href": "/api/resourcelink"
            }
          },
          "duration": "PT15S",
          "iops": {
            "read": "200",
            "total": "1000",
            "write": "100"
          },
          "latency": {
            "read": "200",
            "total": "1000",
            "write": "100"
          },
          "status": "ok",
          "throughput": {
            "read": "200",
            "total": "1000",
            "write": "100"
          },
          "timestamp": "2017-01-25T11:20:13Z"
        },
        "v41": {
          "_links": {
            "self": {
              "href": "/api/resourcelink"
            }
          },
          "duration": "PT15S",
          "iops": {
            "read": "200",
            "total": "1000",
            "write": "100"
          },
          "latency": {
            "read": "200",
            "total": "1000",
            "write": "100"
          },
          "status": "ok",
          "throughput": {
            "read": "200",
            "total": "1000",
            "write": "100"
          },
          "timestamp": "2017-01-25T11:20:13Z"
        }
      },
      "positive_cached_credential_ttl": "7200000",
      "protocol": {
        "v4_id_domain": "string"
      },
      "state": "string",
      "statistics": {
        "v3": {
          "iops_raw": {
            "read": "200",
            "total": "1000",
            "write": "100"
          },
          "latency_raw": {
            "read": "200",
            "total": "1000",
            "write": "100"
          },
          "status": "ok",
          "throughput_raw": {
            "read": "200",
            "total": "1000",
            "write": "100"
          },
          "timestamp": "2017-01-25T11:20:13Z"
        },
        "v4": {
          "iops_raw": {
            "read": "200",
            "total": "1000",
            "write": "100"
          },
          "latency_raw": {
            "read": "200",
            "total": "1000",
            "write": "100"
          },
          "status": "ok",
          "throughput_raw": {
            "read": "200",
            "total": "1000",
            "write": "100"
          },
          "timestamp": "2017-01-25T11:20:13Z"
        },
        "v41": {
          "iops_raw": {
            "read": "200",
            "total": "1000",
            "write": "100"
          },
          "latency_raw": {
            "read": "200",
            "total": "1000",
            "write": "100"
          },
          "status": "ok",
          "throughput_raw": {
            "read": "200",
            "total": "1000",
            "write": "100"
          },
          "timestamp": "2017-01-25T11:20:13Z"
        }
      },
      "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

iops

The rate of I/O operations observed at the storage object.

Name Type Description

other

integer

Performance metric for other I/O operations. Other I/O operations can be metadata operations, such as directory lookups and so on.

read

integer

Performance metric for read I/O operations.

total

integer

Performance metric aggregated over all types of I/O operations.

write

integer

Peformance metric for write I/O operations.

latency

The round trip latency in microseconds observed at the storage object.

Name Type Description

other

integer

Performance metric for other I/O operations. Other I/O operations can be metadata operations, such as directory lookups and so on.

read

integer

Performance metric for read I/O operations.

total

integer

Performance metric aggregated over all types of I/O operations.

write

integer

Peformance metric for write I/O operations.

throughput

The rate of throughput bytes per second observed at the storage object.

Name Type Description

read

integer

Performance metric for read I/O operations.

total

integer

Performance metric aggregated over all types of I/O operations.

write

integer

Peformance metric for write I/O operations.

v3

The NFSv3 operations

Name Type Description

_links

_links

duration

string

The duration over which this sample is calculated. The time durations are represented in the ISO-8601 standard format. Samples can be calculated over the following durations:

iops

iops

The rate of I/O operations observed at the storage object.

latency

latency

The round trip latency in microseconds observed at the storage object.

status

string

Any errors associated with the sample. For example, if the aggregation of data over multiple nodes fails then any of the partial errors might be returned, "ok" on success, or "error" on any internal uncategorized failure. Whenever a sample collection is missed but done at a later time, it is back filled to the previous 15 second timestamp and tagged with "backfilled_data". "Inconsistent_ delta_time" is encountered when the time between two collections is not the same for all nodes. Therefore, the aggregated value might be over or under inflated. "Negative_delta" is returned when an expected monotonically increasing value has decreased in value. "Inconsistent_old_data" is returned when one or more nodes do not have the latest data.

throughput

throughput

The rate of throughput bytes per second observed at the storage object.

timestamp

string

The timestamp of the performance data.

v4

The NFSv4 operations

Name Type Description

_links

_links

duration

string

The duration over which this sample is calculated. The time durations are represented in the ISO-8601 standard format. Samples can be calculated over the following durations:

iops

iops

The rate of I/O operations observed at the storage object.

latency

latency

The round trip latency in microseconds observed at the storage object.

status

string

Any errors associated with the sample. For example, if the aggregation of data over multiple nodes fails then any of the partial errors might be returned, "ok" on success, or "error" on any internal uncategorized failure. Whenever a sample collection is missed but done at a later time, it is back filled to the previous 15 second timestamp and tagged with "backfilled_data". "Inconsistent_ delta_time" is encountered when the time between two collections is not the same for all nodes. Therefore, the aggregated value might be over or under inflated. "Negative_delta" is returned when an expected monotonically increasing value has decreased in value. "Inconsistent_old_data" is returned when one or more nodes do not have the latest data.

throughput

throughput

The rate of throughput bytes per second observed at the storage object.

timestamp

string

The timestamp of the performance data.

v41

The NFSv4.1 operations

Name Type Description

_links

_links

duration

string

The duration over which this sample is calculated. The time durations are represented in the ISO-8601 standard format. Samples can be calculated over the following durations:

iops

iops

The rate of I/O operations observed at the storage object.

latency

latency

The round trip latency in microseconds observed at the storage object.

status

string

Any errors associated with the sample. For example, if the aggregation of data over multiple nodes fails then any of the partial errors might be returned, "ok" on success, or "error" on any internal uncategorized failure. Whenever a sample collection is missed but done at a later time, it is back filled to the previous 15 second timestamp and tagged with "backfilled_data". "Inconsistent_ delta_time" is encountered when the time between two collections is not the same for all nodes. Therefore, the aggregated value might be over or under inflated. "Negative_delta" is returned when an expected monotonically increasing value has decreased in value. "Inconsistent_old_data" is returned when one or more nodes do not have the latest data.

throughput

throughput

The rate of throughput bytes per second observed at the storage object.

timestamp

string

The timestamp of the performance data.

metric

Historical performance numbers, such as IOPS latency and throughput, for SVM-NFS protocol.

Name Type Description

v3

v3

The NFSv3 operations

v4

v4

The NFSv4 operations

v41

v41

The NFSv4.1 operations

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 or later ACLs is enabled.

pnfs_enabled

boolean

Specifies whether NFSv4.1 or later Parallel NFS is enabled.

read_delegation_enabled

boolean

Specifies whether NFSv4.1 or later Read Delegation is enabled.

write_delegation_enabled

boolean

Specifies whether NFSv4.1 or later Write Delegation is enabled.

protocol

Name Type Description

v3_64bit_identifiers_enabled

boolean

Specifies whether 64-bit support for NFSv3 FSIDs and file IDs is enabled.

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 or later protocol is enabled.

v41_features

v41_features

v4_64bit_identifiers_enabled

boolean

Specifies whether 64-bit support for NFSv4.x FSIDs and file IDs is enabled.

v4_id_domain

string

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

iops_raw

The number of I/O operations observed at the storage object. This should be used along with delta time to calculate the rate of I/O operations per unit of time.

Name Type Description

other

integer

Performance metric for other I/O operations. Other I/O operations can be metadata operations, such as directory lookups and so on.

read

integer

Performance metric for read I/O operations.

total

integer

Performance metric aggregated over all types of I/O operations.

write

integer

Peformance metric for write I/O operations.

latency_raw

The raw latency in microseconds observed at the storage object. This should be divided by the raw IOPS value to calculate the average latency per I/O operation.

Name Type Description

other

integer

Performance metric for other I/O operations. Other I/O operations can be metadata operations, such as directory lookups and so on.

read

integer

Performance metric for read I/O operations.

total

integer

Performance metric aggregated over all types of I/O operations.

write

integer

Peformance metric for write I/O operations.

throughput_raw

Throughput bytes observed at the storage object. This should be used along with delta time to calculate the rate of throughput bytes per unit of time.

Name Type Description

read

integer

Performance metric for read I/O operations.

total

integer

Performance metric aggregated over all types of I/O operations.

write

integer

Peformance metric for write I/O operations.

v3

The NFSv3 operations

Name Type Description

iops_raw

iops_raw

The number of I/O operations observed at the storage object. This should be used along with delta time to calculate the rate of I/O operations per unit of time.

latency_raw

latency_raw

The raw latency in microseconds observed at the storage object. This should be divided by the raw IOPS value to calculate the average latency per I/O operation.

status

string

Any errors associated with the sample. For example, if the aggregation of data over multiple nodes fails then any of the partial errors might be returned, "ok" on success, or "error" on any internal uncategorized failure. Whenever a sample collection is missed but done at a later time, it is back filled to the previous 15 second timestamp and tagged with "backfilled_data". "Inconsistent_delta_time" is encountered when the time between two collections is not the same for all nodes. Therefore, the aggregated value might be over or under inflated. "Negative_delta" is returned when an expected monotonically increasing value has decreased in value. "Inconsistent_old_data" is returned when one or more nodes do not have the latest data.

throughput_raw

throughput_raw

Throughput bytes observed at the storage object. This should be used along with delta time to calculate the rate of throughput bytes per unit of time.

timestamp

string

The timestamp of the performance data.

v4

The NFSv4 operations

Name Type Description

iops_raw

iops_raw

The number of I/O operations observed at the storage object. This should be used along with delta time to calculate the rate of I/O operations per unit of time.

latency_raw

latency_raw

The raw latency in microseconds observed at the storage object. This should be divided by the raw IOPS value to calculate the average latency per I/O operation.

status

string

Any errors associated with the sample. For example, if the aggregation of data over multiple nodes fails then any of the partial errors might be returned, "ok" on success, or "error" on any internal uncategorized failure. Whenever a sample collection is missed but done at a later time, it is back filled to the previous 15 second timestamp and tagged with "backfilled_data". "Inconsistent_delta_time" is encountered when the time between two collections is not the same for all nodes. Therefore, the aggregated value might be over or under inflated. "Negative_delta" is returned when an expected monotonically increasing value has decreased in value. "Inconsistent_old_data" is returned when one or more nodes do not have the latest data.

throughput_raw

throughput_raw

Throughput bytes observed at the storage object. This should be used along with delta time to calculate the rate of throughput bytes per unit of time.

timestamp

string

The timestamp of the performance data.

v41

The NFSv4.1 operations

Name Type Description

iops_raw

iops_raw

The number of I/O operations observed at the storage object. This should be used along with delta time to calculate the rate of I/O operations per unit of time.

latency_raw

latency_raw

The raw latency in microseconds observed at the storage object. This should be divided by the raw IOPS value to calculate the average latency per I/O operation.

status

string

Any errors associated with the sample. For example, if the aggregation of data over multiple nodes fails then any of the partial errors might be returned, "ok" on success, or "error" on any internal uncategorized failure. Whenever a sample collection is missed but done at a later time, it is back filled to the previous 15 second timestamp and tagged with "backfilled_data". "Inconsistent_delta_time" is encountered when the time between two collections is not the same for all nodes. Therefore, the aggregated value might be over or under inflated. "Negative_delta" is returned when an expected monotonically increasing value has decreased in value. "Inconsistent_old_data" is returned when one or more nodes do not have the latest data.

throughput_raw

throughput_raw

Throughput bytes observed at the storage object. This should be used along with delta time to calculate the rate of throughput bytes per unit of time.

timestamp

string

The timestamp of the performance data.

statistics

Realtime performance numbers, such as IOPS latency and throughput, for SVM-NFS protocol.

Name Type Description

v3

v3

The NFSv3 operations

v4

v4

The NFSv4 operations

v41

v41

The NFSv4.1 operations

svm

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

auth_sys_extended_groups_enabled

boolean

Specifies whether or not extended groups support over AUTH_SYS is enabled.

enabled

boolean

Specifies if the NFS service is administratively enabled.

extended_groups_limit

integer

Specifies the maximum auxillary groups supported over AUTH_SYS and RPCSEC_GSS.

metric

metric

Historical performance numbers, such as IOPS latency and throughput, for SVM-NFS protocol.

positive_cached_credential_ttl

integer

Specifies the time to live value (in msecs) of a positive cached credential

protocol

protocol

rquota_enabled

boolean

Specifies whether or not the remote quota feature is enabled.

showmount_enabled

boolean

Specifies whether or not the showmount feature is enabled.

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.

statistics

statistics

Realtime performance numbers, such as IOPS latency and throughput, for SVM-NFS protocol.

svm

svm

transport

transport

vstorage_enabled

boolean

Specifies whether or not the VMware vstorage feature is enabled.

_links

Name Type Description

next

href

self

href

nfs_service

Name Type Description

_links

_links

auth_sys_extended_groups_enabled

boolean

Specifies whether or not extended groups support over AUTH_SYS is enabled.

enabled

boolean

Specifies if the NFS service is administratively enabled.

extended_groups_limit

integer

Specifies the maximum auxillary groups supported over AUTH_SYS and RPCSEC_GSS.

metric

metric

Historical performance numbers, such as IOPS latency and throughput, for SVM-NFS protocol.

positive_cached_credential_ttl

integer

Specifies the time to live value (in msecs) of a positive cached credential

protocol

protocol

rquota_enabled

boolean

Specifies whether or not the remote quota feature is enabled.

showmount_enabled

boolean

Specifies whether or not the showmount feature is enabled.

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.

statistics

statistics

Realtime performance numbers, such as IOPS latency and throughput, for SVM-NFS protocol.

svm

svm

transport

transport

vstorage_enabled

boolean

Specifies whether or not the 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.