|
APIs in Category: cifs |
API version 1.3 |
| 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-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. 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
| cifs-share-change | [top] |
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
| 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 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. 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
| Element definition: cifs-session-info | [top] |
Information about a single cifs session.
Name Range Type Description host string
optional
Host name of the PC. 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-share-info | [top] |
Information about a single cifs share.
Name Range Type Description mount-point string
mount point. share-name string
name of the cifs share.
| 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 directories. files integer
Number of open files. volume string
Name of the volume.