Input Name	Range	Type	Description
user-name		string	Name of the user. If the filer is using the "mapped" CIFS home directory naming style, then a mapped Unix name is provided. For the domain naming style, a domain/user is provided. Otherwise the filer will expect the NT name for the user. The filer's CIFS home directory naming style can be obtained with the "options-get" api, using input parameter "name cifs.home_dir_namestyle".
Output Name	Range	Type	Description
homedir-path		string optional	A Unix-style path to the user's CIFS homedir directory, if it exists, for example: /vol/volName/users/joe.

Errno	Description
ESVCNOTAVAIL
ENOMEM
EINVAL
EINTERNALERROR

License

cifs

This ZAPI is used to display the CIFS configuration.

Output Name	Range	Type	Description
AD-site		string optional	Active Directory site that the filer is in.
DC-connection		connection-info[] optional	Information on the Domain Controller's connection.
DNS-domainname		string optional	FQDN of DNS domain.
LDAP-connection		connection-info[] optional	Information on the LDAP connection.
NetBIOS-domainname		string optional	NetBIOS domain name.
NetBIOS-servername		string	NetBIOS name of the server
Windows-type		string optional	Windows type: "NT4" "Windows 2000"
auth-type		string	String specifying the type of authentication, such as: "ad" Active Directory "nt4" Windows NT4 "workgroup" Workgroup "passwd" Password file, NIS or LDAP
security-style		string	String specifying the security style, such as: "ntfs" NTFS "multiprotocol" Multiple Protocol

Errno	Description
ECIFSNOTCONFIGURED
EDNSNOTENABLED
EHOSTNOTFOUND
ELDAPSVRNOTFOUND
ENOMEM

License

cifs

Terminate a list iteration and clean up any saved info.

Input Name	Range	Type	Description
tag		string	Tag from a previous cifs-session-list-iter-start.

License

cifs

Returns items from a previous call to cifs-session-list-iter-start.

Input Name	Range	Type	Description
maximum		integer	The maximum number of entries to retrieve.
tag		string	Tag from a previous cifs-session-list-iter-start.
Output Name	Range	Type	Description
cifs-sessions		cifs-session-info[]	An array, one entry per each cifs session.
records		integer	This tells you how many records are being returned from this particular call to cifs-session-list-iter-next. When this value is 0, you have retrieved everything.

License

cifs

Gives information on current CIFS activity. Without arguments, it returns a summary of information about the filer and lists the users who are connected to the filer.

Input Name	Range	Type	Description
host		string optional	IP address/machine name of the user's client machine.
user		string optional	User name. If user is specified , this api returns information about the specified user, along with the names and access level of files that the user has opened. This api returns information about all the users, if the user is specified as '*' or is not specified.
Output Name	Range	Type	Description
records		integer	Number which tells you how many items have been saved for future retrieval with cifs-session-list-iter-next.
tag		string	Tag to be used in subsequent calls to cifs-session-list-iter-next.

Errno	Description
EAPILICENSE
ESERVICEDISABLED
ESVCNOTAVAIL

License

cifs

Creates a new CIFS share rooted at the specified path.

Input Name	Range	Type	Description
caching		string optional	If specified, the following is done based on the value of the string: "no_caching": disallow Windows clients from caching any files on this share. This is the default value. "auto_document_caching": allow Windows clients to cache user documents on this share. "auto_program_caching": allow Windows clients to cache programs on this share. The actual caching behavior depends on the Windows client.
comment		string optional	If specified, gives description of the new share. CIFS clients see this description when browsing the filer's shares. If not specified, the description is blank.
forcegroup		string optional	If specified, provides name of the group to which files to be created in the share belong. The groupname is the name of a group in the UNIX group database. If it is an empty string or else not specified, then files to be created in the share do not belong to a particular UNIX group. That is, each file belongs to the same group as the owner of the file.
is-symlink-strict-security		boolean optional	If true or not specified, strict symlink security is enabled. If false, allows clients to follow symbolic links to destinations on this filer but outside of the current share. It is not checked if the client is authenticated to the symbolic link's destination.
is-vscan		boolean optional	If true or not specified, virus scan is done when clients open files on this share, else no virus scan is done.
is-vscanread		boolean optional	If true or not specified, virus scan is done when clients open files on this share for read access, else no virus scan is done for read access on this share.
is-widelink		boolean optional	If true, allows clients to follow absolute symbolic links outside of this share, subject to NT security. This feature requires an entry in the /etc/symlink.translations file and it requires that the client supports Microsoft's Distributed File System (DFS). If false or not specified, widelinks in the share are disabled.
maxusers		integer optional	If specified, gives the maximum number of simultaneous connections to the new share. It must be a positive number. If not specified, the filer does not impose a limit on the number of connections to the share.
path		string	Full path name of the directory on the filer corresponding to the root of the new share.
share-name		string	Name of the share to be added. The name cannot exceed 12 characters for DOS-style shares and 256 characters for others.
umask		integer optional	If specified, sets file mode creation mask for a share in qtrees with Unix or mixed security styles. The mask determines the initial permissions setting of a newly created file. If not specified, the file mode creation mask of the share is 0.

