Input Name	Range	Type	Description
desired-attributes		cifs-domain-discovered-servers optional	Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
max-records	[1..100]	integer optional	The maximum number of records to return in this call. Default: 20
query		cifs-domain-discovered-servers optional	A query that specifies which objects to return. A query could be specified on any number of attributes in the cifs-domain-discovered-servers object. All cifs-domain-discovered-servers objects matching this query up to 'max-records' will be returned.
tag		string optional	Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.
Output Name	Range	Type	Description
attributes-list		cifs-domain-discovered-servers[] optional	The list of attributes of cifs-domain-discovered-servers objects.
next-tag		string optional	Tag for the next call. Not present when there are no more cifs-domain-discovered-servers objects to return.
num-records	[0..100]	integer	The number of records returned in this call.

Errno	Description
EINTERNALERROR

Command to trigger re-discovery of servers.

Errno	Description
EOBJECTNOTFOUND
EINTERNALERROR

Add to a list of preferred domain controllers

Input Name	Range	Type	Description
domain		string	The fully qualified domain name of the Active Directory domain to which the domain controllers in the list belong.
preferred-dc		string[]	Preferred Domain Controllers

Errno	Description
EOBJECTNOTFOUND
EINTERNALERROR

Retrieve the list of preferred domain controllers associated with Active Directory domains.

Input Name	Range	Type	Description
desired-attributes		cifs-domain-preferred-dc optional	Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
max-records	[1..100]	integer optional	The maximum number of records to return in this call. Default: 20
query		cifs-domain-preferred-dc optional	A query that specifies which objects to return. A query could be specified on any number of attributes in the cifs-domain-preferred-dc object. All cifs-domain-preferred-dc objects matching this query up to 'max-records' will be returned.
tag		string optional	Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.
Output Name	Range	Type	Description
attributes-list		cifs-domain-preferred-dc[] optional	The list of attributes of cifs-domain-preferred-dc objects.
next-tag		string optional	Tag for the next call. Not present when there are no more cifs-domain-preferred-dc objects to return.
num-records	[0..100]	integer	The number of records returned in this call.

Errno	Description
EINTERNALERROR

Remove from a list of preferred domain controllers

Input Name	Range	Type	Description
domain		string	The fully qualified domain name of the Active Directory domain to which the domain controllers in the list belong.
preferred-dc		string[] optional	Preferred Domain Controllers

Errno	Description
EOBJECTNOTFOUND
EINTERNALERROR

Add a path to the list of paths that will be searched to find a CIFS user's home directory.

Input Name	Range	Type	Description
path		string	The file system path that will be searched for finding a CIFS user's home directory.

Errno	Description
EOBJECTNOTFOUND
EINTERNALERROR

Remove a home directory search path.

Input Name	Range	Type	Description
path		string	The file system path that will be searched for finding a CIFS user's home directory.

Errno	Description
EOBJECTNOTFOUND
EINTERNALERROR

Iterate over a list of cifs-home-directory-search-path objects.

Input Name	Range	Type	Description
desired-attributes		cifs-home-directory-search-path optional	Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
max-records	[1..100]	integer optional	The maximum number of records to return in this call. Default: 20
query		cifs-home-directory-search-path optional	A query that specifies which objects to return. A query could be specified on any number of attributes in the cifs-home-directory-search-path object. All cifs-home-directory-search-path objects matching this query up to 'max-records' will be returned.
tag		string optional	Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.
Output Name	Range	Type	Description
attributes-list		cifs-home-directory-search-path[] optional	The list of attributes of cifs-home-directory-search-path objects.
next-tag		string optional	Tag for the next call. Not present when there are no more cifs-home-directory-search-path objects to return.
num-records	[0..100]	integer	The number of records returned in this call.

Errno	Description
EINTERNALERROR

Change the position of this path in the list of paths that will be searched to find a CIFS user's home directory.

Input Name	Range	Type	Description
path		string	The file system path that will be searched for finding a CIFS user's home directory.
to-position		integer	The target position this entry should be moved to, in the list of CIFS home directory search paths.

Errno	Description
EOBJECTNOTFOUND
EINTERNALERROR

Retrieve the NetBIOS Name Service statistics for Vservers in cluster.

Input Name	Range	Type	Description
desired-attributes		cifs-nbtstat optional	Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
max-records	[1..100]	integer optional	The maximum number of records to return in this call. Default: 20
query		cifs-nbtstat optional	A query that specifies which objects to return. A query could be specified on any number of attributes in the NetBIOS statistics object. All NetBIOS statistics objects matching this query up to 'max-records' will be returned.
tag		string optional	Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.
Output Name	Range	Type	Description
attributes-list		cifs-nbtstat[] optional	The list of attributes of NetBIOS statistics objects.
next-tag		string optional	Tag for the next call. Not present when there are no more NetBIOS statistics objects to return.
num-records	[0..100]	integer	The number of records returned in this call.

Errno	Description
EINTERNALERROR

Iterate over a list of cifs-options objects.

Input Name	Range	Type	Description
desired-attributes		cifs-options optional	Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
max-records	[1..100]	integer optional	The maximum number of records to return in this call. Default: 20
query		cifs-options optional	A query that specifies which objects to return. A query could be specified on any number of attributes in the cifs-options object. All cifs-options objects matching this query up to 'max-records' will be returned.
tag		string optional	Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.
Output Name	Range	Type	Description
attributes-list		cifs-options[] optional	The list of attributes of cifs-options objects.
next-tag		string optional	Tag for the next call. Not present when there are no more cifs-options objects to return.
num-records	[0..100]	integer	The number of records returned in this call.

