APIs in Category: nfs | Vserver API version 1.21

nfs-disable nfs-enable nfs-exportfs-append-rules nfs-exportfs-append-rules-2 nfs-exportfs-check-permission nfs-exportfs-delete-rules nfs-exportfs-list-rules nfs-exportfs-list-rules-2 nfs-exportfs-modify-rule nfs-exportfs-modify-rule-2 nfs-get-supported-sec-flavors nfs-service-create nfs-service-destroy nfs-service-get nfs-service-get-create-defaults nfs-service-get-iter nfs-service-modify nfs-status

NetApp Manage ONTAP

nfs-disable | [top]

> In Data ONTAP 7-Mode, this API will disable NFS server access (effectively same as the CLI command "nfs off") In Data ONTAP Cluster-Mode, this will stop the Vserver's NFS service. If the NFS service was not explicitly created, this API does nothing.

> Errno | Description
> EINTERNALERROR |  |
> EVSERVERNOTFOUND |  |

> Vfiler-enabled
> Yes

> License
> nfs

nfs-enable | [top]

> In Data ONTAP 7-Mode, this API will enable NFS server access (effectively same as the CLI command "nfs on") In Data ONTAP Cluster-Mode, this will start the Vserver's NFS service. If the NFS service was not explicitly created, this API will create one with default options.

> Errno | Description
> EINTERNALERROR |  |
> EVSERVERNOTFOUND |  |

> Vfiler-enabled
> Yes

> License
> nfs

nfs-exportfs-append-rules | [top]

> Enables pathnames for mounting according to the rules specified. New rules for the pathnames take effect immediately, ignoring previous rules for specified pathnames. In the Data ONTAP 7-Mode, set the persistent option to true to save the rule in the etc/exports file and keep the option persistent upon loading or reboot whereas it must be true in Data ONTAP Cluster-Mode as the export entries are always persistent.

> Input Name | Range | Type | Description
> persistent |  | boolean optional | In Data ONTAP 7-Mode, default value is false. If true, modifies the etc/exports file to append the rule for a permanent change. (The new rule still takes effect immediately.) In Data ONTAP Cluster-Mode, the export entries are always persistent. Default value is true. If false, an error will be returned.
> rules |  | exports-rule-info[] | List of rules to add to the exports table.
> verbose |  | boolean optional | If true, returns a list of directories which were appended. Errors during the append are recorded in the 'results' field error and 'loaded-pathnames' will contain which pathnames were successfully appended. Default value is false.
> Output Name | Range | Type | Description
> exported-pathnames |  | pathname-info[] optional | In Data ONTAP 7-Mode, this will return verbose output of what pathnames were successfully saved in the etc/exports file. Only returned if verbose and persistent options are set. In Data ONTAP Cluster-Mode, this will return verbose output of what pathnames were successfully appended. Only returned if verbose option is set.
> loaded-pathnames |  | pathname-info[] optional | Verbose output of what pathnames were successfully appended Only returned if verbose option is set.

> Errno | Description
> EINTERNALERROR |  |
> EVSERVERNOTFOUND |  |
> ENOENT |  |
> EINVAL |  |

> Vfiler-enabled
> Yes

> License
> nfs

nfs-exportfs-append-rules-2 | [top]

> Enables pathnames for mounting according to the rules specified. New rules for the pathnames take effect immediately, ignoring previous rules for specified pathnames. In the Data ONTAP 7-Mode, set the persistent option to true to save the rule in the etc/exports file and keep the option persistent upon loading or reboot whereas it must be true in Data ONTAP Cluster-Mode as the export entries are always persistent. The new security-rule-info structure contains finer grained information about security rules than exports-rule-info.

> Input Name | Range | Type | Description
> persistent |  | boolean optional | In Data ONTAP 7-Mode, default value is false. If true, modifies the etc/exports file to append the rule for a permanent change. (The new rule still takes effect immediately.) In Data ONTAP Cluster-Mode, the export entries are always persistent. Default value is true. If false, an error will be returned.
> rules |  | exports-rule-info-2[] | List of rules to add to the exports table.
> verbose |  | boolean optional | If true, returns a list of directories which were appended. Errors during the append are recorded in the 'results' field error and 'loaded-pathnames' will contain which pathnames were successfully appended. Default value is false.
> Output Name | Range | Type | Description
> exported-pathnames |  | pathname-info[] optional | In Data ONTAP 7-Mode, this will return verbose output of what pathnames were successfully saved in the etc/exports file. Only returned if verbose and persistent options are set. In Data ONTAP Cluster-Mode, this will return verbose output of what pathnames were successfully appended. Only returned if verbose option is set.
> loaded-pathnames |  | pathname-info[] optional | Verbose output of what pathnames were successfully appended Only returned if verbose option is set.

> Errno | Description
> EINTERNALERROR |  |
> EVSERVERNOTFOUND |  |
> ENOENT |  |
> EINVAL |  |

> Vfiler-enabled
> Yes

> License
> nfs

nfs-exportfs-check-permission | [top]

> Returns true if the host IP has mount permissions for a specified path.

> Input Name | Range | Type | Description
> host |  | string | IP address of the host to check in dotted decimal format: AAA.BBB.CCC.DDD
> pathname |  | string | Returns the permissions for this path.
> permission |  | string | Possible values: "read-only", "read-write", and "root".
> Output Name | Range | Type | Description
> is-permissible |  | boolean | True if host has permission to the path.

> Errno | Description
> EINTERNALERROR |  |
> EVSERVERNOTFOUND |  |

