REST API reference
Retrieve NFS configuration for an SVM
Suggest changes
PDFs
GET /protocols/nfs/services/{svm.uuid}
Introduced In: 9.6
Retrieves the NFS configuration of an SVM.
Related ONTAP commands
-
vserver nfs show -
vserver nfs status
Learn more
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
svm.uuid |
string |
path |
True |
|
fields |
array[string] |
query |
False |
Specify the fields to return. |
Response
Status: 200, Ok| 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 |
||
transport |
||
vstorage_enabled |
boolean |
Specifies whether or not the VMware vstorage feature is enabled. |
windows |
Example response
{
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"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"
}
}Error
Status: Default, Error| 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. |
|
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. |
v41
The NFSv4.1 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. |
metric
Historical performance numbers, such as IOPS latency and throughput, for SVM-NFS protocol.
| Name | Type | Description |
|---|---|---|
v3 |
The NFSv3 operations |
|
v4 |
The NFSv4 operations |
|
v41 |
The NFSv4.1 operations |
v3_features
| Name | Type | Description |
|---|---|---|
connection_drop |
boolean |
Specfies whether the dropping of a connection when an NFSv3 request is dropped is enabled. |
ejukebox_enabled |
boolean |
Specifies whether NFSv3 EJUKEBOX error is enabled. |
fsid_change |
boolean |
Specifies whether the change in FSID as NFSv3 clients traverse filesystems should be shown. |
hide_snapshot_enabled |
boolean |
Specifies whether hiding a Snapshot copy directory under a NFSv3 mount point is enabled. |
mount_daemon_port |
integer |
Specifies which port the NFS mount daemon (mountd) uses. |
mount_root_only |
boolean |
Specifies whether the SVM allows MOUNT protocol calls only from privileged ports (port numbers less than 1024). |
network_lock_manager_port |
integer |
Specifies which port the Network lock manager uses. |
network_status_monitor_port |
integer |
Specifies which port the Network status monitor port uses. |
rquota_daemon_port |
integer |
Specifies which port the NFS quota daemon port uses. |
v40_features
| Name | Type | Description |
|---|---|---|
acl_enabled |
boolean |
Specifies whether NFSv4.0 ACLs is enabled. |
acl_max_aces |
integer |
Specifies the maximum number of aces in a NFSv4.0 ACL. |
acl_preserve |
boolean |
Specifies if the NFSv4 ACL is preserved or dropped when chmod is performed. In unified security style, this parameter also specifies if NTFS file permissions are preserved or dropped when chmod, chgrp, or chown are performed. |
read_delegation_enabled |
boolean |
Specifies whether NFSv4.0 Read Delegation is enabled. |
referrals_enabled |
boolean |
Specifies whether NFSv4.0 referrals 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. |
implementation_domain |
string |
Specifies the NFSv4.1 or later implementation ID domain. |
implementation_name |
string |
Specifies the NFSv4.1 or later implementation ID name. |
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. |
referrals_enabled |
boolean |
Specifies whether NFSv4.1 referrals is enabled. |
trunking_enabled |
boolean |
Specifies whether NFSv4.1 or later trunking is enabled. |
write_delegation_enabled |
boolean |
Specifies whether NFSv4.1 or later Write Delegation is enabled. |
v42_features
| Name | Type | Description |
|---|---|---|
seclabel_enabled |
boolean |
Specifies whether NFSv4.2 or later security label is enabled. |
sparsefile_ops_enabled |
boolean |
Specifies whether NFSv4.2 or later sparsefile operation is enabled. |
xattrs_enabled |
boolean |
Specifies whether NFSv4.2 or later extended attributes 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. |
v3_features |
||
v40_enabled |
boolean |
Specifies whether NFSv4.0 protocol is enabled. |
v40_features |
||
v41_enabled |
boolean |
Specifies whether NFSv4.1 or later protocol is enabled. |
v41_features |
||
v42_features |
||
v4_64bit_identifiers_enabled |
boolean |
Specifies whether 64-bit support for NFSv4.x FSIDs and file IDs is enabled. |
v4_fsid_change |
boolean |
Specifies whether the change in FSID when NFSv4 clients traverse file systems is displayed. |
v4_grace_seconds |
integer |
Specifies the grace period for clients to reclaim file locks after a server failure. |
v4_id_domain |
string |
Specifies the domain portion of the string form of user and group names as defined by the NFSv4 protocol. |
v4_lease_seconds |
integer |
Specifies the lease seconds of the NFSv4 clients. If it is inactive for more than the time displayed, all of the file lock states on a node might be lost. |
v4_session_slot_reply_cache_size |
integer |
Specifies the number of bytes of the reply that is cached in each NFSv4.x session slot. |
v4_session_slots |
integer |
Specifies the number of entries in NFSv4.x session slot table. |
protocol_access_rules
| Name | Type | Description |
|---|---|---|
cifs_access_type |
string |
Access available for the CIFS protocol. |
nfs3_access_type |
string |
Access available for the NFSv3 protocol. |
nfs4_access_type |
string |
Access available for the NFSv4 protocol. |
qtree
| Name | Type | Description |
|---|---|---|
export_enabled |
boolean |
Specifies whether qtree export is enabled. |
validate_export |
boolean |
Specifies whether qtree export validation is enabled. |
root
| Name | Type | Description |
|---|---|---|
ignore_nt_acl |
boolean |
Specifies whether Windows ACLs affect root access from NFS. If this option is enabled, root access from NFS ignores the NT ACL set on the file or directory. |
skip_write_permission_check |
boolean |
Specifies if permission checks are to be skipped for NFS WRITE calls from root/owner. For copying read-only files to a destination folder which has inheritable ACLs, this option must be enabled. |
security
| Name | Type | Description |
|---|---|---|
chown_mode |
string |
Specifies whether file ownership can be changed only by the superuser, or if a non-root user can also change file ownership. If you set this parameter to restricted, file ownership can be changed only by the superuser, even though the on-disk permissions allow a non-root user to change file ownership. If you set this parameter to unrestricted, file ownership can be changed by the superuser and by the non-root user, depending upon the access granted by on-disk permissions. If you set this parameter to use-export-policy, file ownership can be changed in accordance with the relevant export rules. |
nt_acl_display_permission |
boolean |
Controls the permissions that are displayed to NFSv3 and NFSv4 clients on a file or directory that has an NT ACL set. When true, the displayed permissions are based on the maximum access granted by the NT ACL to any user. When false, the displayed permissions are based on the minimum access granted by the NT ACL to any user. |
ntfs_unix_security |
string |
Specifies how NFSv3 security changes affect NTFS volumes. If you set this parameter to ignore, ONTAP ignores NFSv3 security changes. If you set this parameter to fail, this overrides the UNIX security options set in the relevant export rules. If you set this parameter to use_export_policy, ONTAP processes NFSv3 security changes in accordance with the relevant export rules.
|
permitted_encryption_types |
array[string] |
Specifies the permitted encryption types for Kerberos over NFS. |
rpcsec_context_idle |
integer |
Specifies, in seconds, the amount of time a RPCSEC_GSS context is permitted to remain unused before it is deleted. |
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 |
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 |
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 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 |
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 |
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 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 |
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 |
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 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 |
The NFSv3 operations |
|
v4 |
The NFSv4 operations |
|
v41 |
The NFSv4.1 operations |
svm
| Name | Type | Description |
|---|---|---|
_links |
||
name |
string |
The name of the SVM. |
uuid |
string |
The unique identifier of the SVM. |
transport
| Name | Type | Description |
|---|---|---|
rdma_enabled |
boolean |
Specifies whether RDMA transport is enabled for the NFS server. |
tcp_enabled |
boolean |
Specifies whether TCP transports are enabled on the server. |
tcp_max_transfer_size |
integer |
Specifies the maximum transfer size in bytes, that the storage system negotiates with the client for TCP transport of data for NFSv3 and NFSv4.x protocols. The range is 8192 to 1048576. |
udp_enabled |
boolean |
Specifies whether UDP transports are enabled on the server. |
windows
| Name | Type | Description |
|---|---|---|
default_user |
string |
Specifies the default Windows user for the NFS server. |
map_unknown_uid_to_default_user |
boolean |
Specifies whether or not the mapping of an unknown UID to the default Windows user is enabled. |
v3_ms_dos_client_enabled |
boolean |
Specifies whether NFSv3 MS-DOS client support 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. |