Errno	Description
EINTERNALERROR

Modify the attributes of cifs-options object.

Input Name	Range	Type	Description
default-unix-user		string optional	This is the default UNIX user mapping that will be used if the identity of a CIFS user connot be mapped using normal name mapping rules.
is-smb2-enabled		boolean optional	This optional parameter specifies whether the CIFS server negotiates the SMB2 version of the CIFS protocol. The default value for this parameter is true.
read-grants-execute		enable optional	On a file with UNIX Style security effective on it, if the file has read permission on it, a CIFS user would be allowed to execute permissions if this option is enabled.
wins-servers		inet-address[] optional	List of Windows Internet Name Service (WINS) IP addresses. The Vserver will send NetBIOS name resolution requests to these addresses.

Errno	Description
EOBJECTNOTFOUND
EINTERNALERROR

Generate a new password for the CIFS server's machine account and change it in the Windows Active Directory domain.

Errno	Description
EOBJECTNOTFOUND
EINTERNALERROR

Reset the CIFS server's machine account password in the Windows Active Directory domain. This may be required if the password stored along with the machine account in the Windows Active Directory domain is changed or reset without the Vserver's knowledge. This operation requires the credentials for a user with permission to reset the password in the organizational unit (OU) that the machine account is a member of.

Input Name	Range	Type	Description
admin-password		string	Account password for the admin-username.
admin-username		string	Username of a user with permission to reset the password in the organizational unit (OU) that the machine account is a member of. This user is expected to be part of the same Windows Active Directory domain as the CIFS server. If the specified username is not part of the same domain but part of a domain that has a trust relationship with the CIFS server's domain, the username can be specified as ' @ ' where FQDN is the fully qualified domain name of the domain of which the user is a member.

Errno	Description
EOBJECTNOTFOUND
EINTERNALERROR

Iterate over a list of cifs-security objects.

Input Name	Range	Type	Description
desired-attributes		cifs-security optional	Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
max-records	[1..100]	integer optional	The maximum number of records to return in this call. Default: 20
query		cifs-security optional	A query that specifies which objects to return. A query could be specified on any number of attributes in the cifs-security object. All cifs-security objects matching this query up to 'max-records' will be returned.
tag		string optional	Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.
Output Name	Range	Type	Description
attributes-list		cifs-security[] optional	The list of attributes of cifs-security objects.
next-tag		string optional	Tag for the next call. Not present when there are no more cifs-security objects to return.
num-records	[0..100]	integer	The number of records returned in this call.

Errno	Description
EINTERNALERROR

Modify the attributes of cifs-security object.

Input Name	Range	Type	Description
kerberos-clock-skew	[0..2^32-1]	integer optional	The clock skew in minutes is the tolerance for accepting tickets with time stamps that do not exactly match the host's system clock.
kerberos-renew-age	[0..2^32-1]	integer optional	This option determines the maximum amount of time in days for which a ticket can be renewed.
kerberos-ticket-age	[0..2^32-1]	integer optional	This option determines the maximum amount of time in hours that a user's ticket may be used for the purpose of Kerberos authentication.

Errno	Description
EOBJECTNOTFOUND
EINTERNALERROR

Configure and setup CIFS services on a Vserver.

Input Name	Range	Type	Description
admin-password		string	The password for the account used to add this CIFS server to the Active Directory.
admin-username		string	The username of the account used to add this CIFS server to the Active Directory.
cifs-server		netbios-name	The NetBIOS name of the CIFS server.
default-site		string optional	The default site used by LIFs that do not have a site membership.
domain		string	The Fully Qualified Domain Name of the Windows Active Directory this CIFS server belongs to.
force-account-overwrite		boolean optional	If this is set and a machine account with the same name as specified in 'cifs-server' exists in the Active Directory, it will be overwritten and reused. The default value for this field is false.
organizational-unit		string optional	The Organizational Unit (OU) within the Windows Active Directory this CIFS server belongs to.

Errno	Description
EOBJECTNOTFOUND
EINTERNALERROR

Delete a CIFS server. If the admin-username and admin-password are not specified, the CIFS server's machine account will not be deleted from the Windows Active Directory domain. The deletion of the CIFS server will also delete the CIFS shares associated with it.

Input Name	Range	Type	Description
admin-password		string optional	Account password for the admin-username.
admin-username		string optional	A user account name that has sufficient privileges in the Windows Active Directory domain to delete the CIFS server's machine account.

Errno	Description
EOBJECTNOTFOUND
EINTERNALERROR

Retrieve the list of CIFS servers on the cluster and their basic configurations.

Input Name	Range	Type	Description
desired-attributes		cifs-server-config optional	Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
max-records	[1..100]	integer optional	The maximum number of records to return in this call. Default: 20
query		cifs-server-config optional	A query that specifies which objects to return. A query could be specified on any number of attributes in the cifs-server object. All cifs-server objects matching this query up to 'max-records' will be returned.
tag		string optional	Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.
Output Name	Range	Type	Description
attributes-list		cifs-server-config[] optional	The list of attributes of cifs-server objects.
next-tag		string optional	Tag for the next call. Not present when there are no more cifs-server objects to return.
num-records	[0..100]	integer	The number of records returned in this call.