> Vfiler-enabled
> Yes

> License
> nfs

nfs-exportfs-delete-rules | [top]

> Removes the rules for a set of pathnames. This returns an error if any of the pathnames don't have a rule. In the Data ONTAP 7-Mode, set the persistent option to modify the etc/exports file and keep this change persistent upon reboots whereas it must be true in Data ONTAP Cluster-Mode as the export entries are always persistent.

> Input Name | Range | Type | Description
> all-pathnames |  | boolean optional | Default value is false. Set to true to delete all rules. 'pathnames' option must be left empty if this option is true.
> pathnames |  | pathname-info[] optional | In the Data ONTAP 7-Mode, these must be the pathnames to be deleted from the exports table. In Data ONTAP Cluster-Mode, the junction paths of the volumes to be unexported must be provided.
> persistent |  | boolean optional | In Data ONTAP 7-Mode, default value is false. Modify the etc/exports file to delete the rules permanently. CAUTION: If 'all-pathnames' and 'persistent' are both true, all exports are removed permanently. In Data ONTAP Cluster-Mode, the export entries are always persistent. Default value is true. If false, an error will be returned.
> verbose |  | boolean optional | Return a verbose output of what occurred. If there is an error after deleting only a few rules, 'deleted-pathnames' will return which rules were deleted. Default value is false.
> Output Name | Range | Type | Description
> deleted-pathnames |  | pathname-info[] optional | In Data ONTAP 7-Mode, this will return the list of pathnames deleted from the exports table in memory. Only returned if verbose option is set. In Data ONTAP Cluster-Mode, this will return the list of pathnames unexported.
> unexported-pathnames |  | pathname-info[] optional | In Data ONTAP 7-Mode, this will return the list of pathnames deleted from the exports file. Only returned if verbose and persistent options are set. In Data ONTAP Cluster-Mode, this will return the list of pathnames unexported.

> Errno | Description
> EINTERNALERROR |  |
> EVSERVERNOTFOUND |  |

> Vfiler-enabled
> Yes

> License
> nfs

nfs-exportfs-list-rules | [top]

> Returns the rules associated with exports. If a pathname is specified, the rules associated with the export matching that pathname, are returned; otherwise, rules for all exports are returned.

> Input Name | Range | Type | Description
> pathname |  | string optional | The pathname, for whose matching export, the client wants a listing of the associated rules. If this parameter is provided, the persistent parameter is ignored.
> persistent |  | boolean optional | In Data ONTAP 7-Mode, default value is false. If true, the export entries that are present in the /etc/exports file are returned; otherwise, those loaded in memory are returned. This parameter is ignored, if the pathname parameter is provided. In Data ONTAP Cluster-Mode, the export entries are always persistent. Default value is true. If false, an empty list will be returned.
> Output Name | Range | Type | Description
> rules |  | exports-rule-info[] | Array of exports rules loaded in memory or found in the etc/exports file. If pathname parameter is provided, returns the corresponding rules that are loaded in memory.

> Errno | Description
> EINTERNALERROR |  |
> EEXPORTSINCOMPATIBLE |  |
> EVSERVERNOTFOUND |  |

> Vfiler-enabled
> Yes

> License
> nfs

nfs-exportfs-list-rules-2 | [top]

> Returns the rules associated with exports, using the new security info structure. If a pathname is specified, the rules associated with the export matching that pathname, are returned; otherwise, rules for all exports are returned.

> Input Name | Range | Type | Description
> pathname |  | string optional | The pathname, for whose matching export, the client wants a listing of the associated rules. If this parameter is provided, the persistent parameter is ignored.
> persistent |  | boolean optional | In Data ONTAP 7-Mode, default value is false. If true, the export entries that are present in the /etc/exports file are returned; otherwise, those loaded in memory are returned. This parameter is ignored, if the pathname parameter is provided. In Data ONTAP Cluster-Mode, the export entries are always persistent. Default value is true. If false, an empty list will be returned.
> Output Name | Range | Type | Description
> rules |  | exports-rule-info-2[] | Array of exports rules loaded in memory or found in the etc/exports file. If pathname parameter is provided, returns the corresponding rules that are loaded in memory.

> Errno | Description
> EINTERNALERROR |  |
> EVSERVERNOTFOUND |  |

> Vfiler-enabled
> Yes

> License
> nfs

nfs-exportfs-modify-rule | [top]

> Functionally similar to append with the following caveats. Returns an error if the rule does not exist. Only works for one rule at a time.

> Input Name | Range | Type | Description
> persistent |  | boolean | In Data ONTAP 7-Mode, default value is false. If true, modifies the etc/exports file to append the rule for a permanent change. (The new rule still takes effect immediately.) In Data ONTAP Cluster-Mode, the export entries are always persistent. Default value is true. If false, an error will be returned.
> rule |  | exports-rule-info | The rule to modify. Returns an error if a previous rule with the same pathname is not already loaded into memory.

> Errno | Description
> EINTERNALERROR |  |
> EVSERVERNOTFOUND |  |
> ENOENT |  |
> EINVAL |  |

> Vfiler-enabled
> Yes

nfs-exportfs-modify-rule-2 | [top]

> Functionally similar to append-2 with the following caveats. Returns an error if the rule does not exist. Only works for one rule at a time.

> Input Name | Range | Type | Description
> persistent |  | boolean | In Data ONTAP 7-Mode, default value is false. If true, modifies the etc/exports file to append the rule for a permanent change. (The new rule still takes effect immediately.) In Data ONTAP Cluster-Mode, the export entries are always persistent. Default value is true. If false, an error will be returned.
> rule |  | exports-rule-info-2 | The rule to modify. Returns an error if a previous rule with the same pathname is not already loaded into memory.

