APIs in Category: nfs | API version 1.3

nfs-disable nfs-enable nfs-exportfs-append-rules nfs-exportfs-check-permission nfs-exportfs-delete-rules nfs-exportfs-flush-cache nfs-exportfs-list-rules nfs-exportfs-load-exports nfs-exportfs-modify-rule nfs-exportfs-storage-path nfs-get-supported-sec-flavors nfs-status

NetApp Manage ONTAP

nfs-disable | [top]

> Disables the NFS option. (Effectively the same as the CLI command "nfs off")

> Errno | Description
> EINTERNALERROR |  |

> License
> nfs

nfs-enable | [top]

> Enables the NFS option. (Effectively the same as the CLI command "nfs on")

> Errno | Description
> EINTERNALERROR |  |

> 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. Set the pe3rsistent 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
> 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.)
> 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
> loaded-pathnames |  | pathname-info[] optional | Verbose output of what pathnames were successfully appended Only returned if verbose option is set. Errors are returned via the results field.

> Errno | Description
> EINTERNALERROR |  |

> 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 |  |

> 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. Set the persistent option to modify the etc/exports file and keep this change persistent upon reboots.

> 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 | Pathnames to be deleted from the exports table.
> persistent |  | boolean optional | 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.
> 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 | List of pathnames deleted from the exports table. Only returned if verbose option is set. Errors are returned via the results field.

> Errno | Description
> EINTERNALERROR |  |

> 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 |  |

> License
> nfs

nfs-exportfs-list-rules | [top]

> Returns a list of the directories and their associated rules.

> Input Name | Range | Type | Description
> persistent |  | boolean optional | Default value is false. If true, only list the pathnames that exist in the etc/exports file.
> Output Name | Range | Type | Description
> rules |  | exports-rule-info[] | Array of exports rules loaded in memory or found in the etc/exports file.

> Errno | Description
> EINTERNALERROR |  |

> License
> nfs

nfs-exportfs-load-exports | [top]

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

> Errno | Description
> EINTERNALERROR |  |

> 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 | If true, modify the etc/exports file to modify the rule permanently. Default value is false.
> 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 |  |

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 |  |

> 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 |  |

> License
> nfs

nfs-status | [top]

> Returns true is the NFS server is running.

> Output Name | Range | Type | Description
> is-enabled |  | boolean | True if NFS server is running.

> Errno | Description
> EINTERNALERROR |  |

> License
> nfs

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 | Pathname inside of the filer which is being exported. The default for this is value in 'pathname'.
> 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 | Directory name or file to export.
> 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".

Element definition: pathname-info | [top]

> Information about a pathname.

> Name | Range | Type | Description
> name |  | string | The name of the path, such as "/vol/vol0".

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: 'none', 'sys', 'Krb5', 'Krb5i', 'Krb5p' are all supported.

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 | 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.