Errno	Description
EINTERNALERROR

Modify the basic configurations of a CIFS server.

Input Name	Range	Type	Description
default-site		string optional	The default site used by LIFs that do not have a site membership.

Errno	Description
EOBJECTNOTFOUND
EINTERNALERROR

Add permissions for a user or group for a defined CIFS share.

Input Name	Range	Type	Description
permission		cifs-access-perms	The access rights that the user or group has on the defined CIFS share. Possible values: "no_access" - No access, "read" - Read, "change" - Change, "full_control" - Full Control
return-record		boolean optional	If set to true, returns the cifs-share-access-control on successful creation. Default: false
share		string	The CIFS share for which the permissions are defined.
user-or-group		string	The user or group name for which the permissions are listed.
Output Name	Range	Type	Description
result		cifs-share-access-control optional	The cifs-share-access-control created (keys or the entire object if requested)

Errno	Description
EINTERNALERROR

Remove permissions for a user or group on a defined CIFS share.

Input Name	Range	Type	Description
share		string	The CIFS share for which the permissions are defined.
user-or-group		string	The user or group name for which the permissions are listed.

Errno	Description
EOBJECTNOTFOUND
EINTERNALERROR

Retrieve the list of permissions on defined CIFS shares.

Input Name	Range	Type	Description
desired-attributes		cifs-share-access-control optional	Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
max-records	[1..100]	integer optional	The maximum number of records to return in this call. Default: 20
query		cifs-share-access-control optional	A query that specifies which objects to return. A query could be specified on any number of attributes in the cifs-share-access-control object. All cifs-share-access-control objects matching this query up to 'max-records' will be returned.
tag		string optional	Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.
Output Name	Range	Type	Description
attributes-list		cifs-share-access-control[] optional	The list of attributes of cifs-share-access-control objects.
next-tag		string optional	Tag for the next call. Not present when there are no more cifs-share-access-control objects to return.
num-records	[0..100]	integer	The number of records returned in this call.

Errno	Description
EINTERNALERROR

Modify the permissions for a user or group on a defined CIFS share.

Input Name	Range	Type	Description
permission		cifs-access-perms optional	The access rights that the user or group has on the defined CIFS share. Possible values: "no_access" - No access, "read" - Read, "change" - Change, "full_control" - Full Control
share		string	The CIFS share for which the permissions are defined.
user-or-group		string	The user or group name for which the permissions are listed.

Errno	Description
EOBJECTNOTFOUND
EINTERNALERROR

Creates a new CIFS share rooted at the specified path.

Input Name	Range	Type	Description
attribute-cache-ttl	[0..2^32-1]	integer optional	The lifetime of an entry in the file attribute cache, in seconds. This value is used if the share has the 'attributecache' property set, which improves the performance of certain metadata operations in common workloads. The default is 10 seconds. Raising this value may improve performance, but the likelihood that stale metadata will be served increases as well. The value of this field must be in the range of 1 to 86400.
comment		string optional	This string gives a description of the CIFS share. CIFS clients see this description when browsing the Vserver's CIFS shares.
dir-umask	[0..777]	integer optional	The value of this field controls the file mode creation mask for the CIFS share in qtrees with UNIX or Mixed security styles. The mask restricts the initial permissions setting of a newly created directory. The input value is a numeric mode comprising of one to three octal digits (0-7), derived by adding up the bits with values 4, 2, and 1. The first digit selects permissions for the user who owns the file: read (4), write (2), and execute (1); the second selects permissions for other users in the file's group, with the same values; and the third for other users not in the file's group, with the same values.
file-umask	[0..777]	integer optional	The value of this field controls the file mode creation mask for the CIFS share in qtrees with UNIX or Mixed security styles. The mask restricts the initial permissions setting of a newly created file. The input value is a numeric mode comprising of one to three octal digits (0-7), derived by adding up the bits with values 4, 2, and 1. The first digit selects permissions for the user who owns the file: read (4), write (2), and execute (1); the second selects permissions for other users in the file's group, with the same values; and the third for other users not in the file's group, with the same values.
path		string	The file system path that is shared through this CIFS share.
return-record		boolean optional	If set to true, returns the cifs-share on successful creation. Default: false
share-name		string	The name of the CIFS share. The CIFS share name is a UTF-8 string with the following characters being illegal: control characters from 0x00 to 0x1F, both inclusive, 0x22 (double quotes) and the characters \/[]:|<>+=;,?
share-properties		cifs-share-properties[] optional	The list of properties for this CIFS share. Possible values: "oplocks" - This specifies that opportunistic locks (client-side caching) are enabled on this share., "browsable" - This specifies that the share can be browsed by Windows clients., "showsnapshot" - This specifies that Snapshots can be viewed and traversed by clients., "changenotify" - This specifies that CIFS clients can request for change notifications for directories on this share., "homedirectory" - This specifies that the share is added and enabled as part of the CIFS home directory feature. The configuration of this share should be done using CIFS home directory feature interface., "attributecache" - This specifies that connections through this share are caching attributes for a short time to improve performance.
symlink-properties		cifs-share-symlink-properties[] optional	This flag controls whether the symlinks under this shared directory are hidden (option 'hide'), accessible (option 'enable') or are accessible as read-only (option 'read-only' along with option 'enable'). Possible values: "enable" , "hide" , "read_only"
Output Name	Range	Type	Description
result		cifs-share optional	The cifs-share created (keys or the entire object if requested)