> Errno | Description
> EINTERNALERROR |  |
> EVSERVERNOTFOUND |  |
> ENOENT |  |
> EINVAL |  |

> Vfiler-enabled
> Yes

nfs-get-supported-sec-flavors | [top]

> Returns a list of currently supported security flavors. Hosts with permmisions and connecting via the proper security flavor have access to directories on the filer. Default security flavor for all exports is "sys".

> Output Name | Range | Type | Description
> sec-flavor |  | sec-flavor-info[] | List of possible security flavors NFS supports.

> Errno | Description
> EINTERNALERROR |  |
> EVSERVERNOTFOUND |  |

> Vfiler-enabled
> Yes

> License
> nfs

nfs-service-create | [top]

> Create a new NFS configuration.

> Input Name | Range | Type | Description
> chown-mode |  | nfschownmode optional | Vserver Change Ownership Mode. Possible values are 'ignore', 'fail', 'use_export_policy'. If 'use_export_policy' is set, export policy option is used. Default value is 'use_export_policy'. Possible values: "restricted" , "unrestricted" , "use_export_policy"
> default-windows-group |  | string optional | The default windows group for CIFS access.
> default-windows-user |  | string optional | The default windows user for CIFS access.
> enable-ejukebox |  | boolean optional | If 'true', then the NFS server will send EJUKEBOX error on server delays.
> is-mount-rootonly-enabled |  | boolean optional | If 'true', then the vserver allows MOUNT protocol calls only from privileged ports (port numbers less than 1024). Default value is 'true'.
> is-nfs-access-enabled |  | boolean optional | If 'true',then NFS server access is enabled. Default value is 'true'.
> is-nfs-rootonly-enabled |  | boolean optional | If 'true', then the vserver allows NFS protocol calls only from privileged ports (port numbers less than 1024). Default value is 'false'.
> is-nfsv2-enabled |  | boolean optional | Starting Data ONTAP 8.2, NFS v2 is no longer supported. Default value is 'false'.
> is-nfsv3-connection-drop-enabled |  | boolean optional | If 'true', then connection is dropped when an NFSv3 request is dropped. Default value is 'true'.
> is-nfsv3-enabled |  | boolean optional | If 'true', then NFS version 3 is enabled. Default value is 'true'.
> is-nfsv3-fsid-change-enabled |  | boolean optional | If 'true', then NFSv3 clients see change in FSID as they traverse filesystems. Default value is 'true'.
> is-nfsv4-fsid-change-enabled |  | boolean optional | If 'true', then clients see change in FSID as NFSv4 clients traverse filesystems. Default value is 'true'.
> is-nfsv4-numeric-ids-enabled |  | boolean optional | If 'true', then NFSv4 support for Numeric Owner IDs is enabled. Default value is 'true'.
> is-nfsv40-acl-enabled |  | boolean optional | If 'true', then NFSv4.0 ACL feature is enabled. Default value is 'false'.
> is-nfsv40-enabled |  | boolean optional | If 'true', then NFS version 4.0 is enabled. Default value is 'false'.
> is-nfsv40-migration-enabled |  | boolean optional | If 'true', then NFSv4.0 Migration feature is enabled. Default value is 'false'.
> is-nfsv40-read-delegation-enabled |  | boolean optional | If 'true', NFSv4.0 read delegation feature is enabled. Default value is 'false'.
> is-nfsv40-referrals-enabled |  | boolean optional | If 'true', then NFSv4.0 Referrals feature is enabled. Default value is 'false'.
> is-nfsv40-req-open-confirm-enabled |  | boolean optional | If 'true', then the server will require an OPEN_CONFIRM operation for all NFSv4.0 clients. Default value is 'false'.
> is-nfsv40-write-delegation-enabled |  | boolean optional | If 'true', NFSv4.0 write delegation feature is enabled. Default value is 'false'.
> is-nfsv41-acl-enabled |  | boolean optional | If 'true', then NFSv4.1 ACL feature is enabled. Default value is 'false'.
> is-nfsv41-acl-preserve-enabled |  | boolean optional | If 'true', the NFSv4 server will preserve and modify ACL when chmod is done. Default value is 'true'.
> is-nfsv41-enabled |  | boolean optional | If 'true', then NFS version 4.1 is enabled. Default value is 'false'.
> is-nfsv41-migration-enabled |  | boolean optional | If 'true', then NFSv4.1 Migration feature is enabled. Default value is 'false'.
> is-nfsv41-pnfs-enabled |  | boolean optional | If 'true', then Parallel NFS support for NFS version 4.1 is enabled. Default value is 'true'.
> is-nfsv41-pnfs-striped-volumes-enabled |  | boolean optional | If 'true', Striped volume support for Parallel NFS is enabled . Default value is 'false'.
> is-nfsv41-read-delegation-enabled |  | boolean optional | If 'true', NFSv4.1 read delegation feature is enabled. Default value is 'false'.
> is-nfsv41-referrals-enabled |  | boolean optional | If 'true', then NFSv4.1 Referrals feature is enabled. Default value is 'false'.
> is-nfsv41-state-protection-enabled |  | boolean optional | If 'true', then NFSv4.1 State Protection is enabled. Default value is 'true'.
> is-nfsv41-write-delegation-enabled |  | boolean optional | If 'true', NFSv4.1 write delegation feature is enabled. Default value is 'false'.
> is-validate-qtree-export-enabled |  | boolean optional | If 'true', then the Vserver performs additional validation for qtree. Default value is 'true'.
> is-vstorage-enabled |  | boolean optional | If 'true', then enables the usage of vStorage protocol for server side copies, which is mostly used in hypervisors. Default value is 'false'.
> nfsv4-acl-max-aces | [192..1024] | integer optional | Maximum Number of ACEs allowed in an ACL. Range is 192 to 1024. Default value is 400.
> nfsv4-grace-seconds | [0..2^32-1] | integer optional | NFSv4 Grace timeout value in seconds. Default value is 45 seconds.
> nfsv4-id-domain |  | string optional | NFSv4 ID mapping domain. Default value is 'defaultv4iddomain.com'.
> nfsv4-lease-seconds | [0..2^32-1] | integer optional | NFSv4 Lease timeout value in seconds. Default value is 30 seconds.
> nfsv41-implementation-id-domain |  | string optional | NFSv4.1 Implementation id domain. Default value is 'defaultv41impliddomain.com'.
> nfsv41-implementation-id-name |  | string optional | NFSv4.1 Implementation id name. Default value is 'defaultv41implidname'.
> nfsv41-implementation-id-time |  | date optional | NFSv4.1 Implementation id time.The number of seconds since January 1, 1970.
> nfsv4x-session-num-slots | [1..2000] | integer optional | Number of Slots in the NFSv4.x Session Slot Tables. Default value is 180.
> nfsv4x-session-slot-reply-cache-size | [512..4096] | integer optional | Size of the Reply that will be Cached in Each NFSv4.x Session Slot (in bytes). Default value is 640.
> ntfs-unix-security-ops |  | string optional | Ignore/Fail unix security operations on NTFS volumes. Possible values are 'ignore', 'fail','use_export_policy'. If 'use_export_policy' is set, export policy option is used. Default value is 'use_export_policy'.
> return-record |  | boolean optional | If set to true, returns the NFS Server on successful creation. Default: false
> rpcsec-ctx-high | [0..2^32-1] | integer optional | High water mark for the RPCSEC_GSS Context Cache. Default value is 0.
> rpcsec-ctx-idle | [0..2^32-1] | integer optional | Time in seconds before an idle entry in RPCSEC_GSS context cache is deleted. Default value is 0.
> Output Name | Range | Type | Description
> result |  | nfs-info optional | The NFS Server created (keys or the entire object if requested)

