APIs in Category: nfs | 7-Mode 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-fence-disable nfs-exportfs-fence-enable nfs-exportfs-flush-cache nfs-exportfs-list-rules nfs-exportfs-list-rules-2 nfs-exportfs-load-exports nfs-exportfs-modify-rule nfs-exportfs-modify-rule-2 nfs-exportfs-storage-path nfs-get-supported-sec-flavors nfs-monitor-add nfs-monitor-list nfs-monitor-reclaim nfs-monitor-remove nfs-monitor-remove-locks nfs-stats-get-client-stats nfs-stats-top-clients-list-iter-end nfs-stats-top-clients-list-iter-next nfs-stats-top-clients-list-iter-start nfs-stats-zero-stats 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 pathname for a volume must be specified using the junction path ("/junction"). The pathname for a qtree must be specified using the qtree path ("/vol/vol0/qtree0").
> 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-fence-disable | [top]

> Disables fencing to the given exports for the given entry. This means that the entry will have write permission to the exports. The rule changes take effect immediately. Set the persistent option to true to save the rule in the /etc/exports file and keep the option persistent upon loading or reboot.

> Input Name | Range | Type | Description
> all-pathnames |  | boolean optional | Default value is false. Set to true to unfence all rules. 'fenced-paths' option must be left empty if this option is true.
> fenced-hosts |  | exports-hostname-info[] | An array of hostnames which are to be fenced off.
> fenced-paths |  | pathname-info[] optional | An array of paths which are to be fenced off.
> persistent |  | boolean optional | 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.) If false, only change the exports in memory.
> remove-locks |  | boolean optional | Default value is false. Set to true to reclaim locks of the specified fenced-hosts.

> Errno | Description
> EINTERNALERROR |  |

> Vfiler-enabled
> Yes

> License
> nfs

nfs-exportfs-fence-enable | [top]

> Enables fencing to the given exports for the given entry. This means that the entry will not have write permission to the exports. The rule changes take effect immediately. Set the persistent option to true to save the rule in the /etc/exports file and keep the option persistent upon loading or reboot.

> Input Name | Range | Type | Description
> all-pathnames |  | boolean optional | Default value is false. Set to true to fence all rules. 'fenced-paths' option must be left empty if this option is true.
> fenced-hosts |  | exports-hostname-info[] | An array of hostnames which are to be fenced off.
> fenced-paths |  | pathname-info[] optional | An array of paths which are to be fenced off.
> persistent |  | boolean optional | 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.) If false, only change the exports in memory.

> Errno | Description
> EINTERNALERROR |  |

> Vfiler-enabled
> Yes

> License
> nfs

nfs-exportfs-flush-cache | [top]

> For the given path, renew or flush the access cache.

> Input Name | Range | Type | Description
> pathname |  | string optional | Pathname to flush. If this input is not provided, all of the paths in the exports table are flushed.

> Errno | Description
> EINTERNALERROR |  |

> 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-load-exports | [top]

> Loads the etc/exports file into memory. Replaces exports rules already residing in memory.

> Input Name | Range | Type | Description
> persistent-only |  | boolean optional | Default value is false. If true, atomically reloads each rule from the exports file and unloads all other rules.

> Errno | Description
> EINTERNALERROR |  |

> 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-exportfs-storage-path | [top]

> For the given path, determine the actual storage path. Returns an error if the path does not exist.

> Input Name | Range | Type | Description
> pathname |  | string | Virtual pathname which has a rule associated with an actual pathname.
> Output Name | Range | Type | Description
> actual-pathname |  | string | True path name on the filer, which uses a virtual path for interfacing with the NFS.

> Errno | Description
> EINTERNALERROR |  |

> Vfiler-enabled
> Yes

> License
> nfs

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-monitor-add | [top]

> starts monitoring the specified hosts for NFS lock recovery purposes. The specified hosts are added to the list of of clients that will be notified of lock recovery in the event of an NFS server crash/reboot. For more information, see the sm_mon(1a) manual page.

> Input Name | Range | Type | Description
> hosts |  | hostaddr[] | an array of hosts that are to be monitored.

> Errno | Description
> EINTERNALERROR |  |

> Vfiler-enabled
> Yes

> License
> nfs

nfs-monitor-list | [top]

> Lists the hosts that are currently being monitored by the NFS status monitor.

> Output Name | Range | Type | Description
> hosts |  | hostaddr[] | an array of hosts that are currently being monitored.

> Errno | Description
> EINTERNALERROR |  |

> Vfiler-enabled
> Yes

> License
> nfs

nfs-monitor-reclaim | [top]

