APIs in Category: vfiler | API version 1.2

vfiler-add-ipaddress vfiler-add-storage vfiler-allow-protocol vfiler-create vfiler-destroy vfiler-disallow-protocol vfiler-get-allowed-protocols vfiler-get-disallowed-protocols vfiler-get-status vfiler-list-info vfiler-remove-ipaddress vfiler-remove-storage vfiler-start vfiler-stop

NetApp Manage ONTAP

vfiler-add-ipaddress | [top]

> Add an ipaddress to a vfiler

> Input Name | Range | Type | Description
> ipaddress |  | string | Ipaddress to be added, in dotted-decimal format (for example, "192.168.11.12").
> vfiler |  | string | Name of the vfiler.

> Errno | Description
> EVFILERNOTFOUND |  |
> EVFILEROPNOTALLOWED |  |

> License
> vfiler

vfiler-add-storage | [top]

> Add a storage unit to a vfiler

> Input Name | Range | Type | Description
> storage-path |  | string | Storage-path to be added, in the form "/vol/<volume>/..."
> vfiler |  | string | Name of the vfiler.

> Errno | Description
> EVFILERNOTFOUND |  |
> EVFILEROPNOTALLOWED |  |

> License
> vfiler

vfiler-allow-protocol | [top]

> Allow a protocol on a specified vfiler

> Input Name | Range | Type | Description
> protocol |  | string | Name of the protocol to be allowed. Possible values are: nfs, cifs, rsh.
> vfiler |  | string | Name of the vfiler.

> Errno | Description
> EVFILERNOTFOUND |  |
> EVFILEROPNOTALLOWED |  |

> License
> vfiler

vfiler-create | [top]

> Create a new vfiler. The inputs specify a list of storage units, which are qtree or volume paths.

> Input Name | Range | Type | Description
> ip-addresses |  | ip-address[] |
> ipspace |  | string optional | Name of the ipspace.
> storage-units |  | storage-unit[] |
> vfiler |  | string | Name of the vfiler.

> Errno | Description
> EVFILERNOTFOUND |  |
> EVFILEROPNOTALLOWED |  |

vfiler-destroy | [top]

> Destroy a vfiler

> Input Name | Range | Type | Description
> vfiler |  | string | Name of the vfiler.

> Errno | Description
> EVFILERNOTFOUND |  |
> EVFILEROPNOTALLOWED |  |

> License
> vfiler

vfiler-disallow-protocol | [top]

> Disallow a protocol on a specified vfiler

> Input Name | Range | Type | Description
> protocol |  | string | Name of the protocol to be disallowed. Possible values are: nfs, cifs, rsh.
> vfiler |  | string | Name of the vfiler.

> Errno | Description
> EVFILERNOTFOUND |  |
> EVFILEROPNOTALLOWED |  |

> License
> vfiler

vfiler-get-allowed-protocols | [top]

> Get the protocols allowed for a vfiler

> Input Name | Range | Type | Description
> vfiler |  | string | Name of the vfiler.
> Output Name | Range | Type | Description
> allowed-protocols |  | protocol-info[] | This contains a list of all allowed protocols for this vfiler.

> Errno | Description
> EVFILERNOTFOUND |  |
> EVFILEROPNOTALLOWED |  |

> License
> vfiler

vfiler-get-disallowed-protocols | [top]

> Get the protocols disallowed for a vfiler

> Input Name | Range | Type | Description
> vfiler |  | string | Name of the vfiler.
> Output Name | Range | Type | Description
> disallowed-protocols |  | protocol-info[] | This contains a list of all disallowed protocols for this vfiler.

> Errno | Description
> EVFILERNOTFOUND |  |
> EVFILEROPNOTALLOWED |  |

> License
> vfiler

vfiler-get-status | [top]

> Get the status of a vfiler

> Input Name | Range | Type | Description
> vfiler |  | string | Name of the vfiler.
> Output Name | Range | Type | Description
> status |  | string | Status of the vfiler. Possible values: running, stopped, inconsistent or defunct.

> Errno | Description
> EVFILERNOTFOUND |  |
> EVFILEROPNOTALLOWED |  |

> License
> vfiler

vfiler-list-info | [top]

> Retrieve information about all vfilers. An optional vfiler parameter lets you retrive information about a single vfiler.

> Input Name | Range | Type | Description
> vfiler |  | string optional | Name of the vfiler whose information you want to retrieve. If this parameter is not provided, information about all vfilers will be returned.
> Output Name | Range | Type | Description
> vfilers |  | vfiler-info[] | This contains a list of all the vfilers.

> Errno | Description
> EVFILERNOTFOUND |  |
> EVFILEROPNOTALLOWED |  |

> License
> vfiler

vfiler-remove-ipaddress | [top]

> Remove an ipaddress from a vfiler

> Input Name | Range | Type | Description
> ipaddress |  | string | Ipaddress to be removed, in dotted-decimal format (for example, "192.168.11.12").
> vfiler |  | string | Name of the vfiler.

> Errno | Description
> EVFILERNOTFOUND |  |
> EVFILEROPNOTALLOWED |  |

> License
> vfiler

vfiler-remove-storage | [top]

> Remove a storage unit from a vfiler

> Input Name | Range | Type | Description
> storage-path |  | string | Storage-path to be removed, in the form "/vol/<volume>/..."
> vfiler |  | string | Name of the vfiler.

> Errno | Description
> EVFILERNOTFOUND |  |
> EVFILEROPNOTALLOWED |  |

> License
> vfiler

vfiler-start | [top]

> Start a stopped vfiler. This operation is synchronous.

> Input Name | Range | Type | Description
> vfiler |  | string | Name of the vfiler.

> Errno | Description
> EVFILERNOTFOUND |  |
> EVFILEROPNOTALLOWED |  |

vfiler-stop | [top]

> Stop a started vfiler

> Input Name | Range | Type | Description
> vfiler |  | string | Name of the vfiler.

> Errno | Description
> EVFILERNOTFOUND |  |
> EVFILEROPNOTALLOWED |  |

Element definition: ip-address | [top]

> One ip address, in dotted-decimal format (for example, "192.168.11.12").

> [none]

Element definition: protocol-info | [top]

> This is information about one protocol

> Name | Range | Type | Description
> protocol |  | string | Name of a disallowed protocol

Element definition: storage-unit | [top]

> one storage unit

> [none]

Element definition: vfiler-info | [top]

> Information about one vfiler.

> Name | Range | Type | Description
> ipspace |  | string | Name of the vfiler's ipspace
> name |  | string | Name of the vfiler.
> vfnets |  | vfnet-info[] | List of all networking resources of this vfiler.
> vfstores |  | vfstore-info[] | List of all storage resources of the vfiler.

Element definition: vfnet-info | [top]

> Information about one networking resource.

> Name | Range | Type | Description
> interface |  | string | Name of the interface, which should be something that the "ifconfig" command recognizes, like "e0" or a vif name.
> ipaddress |  | string | IP address of the networking resource

Element definition: vfstore-info | [top]

> Information about one storage resource.

> Name | Range | Type | Description
> is-etc |  | boolean | True if this storage unit is the etcpath, false otherwise.
> path |  | string | Path of the storage resource
> status |  | string | Status of the storage resource. Possible values are: online, offline, inconsistent.