> Errno | Description
> EINTERNALERROR |  |

nfs-service-destroy | [top]

> Delete an NFS configuration.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |

nfs-service-get | [top]

> Get the NFS server configuration.

> Input Name | Range | Type | Description
> desired-attributes |  | nfs-info optional | Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
> Output Name | Range | Type | Description
> attributes |  | nfs-info | The attributes of the NFS Server.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |

nfs-service-get-create-defaults | [top]

> Obtain the default values for NFS server configuration.

> Input Name | Range | Type | Description
> attributes |  | nfs-info optional | Optionally specify the value for attributes if available. The default values for some attributes may depend on the values specified for some other attribute.
> Output Name | Range | Type | Description
> defaults |  | nfs-info | The default attributes for the NFS Server.

nfs-service-get-iter | [top]

> Iterate over the list of NFS servers.

> Input Name | Range | Type | Description
> desired-attributes |  | nfs-info optional | Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
> max-records | [1..2^32-1] | integer optional | The maximum number of records to return in this call. Default: 20
> query |  | nfs-info optional | A query that specifies which objects to return. A query could be specified on any number of attributes in the NFS Server object. All NFS Server objects matching this query up to 'max-records' will be returned.
> tag |  | string optional | Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.
> Output Name | Range | Type | Description
> attributes-list |  | nfs-info[] optional | The list of attributes of NFS Server objects.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more NFS Server objects to return.
> num-records | [0..2^32-1] | integer | The number of records returned in this call.

> Errno | Description
> EINTERNALERROR |  |

nfs-service-modify | [top]

> Modify an NFS configuration. If no values are given, the NFS configuration is not modified.