> reclaims the NFS locks for the specified client hosts. If no hosts are specified, then all the clients locks are removed and are notified about lock recovery, as if an NFS server crash/reboot had happened. If any hosts are specified, then only those client hosts locks are reclaimed For more information, see the sm_mon(1a) manual page.

> Input Name | Range | Type | Description
> hosts |  | hostaddr[] optional | hosts whose locks have to be reclaimed. If no hosts are specified, then all the clients locks are reclaimed.

> Errno | Description
> EINTERNALERROR |  |

> Vfiler-enabled
> Yes

> License
> nfs

nfs-monitor-remove | [top]

> Starts unmonitoring the specified hosts for NFS lock recovery purposes. The specified hosts are removed from the list of clients that will be notified of lock recovery in the event of an NFS server crash/reboot. For more information, see the sm_mon(1a) manual page.

> Input Name | Range | Type | Description
> hosts |  | hostaddr[] | an array of hosts that are to be unmonitored.

> Errno | Description
> EINTERNALERROR |  |

> Vfiler-enabled
> Yes

> License
> nfs

nfs-monitor-remove-locks | [top]

> removes the NFS locks of a specfied process of a specified client host.

> Input Name | Range | Type | Description
> owners |  | owner-info[] | List of owners whose locks have to be deleted.

> Errno | Description
> EINTERNALERROR |  |

> Vfiler-enabled
> Yes

> License
> nfs

nfs-stats-get-client-stats | [top]

> Collects NFS statistics for a specified client

> Input Name | Range | Type | Description
> host |  | string | Hostname or IP address of client
> Output Name | Range | Type | Description
> client-info |  | string | Hostname or IP address of client
> nfs-stats |  | nfs-stats-info | detailed statistics for each NFS operation
> rpc-stats |  | rpc-stats-info | detailed statistics for RPC operations
> tcp-flowcontrol-stats |  | tcp-flowcontrol-stats-info | detailed statistics for TCP flowcontrol

> Errno | Description
> ENFS_CLIENT_STATS_NOT_ENABLED |  |
> ENOACTIVECLIENTS |  |
> EHOSTNOTFOUND |  |

> Vfiler-enabled
> Yes

> License
> nfs

nfs-stats-top-clients-list-iter-end | [top]

> Terminate NFS client statistics iteration and cleanup any saved info.

> Input Name | Range | Type | Description
> tag |  | string | Tag from a previous nfs-stats-top-clients-list-iter-start

> Vfiler-enabled
> Yes

> License
> nfs

nfs-stats-top-clients-list-iter-next | [top]

> Continues the nfs-stats-top-clients-list-iter-start iteration through the top NFS clients, ordered by total NFS operations.

> Input Name | Range | Type | Description
> maximum |  | integer | The maximum number of entries to retrieve. Range : [0..2^32-1].
> tag |  | string | Tag from a previous nfs-stats-top-iter-start
> Output Name | Range | Type | Description
> nfs-top |  | nfs-top-info[] | An array, one entry per nfs top.
> records |  | integer | This tells you how many records are being returned from this particular call to nfs-stats-top-client-list-iter-next When this value is 0, you have retrieved everything. Range : [0..2^32-1].

> Vfiler-enabled
> Yes

> License
> nfs

nfs-stats-top-clients-list-iter-start | [top]

> Starts an iteration through the top NFS clients, ordered by total NFS operations.

> Input Name | Range | Type | Description
> maxclients |  | integer optional | Specifies the maximum number of top clients to retrieve (the default is 20) Range : [1..2^32-1].
> Output Name | Range | Type | Description
> records |  | integer | Number which tells you how many items have been saved for future retrieval with nfs-stats-top-clients-list-iter-next Range : [0..2^32-1]
> tag |  | string | Tag to be used in subsequent calls to nfs-stats-top-clients-list-iter-next

> Errno | Description
> ENFS_CLIENT_STATS_NOT_ENABLED |  |
> ECLIENTSTATSVFILER |  |
> ENOACTIVECLIENTS |  |
> EAPIERROR |  |
> EINVALIDINPUTERROR |  |

> Vfiler-enabled
> Yes

> License
> nfs

nfs-stats-zero-stats | [top]

> Set all NFS statistcs to zero

> Vfiler-enabled
> Yes