Errno	Description
EINTERNALERROR

Deletes the specified CIFS share.

Input Name	Range	Type	Description
share-name		string	The name of the CIFS share. The CIFS share name is a UTF-8 string with the following characters being illegal: control characters from 0x00 to 0x1F, both inclusive, 0x22 (double quotes) and the characters \/[]:|<>+=;,?

Errno	Description
EAPIMISSINGARGUMENT
EAPILICENSE
EONTAPI_EINVAL
ESHAREACCESSDENIED
ESVCDISABLED
ESVCNOTAVAIL
EINTERNALERROR
EOBJECTNOTFOUND

Vfiler-enabled

Yes

License

cifs

Gives information about one or more CIFS shares.

Input Name	Range	Type	Description
desired-attributes		cifs-share optional	Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
max-records	[1..100]	integer optional	The maximum number of records to return in this call. Default: 20
query		cifs-share optional	A query that specifies which objects to return. A query could be specified on any number of attributes in the cifs-share object. All cifs-share objects matching this query up to 'max-records' will be returned.
tag		string optional	Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.
Output Name	Range	Type	Description
attributes-list		cifs-share[] optional	The list of attributes of cifs-share objects.
next-tag		string optional	Tag for the next call. Not present when there are no more cifs-share objects to return.
num-records	[0..100]	integer	The number of records returned in this call.

Errno	Description
EINTERNALERROR

Modifies settings of a CIFS share, even if the shares are in use.

Input Name	Range	Type	Description
attribute-cache-ttl	[0..2^32-1]	integer optional	The lifetime of an entry in the file attribute cache, in seconds. This value is used if the share has the 'attributecache' property set, which improves the performance of certain metadata operations in common workloads. The default is 10 seconds. Raising this value may improve performance, but the likelihood that stale metadata will be served increases as well. The value of this field must be in the range of 1 to 86400.
comment		string optional	This string gives a description of the CIFS share. CIFS clients see this description when browsing the Vserver's CIFS shares.
dir-umask	[0..777]	integer optional	The value of this field controls the file mode creation mask for the CIFS share in qtrees with UNIX or Mixed security styles. The mask restricts the initial permissions setting of a newly created directory. The input value is a numeric mode comprising of one to three octal digits (0-7), derived by adding up the bits with values 4, 2, and 1. The first digit selects permissions for the user who owns the file: read (4), write (2), and execute (1); the second selects permissions for other users in the file's group, with the same values; and the third for other users not in the file's group, with the same values.
file-umask	[0..777]	integer optional	The value of this field controls the file mode creation mask for the CIFS share in qtrees with UNIX or Mixed security styles. The mask restricts the initial permissions setting of a newly created file. The input value is a numeric mode comprising of one to three octal digits (0-7), derived by adding up the bits with values 4, 2, and 1. The first digit selects permissions for the user who owns the file: read (4), write (2), and execute (1); the second selects permissions for other users in the file's group, with the same values; and the third for other users not in the file's group, with the same values.
path		string optional	The file system path that is shared through this CIFS share.
share-name		string	The name of the CIFS share. The CIFS share name is a UTF-8 string with the following characters being illegal: control characters from 0x00 to 0x1F, both inclusive, 0x22 (double quotes) and the characters \/[]:|<>+=;,?
share-properties		cifs-share-properties[] optional	The list of properties for this CIFS share. Possible values: "oplocks" - This specifies that opportunistic locks (client-side caching) are enabled on this share., "browsable" - This specifies that the share can be browsed by Windows clients., "showsnapshot" - This specifies that Snapshots can be viewed and traversed by clients., "changenotify" - This specifies that CIFS clients can request for change notifications for directories on this share., "homedirectory" - This specifies that the share is added and enabled as part of the CIFS home directory feature. The configuration of this share should be done using CIFS home directory feature interface., "attributecache" - This specifies that connections through this share are caching attributes for a short time to improve performance.
symlink-properties		cifs-share-symlink-properties[] optional	This flag controls whether the symlinks under this shared directory are hidden (option 'hide'), accessible (option 'enable') or are accessible as read-only (option 'read-only' along with option 'enable'). Possible values: "enable" , "hide" , "read_only"

Errno	Description
EOBJECTNOTFOUND
EINTERNALERROR

Create a new CIFS symbolic link path mapping from a UNIX symlink to a target CIFS path. This symbolic link path mapping will be effective on symbolic links that have a prefix match with the value of 'unix-path'. e.g.: if the value of 'unix-path' is '/usr/local/' and there exists a symbolic link on the file system at '/home/user/link' which points to '/usr/local/share/dest'. If a CIFS client accesses the symbolic link 'link', this entry of path mapping would have a prefix match '/usr/local/'. The CIFS client would be redirected to the location pointed to by this path mapping's 'cifs-server', 'share-name' and 'cifs-path' fields.