> Input Name | Range | Type | Description
> chown-mode |  | nfschownmode optional | Vserver Change Ownership Mode. Possible values are 'ignore', 'fail', 'use_export_policy'. If 'use_export_policy' is set, export policy option is used. Default value is 'use_export_policy'. Possible values: "restricted" , "unrestricted" , "use_export_policy"
> default-windows-group |  | string optional | The default windows group for CIFS access.
> default-windows-user |  | string optional | The default windows user for CIFS access.
> enable-ejukebox |  | boolean optional | If 'true', then the NFS server will send EJUKEBOX error on server delays.
> is-mount-rootonly-enabled |  | boolean optional | If 'true', then the vserver allows MOUNT protocol calls only from privileged ports (port numbers less than 1024). Default value is 'true'.
> is-nfs-access-enabled |  | boolean optional | If 'true',then NFS server access is enabled. Default value is 'true'.
> is-nfs-rootonly-enabled |  | boolean optional | If 'true', then the vserver allows NFS protocol calls only from privileged ports (port numbers less than 1024). Default value is 'false'.
> is-nfsv2-enabled |  | boolean optional | Starting Data ONTAP 8.2, NFS v2 is no longer supported. Default value is 'false'.
> is-nfsv3-connection-drop-enabled |  | boolean optional | If 'true', then connection is dropped when an NFSv3 request is dropped. Default value is 'true'.
> is-nfsv3-enabled |  | boolean optional | If 'true', then NFS version 3 is enabled. Default value is 'true'.
> is-nfsv3-fsid-change-enabled |  | boolean optional | If 'true', then NFSv3 clients see change in FSID as they traverse filesystems. Default value is 'true'.
> is-nfsv4-fsid-change-enabled |  | boolean optional | If 'true', then clients see change in FSID as NFSv4 clients traverse filesystems. Default value is 'true'.
> is-nfsv4-numeric-ids-enabled |  | boolean optional | If 'true', then NFSv4 support for Numeric Owner IDs is enabled. Default value is 'true'.
> is-nfsv40-acl-enabled |  | boolean optional | If 'true', then NFSv4.0 ACL feature is enabled. Default value is 'false'.
> is-nfsv40-enabled |  | boolean optional | If 'true', then NFS version 4.0 is enabled. Default value is 'false'.
> is-nfsv40-migration-enabled |  | boolean optional | If 'true', then NFSv4.0 Migration feature is enabled. Default value is 'false'.
> is-nfsv40-read-delegation-enabled |  | boolean optional | If 'true', NFSv4.0 read delegation feature is enabled. Default value is 'false'.
> is-nfsv40-referrals-enabled |  | boolean optional | If 'true', then NFSv4.0 Referrals feature is enabled. Default value is 'false'.
> is-nfsv40-req-open-confirm-enabled |  | boolean optional | If 'true', then the server will require an OPEN_CONFIRM operation for all NFSv4.0 clients. Default value is 'false'.
> is-nfsv40-write-delegation-enabled |  | boolean optional | If 'true', NFSv4.0 write delegation feature is enabled. Default value is 'false'.
> is-nfsv41-acl-enabled |  | boolean optional | If 'true', then NFSv4.1 ACL feature is enabled. Default value is 'false'.
> is-nfsv41-acl-preserve-enabled |  | boolean optional | If 'true', the NFSv4 server will preserve and modify ACL when chmod is done. Default value is 'true'.
> is-nfsv41-enabled |  | boolean optional | If 'true', then NFS version 4.1 is enabled. Default value is 'false'.
> is-nfsv41-migration-enabled |  | boolean optional | If 'true', then NFSv4.1 Migration feature is enabled. Default value is 'false'.
> is-nfsv41-pnfs-enabled |  | boolean optional | If 'true', then Parallel NFS support for NFS version 4.1 is enabled. Default value is 'true'.
> is-nfsv41-pnfs-striped-volumes-enabled |  | boolean optional | If 'true', Striped volume support for Parallel NFS is enabled . Default value is 'false'.
> is-nfsv41-read-delegation-enabled |  | boolean optional | If 'true', NFSv4.1 read delegation feature is enabled. Default value is 'false'.
> is-nfsv41-referrals-enabled |  | boolean optional | If 'true', then NFSv4.1 Referrals feature is enabled. Default value is 'false'.
> is-nfsv41-state-protection-enabled |  | boolean optional | If 'true', then NFSv4.1 State Protection is enabled. Default value is 'true'.
> is-nfsv41-write-delegation-enabled |  | boolean optional | If 'true', NFSv4.1 write delegation feature is enabled. Default value is 'false'.
> is-validate-qtree-export-enabled |  | boolean optional | If 'true', then the Vserver performs additional validation for qtree. Default value is 'true'.
> is-vstorage-enabled |  | boolean optional | If 'true', then enables the usage of vStorage protocol for server side copies, which is mostly used in hypervisors. Default value is 'false'.
> nfsv4-acl-max-aces | [192..1024] | integer optional | Maximum Number of ACEs allowed in an ACL. Range is 192 to 1024. Default value is 400.
> nfsv4-grace-seconds | [0..2^32-1] | integer optional | NFSv4 Grace timeout value in seconds. Default value is 45 seconds.
> nfsv4-id-domain |  | string optional | NFSv4 ID mapping domain. Default value is 'defaultv4iddomain.com'.
> nfsv4-lease-seconds | [0..2^32-1] | integer optional | NFSv4 Lease timeout value in seconds. Default value is 30 seconds.
> nfsv41-implementation-id-domain |  | string optional | NFSv4.1 Implementation id domain. Default value is 'defaultv41impliddomain.com'.
> nfsv41-implementation-id-name |  | string optional | NFSv4.1 Implementation id name. Default value is 'defaultv41implidname'.
> nfsv41-implementation-id-time |  | date optional | NFSv4.1 Implementation id time.The number of seconds since January 1, 1970.
> nfsv4x-session-num-slots | [1..2000] | integer optional | Number of Slots in the NFSv4.x Session Slot Tables. Default value is 180.
> nfsv4x-session-slot-reply-cache-size | [512..4096] | integer optional | Size of the Reply that will be Cached in Each NFSv4.x Session Slot (in bytes). Default value is 640.
> ntfs-unix-security-ops |  | string optional | Ignore/Fail unix security operations on NTFS volumes. Possible values are 'ignore', 'fail','use_export_policy'. If 'use_export_policy' is set, export policy option is used. Default value is 'use_export_policy'.
> rpcsec-ctx-high | [0..2^32-1] | integer optional | High water mark for the RPCSEC_GSS Context Cache. Default value is 0.
> rpcsec-ctx-idle | [0..2^32-1] | integer optional | Time in seconds before an idle entry in RPCSEC_GSS context cache is deleted. Default value is 0.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |

nfs-status | [top]

> Returns the status of the NFS server.

