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

Update NFS configuration for an SVM

Contributors
PDFs

PATCH /protocols/nfs/services/{svm.uuid}

Updates the NFS configuration of an SVM.

  • vserver nfs modify

  • vserver nfs on

  • vserver nfs off

  • vserver nfs start

  • vserver nfs stop

Learn more

Parameters

Name Type In Required Description

svm.uuid

string

path

True

Request Body

Name Type Description

_links

_links

enabled

boolean

Specifies if the NFS service is administratively enabled.

metric

metric

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

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.

statistics

statistics

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

svm

svm

transport

transport

vstorage_enabled

boolean

Specifies whether VMware vstorage feature is enabled.
Example request 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "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-25 11:20:13 UTC"
    }
  },
  "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-25 11:20:13 UTC"
    }
  },
  "svm": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "svm1",
    "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
  }
}

Response

Status: 200, Ok

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

3276916

Vserver is not running

3277069

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

3277087

Attempting to reduce the number of bits used for NFSv3 FSIDs and File IDs from 64 to 32 on Vserver. This could result in collisions between different File IDs and is not recommended

3277088

Attempting to increase the number of bits used for NFSv3 FSIDs and File IDs from 32 to 64 on Vserver. This could result in older client software no longer working with the volumes owned by Vserver

3277090

Attempting to disallow multiple FSIDs per mount point on Vserver. Since this Vserver currently uses 32-bit NFSv3 FSIDs and File IDs, this could result in collisions between different File IDs and is not recommended

3277099

Domain name contains invalid characters or its 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.

metric

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

Name Type Description

v3

v3

The NFSv3 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 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.

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.

statistics

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

Name Type Description

v3

v3

The NFSv3 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

enabled

boolean

Specifies if the NFS service is administratively enabled.

metric

metric

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

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.

statistics

statistics

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

svm

svm

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.