Input Name	Range	Type	Description
cifs-path		string	This field specifies the CIFS path on the destination to which the symbolic link maps. The final path is generated by concatenating the CIFS server name, the share name, the cifs-path and the remaining path in the symbolic link left after the prefix match. This value is specified by using a UNIX-style path name. The trailing forward slash is required for the full path name to be properly interpreted. This is a UTF-8 string and supports localization.
cifs-server		string optional	This field specifies the destination CIFS server name for the mapping to which the symbolic link is mapped. The default is the local CIFS server. The field needs to be specified if the locality of the symbolic link is 'widelink'. This can be either a DNS name, NetBIOS name or an IP address. If a DNS name or a NetBIOS name are specified, the CIFS client configuration should be such that it is capable of resolving the CIFS server name to the correct IP address.
locality		cifs-symlink-locality optional	This field specifies whether the CIFS symbolic link is a local link or wide link. A local symbolic link maps to the local CIFS share, whereas a wide symbolic link maps to any CIFS share on the network. If the CIFS server matches the VServer's NetBIOS name then the default value is local otherwise widelink. Possible values: "local" - Share On This VServer, "widelink" - Share On Another CIFS Server
return-record		boolean optional	If set to true, returns the cifs-symlink on successful creation. Default: false
share-name		string	This field specifies the CIFS share name on the destination CIFS server to which the symbolic link is mapped. This is a UTF-8 string and supports localization.
unix-path		string	This field specifies the UNIX path prefix to be matched for the mapping. If the prefix of the target path in the symbolic link matches against this field, this entry of symbolic link path mapping would be used. The path is a UTF-8 string and supports localization. The path must start and end with a forward slash ('/'). For example '/usr/local/'.
Output Name	Range	Type	Description
result		cifs-symlink optional	The cifs-symlink created (keys or the entire object if requested)

Errno	Description
EINTERNALERROR

Delete a CIFS symbolic link path mapping.

Input Name	Range	Type	Description
unix-path		string	This field specifies the UNIX path prefix to be matched for the mapping. If the prefix of the target path in the symbolic link matches against this field, this entry of symbolic link path mapping would be used. The path is a UTF-8 string and supports localization. The path must start and end with a forward slash ('/'). For example '/usr/local/'.

Errno	Description
EOBJECTNOTFOUND
EINTERNALERROR

Retrieve the list of CIFS symbolic link path mappings.

Input Name	Range	Type	Description
desired-attributes		cifs-symlink optional	Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
max-records	[1..100]	integer optional	The maximum number of records to return in this call. Default: 20
query		cifs-symlink optional	A query that specifies which objects to return. A query could be specified on any number of attributes in the cifs-symlink object. All cifs-symlink objects matching this query up to 'max-records' will be returned.
tag		string optional	Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.
Output Name	Range	Type	Description
attributes-list		cifs-symlink[] optional	The list of attributes of cifs-symlink objects.
next-tag		string optional	Tag for the next call. Not present when there are no more cifs-symlink objects to return.
num-records	[0..100]	integer	The number of records returned in this call.

Errno	Description
EINTERNALERROR

Modify a CIFS symbolic link path mapping parameters.

Input Name	Range	Type	Description
cifs-path		string optional	This field specifies the CIFS path on the destination to which the symbolic link maps. The final path is generated by concatenating the CIFS server name, the share name, the cifs-path and the remaining path in the symbolic link left after the prefix match. This value is specified by using a UNIX-style path name. The trailing forward slash is required for the full path name to be properly interpreted. This is a UTF-8 string and supports localization.
cifs-server		string optional	This field specifies the destination CIFS server name for the mapping to which the symbolic link is mapped. The default is the local CIFS server. The field needs to be specified if the locality of the symbolic link is 'widelink'. This can be either a DNS name, NetBIOS name or an IP address. If a DNS name or a NetBIOS name are specified, the CIFS client configuration should be such that it is capable of resolving the CIFS server name to the correct IP address.
locality		cifs-symlink-locality optional	This field specifies whether the CIFS symbolic link is a local link or wide link. A local symbolic link maps to the local CIFS share, whereas a wide symbolic link maps to any CIFS share on the network. If the CIFS server matches the VServer's NetBIOS name then the default value is local otherwise widelink. Possible values: "local" - Share On This VServer, "widelink" - Share On Another CIFS Server
share-name		string optional	This field specifies the CIFS share name on the destination CIFS server to which the symbolic link is mapped. This is a UTF-8 string and supports localization.
unix-path		string	This field specifies the UNIX path prefix to be matched for the mapping. If the prefix of the target path in the symbolic link matches against this field, this entry of symbolic link path mapping would be used. The path is a UTF-8 string and supports localization. The path must start and end with a forward slash ('/'). For example '/usr/local/'.

Errno	Description
EOBJECTNOTFOUND
EINTERNALERROR

access rights Possible values: "no_access" - No access, "read" - Read, "change" - Change, "full_control" - Full Control

[none]

List of servers discovered by the cluster. When returned as part of the output, all elements of this typedef are reported, unless limited by a set of desired attributes specified by the caller. When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.