> Output Name | Range | Type | Description
> is-drained |  | boolean | If true, then the NFS server has been disabled and all NFS messages have been drained. In Data ONTAP Cluster-Mode, there is no way of finding out if the NFS messages have been drained. Hence this field will always be false.
> is-enabled |  | boolean | True if NFS server is running.

> Errno | Description
> EINTERNALERROR |  |
> EVSERVERNOTFOUND |  |

> Vfiler-enabled
> Yes

> License
> nfs

Element definition: date | [top]

> Date (in seconds since Jan. 1, 1970 12:00:00) Range : [0..2^31-1].

> [none]

Element definition: exports-rule-info | [top]

> Information necessary to create a new rule in the etc/exports file or for just adding a rule similar to the exportfs command. ORDER MATTERS for the hostnames in 'read-only' and 'read-write' privileges. Please see documentation for exportfs command or etc/exports file for complete details.

> Name | Range | Type | Description
> actual-pathname |  | string optional | In Data ONTAP 7-Mode, it must be pathname inside of the filer which is being exported. The default for this is value in 'pathname'. In Data ONTAP Cluster-Mode, this value must be an empty string.
> anon |  | string optional | All hosts with this user-id or username have root access to this directory.
> nosuid |  | boolean optional | If true, causes the server file system to silently ignore any attempt to enable the setuid or setgid mode bits. Default value is false.
> pathname |  | string | In Data ONTAP 7-Mode, it must be directory name or file to export. In Data ONTAP Cluster-Mode, it must be the path of the volume or qtree to be exported such as "vol/vol0" or "/vol/vol0/qtree0".
> read-only |  | exports-hostname-info[] optional | An array of hostnames which only have read privileges.
> read-write |  | exports-hostname-info[] optional | An array of hostnames which have read and write privileges. Any hostname in read-only must not be in read-write also. By default, if no 'read-only' or 'read-write' hosts are given, then 'read-write' contains a hostname of 'all-hosts'.
> root |  | exports-hostname-info[] optional | Array of hostnames which have roots with 'read-write' or 'read-only' privileges.
> sec-flavor |  | sec-flavor-info[] optional | List of possible security flavors this rule supports. Default security is "sys". In Data ONTAP Cluster-Mode, all the security flavors supported by 7-Mode are not supported. Hence the security flavors supported in both the ONTAP versions [for reference: 'none','sys','krb5'] will be considered valid.

Element definition: exports-rule-info-2 | [top]

> Information necessary to create a new rule in the etc/exports file or for just adding a rule similar to the exportfs command.

> Name | Range | Type | Description
> actual-pathname |  | string optional | In Data ONTAP 7-Mode, it must be pathname inside of the filer which is being exported. The default for this is value in 'pathname'. In Data ONTAP Cluster-Mode, this value must be an empty string.
> pathname |  | string | In Data ONTAP 7-Mode, it must be directory name or file to export. In Data ONTAP Cluster-Mode, it must be the path of the volume or qtree to be exported such as "vol/vol0" or "/vol/vol0/qtree0".
> security-rules |  | security-rule-info[] | Access block information for lists of hosts.

Element definition: nfs-info | [top]

> Information about NFS server configuration When returned as part of the output, all elements of this typedef are reported, unless limited by a set of desired attributes specified by the caller. When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.

