Update NFS configuration for an SVM
PATCH /protocols/nfs/services/{svm.uuid}
Introduced In: 9.6
Updates the NFS configuration of an SVM.
Related ONTAP commands
-
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 |
||
access_cache_config |
||
auth_sys_extended_groups_enabled |
boolean |
Specifies whether or not extended groups support over AUTH_SYS is enabled. |
credential_cache |
||
enabled |
boolean |
Specifies if the NFS service is administratively enabled. |
exports |
||
extended_groups_limit |
integer |
Specifies the maximum auxiliary groups supported over AUTH_SYS and RPCSEC_GSS. |
file_session_io_grouping_count |
integer |
Number of I/O operations on a file to be grouped and considered as one session for event generation applications, such as FPolicy. |
file_session_io_grouping_duration |
integer |
The duration for which I/O operations on a file will be grouped and considered as one session for event generation applications, such as FPolicy. |
metric |
Historical performance numbers, such as IOPS latency and throughput, for SVM-NFS protocol. |
|
protocol |
||
protocol_access_rules |
||
qtree |
||
root |
||
rquota_enabled |
boolean |
Specifies whether or not the remote quota feature is enabled. |
security |
||
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:
|
statistics |
Realtime performance numbers, such as IOPS latency and throughput, for SVM-NFS protocol. |
|
svm |
SVM, applies only to SVM-scoped objects. |
|
transport |
||
vstorage_enabled |
boolean |
Specifies whether or not the VMware vstorage feature is enabled. |
windows |
Example request
{
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"access_cache_config": {
"harvest_timeout": 3600,
"ttl_failure": 1,
"ttl_negative": 30,
"ttl_positive": 60
},
"credential_cache": {
"negative_ttl": 7200000,
"positive_ttl": 7200000,
"transient_error_ttl": 72000
},
"exports": {
"name_service_lookup_protocol": "string"
},
"extended_groups_limit": 32,
"file_session_io_grouping_count": 5000,
"file_session_io_grouping_duration": 120,
"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 06:20:13 -0500"
},
"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-25 06:20:13 -0500"
},
"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-25 06:20:13 -0500"
}
},
"protocol": {
"v40_features": {
"acl_max_aces": 500
},
"v41_features": {
"implementation_domain": "string",
"implementation_name": "string"
},
"v4_id_domain": "string"
},
"protocol_access_rules": {
"cifs_access_type": "string",
"nfs3_access_type": "string",
"nfs4_access_type": "string"
},
"security": {
"chown_mode": "string",
"ntfs_unix_security": "string",
"permitted_encryption_types": [
"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 06:20:13 -0500"
},
"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-25 06:20:13 -0500"
},
"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-25 06:20:13 -0500"
}
},
"svm": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "svm1",
"uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
},
"transport": {
"tcp_max_transfer_size": 16384
},
"windows": {
"default_user": "string"
}
}
Response
Status: 200, Ok
Error
Status: Default
ONTAP Error Response Codes
Error Code | Description |
---|---|
1534829 |
The port numbers allowed are 635 (the default) and 1024 through 9999 |
2621516 |
This operation is only supported on a data SVM |
2621574 |
This operation is not permitted on a SVM that is configured as the destination of a MetroCluster SVM relationship |
3276916 |
Vserver is not running |
3276969 |
Ports cannot be modified when NFS access is enabled. Disable NFS access before changing port settings |
3277048 |
The port numbers allowed are 635 (the default) and 1024 through 9999 |
3277069 |
Cannot disable TCP because the SnapDiff RPC server is in the \"on\" state |
3277085 |
The port numbers allowed are 1024 through 9999. |
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 |
3277140 |
Cannot set "transport.tcp_max_transfer_size" to a value other than multiples of 4096 |
Name | Type | Description |
---|---|---|
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 |
access_cache_config
Name | Type | Description |
---|---|---|
harvest_timeout |
integer |
Specifies the time after which an entry is deleted from the access cache, if unused. |
isDnsTTLEnabled |
boolean |
Specifies whether Dns TTL is enabled. |
ttl_failure |
integer |
Specifies the time to live value for entries for which a failure was encountered, in seconds. |
ttl_negative |
integer |
Specifies the time to live value of a negative access cache, in seconds. |
ttl_positive |
integer |
Specifies the time to live value of a positive access cache, in seconds. |
credential_cache
Name | Type | Description |
---|---|---|
negative_ttl |
integer |
Specifies the age in milliseconds, of the negative cached credentials after which they are cleared from the cache. |
positive_ttl |
integer |
Specifies the age in milliseconds, of the positive cached credentials after which they are cleared from the cache. |
transient_error_ttl |
integer |
Specifies the age in milliseconds, of the cached entries during a transient error situation. |
exports
Name | Type | Description |
---|---|---|
name_service_lookup_protocol |
string |
Specifies the protocol to use for doing name service lookups. |
netgroup_trust_any_nsswitch_no_match |
boolean |
Specifies if you can consider a no-match result from any of the netgroup ns-switch sources to be authoritative. If this option is enabled, then a no-match response from any of the netgroup ns-switch sources is deemed conclusive even if other sources could not be searched. |
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 |
||
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 |
The rate of I/O operations observed at the storage object. |
|
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 |
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 |
||
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 |
The rate of I/O operations observed at the storage object. |
|