Name	Range	Type	Description
address		inet-address optional	The IP address of the server that was discovered. Attributes: non-creatable, non-modifiable
domain		string optional	The Active Directory domain that the discovered server is a member of. Attributes: key, non-creatable, non-modifiable
name		string optional	The hostname of the server that was discovered. Attributes: key, non-creatable, non-modifiable
node		node-name optional	The name of the node on which server discovery was done. Attributes: key, non-creatable, non-modifiable
prefer-type		cifs-domain-server-prefer-type optional	The preference level of the server that was discovered. Attributes: non-creatable, non-modifiable Possible values: "unknown" - The preference level of this server is unknown., "preferred" - This server was administratively marked as a preferred server due to its presence in the list of preferred servers., "favored" - This server was marked as favored by the server discovery process by virtue of site membership., "adequate" - This server was discovered by the server discovery process and can be used, but has no preference associated with it.
server-type		cifs-domain-discovered-server-type optional	The type of the server that was discovered. Attributes: key, non-creatable, non-modifiable Possible values: "unknown" - The server type is not known, "kerberos" - Kerberos server, "ms_ldap" - Microsoft Lightweight Directory Access Protocol (LDAP) server, "ms_dc" - Microsoft Domain Controller, "ldap" - Lightweight Directory Access Protocol (LDAP) server, "nis" - Network Information Service (NIS) server
status		cifs-domain-discovered-server-status optional	The status of the connection to the server that was discovered. Attributes: non-creatable, non-modifiable Possible values: "ok" - The connection to this server is usable., "unavailable" - This server is currently unavailable for use., "slow" - The connection to this server is usable but slow., "expired" - The connection to this server has expired.

List of preferred domain controllers associated with an Active Directory domain, organized by Vserver. When returned as part of the output, all elements of this typedef are reported, unless limited by a set of desired attributes specified by the caller. When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.

Name	Range	Type	Description
domain		string optional	The fully qualified domain name of the Active Directory domain to which the domain controllers in the list belong. Attributes: key, required-for-create, non-modifiable
preferred-dc		inet-address[] optional	The list of preferred domain controller IP addresses. Attributes: required-for-create, non-modifiable

This is a list of CIFS Home Directory search paths. When a CIFS client connects to a home directory share, these paths are searched in the order indicated by the 'position' field to find the user's home directory. When returned as part of the output, all elements of this typedef are reported, unless limited by a set of desired attributes specified by the caller. When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.

Name	Range	Type	Description
path		string optional	The file system path that will be searched for finding a CIFS user's home directory. Attributes: key, required-for-create, non-modifiable
position	[1..1024]	integer optional	The position of this entry in the list of paths that will be searched for finding a CIFS user's home directory. Attributes: key, non-creatable, non-modifiable

Display NetBIOS Statistics. When returned as part of the output, all elements of this typedef are reported, unless limited by a set of desired attributes specified by the caller. When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.

Name	Range	Type	Description
nbt-mode		string optional	Mode in which the NetBIOS Name Service is configured. Possible values: 'p' - Point to Point, 'h' - Hybrid, 'm' - Mixed or 'b' - Broadcast. Attributes: non-creatable, non-modifiable
nbt-name-state		string optional	Registration State of NetBIOS Name. Possible values: 'must_register', 'must_unregister', 'wins', 'broadcast', 'name_released', 'wins_conflict', 'broadcast_conflict. Attributes: non-creatable, non-modifiable
nbt-scope		string optional	Scope is used as a name for the set of NetBIOS nodes that participate in an NBT virtual LAN. Attributes: non-creatable, non-modifiable
netbios-name		string optional	NetBIOS Name. Attributes: key, non-creatable, non-modifiable
netbios-suffix		string optional	A NetBIOS suffix is the 16th character of the 16-character NetBIOS name. The NetBIOS suffix is used by Microsoft Networking software to identify functionality installed on the registered device. Attributes: key, non-creatable, non-modifiable
node		string optional	The name of the node on which nbtstat was done. Attributes: key, non-creatable, non-modifiable
registered-addresses		ip-address[] optional	List of interface IP Addresses for which the NetBIOS Name is registered. Attributes: non-creatable, non-modifiable
registered-type		string optional	Name registration type. Possible values: 'registered', 'active', 'permanent', 'group'. Attributes: non-creatable, non-modifiable
registration-time-left-minutes	[0..2^32-1]	integer optional	Time left in minutes for a name registered with WINS. Attributes: non-creatable, non-modifiable
vserver		string optional	The Vserver name on which nbtstat was done. Attributes: key, non-creatable, non-modifiable
wins-entries		wins-entry-info[] optional	Windows Internet Name Server (WINS) information

The CIFS specific tunables that can be set on a Vserver. When returned as part of the output, all elements of this typedef are reported, unless limited by a set of desired attributes specified by the caller. When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.

Name	Range	Type	Description
default-unix-user		string optional	This is the default UNIX user mapping that will be used if the identity of a CIFS user connot be mapped using normal name mapping rules. Attributes: optional-for-create, modifiable
is-smb2-enabled		boolean optional	This optional parameter specifies whether the CIFS server negotiates the SMB2 version of the CIFS protocol. The default value for this parameter is true. Attributes: optional-for-create, modifiable
read-grants-execute		enable optional	On a file with UNIX Style security effective on it, if the file has read permission on it, a CIFS user would be allowed to execute permissions if this option is enabled. Attributes: optional-for-create, modifiable
wins-servers		inet-address[] optional	List of Windows Internet Name Service (WINS) IP addresses. The Vserver will send NetBIOS name resolution requests to these addresses. Attributes: optional-for-create, modifiable

CIFS security tunable parameters. When returned as part of the output, all elements of this typedef are reported, unless limited by a set of desired attributes specified by the caller. When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.