> Name | Range | Type | Description
> chown-mode |  | nfschownmode optional | Vserver Change Ownership Mode. Possible values are 'ignore', 'fail', 'use_export_policy'. If 'use_export_policy' is set, export policy option is used. Default value is 'use_export_policy'. Attributes: optional-for-create, modifiable Possible values: "restricted" , "unrestricted" , "use_export_policy"
> default-windows-group |  | string optional | The default windows group for CIFS access. Attributes: optional-for-create, modifiable
> default-windows-user |  | string optional | The default windows user for CIFS access. Attributes: optional-for-create, modifiable
> enable-ejukebox |  | boolean optional | If 'true', then the NFS server will send EJUKEBOX error on server delays. Attributes: optional-for-create, modifiable
> is-mount-rootonly-enabled |  | boolean optional | If 'true', then the vserver allows MOUNT protocol calls only from privileged ports (port numbers less than 1024). Default value is 'true'. Attributes: optional-for-create, modifiable
> is-nfs-access-enabled |  | boolean optional | If 'true',then NFS server access is enabled. Default value is 'true'. Attributes: optional-for-create, modifiable
> is-nfs-rootonly-enabled |  | boolean optional | If 'true', then the vserver allows NFS protocol calls only from privileged ports (port numbers less than 1024). Default value is 'false'. Attributes: optional-for-create, modifiable
> is-nfsv2-enabled |  | boolean optional | Starting Data ONTAP 8.2, NFS v2 is no longer supported. Default value is 'false'. Attributes: optional-for-create, modifiable
> is-nfsv3-connection-drop-enabled |  | boolean optional | If 'true', then connection is dropped when an NFSv3 request is dropped. Default value is 'true'. Attributes: optional-for-create, modifiable
> is-nfsv3-enabled |  | boolean optional | If 'true', then NFS version 3 is enabled. Default value is 'true'. Attributes: optional-for-create, modifiable
> is-nfsv3-fsid-change-enabled |  | boolean optional | If 'true', then NFSv3 clients see change in FSID as they traverse filesystems. Default value is 'true'. Attributes: optional-for-create, modifiable
> is-nfsv4-fsid-change-enabled |  | boolean optional | If 'true', then clients see change in FSID as NFSv4 clients traverse filesystems. Default value is 'true'. Attributes: optional-for-create, modifiable
> is-nfsv4-numeric-ids-enabled |  | boolean optional | If 'true', then NFSv4 support for Numeric Owner IDs is enabled. Default value is 'true'. Attributes: optional-for-create, modifiable
> is-nfsv40-acl-enabled |  | boolean optional | If 'true', then NFSv4.0 ACL feature is enabled. Default value is 'false'. Attributes: optional-for-create, modifiable
> is-nfsv40-enabled |  | boolean optional | If 'true', then NFS version 4.0 is enabled. Default value is 'false'. Attributes: optional-for-create, modifiable
> is-nfsv40-migration-enabled |  | boolean optional | If 'true', then NFSv4.0 Migration feature is enabled. Default value is 'false'. Attributes: optional-for-create, modifiable
> is-nfsv40-read-delegation-enabled |  | boolean optional | If 'true', NFSv4.0 read delegation feature is enabled. Default value is 'false'. Attributes: optional-for-create, modifiable
> is-nfsv40-referrals-enabled |  | boolean optional | If 'true', then NFSv4.0 Referrals feature is enabled. Default value is 'false'. Attributes: optional-for-create, modifiable
> is-nfsv40-req-open-confirm-enabled |  | boolean optional | If 'true', then the server will require an OPEN_CONFIRM operation for all NFSv4.0 clients. Default value is 'false'. Attributes: optional-for-create, modifiable
> is-nfsv40-write-delegation-enabled |  | boolean optional | If 'true', NFSv4.0 write delegation feature is enabled. Default value is 'false'. Attributes: optional-for-create, modifiable
> is-nfsv41-acl-enabled |  | boolean optional | If 'true', then NFSv4.1 ACL feature is enabled. Default value is 'false'. Attributes: optional-for-create, modifiable
> is-nfsv41-acl-preserve-enabled |  | boolean optional | If 'true', the NFSv4 server will preserve and modify ACL when chmod is done. Default value is 'true'. Attributes: optional-for-create, modifiable
> is-nfsv41-enabled |  | boolean optional | If 'true', then NFS version 4.1 is enabled. Default value is 'false'. Attributes: optional-for-create, modifiable
> is-nfsv41-migration-enabled |  | boolean optional | If 'true', then NFSv4.1 Migration feature is enabled. Default value is 'false'. Attributes: optional-for-create, modifiable
> is-nfsv41-pnfs-enabled |  | boolean optional | If 'true', then Parallel NFS support for NFS version 4.1 is enabled. Default value is 'true'. Attributes: optional-for-create, modifiable
> is-nfsv41-pnfs-striped-volumes-enabled |  | boolean optional | If 'true', Striped volume support for Parallel NFS is enabled . Default value is 'false'. Attributes: optional-for-create, modifiable
> is-nfsv41-read-delegation-enabled |  | boolean optional | If 'true', NFSv4.1 read delegation feature is enabled. Default value is 'false'. Attributes: optional-for-create, modifiable
> is-nfsv41-referrals-enabled |  | boolean optional | If 'true', then NFSv4.1 Referrals feature is enabled. Default value is 'false'. Attributes: optional-for-create, modifiable
> is-nfsv41-state-protection-enabled |  | boolean optional | If 'true', then NFSv4.1 State Protection is enabled. Default value is 'true'. Attributes: optional-for-create, modifiable
> is-nfsv41-write-delegation-enabled |  | boolean optional | If 'true', NFSv4.1 write delegation feature is enabled. Default value is 'false'. Attributes: optional-for-create, modifiable
> is-qtree-export-enabled |  | boolean optional | If 'true', then the Vserver allows qtree exports (read-only). Default value is 'false'. Attributes: non-creatable, non-modifiable
> is-validate-qtree-export-enabled |  | boolean optional | If 'true', then the Vserver performs additional validation for qtree. Default value is 'true'. Attributes: optional-for-create, modifiable
> is-vstorage-enabled |  | boolean optional | If 'true', then enables the usage of vStorage protocol for server side copies, which is mostly used in hypervisors. Default value is 'false'. Attributes: optional-for-create, modifiable
> nfsv4-acl-max-aces | [192..1024] | integer optional | Maximum Number of ACEs allowed in an ACL. Range is 192 to 1024. Default value is 400. Attributes: optional-for-create, modifiable
> nfsv4-grace-seconds | [0..2^32-1] | integer optional | NFSv4 Grace timeout value in seconds. Default value is 45 seconds. Attributes: optional-for-create, modifiable
> nfsv4-id-domain |  | string optional | NFSv4 ID mapping domain. Default value is 'defaultv4iddomain.com'. Attributes: optional-for-create, modifiable
> nfsv4-lease-seconds | [0..2^32-1] | integer optional | NFSv4 Lease timeout value in seconds. Default value is 30 seconds. Attributes: optional-for-create, modifiable
> nfsv41-implementation-id-domain |  | string optional | NFSv4.1 Implementation id domain. Default value is 'defaultv41impliddomain.com'. Attributes: optional-for-create, modifiable
> nfsv41-implementation-id-name |  | string optional | NFSv4.1 Implementation id name. Default value is 'defaultv41implidname'. Attributes: optional-for-create, modifiable
> nfsv41-implementation-id-time |  | date optional | NFSv4.1 Implementation id time.The number of seconds since January 1, 1970. Attributes: optional-for-create, modifiable
> nfsv4x-session-num-slots | [1..2000] | integer optional | Number of Slots in the NFSv4.x Session Slot Tables. Default value is 180. Attributes: optional-for-create, modifiable
> nfsv4x-session-slot-reply-cache-size | [512..4096] | integer optional | Size of the Reply that will be Cached in Each NFSv4.x Session Slot (in bytes). Default value is 640. Attributes: optional-for-create, modifiable
> ntfs-unix-security-ops |  | string optional | Ignore/Fail unix security operations on NTFS volumes. Possible values are 'ignore', 'fail','use_export_policy'. If 'use_export_policy' is set, export policy option is used. Default value is 'use_export_policy'. Attributes: optional-for-create, modifiable
> rpcsec-ctx-high | [0..2^32-1] | integer optional | High water mark for the RPCSEC_GSS Context Cache. Default value is 0. Attributes: optional-for-create, modifiable
> rpcsec-ctx-idle | [0..2^32-1] | integer optional | Time in seconds before an idle entry in RPCSEC_GSS context cache is deleted. Default value is 0. Attributes: optional-for-create, modifiable
> vserver |  | string optional | Vserver name Attributes: key, non-creatable, non-modifiable

