|
APIs in Category: cifs |
API version 1.6 |
| cifs-homedir-path-get-for-user | [top] |
Return path to the user's CIFS home directory if it exists.
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-user 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 EONTAPI_ENOMEM EONTAPI_EINVAL EINVALIDINPUTERROR EINTERNALERROR
License cifs
| cifs-homedir-paths-get | [top] |
Return the current list of paths to users' cifs home directories, if any.
Output Name Range Type Description homedir-paths homedir-path-info[]
optional
An array, one entry per each cifs home directory path.
Errno Description ESVCNOTAVAIL EONTAPI_ENOMEM EONTAPI_EINVAL EINTERNALERROR
License cifs
| cifs-homedir-paths-set | [top] |
Provides a list of CIFS home directory paths for the filer. Replaces the current list of paths in use by the filer. Note that supplying an empty path list causes the filer to delete any current entries.
Input Name Range Type Description force boolean
optional
If true, the new set of homedir paths will be put into use even if some user homedir connections will be broken. This can cause users with open files in their home directories to lose access to the files. A user can lose data if there are updates not yet committed to disk. homedir-paths homedir-path-info[]
optional
An array, one entry per each cifs home directory path. note: homedir-path-info defined above Output Name Range Type Description path-error path-error-info[]
optional
An array, one entry for each homedir path error detected. Note that normally the API will complete sucessfully and activate as many paths as possible even if some paths cannot be activated.
Errno Description ESVCNOTAVAIL EINVALIDINPUTERROR EINTERNALERROR
License cifs
| cifs-list-config | [top] |
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 EONTAPI_ENOMEM
License cifs
| cifs-nbalias-names-get | [top] |
Return the current list of NetBIOS alias names for the filer
Output Name Range Type Description nbalias-names nbalias-name-info[]
optional
An array, one entry for each NetBIOS alias name
Errno Description ESVCNOTAVAIL EONTAPI_EINVAL EINTERNALERROR
License cifs
| cifs-nbalias-names-set | [top] |
Provides a list of NetBIOS alias names for the filer. The filer replaces the current list of aliases with with this list. Note that supplying an empty name list causes the filer to delete all current entries.
Output Name Range Type Description nbalias-names nbalias-name-info[]
optional
An array, one entry for each NetBIOS alias name note: nbalias-name_info defined above
Errno Description ESVCNOTAVAIL EINVALIDINPUTERROR EINTERNALERROR
License cifs
| cifs-session-list-iter-end | [top] |
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
| cifs-session-list-iter-next | [top] |
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
| cifs-session-list-iter-start | [top] |
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
| cifs-setup | [top] |
Configures the filer's CIFS service. The CIFS service will start automatically once this call completes successfully.
Input Name Range Type Description auth-type string
The authentication style that determines the method by which clients will be authenticated when connecting to this CIFS server. These styles are subject to change in a future release. Possible values: ad, nt4, workgroup, passwd Note: The domain-name, login-user and login-password fields are optional unless the auth-type is ad. domain-name string
optional
The name of the domain that the CIFS server will join. This can be the NetBIOS or fully qualified domain name. Examples: cifsdomain, cifs.domain.com login-password string
optional
encrypted
The password for login-user. login-user string
optional
The name of a domain user that has the ability to add the CIFS server to the domain given in domain-name. Examples: username (assumes domain-name is the user's domain), cifsdomain\username, cifs.domain.com\username ou-name string
optional
The distinguished name of the organizational unit that the CIFS service will become a member of. This value must be one of the cifs-setup-ous retrieved from a call to the cifs-setup-container-list-iter APIs. By default, the filer will join the 'CN=Computers' organizational unit. Note: This information is only used when the auth-type is 'ad'. pdc-ip-address ip-address
optional
If this value is defined, CIFS will attempt to communicate with the domain controller directly using this address. Note: This information is only used when the auth-type is 'nt4'. security-style string
The security style determines whether or not the CIFS service will support multiprotocol access. These styles are subject to change in a future release. Possible values: ntfs, multiprotocol server-name string
The resulting CIFS server name. site-name string
optional
The name of the site that the CIFS service will become a member of. This value must be one of the cifs-setup-sites retrieved from a call to the cifs-setup-container-list-iter APIs. If a default-site was returned, it is the recommended choice. Sites will be ignored if this value is left blank. Note: This information is only used when the auth-type is 'ad'.
Errno Description EAPILICENSE EINVALIDINPUTERROR ESVCNOTAVAIL ESVCDISABLED EINTERNALERROR ECIFS_LOGIN_FAILED ECIFS_BIND_FAILED ECIFS_DNS_REQUIRED ECIFS_KRB_CONFLICT ECIFS_AD_CLOCK_SKEW ECIFS_AD_RESET_REQUIRED ECIFS_LIST_UNAVAILABLE ECIFS_DC_CONNECT_FAILED ECIFS_PASSWD_AND_GROUP_REQUIRED
License cifs
| cifs-setup-create-group-file | [top] |
Creates a basic /etc/group file. Note: This will overwrite an existing /etc/group file. See cifs-setup-verify-passwd-and-group for more information.
Errno Description EAPILICENSE EINVALIDINPUTERROR EINTERNALERROR ECIFS_SETUP_CANNOT_WRITE
License cifs
| cifs-setup-create-passwd-file | [top] |
Creates a basic /etc/passwd file including a root user with the specified password. Note: This will overwrite an existing /etc/passwd file. See cifs-setup-verify-passwd-and-group for more information.
Input Name Range Type Description default-root-password string
encrypted
The password given to a locally defined root user which may be used in the event that other authentication services are unavailable. This will be defined in the filer's local /etc/passwd file.
Errno Description EAPILICENSE EINVALIDINPUTERROR EINTERNALERROR ECIFS_SETUP_CANNOT_WRITE
License cifs
| cifs-setup-ou-list-iter-end | [top] |
Terminate a list iteration and clean up any saved info.
Input Name Range Type Description tag string
Tag from a previous cifs-setup-ou-list-iter-start.
License cifs
| cifs-setup-ou-list-iter-next | [top] |
Returns items from a previous call to cifs-setup-ou-list-iter-start
Input Name Range Type Description maximum integer
The maximum number of entries to retrieve. tag string
Tag from a previous cifs-setup-ou-list-iter-start. Output Name Range Type Description cifs-setup-ous cifs-setup-ou[]
An array, one entry per each joinable organizational unit. records integer
This tells you how many records are being returned from this particular call to cifs-setup-ou-list-iter-next. When this value is 0, you have retrieved everything.
License cifs
| cifs-setup-ou-list-iter-start | [top] |
Gathers a list of joinable sites and organizational units from Active Directory for the login-user specified, which is retrieved by using cifs-setup-ou-list-iter-next. For more information regarding Active Directory organizational units and their use, please reference Microsoft's Active Directory documentation.
Input Name Range Type Description domain-name string
The name of the domain that the CIFS server will join. Examples: cifsdomain, cifs.domain.com login-password string
encrypted
The password for login-user. login-user string
The name of a domain user that has the ability to add the CIFS server to the domain given in domain-name. Examples: username (assumes domain-name is the user's domain), cifsdomain\username, cifs.domain.com\username Output Name Range Type Description records integer
Number which tells you how many items have been saved for future retrieval with cifs-setup-ou-list-iter-next. tag string
Tag to be used in subsequent calls to cifs-setup-ou-list-iter-next.
Errno Description EAPILICENSE EINVALIDINPUTERROR ESVCNOTAVAIL ESVCDISABLED EINTERNALERROR ECIFS_LOGIN_FAILED ECIFS_BIND_FAILED ECIFS_DNS_REQUIRED ECIFS_KRB_CONFLICT ECIFS_AD_CLOCK_SKEW ECIFS_AD_RESET_REQUIRED ECIFS_LIST_UNAVAILABLE ECIFS_DC_CONNECT_FAILED
License cifs
| cifs-setup-site-list-iter-end | [top] |
Terminate a list iteration and clean up any saved info.
Input Name Range Type Description tag string
Tag from a previous cifs-setup-site-list-iter-start.
License cifs
| cifs-setup-site-list-iter-next | [top] |
Returns items from a previous call to cifs-setup-site-list-iter-start
Input Name Range Type Description maximum integer
The maximum number of entries to retrieve. tag string
Tag from a previous cifs-setup-site-list-iter-start. Output Name Range Type Description cifs-setup-sites cifs-setup-site[]
An array, one entry per each joinable organizational unit. default-site string
optional
If this subnet is part of a pre-defined site in Active Directory, this is the site name that would be used by default unless one of the other sites in cifs-setup-sites are specified instead. records integer
This tells you how many records are being returned from this particular call to cifs-setup-site-list-iter-next. When this value is 0, you have retrieved everything.
License cifs
| cifs-setup-site-list-iter-start | [top] |
Gathers a list of joinable sites and organizational units from Active Directory for the login-user specified, which is retrieved by using cifs-setup-site-list-iter-next. For more information regarding Active Directory sites and their use, please reference Microsoft's Active Directory documentation.
Input Name Range Type Description domain-name string
The name of the domain that the CIFS server will join. Examples: cifsdomain, cifs.domain.com login-password string
encrypted
The password for login-user. login-user string
The name of a domain user that has the ability to add the CIFS server to the domain given in domain-name. Examples: username (assumes domain-name is the user's domain), cifsdomain\username, cifs.domain.com\username Output Name Range Type Description records integer
Number which tells you how many items have been saved for future retrieval with cifs-setup-site-list-iter-next. tag string
Tag to be used in subsequent calls to cifs-setup-site-list-iter-next.
Errno Description EAPILICENSE EINVALIDINPUTERROR ESVCNOTAVAIL ESVCDISABLED EINTERNALERROR ECIFS_LOGIN_FAILED ECIFS_BIND_FAILED ECIFS_DNS_REQUIRED ECIFS_KRB_CONFLICT ECIFS_AD_CLOCK_SKEW ECIFS_AD_RESET_REQUIRED ECIFS_LIST_UNAVAILABLE ECIFS_DC_CONNECT_FAILED
License cifs
| cifs-setup-verify-name | [top] |
Determines whether or not a particular CIFS server name is already in use on the network and a specified domain.
Input Name Range Type Description auth-type string
The authentication style that will be used in a subsequent call to cifs-setup. These styles are subject to change in a future release. Possible values: ad, nt4, workgroup, passwd Note: The domain-name, login-user and login-password fields are optional unless the auth-type is ad. domain-name string
The name of the domain that the CIFS server will join. Examples: cifsdomain, cifs.domain.com login-password string
optional
encrypted
The password for login-user. login-user string
optional
The name of a domain user that has the ability to add the CIFS server to the domain given in domain-name. Examples: username (assumes domain-name is the user's domain), cifsdomain\username, cifs.domain.com\username pdc-ip-address ip-address
optional
If this value is defined, CIFS will attempt to communicate with the domain controller directly using this address. Note: This information is only used when the auth-type is 'nt4'. server-name string
The NetBIOS CIFS server name that will be verified. Example: cifsserver Output Name Range Type Description is-in-domain boolean
Returns 'true' if the name exists in the domain, otherwise returns 'false'. For 'ad'-style domains, if an entry exists a warning should be provided. For 'nt4'-style domains, an entry must exist or cifs-setup will fail. is-in-use boolean
Returns 'true' if the name is in use on the network, otherwise returns 'false'.
Errno Description EAPILICENSE EINVALIDINPUTERROR ESVCNOTAVAIL ESVCDISABLED EINTERNALERROR ECIFS_LOGIN_FAILED ECIFS_BIND_FAILED ECIFS_DNS_REQUIRED ECIFS_KRB_CONFLICT ECIFS_AD_CLOCK_SKEW ECIFS_AD_RESET_REQUIRED ECIFS_LIST_UNAVAILABLE ECIFS_DC_CONNECT_FAILED
License cifs
| cifs-setup-verify-passwd-and-group | [top] |
Determines whether or not the /etc/passwd and /etc/group files exist, which would be used in the event that the configured CIFS authentication method fails.
Output Name Range Type Description group-file-exists boolean
Returns 'true' if the /etc/group file exists, otherwise returns 'false'. passwd-file-exists boolean
Returns 'true' if the /etc/passwd file exists, otherwise returns 'false'. required boolean
Returns 'true' if the /etc/passwd and /etc/group files would be required before running the cifs-setup API. cifs-setup will require these files if neither LDAP nor NIS are enabled, as they will be used as a backup authentication method should the primary method (i.e. domain authentication) become unavailable.
Errno Description EAPILICENSE EINVALIDINPUTERROR EINTERNALERROR
License cifs
| cifs-share-add | [top] |
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. dir-umask integer
optional
If specified, sets file mode creation mask for a share in qtrees with Unix or mixed security styles. The mask restricts the initial permissions setting of a newly created directory. For directories, this mask overrides one set with "umask". file-umask integer
optional
If specified, sets file mode creation mask for a share in qtrees with Unix or mixed security styles. The mask restricts the initial permissions setting of a newly created file. For files, this mask overrides one set with "umask". 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-browse boolean
optional
If true or not specified, shares are visible to browsing clients and can be enumerated (e.g. "net view", SrvMgr, AD). 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 restricts the initial permissions setting of a newly created file or directory. If not specified, the file mode creation mask of the share is 0. This field is ignored when both dir-umask and file-umask are present.
Errno Description EAPIMISSINGARGUMENT EAPILICENSE EONTAPI_EINVAL ESHAREACCESSDENIED ESVCDISABLED ESVCNOTAVAIL ECIFSSHARINGVIOLATION EVOLUMEINUSE EONTAPI_ENOMEM ESHARETOOMANY ESHAREEXISTS EINTERNALERROR
License cifs
| cifs-share-change | [top] |
Changes settings of one or more CIFS shares at any time, even if the shares are 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. dir-umask integer
optional
If specified, changes file mode creation mask for a share in qtrees with Unix or mixed security styles. The mask restricts the initial permissions setting of a newly created directory. For directories, this mask overrides one set with "umask". Specifying an empty string resets (removes) this dir-umask. file-umask integer
optional
If specified, changes file mode creation mask for a share in qtrees with Unix or mixed security styles. The mask restricts the initial permissions setting of a newly created file. For files, this mask overrides one set with "umask". Specifying an empty string resets (removes) this file-umask. 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-browse boolean
optional
If true or undefined, share is visible to browsers and can be enumerated. 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
If fully specified, it's the name of the existing share to be changed. If the name contains the wildcard characters * or ?, then all the shares matching the specified name are 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 restricts the initial permissions setting of a newly created file or directory. Specifying a zero value resets (removes) the file mode creation mask. This field is ignored when both dir-umask and file-umask are present.
Errno Description EAPIMISSINGARGUMENT EAPILICENSE EONTAPI_EINVAL ESHAREACCESSDENIED ESVCDISABLED ESVCNOTAVAIL EONTAPI_ENOMEM EINTERNALERROR
License cifs
| cifs-share-delete | [top] |
Deletes the specified CIFS share.
Input Name Range Type Description share-name string
Name of the share to be deleted.
Errno Description EAPIMISSINGARGUMENT EAPILICENSE EONTAPI_EINVAL ESHAREACCESSDENIED ESVCDISABLED ESVCNOTAVAIL EINTERNALERROR
License cifs
| cifs-share-list-iter-end | [top] |
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
| cifs-share-list-iter-next | [top] |
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
| cifs-share-list-iter-start | [top] |
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. If the name contains the wildcard characters * or ?, then all the shares matching the specified name are listed. 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 EONTAPI_EINVAL ESHAREACCESSDENIED ESERVICEDISABLED ESVCNOTAVAIL EINTERNALERROR
License cifs
| cifs-start | [top] |
Starts the CIFS service, usually after a previous call to cifs-stop as the CIFS service starts automatically when cifs-setup completes successfully or the system reboots.
Errno Description EAPILICENSE ESVCNOTAVAIL ESVCDISABLED EINTERNALERROR
License cifs
| cifs-status | [top] |
Returns the running state of the CIFS service.
Output Name Range Type Description status string
The current status of the CIFS service, which will be one of the following: STOPPED, STARTED, STOPPING, STARTING
Errno Description EAPILICENSE EINTERNALERROR
License cifs
| cifs-stop | [top] |
Stops the CIFS service for all users or a particular workstation, if specified. Appropriate warning should be given to connected clients before calling this API, as it will immediately terminate those sessions regardless of their current state. See the cifs-sessions API for the list of clients that are currently connected.
Input Name Range Type Description workstation string
optional
The name or IP address of a workstation that will be disconnected from the CIFS service. Note that the CIFS service does not stop if this value is specified, it simply disconnects related sessions.
Errno Description EAPILICENSE EINVALIDINPUTERROR ESVCNOTAVAIL ESVCDISABLED EINTERNALERROR
License cifs
| cifs-top-iter-end | [top] |
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
| cifs-top-iter-next | [top] |
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
| cifs-top-iter-start | [top] |
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
| Element definition: cifs-session-info | [top] |
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.
| Element definition: cifs-setup-ou | [top] |
The fully qualified name of a single joinable organizational unit.
[none]
| Element definition: cifs-setup-site | [top] |
The fully qualified name of a single joinable organizational unit.
[none]
| Element definition: cifs-share-info | [top] |
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. dir-umask integer
optional
File mode creation mask for a share in qtrees with Unix or mixed security styles. The mask restricts the initial permissions setting of a newly created directory. This mask overrides one set with "umask". file-umask integer
optional
File mode creation mask for a share in qtrees with Unix or mixed security styles. The mask restricts the initial permissions setting of a newly created file. This mask overrides one set with "umask". 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-vol-offline boolean
optional
If true, volume is offline and the shares are not available. 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 restricts the initial permissions setting of newly created files and directories. This field is ignored when both dir-umask and file-umask are present.
| Element definition: cifs-top-info | [top] |
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.
| Element definition: connection-info | [top] |
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 is in ASCII and must begin with an alpha character. snapmirror-error snapmirror-error
optional
Present if there is an error for a snapmirror connection.
| Element definition: homedir-path-info | [top] |
path to user home directory paths Unix style path to user home directories, example: /vol/vol1/users1 The paths are listed in the same order that the filer will use to evaluate whether a user has a cifs home directory.
[none]
| Element definition: ip-address | [top] |
One ip address, in dotted-decimal format (for example, "192.168.11.12").
[none]
| Element definition: nbalias-name-info | [top] |
NetBIOS alias for the filer
[none]
| Element definition: path-error-info | [top] |
Error description
Name Range Type Description error-path string
Homedir path, if any, which had the error. This value is set to NULL if there is no path associated with the error. error-path-desc string
A description of the error.
| Element definition: address-pair | [top] |
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.
| Element definition: snapmirror-error | [top] |
Information about a single snapmirror schedule error.
Name Range Type Description errno integer
The error number. reason string
A human-readable concise reason for the error.
| Element definition: volumes-list-info | [top] |
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.