Errno	Description
EAPIMISSINGARGUMENT
EAPILICENSE
EINVAL
ESHAREACCESSDENIED
ESVCDISABLED
ESVCNOTAVAIL
ECIFSSHARINGVIOLATION
EVOLUMEINUSE
ENOMEM
ESHARETOOMANY
ESHAREEXISTS
EINTERNALERROR

License

cifs

Changes settings of a CIFS share at any time, even if the share is in use.

Input Name	Range	Type	Description
caching		string optional	If specified, the following is done based on the value of the string: "no_caching": disallow Windows clients from caching any files on this share. This is the default value. "auto_document_caching": allow Windows clients to cache user documents on this share. "auto_program_caching": allow Windows clients to cache programs on this share. The actual caching behavior depends on the Windows client. "manual_caching": allow users on Windows clients to manually select files to be cached.
comment		string optional	If specified, changes description of the share. CIFS clients see this description when browsing the filer's shares. Specifying an empty string clears the previous description.
forcegroup		string optional	If specified, changes name of the group to which files to be created in the share belong. The groupname is the name of a group in the UNIX group database. If the string is empty, files to be created in the share do not belong to a particular UNIX group. That is, each file belongs to the same group as the owner of the file.
is-symlink-strict-security		boolean optional	If true, strict symlink security is enabled. If false, allows clients to follow symbolic links to destinations on this filer but outside of the current share. It is not checked if the client is authenticated to the symbolic link's destination.
is-vscan		boolean optional	If true, virus scan is done when clients open files on this share, else virus scan is not done.
is-vscanread		boolean optional	If true, virus scan is done when clients open files on this share for read access, else virus scan is not done for read access.
is-widelink		boolean optional	If true, allows clients to follow absolute symbolic links outside of this share, subject to NT security. This feature requires an entry in the /etc/symlink.translations file and it requires that the client supports Microsoft's Distributed File System (DFS). If false, widelinks in the share are disabled.
maxusers		integer optional	If specified, changes the maximum number of simultaneous connections to the new share. It must be a positive number or else zero, in which case no limit is imposed on the number of connections to the share.
share-name		string	Name of the existing share to be changed.
umask		integer optional	If specified, changes file mode creation mask for a share in qtrees with Unix or mixed security styles. The mask determines the initial permissions setting of a newly created file. Specifying a zero value resets the file mode creation mask.

Errno	Description
EAPIMISSINGARGUMENT
EAPILICENSE
EINVAL
ESHAREACCESSDENIED
ESVCDISABLED
ESVCNOTAVAIL
ENOMEM
EINTERNALERROR

License

cifs

Deletes the specified CIFS share.

Input Name	Range	Type	Description
share-name		string	Name of the share to be deleted.

Errno	Description
EAPIMISSINGARGUMENT
EAPILICENSE
EINVAL
ESHAREACCESSDENIED
ESVCDISABLED
ESVCNOTAVAIL
EINTERNALERROR

License

cifs

Terminate a list iteration and clean up any saved info.

Input Name	Range	Type	Description
tag		string	Tag from a previous cifs-share-list-iter-start.

License

cifs

Returns items from a previous call to cifs-share-list-iter-start

Input Name	Range	Type	Description
maximum		integer	The maximum number of entries to retrieve.
tag		string	Tag from a previous cifs-share-list-iter-start.
Output Name	Range	Type	Description
cifs-shares		cifs-share-info[]	An array, one entry per each cifs share.
records		integer	This tells you how many records are being returned from this particular call to cifs-share-list-iter-next. When this value is 0, you have retrieved everything.

License

cifs

Gives information about one or more shares, the results of which are retrieved by using cifs-share-list-iter-next.

Input Name	Range	Type	Description
share-name		string optional	Cifs share name. If share-name is specified, only information about that share is returned. If share-name is not specified, then information about all the shares is returned.
Output Name	Range	Type	Description
records		integer	Number which tells you how many items have been saved for future retrieval with cifs-share-list-iter-next.
tag		string	Tag to be used in subsequent calls to cifs-share-list-iter-next.

