Create an NFS configuration for an SVM
POST /protocols/nfs/services
Introduced In: 9.6
Creates an NFS configuration for an SVM.
Required properties
-
svm.uuid
orsvm.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 -
transport.rdma_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 -
qtree.export_enabled
- false -
qtree.validate_export
- true -
access_cache_config.ttl_positive
- 60 -
access_cache_config.ttl_negative
- 30 -
access_cache_config.ttl_failure
- 1 -
access_cache_config.harvest_timeout
- 3600 -
access_cache_config.isDnsTTLEnabled
- false -
file_session_io_grouping_count
- 5000 -
file_session_io_grouping_duration
- 120 -
security.nt_acl_display_permission
- false -
exports.netgroup_trust_any_nsswitch_no_match
- false -
exports.name_service_lookup_protocol
- udp -
security.permitted_encryption_types
- [aes-256,aes-128,des3,des] -
security.rpcsec_context_idle
- 0 -
security.chown_mode
- use_export_policy -
security.ntfs_unix_security
- use_export_policy -
windows.v3_ms_dos_client_enabled
- false -
windows.default_user
- "" -
windows.map_unknown_uid_to_default_user
- true -
credential_cache.positive_ttl
- 86400000 -
credential_cache.negative_ttl
- 7200000 -
credential_cache.transient_error_ttl
- 30000 -
protocol.v40_features.acl_preserve
- true -
protocol.v41_features.implementation_domain
- 'netapp.com' -
protocol.v40_features.acl_max_aces
- 400 -
protocol.v3_features.ejukebox_enabled
- true -
protocol.v3_features.connection_drop
- true -
protocol.v3_features.fsid_change
- true -
protocol.v3_features.mount_daemon_port
- 635 -
protocol.v3_features.network_lock_manager_port
- 4045 -
protocol.v3_features.network_status_monitor_port
- 4046 -
protocol.v3_features.rquota_daemon_port
- 4046 -
protocol.v3_features.mount_root_only
- true -
transport.tcp_max_transfer_size
- 65536 -
root.ignore_nt_acl
- false -
root.skip_write_permission_check
- false -
protocol.v40_features.referrals_enabled
- false -
protocol.v41_features.referrals_enabled
- false -
protocol.v4_fsid_change
- true -
protocol.v4_lease_seconds
- 30 -
protocol.v4_grace_seconds
- 45 -
protocol.v4_session_slots
- 180 -
protocol.v4_session_slot_reply_cache_size
- 640
Related ONTAP commands
-
vserver nfs create
-
export-policy access-cache config show
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.
|
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: * online - NFS server is ready to accept client requests. * offline - NFS server is not ready to accept client requests. |
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: 201, Created
Name | Type | Description |
---|---|---|
_links |
||
num_records |
integer |
Number of NFS Server Records |
records |
array[nfs_service] |
Example response
{
"_links": {
"next": {
"href": "/api/resourcelink"
},
"self": {
"href": "/api/resourcelink"
}
},
"num_records": 1,
"records": [
{
"_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"
}
}
]
}
Headers
Name | Description | Type |
---|---|---|
Location |
Useful for tracking the resource location |
string |
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 |
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 |
3277048 |
The port numbers allowed are 635 (the default) and 1024 through 9999 |
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 |
3277085 |
The port numbers allowed are 1024 through 9999 |
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 |
3277140 |
Cannot set "transport.tcp_max_transfer_size" to a value other than multiples of 4096 |
2621519 |
SVM name is invalid. The SVM name must begin with a letter or an underscore. If the SVM is of type "sync-source", the maximum supported length is 41. Otherwise, the maximum supported length is 47. |
262196 |
Field "access_cache_config.harvest_timeout" cannot be set in this operation. |
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 |