Name	Range	Type	Description
kerberos-clock-skew	[0..2^32-1]	integer optional	The clock skew in minutes is the tolerance for accepting tickets with time stamps that do not exactly match the host's system clock. Attributes: required-for-create, modifiable
kerberos-renew-age	[0..2^32-1]	integer optional	This option determines the maximum amount of time in days for which a ticket can be renewed. Attributes: required-for-create, modifiable
kerberos-ticket-age	[0..2^32-1]	integer optional	This option determines the maximum amount of time in hours that a user's ticket may be used for the purpose of Kerberos authentication. Attributes: required-for-create, modifiable

Basic configuration information for the CIFS Server. When returned as part of the output, all elements of this typedef are reported, unless limited by a set of desired attributes specified by the caller. When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.

Name	Range	Type	Description
auth-style		cifs-auth-style optional	The authentication style to be used for CIFS clients connecting to this CIFS server. Attributes: non-creatable, non-modifiable Possible values: "domain" - DOMAIN, "workgroup" - WORKGROUP
cifs-server		netbios-name optional	The NetBIOS name of the CIFS server. Attributes: required-for-create, non-modifiable
default-site		string optional	The default site used by LIFs that do not have a site membership. Attributes: optional-for-create, modifiable
domain		string optional	The Fully Qualified Domain Name of the Windows Active Directory this CIFS server belongs to. Attributes: required-for-create, non-modifiable
domain-workgroup		domain-name optional	The NetBIOS name of the domain or workgroup this CIFS server belongs to. Attributes: non-creatable, non-modifiable
organizational-unit		string optional	The Organizational Unit (OU) within the Windows Active Directory this CIFS server belongs to. Attributes: optional-for-create, non-modifiable

CIFS share configuration. When returned as part of the output, all elements of this typedef are reported, unless limited by a set of desired attributes specified by the caller. When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.

Name	Range	Type	Description
acl		string[] optional	This string list gives the applicable Access Control list for the CIFS share. Each list entry is a '/' separated pair of the User or Group name and the effective permissions. The permission could be 'Full Control', Change', 'Read' or 'No access'. e.g.: If the group is 'Everyone' and the effective permission for this group is 'Change', the entry would be 'Everyone / Change'. Attributes: non-creatable, non-modifiable
attribute-cache-ttl	[0..2^32-1]	integer optional	The lifetime of an entry in the file attribute cache, in seconds. This value is used if the share has the 'attributecache' property set, which improves the performance of certain metadata operations in common workloads. The default is 10 seconds. Raising this value may improve performance, but the likelihood that stale metadata will be served increases as well. The value of this field must be in the range of 1 to 86400. Attributes: optional-for-create, modifiable
cifs-server		string optional	The NetBIOS name of the CIFS server that owns this share. Attributes: non-creatable, non-modifiable
comment		string optional	This string gives a description of the CIFS share. CIFS clients see this description when browsing the Vserver's CIFS shares. Attributes: optional-for-create, modifiable
dir-umask	[0..777]	integer optional	The value of this field controls the file mode creation mask for the CIFS share in qtrees with UNIX or Mixed security styles. The mask restricts the initial permissions setting of a newly created directory. The input value is a numeric mode comprising of one to three octal digits (0-7), derived by adding up the bits with values 4, 2, and 1. The first digit selects permissions for the user who owns the file: read (4), write (2), and execute (1); the second selects permissions for other users in the file's group, with the same values; and the third for other users not in the file's group, with the same values. Attributes: optional-for-create, modifiable
file-umask	[0..777]	integer optional	The value of this field controls the file mode creation mask for the CIFS share in qtrees with UNIX or Mixed security styles. The mask restricts the initial permissions setting of a newly created file. The input value is a numeric mode comprising of one to three octal digits (0-7), derived by adding up the bits with values 4, 2, and 1. The first digit selects permissions for the user who owns the file: read (4), write (2), and execute (1); the second selects permissions for other users in the file's group, with the same values; and the third for other users not in the file's group, with the same values. Attributes: optional-for-create, modifiable
path		string optional	The file system path that is shared through this CIFS share. Attributes: required-for-create, modifiable
share-name		string optional	The name of the CIFS share. The CIFS share name is a UTF-8 string with the following characters being illegal: control characters from 0x00 to 0x1F, both inclusive, 0x22 (double quotes) and the characters \/[]:|<>+=;,? Attributes: key, required-for-create, non-modifiable
share-properties		cifs-share-properties[] optional	The list of properties for this CIFS share. Attributes: optional-for-create, modifiable Possible values: "oplocks" - This specifies that opportunistic locks (client-side caching) are enabled on this share., "browsable" - This specifies that the share can be browsed by Windows clients., "showsnapshot" - This specifies that Snapshots can be viewed and traversed by clients., "changenotify" - This specifies that CIFS clients can request for change notifications for directories on this share., "homedirectory" - This specifies that the share is added and enabled as part of the CIFS home directory feature. The configuration of this share should be done using CIFS home directory feature interface., "attributecache" - This specifies that connections through this share are caching attributes for a short time to improve performance.
symlink-properties		cifs-share-symlink-properties[] optional	This flag controls whether the symlinks under this shared directory are hidden (option 'hide'), accessible (option 'enable') or are accessible as read-only (option 'read-only' along with option 'enable'). Attributes: optional-for-create, modifiable Possible values: "enable" , "hide" , "read_only"

The permissions that users and groups have to a CIFS share. When returned as part of the output, all elements of this typedef are reported, unless limited by a set of desired attributes specified by the caller. When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.