> License
> nfs

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: 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: 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 the pathname for a volume must be specified using the junction path ("/junction"). The pathname for a qtree must be specified using the qtree path ("/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 the pathname for a volume must be specified using the junction path ("/junction"). The pathname for a qtree must be specified using the qtree path ("/vol/vol0/qtree0").
> security-rules |  | security-rule-info[] | Access block information for lists of hosts.

Element definition: hostaddr | [top]

> the individual client hosts. could be a hostname or an IP address.

> [none]

Element definition: nfs-stats-info | [top]

> structure containing statistics for each NFS version

> Name | Range | Type | Description
> badcalls-total |  | integer | total bad NFS calls Range : [0..2^32-1].
> calls-total |  | integer | total NFS calls Range : [0..2^64-1].
> nfsv2-client-stats |  | nfsv2-client-stats-info | detailed statistics for NFSv2 operations
> nfsv3-client-stats |  | nfsv3-client-stats-info | detailed statistics for NFSv3 operations
> nfsv4-client-stats |  | nfsv4-client-stats-info | detailed statistics for NFSv4 operations

Element definition: nfs-top-info | [top]

> Information about a single nfs top.

> Name | Range | Type | Description
> client-info |  | string | Client IP address
> create-ops |  | integer | The number of nfs CREATE operations Range : [0..2^64-1].
> getattr-ops |  | integer | The number of nfs GETATTR operations Range : [0..2^64-1].
> lookup-ops |  | integer | The number of nfs LOOKUP operations Range : [0..2^64-1].
> read-ops |  | integer | The number of nfs READ operations Range : [0..2^64-1].
> readdir-ops |  | integer | The number of nfs READDIR and READIDRPLUS operations Range : [0..2^64-1].
> readlink-ops |  | integer | The number of nfs READLINK operations Range : [0..2^64-1].
> remove-ops |  | integer | The number of nfs REMOVE operations Range : [0..2^64-1].
> total-ops |  | integer | The number of nfs operations Range : [0..2^64-1].
> write-ops |  | integer | The number of nfs WRITE operations Range : [0..2^64-1].

Element definition: owner-info | [top]

> Information about the client host and the owner process on the client host whose locks have to be removed.

> Name | Range | Type | Description
> client-host |  | string | client host on which the locks have to be removed.
> client-host-pid |  | string | process owner on the above client host whose locks have to be removed.

Element definition: pathname-info | [top]

> pathname info for each file

> Name | Range | Type | Description
> pathname |  | string | pathname of the file. Pathname must be of the format /vol//

Element definition: rpc-stats-info | [top]

> structure containing statistics for RPC operations

> Name | Range | Type | Description
> tcp-info |  | rpc-data-info | detailed statistics for RPC over TCP operations
> udp-info |  | rpc-data-info | detailed statistics for RPC over UDP operations

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

> Security flavor information for RPC. Only hosts connecting using the proper security can access the directory.

> Name | Range | Type | Description
> flavor |  | string | Current possible values can be found using the 'nfs-get-supported-sec-flavors' command. For reference: In Data ONTAP 7-Mode, 'none', 'sys', 'Krb5', 'Krb5i', 'Krb5p' are all supported. In Data ONTAP Cluster-Mode, 'none', 'sys', 'krb5', 'ntlm', 'any', 'never', 'spinauth' are supported.

Element definition: tcp-flowcontrol-stats-info | [top]

> structure containing statistics for tcp flowcontrol

> Name | Range | Type | Description
> receive-out-total |  | integer | total number of times output was flow controlled on receive Range : [0..2^32-1].
> receive-total |  | integer | total number of times input was flow controlled on receive Range : [0..2^32-1].
> transmit-out-total |  | integer | total number of times output was flow controlled on transmit Range : [0..2^32-1].
> transmit-total |  | integer | total number of times input was flow controlled on transmit Range : [0..2^32-1].

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: nfsv2-client-stats-info | [top]

> structure containing statistics for NFSv2 operations

> Name | Range | Type | Description
> create-ops |  | integer | total 'create' NFSv2 operations Range : [0..2^64-1].
> getattr-ops |  | integer | total 'getattr' NFSv2 operation Range : [0..2^64-1].
> link-ops |  | integer | total 'link' NFSv2 operations Range : [0..2^64-1].
> lookup-ops |  | integer | total 'lookup' NFSv2 operations Range : [0..2^64-1].
> mkdir-ops |  | integer | total 'mkdir' NFSv2 operations Range : [0..2^64-1].
> null-ops |  | integer | total 'null' NFSv2 operations Range : [0..2^64-1].
> read-ops |  | integer | total 'read' NFSv2 operations Range : [0..2^64-1].
> readdir-ops |  | integer | total 'readdir' NFSv2 operations Range : [0..2^64-1].
> readlink-ops |  | integer | total 'readlink' NFSv2 operations Range : [0..2^64-1].
> remove-ops |  | integer | total 'remove' NFSv2 operations Range : [0..2^64-1].
> rename-ops |  | integer | total 'rename' NFSv2 operations Range : [0..2^64-1].
> rmdir-ops |  | integer | total 'rmdir' NFSv2 operations Range : [0..2^64-1].
> root-ops |  | integer | total 'root' NFSv2 operations Range : [0..2^64-1].
> setattr-ops |  | integer | total 'setattr' NFSv2 operations Range : [0..2^64-1].
> statfs-ops |  | integer | total 'statfs' NFSv2 operations Range : [0..2^64-1].
> symlink-ops |  | integer | total 'symlink' NFSv2 operations Range : [0..2^64-1].
> wrcache-ops |  | integer | total 'wrcache' NFSv2 operations Range : [0..2^64-1].
> write-ops |  | integer | total 'write' NFSv2 operations Range : [0..2^64-1].

Element definition: nfsv3-client-stats-info | [top]

> structure containing statistics for NFSv3 operations

> Name | Range | Type | Description
> access-ops |  | integer | total 'access' NFSv3 operations Range : [0..2^64-1].
> commit-ops |  | integer | total 'commit' NFSv3 operations Range : [0..2^64-1].
> create-ops |  | integer | total 'create' NFSv3 operations Range : [0..2^64-1].
> fsinfo-ops |  | integer | total 'fsinfo' NFSv3 operations Range : [0..2^64-1].
> fsstat-ops |  | integer | total 'fsstat' NFSv3 operations Range : [0..2^64-1].
> getattr-ops |  | integer | total 'getattr' NFSv3 operations Range : [0..2^64-1].
> link-ops |  | integer | total 'link' NFSv3 operations Range : [0..2^64-1].
> lookup-ops |  | integer | total 'lookup' NFSv3 operations Range : [0..2^64-1].
> mkdir-ops |  | integer | total 'mkdir' NFSv3 operations Range : [0..2^64-1].
> mknod-ops |  | integer | total 'mknod' NFSv3 operations Range : [0..2^64-1].
> null-ops |  | integer | total 'null' NFSv3 operations Range : [0..2^64-1].
> pathconf-ops |  | integer | total 'pathconf' NFSv3 operations Range : [0..2^64-1].
> read-ops |  | integer | total 'read' NFSv3 operations Range : [0..2^64-1].
> readdir-ops |  | integer | total 'readdir' NFSv3 operations Range : [0..2^64-1].
> readdirplus-ops |  | integer | total 'readdirplus' NFSv3 operations Range : [0..2^64-1].
> readlink-ops |  | integer | total 'readlink' NFSv3 operations Range : [0..2^64-1].
> remove-ops |  | integer | total 'remove' NFSv3 operations Range : [0..2^64-1].
> rename-ops |  | integer | total 'rename' NFSv3 operations Range : [0..2^64-1].
> rmdir-ops |  | integer | total 'rmdir' NFSv3 operations Range : [0..2^64-1].
> setattr-ops |  | integer | total 'setattr' NFSv3 operations Range : [0..2^64-1].
> symlink-ops |  | integer | total 'symlink' NFSv3 operations Range : [0..2^64-1].
> write-ops |  | integer | total 'write' NFSv3 operations Range : [0..2^64-1].

Element definition: nfsv4-client-stats-info | [top]

> structure containing statistics for NFSv4 operations

> Name | Range | Type | Description
> access-ops |  | integer optional | total 'access' NFSv4 operations Range : [0..2^64-1].
> acls-set-total |  | integer optional | number of ACLs set on files Range : [0..2^32-1].
> badproc2-ops |  | integer optional | total 'badproc2' NFSv4 operations Range : [0..2^64-1].
> close-ops |  | integer optional | total 'close' NFSv4 operations Range : [0..2^64-1].
> commit-ops |  | integer optional | total 'commit' NFSv4 operations Range : [0..2^64-1].
> compound-ops |  | integer optional | total 'compound' NFSv4 operations Range : [0..2^64-1].
> create-ops |  | integer optional | total 'create' NFSv4 operations Range : [0..2^64-1].
> delegpurge |  | integer optional | total 'delegpurge' NFSv4 operations Range : [0..2^64-1].
> delegret-ops |  | integer optional | total 'delegret' NFSv4 operations Range : [0..2^64-1].
> getattr-ops |  | integer optional | total 'getattr' NFSv4 operations Range : [0..2^64-1].
> getfh-ops |  | integer optional | total 'getfh' NFSv4 operations Range : [0..2^64-1].
> link-ops |  | integer optional | total 'link' NFSv4 operations Range : [0..2^64-1].
> lock-ops |  | integer optional | total 'lock' NFSv4 operations Range : [0..2^64-1].
> lockt-ops |  | integer optional | total 'lockt' NFSv4 operations Range : [0..2^64-1].
> locku-ops |  | integer optional | total 'locku' NFSv4 operations Range : [0..2^64-1].
> lookup-ops |  | integer optional | total 'lookup' NFSv4 operations Range : [0..2^64-1].
> lookupp-ops |  | integer optional | total 'lookupp' NFSv4 operations Range : [0..2^64-1].
> no-delegation-total |  | integer optional | total calls where a delegation could not be granted Range : [0..2^32-1].
> null-ops |  | integer optional | total 'null' NFSv4 operations Range : [0..2^64-1].
> nverify-ops |  | integer optional | total 'nverify' NFSv4 operations Range : [0..2^64-1].
> open-confirm-ops |  | integer optional | total 'open_confirm' NFSv4 operations Range : [0..2^64-1].
> open-downgrade-ops |  | integer optional | total 'open_downgrade' NFSv4 operations Range : [0..2^64-1].
> open-ops |  | integer optional | total 'open' NFSv4 operations Range : [0..2^64-1].
> openattr-ops |  | integer optional | total 'openattr' NFSv4 operations Range : [0..2^64-1].
> putfh-ops |  | integer optional | total 'putfh' NFSv4 operations Range : [0..2^64-1].
> putpubfh-ops |  | integer optional | total 'putpubfh' NFSv4 operations Range : [0..2^64-1].
> putrootfh-ops |  | integer optional | total 'putrootfh' NFSv4 operations Range : [0..2^64-1].
> read-delegation-total |  | integer optional | total calls where a read delegation was granted Range : [0..2^32-1].
> read-ops |  | integer optional | total 'read' NFSv4 operations Range : [0..2^64-1].
> readdir-ops |  | integer optional | total 'readdir' NFSv4 operations Range : [0..2^64-1].
> readlink-ops |  | integer optional | total 'readlink' NFSv4 operations Range : [0..2^64-1].
> remove-ops |  | integer optional | total 'remove' NFSv4 operations Range : [0..2^64-1].
> rename-ops |  | integer optional | total 'rename' NFSv4 operations Range : [0..2^64-1].
> renew-ops |  | integer optional | total 'renew' NFSv4 operations Range : [0..2^64-1].
> restorefh-ops |  | integer optional | total 'restorefh' NFSv4 operations Range : [0..2^64-1].
> rlsowner-ops |  | integer optional | total 'rlsowner' NFSv4 operations Range : [0..2^64-1].
> savefh-ops |  | integer optional | total 'savefh' NFSv4 operations Range : [0..2^64-1].
> secinfo-ops |  | integer optional | total 'secinfo' NFSv4 operations Range : [0..2^64-1].
> setattr-ops |  | integer optional | total 'setattr' NFSv4 operations Range : [0..2^64-1].
> setclntid-cfm-ops |  | integer optional | total 'setclntid_cfm' NFSv4 operations Range : [0..2^64-1].
> setclntid-ops |  | integer optional | total 'setclntid' NFSv4 operations Range : [0..2^64-1].
> verify-ops |  | integer optional | total 'verify' NFSv4 operations Range : [0..2^64-1].
> write-delegation-total |  | integer optional | total calls where a write delegation was granted Range : [0..2^32-1].
> write-ops |  | integer optional | total 'write' NFSv4 operations Range : [0..2^64-1].

Element definition: rpc-data-info | [top]

> structure containing statisticcs for RPC operations

> Name | Range | Type | Description
> badcalls-total |  | integer | total bad RPC calls Range : [0..2^32-1].
> badlen-total |  | integer | total badlen RPC calls Range : [0..2^32-1].
> calls-total |  | integer | total RPC calls Range : [0..2^64-1].
> nullrecv-total |  | integer | total nullrecv RPC calls Range : [0..2^32-1].
> xdrcall-total |  | integer | total badhdr RPC calls Range : [0..2^32-1].

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]

> Security flavor information for RPC. Only hosts connecting using the proper security can access the directory.

> Name | Range | Type | Description
> flavor |  | string | Current possible values can be found using the 'nfs-get-supported-sec-flavors' command. For reference: In Data ONTAP 7-Mode, 'none', 'sys', 'Krb5', 'Krb5i', 'Krb5p' are all supported. In Data ONTAP Cluster-Mode, 'none', 'sys', 'krb5', 'ntlm', 'any', 'never', 'spinauth' are supported.