Element definition: nfschownmode | [top]

> restricted|unrestricted|use-export-policy Possible values: "restricted" , "unrestricted" , "use_export_policy"

> [none]

Element definition: pathname-info | [top]

> Information about a pathname.

> Name | Range | Type | Description
> name |  | string | In Data ONTAP 7-Mode, it must be the name of the path, such as "/vol/vol0". In Data ONTAP Cluster-Mode, it must be the path of the volume or qtree to be exported such as "vol/vol0" or "/vol/vol0/qtree0".

Element definition: sec-flavor-info | [top]

> Sec flavor info

> Name | Range | Type | Description
> flavor |  | string optional | Security_Flavor Attributes: key, non-creatable, non-modifiable

Element definition: date | [top]

> Date (in seconds since Jan. 1, 1970 12:00:00) Range : [0..2^31-1].

> [none]

Element definition: exports-hostname-info | [top]

> Structure containing information pertaining to a host.

> Name | Range | Type | Description
> all-hosts |  | boolean optional | Default value is false. If true, enables all hosts to have this rule's access rights. A hostname of 'all-hosts' must exist as the only non-negated element in a hostname array.
> name |  | string optional | A hostname can be ONE of the following formats. If 'all-hosts' is true, 'name' must not have a value. machine-name: Alphanumeric string based on DNS. netgroup: Alphanumeric string describing a group of machine names ip: An IP address in dotted decimal format AAA.BBB.CCC.DDD subnet: "[network] subnet [netmask] netmask" ip-subnet: IP/numbits. The IP is a subnet number and the numbits specifies the size of the subnet by the number of leading bits of the netmask. dns: A DNS domain. An Alphanumeric starting with a '.'
> negate |  | boolean optional | In Data ONTAP 7-Mode, default is false. If true, the rule applies to every host but this one. Used most commonly when adding a group minus a few hosts. In Data ONTAP Cluster-Mode, negations are not supported. An error will be returned if true.

Element definition: security-rule-info | [top]

> Information on hostnames and security availability for the hosts. ORDER MATTERS for the hostnames in 'read-only' and 'read-write' privileges. Please see documentation for exportfs command or etc/exports file for complete details.

> Name | Range | Type | Description
> anon |  | string optional | All hosts with this user-id or username have root access to this directory.
> nosuid |  | boolean optional | If true, causes the server file system to silently ignore any attempt to enable the setuid or setgid mode bits. Default value is false.
> read-only |  | exports-hostname-info[] optional | An array of hostnames which only have read privileges for all the security flavors found in the sec-flavor list.
> read-write |  | exports-hostname-info[] optional | An array of hostnames which have read and write privileges for all the security flavors found in the 'sec-flavor list'. Any hostname in 'read-only' must not be in 'read-write' also. By default, if no 'read-only' or 'read-write' hosts are given, then 'read-write' contains a hostname of 'all-hosts'.
> root |  | exports-hostname-info[] optional | Array of hostnames which have roots with 'read-write' or 'read-only' privileges.
> sec-flavor |  | sec-flavor-info[] optional | List of possible security flavors this rule supports. Default security is "sys". In Data ONTAP Cluster-Mode, all the security flavors supported by 7-Mode are not supported. Hence the security flavors supported in both the ONTAP versions [for reference: 'none','sys','krb5'] will be considered valid.

Element definition: exports-hostname-info | [top]

> Structure containing information pertaining to a host.

> Name | Range | Type | Description
> all-hosts |  | boolean optional | Default value is false. If true, enables all hosts to have this rule's access rights. A hostname of 'all-hosts' must exist as the only non-negated element in a hostname array.
> name |  | string optional | A hostname can be ONE of the following formats. If 'all-hosts' is true, 'name' must not have a value. machine-name: Alphanumeric string based on DNS. netgroup: Alphanumeric string describing a group of machine names ip: An IP address in dotted decimal format AAA.BBB.CCC.DDD subnet: "[network] subnet [netmask] netmask" ip-subnet: IP/numbits. The IP is a subnet number and the numbits specifies the size of the subnet by the number of leading bits of the netmask. dns: A DNS domain. An Alphanumeric starting with a '.'
> negate |  | boolean optional | In Data ONTAP 7-Mode, default is false. If true, the rule applies to every host but this one. Used most commonly when adding a group minus a few hosts. In Data ONTAP Cluster-Mode, negations are not supported. An error will be returned if true.

Element definition: sec-flavor-info | [top]

> Sec flavor info

> Name | Range | Type | Description
> flavor |  | string optional | Security_Flavor Attributes: key, non-creatable, non-modifiable