Name	Range	Type	Description
permission		cifs-access-perms optional	The access rights that the user or group has on the defined CIFS share. Attributes: required-for-create, modifiable Possible values: "no_access" - No access, "read" - Read, "change" - Change, "full_control" - Full Control
share		string optional	The CIFS share for which the permissions are defined. Attributes: key, required-for-create, non-modifiable
user-or-group		string optional	The user or group name for which the permissions are listed. Attributes: key, required-for-create, non-modifiable
winsid		windows-sid optional	The Windows SID for the user or group for which the permission is defined. Attributes: non-creatable, non-modifiable

The list of properties on a CIFS share. Possible values: "oplocks" - This specifies that opportunistic locks (client-side caching) are enabled on this share., "browsable" - This specifies that the share can be browsed by Windows clients., "showsnapshot" - This specifies that Snapshots can be viewed and traversed by clients., "changenotify" - This specifies that CIFS clients can request for change notifications for directories on this share., "homedirectory" - This specifies that the share is added and enabled as part of the CIFS home directory feature. The configuration of this share should be done using CIFS home directory feature interface., "attributecache" - This specifies that connections through this share are caching attributes for a short time to improve performance.

[none]

enable|hide|read_only Possible values: "enable" , "hide" , "read_only"

[none]

CIFS symbolic link path mapping configuration. When returned as part of the output, all elements of this typedef are reported, unless limited by a set of desired attributes specified by the caller. When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.

Name	Range	Type	Description
cifs-path		string optional	This field specifies the CIFS path on the destination to which the symbolic link maps. The final path is generated by concatenating the CIFS server name, the share name, the cifs-path and the remaining path in the symbolic link left after the prefix match. This value is specified by using a UNIX-style path name. The trailing forward slash is required for the full path name to be properly interpreted. This is a UTF-8 string and supports localization. Attributes: required-for-create, modifiable
cifs-server		string optional	This field specifies the destination CIFS server name for the mapping to which the symbolic link is mapped. The default is the local CIFS server. The field needs to be specified if the locality of the symbolic link is 'widelink'. This can be either a DNS name, NetBIOS name or an IP address. If a DNS name or a NetBIOS name are specified, the CIFS client configuration should be such that it is capable of resolving the CIFS server name to the correct IP address. Attributes: optional-for-create, modifiable
locality		cifs-symlink-locality optional	This field specifies whether the CIFS symbolic link is a local link or wide link. A local symbolic link maps to the local CIFS share, whereas a wide symbolic link maps to any CIFS share on the network. If the CIFS server matches the VServer's NetBIOS name then the default value is local otherwise widelink. Attributes: optional-for-create, modifiable Possible values: "local" - Share On This VServer, "widelink" - Share On Another CIFS Server
share-name		string optional	This field specifies the CIFS share name on the destination CIFS server to which the symbolic link is mapped. This is a UTF-8 string and supports localization. Attributes: required-for-create, modifiable
unix-path		string optional	This field specifies the UNIX path prefix to be matched for the mapping. If the prefix of the target path in the symbolic link matches against this field, this entry of symbolic link path mapping would be used. The path is a UTF-8 string and supports localization. The path must start and end with a forward slash ('/'). For example '/usr/local/'. Attributes: key, required-for-create, non-modifiable

Locality of the destination where this symbolic link points. Possible values: "local" - Share On This VServer, "widelink" - Share On Another CIFS Server

[none]

'enabled' or 'disabled'

[none]

Internet Address

[none]

Name of a client or a server participating in a NetBIOS Windows File sharing service network. This can be different from the host name.

[none]

access rights Possible values: "no_access" - No access, "read" - Read, "change" - Change, "full_control" - Full Control

[none]

domain|workgroup Possible values: "domain" - DOMAIN, "workgroup" - WORKGROUP

[none]

Classification of server based on the status of the connection. Possible values: "ok" - The connection to this server is usable., "unavailable" - This server is currently unavailable for use., "slow" - The connection to this server is usable but slow., "expired" - The connection to this server has expired.

[none]

The classification of servers based on service provided. Possible values: "unknown" - The server type is not known, "kerberos" - Kerberos server, "ms_ldap" - Microsoft Lightweight Directory Access Protocol (LDAP) server, "ms_dc" - Microsoft Domain Controller, "ldap" - Lightweight Directory Access Protocol (LDAP) server, "nis" - Network Information Service (NIS) server

[none]

The preference level of the server either set due to configuration or due to the site membership determined by server discovery. Possible values: "unknown" - The preference level of this server is unknown., "preferred" - This server was administratively marked as a preferred server due to its presence in the list of preferred servers., "favored" - This server was marked as favored by the server discovery process by virtue of site membership., "adequate" - This server was discovered by the server discovery process and can be used, but has no preference associated with it.

[none]

The domain name is an identification label that defines a realm based on Domain Name Service (DNS).

[none]

IPv4 address in dotted notation as '192.168.125.123'

[none]

The node's name

[none]

Unique Windows Security Identifier that identifies a User or Group or Machine account.

[none]

Windows Internet Name Server (WINS) information

Name	Range	Type	Description
wins-address		ip-address optional	Windows Internet Name Service (WINS) Server address. Attributes: non-creatable, non-modifiable
wins-state		string optional	WINS Server State. Possible values: 'active', 'inactive'. Attributes: non-creatable, non-modifiable

IPv4 address in dotted notation as '192.168.125.123'

[none]