|
APIs in Category: vfiler |
API version 1.9 |
vfiler-add-ipaddress |
Vfiler management is done from the physical filer. All the vfiler ZAPIs are available on the physical filer. |
| 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
License vfiler
| 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-dr-activate | [top] |
Stop the remote vfiler and activate the disaster recovery vfiler on the local machine.
Input Name Range Type Description remote-vfiler-location vfiler-location
Name of the remote vfiler and the remote filer hosting it
Errno Description EVFILERNOTFOUND
License vfiler
| vfiler-dr-configure | [top] |
Create a new vfiler disaster recovery relationship. The inputs specify the information for the remote vfiler/filer to connect to and configuration information for the vfiler to use upon activation.
Input Name Range Type Description DNS-server-ipaddrs ip-address[]
optional
ip-addresses of the DNS servers the vfiler should use NIS-server-ipaddrs ip-address[]
optional
ip-addresses of the NIS servers the vfiler should use alternate-src-dst hostname-pair
optional
Alternate hostnames or IP addresses for redundancy purposes ipaddrs ipaddr-info[]
Contains a list of all the IP address (and associated information) which should be bound to the vfiler at the destination is-synchronous boolean
Set true to use synchronous snapmirror remote-authentication-info authentication-info
Login name and password to use on the remote filer remote-vfiler-location vfiler-location
Name of the remote vfiler and the remote filer hosting it use-secure-command-channel boolean
optional
Set true to use the secure command channel while communicating with remote filer. Default is false.
Errno Description EVFILERNOTFOUND
License vfiler
| vfiler-dr-delete | [top] |
delete the vfiler disaster recovery relationship on this machine.
Input Name Range Type Description is-forced boolean
if set it will force the deletion of the vfiler remote-vfiler-location vfiler-location
Name of the remote vfiler and the remote filer hosting it use-secure-command-channel boolean
optional
Set true to use the secure command channel while communicating with remote filer. Default is false.
Errno Description EVFILERNOTFOUND
License vfiler
| vfiler-dr-get-status | [top] |
Get the status of the disaster recovery relationship with the given remote vfiler and filer.
Input Name Range Type Description remote-vfiler-location vfiler-location
Name of the remote vfiler and the remote filer hosting it Output Name Range Type Description dr-status storage-dr-status[]
array with disaster recovery status of each storage entity
Errno Description EVFILERNOTFOUND
License vfiler
| vfiler-dr-resync | [top] |
move a vfiler which has been migrated by vfiler disaster recovery to back to its original filer
Input Name Range Type Description alternate-src-dst hostname-pair
optional
Alternate hostnames or IP addresses for redundancy is-synchronous boolean
Set true to use synchronous snapmirror remote-authentication-info authentication-info
Login name and password to use on the remote filer remote-vfiler-location vfiler-location
Name of the remote vfiler and the remote filer hosting it use-secure-command-channel boolean
optional
Set true to use the secure command channel while communicating with remote filer. Default is false.
Errno Description EVFILERNOTFOUND
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 and this zapi is run on pfiler then, information about all vfilers will be retrieved. This parameter is not provided and if you are running zapi on vfiler then information about that vfiler only will be retrieved. Output Name Range Type Description vfilers vfiler-info[]
This contains a list of all the vfilers.
Errno Description EVFILERNOTFOUND EVFILEROPNOTALLOWED
Vfiler-enabled Yes
License vfiler
| vfiler-migrate | [top] |
Migrate a vfiler on remote filer to this filer. The vfiler facility must be licensed on the remote filer and on the local filer. Other requirements are detailed in the migration-method parameter documentation below. Migration may fail for a number of reasons. For example, the vfiler facility may not be licensed or the vfiler may not be in a state suitable for migration. In these cases EVFILEROPNOTALLOWED will be returned, along with a descriptive reason string.
Input Name Range Type Description force boolean
optional
If this value is true, the vfiler should be migrated even under various conditions which would normally prevent a migration are encountered. See na_vfiler(1) for details. ipaddrs ipaddr-info[]
Contains a list of all the IP address (and associated information) which should be bound to the vfiler at the destination migration-method string
optional
Name of the vfiler migration method. Possible values: snapmirror, nocopy. Defaults to "snapmirror". Snapmirror: SnapMirror must be licensed on the local and remote filer.
Nocopy: SnapMover must be licensed on the local and remote filer. If the force parameter is not set to true, the vfiler will not be migrated if data belonging to belonging to the source vfiler is part of a SnapMirror or SnapVault relationship, if the source filer file system version is not the same as the local file system version, if NFS, CIFS, DAFS, or iSCSI are allowed on the source vfiler but not licensed locally, or if clustering is licensed on the source filer but not licensed locally. The "force" parameter overrides these checks. However, even if the "force" parameter is supplied the vfiler will not be migrated if the source filer's file system version is greater than the local filer's file system version.
password string
encrypted
Administrative password on remote-filer. remote-filer string
Name of the filer on which the vfiler resides. This may also take the form of an IP address. use-secure-command-channel boolean
optional
Set true to use the secure command channel while communicating with remote filer. Default is false. username string
Administrative login name on remote-filer. vfiler string
Name of the vfiler being migrated. There must not be a vfiler with the same name on the local filer. "vfiler0" is not allowed, as the default vfiler may not be migrated.
Errno Description EAPIMISSINGARGUMENT EVFILEROPNOTALLOWED EVFILERNOTFOUND
License vfiler
| vfiler-migrate-cancel | [top] |
cancels the vfiler migration.
Input Name Range Type Description force boolean
optional
If this value is true, the vfiler migration should be canceled even under various conditions which would normally prevent it. Default is FALSE. remote-vfiler-location vfiler-location
Name of the remote vfiler and the remote filer hosting it use-secure-command-channel boolean
optional
Set true to use the secure command channel while communicating with remote filer. Default is false.
Errno Description EVFILERNOTFOUND
License vfiler
| vfiler-migrate-complete | [top] |
Completes the migration by stopping the remote vfiler and activating the vfiler on the local machine. The source vfiler unit will be destroyed after migration is complete.
Input Name Range Type Description force boolean
optional
If this value is true, the vfiler should be migrated even under various conditions which would normally prevent a migration. Default is FALSE. If the force parameter is not set to true and if the vfiler migration is configured with Nocopy option, the vfiler will not be migrated if data belonging to the source vfiler is part of a SnapMirror or SnapVault relationship, if the source filer file system version is not the same as the local file system version, if NFS,CIFS, DAFS, or iSCSI are allowed on the source vfiler but not licensed locally, or if clustering is licensed on the source filer but not licensed locally. The "force" parameter overrides these checks. However, even if the "force" parameter is supplied the vfiler will not be migrated if the source filer's file system version is greater than the local filer's file system version. remote-authentication-info authentication-info
optional
Login name and password to use on the remote filer. Use this option if the password has been changed at the remote filer after configuring migrate start. remote-vfiler-location vfiler-location
Name of the remote vfiler and the remote filer hosting it use-secure-command-channel boolean
optional
Set true to use the secure command channel while communicating with remote filer. Default is false.
Errno Description EVFILERNOTFOUND EVFILEROPNOTALLOWED
License vfiler
| vfiler-migrate-start | [top] |
Starts vfiler unit migration from remote filer to this filer. The data and remote vfiler configuration are migrated as a vfiler unit. It starts SnapMirror relationships between source vfiler volumes and destination vfiler volumes. The ZAPI vfiler-migrate-complete, when run completes the vfiler migration. The following are requirements for vfiler migration 1.The vfiler facility must be licensed on the remote filer and on the local filer. 2.There should not be a local vfiler with the same name as the source vfiler. 3.The local filer should have enough storage space to hold the source vFiler unit's volumes. 4.The volumes to be used by the destination vFiler unit should exist and should not be used by any other non defualt vFiler unit. 5.The destination vFiler unit must have the same path names to the volumes that remote vFiler unit is holding. 6.There should not be any qtrees in the destination volumes whose names match those of qtrees in the source volumes. 7.SnapMirror facility must be licensed on the remote filer and on the local filer. The destination vfiler will have same DNS, NIS and IPSpace configuration as the source vfiler after migration. If the destination vfiler is in different domain or in different subnet then user might need to run setup on destination vfiler. Migration may fail for a number of reasons. For example, the vfiler facility may not be licensed or the vfiler may not be in a state suitable for migration. In these cases EVFILEROPNOTALLOWED will be returned, along with a descriptive reason string.
Input Name Range Type Description ipaddrs ipaddr-info[]
Contains a list of all the IP addresses (and associated information) which should be bound to the vfiler at the destination remote-authentication-info authentication-info
Login name and password to use on the remote filer remote-vfiler-location vfiler-location
Name of the vfiler being migrated. use-secure-command-channel boolean
optional
Set true to use the secure command channel while communicating with remote filer. Default is false.
Errno Description EVFILEROPNOTALLOWED EVFILERNOTFOUND
License vfiler
| vfiler-migrate-status | [top] |
Get the status of the vfiler migrate relationship with the given remote vfiler and filer.
Input Name Range Type Description remote-vfiler-location vfiler-location
Name of the remote vfiler and the remote filer hosting it Output Name Range Type Description migrate-status storage-mr-status[]
migration status of the storage entities.
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-setup | [top] |
Setup services for a vfiler that has been already created. At least one of the optional arguments must be specified.
Input Name Range Type Description adminhost adminhost
optional
Information about the administrative host dnsdomain string
optional
DNS domain name dnsservers dnsserver-info[]
optional
List of DNS servers ipbindings ipbinding-info[]
optional
Contains a list of all IP address bindings to apply nisdomain string
optional
NIS domain name nisservers nisserver-info[]
optional
List of NIS servers password string
optional
root password for the vfiler vfiler string
Name of the vfiler that you want to setup.
Errno Description EAPIMISSINGARGUMENT EVFILEROPNOTALLOWED EVFILERNOTFOUND
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
License vfiler
| vfiler-stop | [top] |
Stop a started vfiler
Input Name Range Type Description vfiler string
Name of the vfiler.
Errno Description EVFILERNOTFOUND EVFILEROPNOTALLOWED
License vfiler
| Element definition: adminhost | [top] |
This is information about the administrative host
Name Range Type Description ipaddress string
IP address of administrative host. IP address is either IPv4 address or IPv6 address. name string
name of administrative host, pass an empty string if this is not known
| Element definition: authentication-info | [top] |
Login and password information
Name Range Type Description password string
encrypted
password to use on remote filer username string
login name to use on remote filer
| Element definition: dnsserver-info | [top] |
This is information about one DNS server
Name Range Type Description ipaddress string
DNS server IP address. IP address is either IPv4 address or IPv6 address.
| Element definition: hostname-pair | [top] |
Alternate hostnames or IP addresses for redundancy purposes
Name Range Type Description alternate-destination string
Hostname or IP address of alternate destination filer. alternate-source string
Hostname or IP address of alternate source filer.
| Element definition: ip-address | [top] |
One ip address, in dotted-decimal format (for example, "192.168.11.12").
[none]
| Element definition: ipaddr-info | [top] |
Information about one IP address that should be bound to the vfiler at the destination.
Name Range Type Description interface string
Name of the network interface. ip-address string
One ip address, in dotted-decimal format (for example, "192.168.11.12"). netmask string
Netmask, in dotted-decimal format (for example, "255.255.255.0").
| Element definition: ipbinding-info | [top] |
This is information about one IP address binding
Name Range Type Description interface string
Name of interface to bind IP address to. ipaddress string
IP address to bind binding. IP address is either IPv4 address or IPv6 address. netmask string
Netmask or Prefix length of IP address binding
| Element definition: nisserver-info | [top] |
This is information about one NIS server
Name Range Type Description ipaddress string
NIS server IP address, or "*". IP address is either IPv4 address or IPv6 address.
| Element definition: protocol-info | [top] |
This is information about one protocol
Name Range Type Description protocol string
Name of a allowed protocol
| Element definition: storage-dr-status | [top] |
disaster recovery status of storage entity
Name Range Type Description status string
status of storage entity. Possible values are: initializing, snapmirrored, unknown. storage-path string
path of storage entity. Example: vol1.
| Element definition: storage-mr-status | [top] |
vfiler migration status of each storage entity
Name Range Type Description error-msg string
optional
In case of migration failure, this field displays the reason for failure. status string
status of storage entity. Possible values are: "initializing", "snapmirrored", "unknown". storage-path string
Name of storage entity. Example: vol1.
| Element definition: storage-unit | [top] |
one storage unit
[none]
| Element definition: vfiler-info | [top] |
Information about one vfiler.
Name Range Type Description admin-host adminhost
optional
ID of administration host, if configured for this vfiler; dns-info dns-info[]
Information about this vfiler's DNS configuration. ipspace string
Name of the vfiler's ipspace name string
Name of the vfiler. nis-info nis-info[]
Information about this vfiler's NIS configuration. uuid string
The vfiler's uuid. vfnets vfnet-info[]
List of all networking resources of this vfiler. vfstores vfstore-info[]
List of all storage resources of the vfiler.
| Element definition: vfiler-location | [top] |
Name of vfiler and the physical filer hosting it
Name Range Type Description filer string
Name of the physical filer vfiler string
Name of the vfiler
| Element definition: adminhost | [top] |
This is information about the administrative host
Name Range Type Description ipaddress string
IP address of administrative host. IP address is either IPv4 address or IPv6 address. name string
name of administrative host, pass an empty string if this is not known
| Element definition: dns-info | [top] |
Information about one vfiler DNS configuration.
Name Range Type Description dns-domain-name string
optional
Configured DNS domain name dns-servers server-address[]
optional
IP addresses of the DNS servers. If DNS domain name is confiugred, at least one dns-server must have specified.
| Element definition: nis-info | [top] |
Information about one vfiler NIS configuration.
Name Range Type Description nis-domain-name string
optional
Configured NIS domain name nis-servers server-address[]
optional
Addresses of the NIS servers.
| 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 "e0a" or a vif name. ipaddress string
IP address of the networking resource netmask string
Netmask, in dotted decimal format. (example, "255.255.192.0" for IPV4 "32" for IPV6).
| 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.
| Element definition: server-address | [top] |
Address information about one NIS server
Name Range Type Description server string
Address of the NIS server.