Errno	Description
EAPILICENSE
EINVAL
ESHAREACCESSDENIED
ESERVICEDISABLED
ESVCNOTAVAIL
EINTERNALERROR

License

cifs

Terminate a list iteration and clean up any saved info.

Input Name	Range	Type	Description
tag		string	Tag from a previous cifs-top-iter-start.

License

cifs

Returns items from a previous call to cifs-top-iter-start.

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

License

cifs

Display CIFS client statistics

Input Name	Range	Type	Description
avgtype		string optional	Specifies how the client statistics are to be averaged for display: "smooth": Use a smoothed average which is weighted towards recent behavior but takes into account previous history of the client. "now": Use a one-second sample taken immediately and no history is taken into account. "total": Use the total count of each statistic divided by the total time since sampling started. If the is-verbose option is also set, the totals are given without dividing by the sample time.
maxclients		integer optional	Specifies the maximum number of top clients to display (the default is 20).
sortgroup		string optional	If specified, the client statistics are sorted by the value of the string: "ops": Sort by the number of operations per second of any type. "reads": Sort by kbytes/sec of data in response to read requests. "writes": Sort by kbytes/sec of data written to the filer. "ios": Sort by the combined total of reads plus writes for each client. "suspicious": Sort by the number of "suspicious" events per second by each client.

Errno	Description
ECLIENTSTATSVFILER
ECLIENTSTATSNOTENABLED
ENOACTIVECLIENTS

License

cifs

Information about a single cifs session.

Name	Range	Type	Description
host		string optional	NetBios name of the CIFS client. This may be unavailable in certain situations. In such cases, the ONTAPI element 'host-ip' alone provides identity of the host.
host-ip		ip-address	IP address, in dotted-decimal format, of the CIFS client.
shares		integer	Number of open shares.
user		string optional	Name of the user.
volumes-list		volumes-list-info[]	List of volumes being accessed during the session.

Information about a single cifs share.

Name	Range	Type	Description
caching		string optional	String specifying the type of caching: "no_caching", "auto_document_caching", "auto_program_caching" and "manual_caching".
description		string optional	description of the share.
forcegroup		string optional	name of the group to which files to be created in the share belong to.
is-symlink-strict-security		boolean optional	If true or not specified, strict symlink security is enabled. If false, allows clients to follow symbolic links to destinations on this filer but outside of the current share.
is-vscan		boolean optional	If true or not specified, virus scan is done when clients open files on this share.
is-vscanread		boolean optional	If true or not specified, virus scan is done when clients open files on this share for read access.
is-widelink		boolean optional	If true, allows clients to follow absolute symbolic links outside of this share, subject to NT security.
maxusers		integer optional	max no. of simultaneous connections to the share.
mount-point		string	mount point of the share.
share-name		string	name of the cifs share.
umask		integer optional	File mode creation mask for a share in qtrees with Unix or mixed security styles. The mask determines the initial permissions setting of a newly created file.

Information about a single cifs top.

Name	Range	Type	Description
ops-per-sec		integer	The number of operations of any type per second.
read-ops		integer	The number of read requests.
read-size		integer	The size in kbytes per second of data of read requests.
suspicious-per-sec		integer	The number of "suspicious" events per second due to the following conditions: ACCESS-DENIED returned for FindFirst ACCESS-DENIED returned for Open/CreateFile ACCESS-DENIED returned for DeleteFile SUCCESS returned for DeleteFile SUCCESS returned for TruncateFile
user-info		string	Information on the client with its IP address and user account.
write-ops		integer	The number of write requests.
write-size		integer	The size in kbytes per second of data of write requests.

Information about one connection.

Name	Range	Type	Description
address-pair1		address-pair	The first source and destination address pair.
address-pair2		address-pair optional	The second source and destination address pair.
mode		string	Connection mode. Possible values are: multi and failover.
name		string	Name of the connection. The name isn in ASCII and must begin with an alpha character.
snapmirror-error		snapmirror-error optional	Present if there is an error for a snapmirror connection.

Source and destination address pair.

Name	Range	Type	Description
destination-addr		string	Destination address in the form of filer name or IP address.
source-addr		string	Source address in the form of filer name or IP address.

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

[none]

Information about a single snapmirror connection error.

Name	Range	Type	Description
errno		integer	The error number.
reason		string	A human-readable concise reason for the error.

Information about a single volume.

Name	Range	Type	Description
change-notifies		integer	Number of active ChangeNotify requests.
dirs		integer	Number of open directories.
files		integer	Number of open files.
volume		string	Name of the volume.