APIs in Category: cifs | Cluster-Mode API version 1.21

cifs-branchcache-get-iter cifs-domain-discovered-servers-get-iter cifs-domain-name-mapping-search-get-iter cifs-domain-preferred-dc-get-iter cifs-domain-trusts-get-iter cifs-home-directory-search-path-get-iter cifs-local-group-get-iter cifs-local-group-members-get-iter cifs-local-user-get-iter cifs-local-user-membership-get-iter cifs-nbtstat-get-iter cifs-options-get-iter cifs-privilege-get-iter cifs-security-get-iter cifs-server-get-iter cifs-session-file-get-iter cifs-session-get-iter cifs-share-access-control-get-iter cifs-share-get-iter cifs-symlink-get-iter | This set of APIs allows managing CIFS configuration.

NetApp Manage ONTAP

cifs-branchcache-get-iter | [top]

> Retrieve the per-Vserver BranchCache configurations for the cluster.

> Input Name | Range | Type | Description
> desired-attributes |  | cifs-branchcache 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..2^32-1] | integer optional | The maximum number of records to return in this call. Default: 20
> query |  | cifs-branchcache optional | A query that specifies which objects to return. A query could be specified on any number of attributes in the cifs-branchcache object. All cifs-branchcache 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-branchcache[] optional | The list of attributes of cifs-branchcache objects.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more cifs-branchcache objects to return.
> num-records | [0..2^32-1] | integer | The number of records returned in this call.

> Errno | Description
> EINTERNALERROR |  |

cifs-domain-discovered-servers-get-iter | [top]

> Retrieve the list of servers discovered by the cluster.

> 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..2^32-1] | 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..2^32-1] | integer | The number of records returned in this call.

> Errno | Description
> EINTERNALERROR |  |

cifs-domain-name-mapping-search-get-iter | [top]

> Retrieve the list of trusted domains for name-mapping search.

> Input Name | Range | Type | Description
> desired-attributes |  | cifs-domain-name-mapping-search 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..2^32-1] | integer optional | The maximum number of records to return in this call. Default: 20
> query |  | cifs-domain-name-mapping-search optional | A query that specifies which objects to return. A query could be specified on any number of attributes in the cifs-domain-name-mapping-search object. All cifs-domain-name-mapping-search 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-name-mapping-search[] optional | The list of attributes of cifs-domain-name-mapping-search objects.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more cifs-domain-name-mapping-search objects to return.
> num-records | [0..2^32-1] | integer | The number of records returned in this call.

> Errno | Description
> EINTERNALERROR |  |

cifs-domain-preferred-dc-get-iter | [top]

> 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..2^32-1] | 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..2^32-1] | integer | The number of records returned in this call.

> Errno | Description
> EINTERNALERROR |  |

cifs-domain-trusts-get-iter | [top]

> Retrieve the list of discovered trusted domains.

> Input Name | Range | Type | Description
> desired-attributes |  | cifs-domain-trusts 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..2^32-1] | integer optional | The maximum number of records to return in this call. Default: 20
> query |  | cifs-domain-trusts optional | A query that specifies which objects to return. A query could be specified on any number of attributes in the cifs-domain-trusts object. All cifs-domain-trusts 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-trusts[] optional | The list of attributes of cifs-domain-trusts objects.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more cifs-domain-trusts objects to return.
> num-records | [0..2^32-1] | integer | The number of records returned in this call.

> Errno | Description
> EINTERNALERROR |  |

cifs-home-directory-search-path-get-iter | [top]

> 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..2^32-1] | 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..2^32-1] | integer | The number of records returned in this call.

> Errno | Description
> EINTERNALERROR |  |

cifs-local-group-get-iter | [top]

> Retrieve the list of local groups

> Input Name | Range | Type | Description
> desired-attributes |  | cifs-local-group 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..2^32-1] | integer optional | The maximum number of records to return in this call. Default: 20
> query |  | cifs-local-group optional | A query that specifies which objects to return. A query could be specified on any number of attributes in the cifs-local-group object. All cifs-local-group 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-local-group[] optional | The list of attributes of cifs-local-group objects.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more cifs-local-group objects to return.
> num-records | [0..2^32-1] | integer | The number of records returned in this call.

> Errno | Description
> EINTERNALERROR |  |

cifs-local-group-members-get-iter | [top]

> Retrieve the list of local group members

> Input Name | Range | Type | Description
> desired-attributes |  | cifs-local-group-members 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..2^32-1] | integer optional | The maximum number of records to return in this call. Default: 20
> query |  | cifs-local-group-members optional | A query that specifies which objects to return. A query could be specified on any number of attributes in the cifs-local-group-members object. All cifs-local-group-members 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-local-group-members[] optional | The list of attributes of cifs-local-group-members objects.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more cifs-local-group-members objects to return.
> num-records | [0..2^32-1] | integer | The number of records returned in this call.

> Errno | Description
> EINTERNALERROR |  |

cifs-local-user-get-iter | [top]

> Retrieve the list of local users

> Input Name | Range | Type | Description
> desired-attributes |  | cifs-local-user 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..2^32-1] | integer optional | The maximum number of records to return in this call. Default: 20
> query |  | cifs-local-user optional | A query that specifies which objects to return. A query could be specified on any number of attributes in the cifs-local-user object. All cifs-local-user 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-local-user[] optional | The list of attributes of cifs-local-user objects.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more cifs-local-user objects to return.
> num-records | [0..2^32-1] | integer | The number of records returned in this call.

> Errno | Description
> EINTERNALERROR |  |

cifs-local-user-membership-get-iter | [top]

> Retrieve local users' membership information

> Input Name | Range | Type | Description
> desired-attributes |  | cifs-local-user-membership 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..2^32-1] | integer optional | The maximum number of records to return in this call. Default: 20
> query |  | cifs-local-user-membership optional | A query that specifies which objects to return. A query could be specified on any number of attributes in the cifs-local-user-membership object. All cifs-local-user-membership 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-local-user-membership[] optional | The list of attributes of cifs-local-user-membership objects.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more cifs-local-user-membership objects to return.
> num-records | [0..2^32-1] | integer | The number of records returned in this call.

> Errno | Description
> EINTERNALERROR |  |

cifs-nbtstat-get-iter | [top]

> 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..2^32-1] | 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..2^32-1] | integer | The number of records returned in this call.

> Errno | Description
> EINTERNALERROR |  |

cifs-options-get-iter | [top]

> 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..2^32-1] | 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..2^32-1] | integer | The number of records returned in this call.

> Errno | Description
> EINTERNALERROR |  |

cifs-privilege-get-iter | [top]

> Retrieve the list of local groups

> Input Name | Range | Type | Description
> desired-attributes |  | cifs-privilege 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..2^32-1] | integer optional | The maximum number of records to return in this call. Default: 20
> query |  | cifs-privilege optional | A query that specifies which objects to return. A query could be specified on any number of attributes in the cifs-privilege object. All cifs-privilege 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-privilege[] optional | The list of attributes of cifs-privilege objects.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more cifs-privilege objects to return.
> num-records | [0..2^32-1] | integer | The number of records returned in this call.

> Errno | Description
> EINTERNALERROR |  |

cifs-security-get-iter | [top]

> 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..2^32-1] | 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..2^32-1] | integer | The number of records returned in this call.

> Errno | Description
> EINTERNALERROR |  |

cifs-server-get-iter | [top]

> 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..2^32-1] | 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..2^32-1] | integer | The number of records returned in this call.

> Errno | Description
> EINTERNALERROR |  |

cifs-session-file-get-iter | [top]

> Retrieve the list of the opened CIFS files.

> Input Name | Range | Type | Description
> desired-attributes |  | cifs-session-file 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..2^32-1] | integer optional | The maximum number of records to return in this call. Default: 20
> query |  | cifs-session-file optional | A query that specifies which objects to return. A query could be specified on any number of attributes in the cifs-session-file object. All cifs-session-file 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-session-file[] optional | The list of attributes of cifs-session-file objects.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more cifs-session-file objects to return.
> num-records | [0..2^32-1] | integer | The number of records returned in this call.

> Errno | Description
> EINTERNALERROR |  |

cifs-session-get-iter | [top]

> Retrieve the list of the established CIFS sessions.

> Input Name | Range | Type | Description
> desired-attributes |  | cifs-session 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..2^32-1] | integer optional | The maximum number of records to return in this call. Default: 20
> query |  | cifs-session optional | A query that specifies which objects to return. A query could be specified on any number of attributes in the cifs-session object. All cifs-session 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-session[] optional | The list of attributes of cifs-session objects.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more cifs-session objects to return.
> num-records | [0..2^32-1] | integer | The number of records returned in this call.

> Errno | Description
> EINTERNALERROR |  |

cifs-share-access-control-get-iter | [top]

> 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..2^32-1] | 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..2^32-1] | integer | The number of records returned in this call.

> Errno | Description
> EINTERNALERROR |  |

cifs-share-get-iter | [top]

> 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..2^32-1] | 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..2^32-1] | integer | The number of records returned in this call.

> Errno | Description
> EINTERNALERROR |  |

cifs-symlink-get-iter | [top]

> 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..2^32-1] | 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..2^32-1] | integer | The number of records returned in this call.

> Errno | Description
> EINTERNALERROR |  |

Element definition: cifs-branchcache | [top]

> CIFS BranchCache 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
> hash-store-max-size |  | size optional | Maximum size the hash store can grow to. Attributes: optional-for-create, modifiable
> hash-store-path |  | string optional | Path to the directory where hash files are stored. Attributes: required-for-create, modifiable
> operating-mode |  | string optional | The mode in which the BranchCache service will operate. Attributes: optional-for-create, modifiable
> server-key |  | string optional | BranchCache server key. Attributes: optional-for-create, modifiable
> versions |  | cifs-bc-version-control[] optional | Versions of the BranchCache protocol that are supported. Attributes: optional-for-create, modifiable
> vserver |  | vserver-name optional | The name of the Vserver associated with this CIFS server. Attributes: key, non-creatable, non-modifiable

Element definition: cifs-domain-discovered-servers | [top]

> 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., "undetermined" - A connection to this server has not been attempted., "unreachable" - This server is currently unreachable.
> vserver |  | vserver-name optional | The name of the Vserver which scopes the discovered servers. Attributes: key, non-creatable, non-modifiable

Element definition: cifs-domain-name-mapping-search | [top]

> List of trusted domains, 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
> trusted-domains |  | realm-name[] optional | The list of trusted domains used for name-mapping. Attributes: required-for-create, modifiable
> vserver |  | vserver-name optional | Vserver containing the CIFS server. Attributes: key, non-creatable, non-modifiable

Element definition: cifs-domain-preferred-dc | [top]

> 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
> vserver |  | vserver-name optional | Vserver containing the CIFS server. Attributes: key, non-creatable, non-modifiable

Element definition: cifs-domain-trusts | [top]

> List of trusted domains discovered. 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
> home-domain |  | realm-name optional | The fully-qualified domain name of the Active Directory domain the CIFS server is joined to. Attributes: non-creatable, non-modifiable
> node |  | node-name optional | The name of the node on which discovery was done. Attributes: key, non-creatable, non-modifiable
> trusted-domain |  | realm-name[] optional | A domain that has a trust relationship with the home domain. Attributes: non-creatable, non-modifiable
> vserver |  | vserver-name optional | The name of the Vserver which scopes the discovered trusted domains. Attributes: key, non-creatable, non-modifiable

Element definition: cifs-home-directory-search-path | [top]

> 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
> vserver |  | vserver-name optional | The name of the Vserver associated with this CIFS server. Attributes: key, non-creatable, non-modifiable

Element definition: cifs-local-group | [top]

> List of local groups, 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
> description |  | string optional | The description of the local group Attributes: optional-for-create, modifiable
> group-name |  | cifs-name optional | The name of the local group Attributes: key, required-for-create, non-modifiable
> vserver |  | vserver-name optional | Vserver Attributes: key, non-creatable, non-modifiable

Element definition: cifs-local-group-members | [top]

> List of local groups, 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
> group-name |  | cifs-name optional | The name of the local group Attributes: key, non-creatable, non-modifiable
> member |  | cifs-name optional | The member of a local group Attributes: non-creatable, non-modifiable
> vserver |  | vserver-name optional | Vserver Attributes: key, non-creatable, non-modifiable

Element definition: cifs-local-user | [top]

> List of local users, 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
> description |  | string optional | The description of the local user Attributes: optional-for-create, modifiable
> full-name |  | string optional | Full name of the local user Attributes: optional-for-create, modifiable
> is-account-disabled |  | boolean optional | The user account is disabled Attributes: optional-for-create, modifiable
> user-name |  | cifs-name optional | The name of the local user Attributes: key, required-for-create, non-modifiable
> vserver |  | vserver-name optional | Vserver Attributes: key, non-creatable, non-modifiable

Element definition: cifs-local-user-membership | [top]

> List of local users' membership information, 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
> membership |  | cifs-name optional | The membership of the local user Attributes: non-creatable, non-modifiable
> user-name |  | cifs-name optional | The name of the local user Attributes: key, non-creatable, non-modifiable
> vserver |  | vserver-name optional | Vserver Attributes: key, non-creatable, non-modifiable

Element definition: cifs-nbtstat | [top]

> 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

Element definition: cifs-options | [top]

> 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-group |  | string optional | The default UNIX group used if the identity of a CIFS group cannot be mapped using normal group mapping rules. Attributes: optional-for-create, modifiable
> default-unix-user |  | string optional | The default UNIX user used if the identity of a CIFS user cannot be mapped using normal user mapping rules. Attributes: optional-for-create, modifiable
> file-system-sector-size |  | cifs-filesystem-sector-size optional | This optional parameter specifies the size of file system sector in bytes reported to SMB Clients. Attributes: optional-for-create, modifiable Possible values: "512" - Reported file system sector size to SMB clients is 512 bytes, "4096" - Reported file system sector size to SMB clients is 4096 bytes
> is-copy-offload-enabled |  | boolean optional | This optional parameter specifies whether the CIFS server is capable of performing copy offload operation. The default value for this parameter is true. Attributes: optional-for-create, modifiable
> is-exportpolicy-enabled |  | boolean optional | This optional parameter specifies whether the CIFS server uses export policies to control client access. The default value for this parameter is false. Attributes: optional-for-create, modifiable
> is-local-auth-enabled |  | boolean optional | This optional parameter specifies whether CIFS local users can authenticate. Attributes: optional-for-create, modifiable
> is-local-users-and-groups-enabled |  | boolean optional | This optional parameter specifies whether the CIFS local users and groups feature is enabled on the cluster. Attributes: optional-for-create, modifiable
> is-referral-enabled |  | boolean optional | This optional parameter specifies whether the CIFS server refers clients to more optimal data access paths (LIFs). The default value for this parameter is false. Attributes: optional-for-create, modifiable
> is-shadowcopy-enabled |  | boolean optional | This optional parameter specifies whether the CIFS server is capable of performing shadow copy operations. Attributes: optional-for-create, modifiable
> is-smb2-enabled |  | boolean optional | This optional parameter specifies whether the CIFS server negotiates the SMB2 versions of the CIFS protocol. The default value for this parameter is true. Attributes: optional-for-create, modifiable
> is-smb3-enabled |  | boolean optional | This optional parameter specifies whether the CIFS server negotiates the SMB3 version of the CIFS protocol. The default value for this parameter is true. Attributes: optional-for-create, modifiable
> is-trusted-domain-enum-search-enabled |  | boolean optional | This optional parameter specifies whether the CIFS server is capable of performing enumeration of trusted domains and search to map a UNIX user to a Windows user. Attributes: optional-for-create, modifiable
> is-unix-nt-acl-enabled |  | boolean optional | This optional parameter specifies whether NT ACLs can be set on a volume with UNIX security-style. Attributes: optional-for-create, modifiable
> is-use-junctions-as-reparse-points-enabled |  | boolean optional | This optional parameter specifies whether the CIFS server exposes junction points as reparse points to Windows clients. Attributes: optional-for-create, modifiable
> max-mpx | [2..65535] | integer optional | This option controls maximum simultaneous operations the CIFS server reports it can process per TCP connection. The default value for this option is 255. 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
> restrict-anonymous |  | anonymous-restriction-level optional | This optional parameter specifies what level of access will a non authenticated user get Attributes: optional-for-create, modifiable Possible values: "no_restriction" - No Access Restriction for NULL User., "no_enumeration" - Only Enumeration Is Restricted., "no_access" - Access Restricted for NULL User.
> shadowcopy-dir-depth | [0..2^32-1] | integer optional | This optional parameter specifies the maximum depth of directories to shadow copy. Attributes: optional-for-create, modifiable
> vserver |  | vserver-name optional | The name of the Vserver associated with this CIFS server. Attributes: key, non-creatable, non-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

Element definition: cifs-privilege | [top]

> List of privileges assigned to local or Active Directory users or groups, 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
> privileges |  | cifs-privilege-entries[] optional | The privileges associated with a local or Active Directory user or group Attributes: non-creatable, non-modifiable Possible values: "setcbprivilege" - Act as part of the operating system, "sebackupprivilege" - Back up files and directories, overriding any ACLs, "serestoreprivilege" - Restore files and directories, overriding any ACLs, "setakeownershipprivilege" - Take ownership of files or other objects, "sesecurityprivilege" - Manage auditing and viewing/dumping/clearing the security log
> user-or-group-name |  | cifs-name optional | The name of the local or Active Directory user or group Attributes: non-creatable, non-modifiable
> vserver |  | vserver-name optional | Vserver Attributes: key, non-creatable, non-modifiable

Element definition: cifs-security | [top]

> 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
> is-password-complexity-required |  | boolean optional | This option determines whether password complexity is required for local users. By default this option is true. Attributes: non-creatable, modifiable
> is-signing-required |  | boolean optional | This option determines whether signing is required for incoming CIFS traffic. By default this option is false. Attributes: non-creatable, modifiable
> 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: non-creatable, 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: non-creatable, 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: non-creatable, modifiable
> use-start-tls-for-ad-ldap |  | boolean optional | This option determines whether to use start-tls for AD LDAP connections. By default this option is false. Attributes: non-creatable, modifiable
> vserver |  | vserver-name optional | The name of the Vserver associated with this CIFS server. Attributes: key, non-creatable, non-modifiable

Element definition: cifs-server-config | [top]

> 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
> administrative-status |  | service-state optional | CIFS Server Administrative Status. Attributes: optional-for-create, modifiable Possible values: "down" , "up"
> 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, 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
> vserver |  | string optional | Vserver containing the CIFS server. Attributes: key, non-creatable, non-modifiable

Element definition: cifs-session | [top]

> Displays the established CIFS sessions 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 |  | ip-address optional | The ip address of the workstation from which the session is opened. Attributes: non-creatable, non-modifiable
> auth-mechanism |  | auth-mechanism optional | The authentication mechanism used to establish the session. Attributes: non-creatable, non-modifiable Possible values: "none" , "ntlmv1" , "ntlmv2" , "kerberos" , "anonymous"
> connected-time |  | elapsed-time optional | The time duration since the session was established. Attributes: non-creatable, non-modifiable
> connection-id | [0..2^32-1] | integer optional | The connection that is used to establish the session. Attributes: non-creatable, non-modifiable
> continuously-available |  | cifs-ca-protection optional | The type of continuous avalability protection provided to the session. Attributes: non-creatable, non-modifiable Possible values: "no" - The open file is not continuously available. For sessions, it contains one or more open file but none of them are continuously available., "yes" - The open file is continuously available. For sessions, it contains one or more open files and all of them are continuously available., "partial" - This value is used for sessions only. It contains at least one continuously available open file but other open files that are not.
> files | [0..2^64-1] | integer optional | The number of the regular files that are opened under the session. Attributes: non-creatable, non-modifiable
> idle-time |  | elapsed-time optional | The time duration since there was last activity on the session. Attributes: non-creatable, non-modifiable
> lif-address |  | ip-address optional | The data lif that is used to establish the session. Attributes: non-creatable, non-modifiable
> node |  | string optional | The name of the node on which the session listing is done. Attributes: key, required-for-create, non-modifiable
> other | [0..2^64-1] | integer optional | The number of the special files that are opened under the session. Attributes: non-creatable, non-modifiable
> protocol-version |  | cifs-dialects optional | The CIFS protocol version that is used to establish the session. Attributes: non-creatable, non-modifiable Possible values: "smb1" - SMB 1.0, "smb2" - SMB 2.0, "smb2_1" - SMB 2.1, "smb3" - SMB 3.0
> session-id | [0..2^64-1] | integer optional | The unique identifier for the session. Attributes: non-creatable, non-modifiable
> shares | [0..2^32-1] | integer optional | The number of the CIFS shares that are opened under the session. Attributes: non-creatable, non-modifiable
> unix-user |  | string optional | The name of the UNIX user for which the session is established. Attributes: non-creatable, non-modifiable
> vserver |  | string optional | The Vserver name on which the session listing is done. Attributes: key, non-creatable, non-modifiable
> windows-user |  | string optional | The name of the CIFS user for which the session is established. Attributes: non-creatable, non-modifiable

Element definition: cifs-session-file | [top]

> Displays the opened CIFS files 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
> connection-id | [0..2^32-1] | integer optional | The connection that is used to open the file. Attributes: non-creatable, non-modifiable
> continuously-available |  | cifs-ca-protection optional | The type of continuous availability protection provided to the file. Attributes: non-creatable, non-modifiable Possible values: "no" - The open file is not continuously available. For sessions, it contains one or more open file but none of them are continuously available., "yes" - The open file is continuously available. For sessions, it contains one or more open files and all of them are continuously available., "partial" - This value is used for sessions only. It contains at least one continuously available open file but other open files that are not.
> file-id | [0..2^64-1] | integer optional | The unique identifier for the opened file. Attributes: key, required-for-create, non-modifiable
> file-type |  | cifs-file-type optional | The type of opened file. Attributes: non-creatable, non-modifiable Possible values: "regular" , "symlink" , "stream" , "directory"
> hosting-aggregate |  | aggr-name optional | The name of the aggregate on which the file resides. Attributes: non-creatable, non-modifiable
> hosting-volume |  | volume-name optional | The name of the volume on which the file resides. Attributes: non-creatable, non-modifiable
> node |  | string optional | The name of the node on which the file listing is done. Attributes: key, required-for-create, non-modifiable
> open-mode |  | cifs-open-mode optional | The mode in which the file is opened. Attributes: non-creatable, non-modifiable Possible values: "r" - Read, "w" - Write, "d" - Delete
> path |  | string optional | The path of the file. Attributes: non-creatable, non-modifiable
> range-locks | [0..2^32-1] | integer optional | The number of range locks granted on the file. Attributes: non-creatable, non-modifiable
> reconnected |  | string optional | The state that represents if the file was opened after network disconnect. Attributes: non-creatable, non-modifiable
> session-id | [0..2^64-1] | integer optional | The session under which file is opened. Attributes: non-creatable, non-modifiable
> share |  | cifs-share-name optional | The share name where the file resides. Attributes: non-creatable, non-modifiable
> share-mode |  | cifs-open-mode optional | The share mode used to open the file. Attributes: non-creatable, non-modifiable Possible values: "r" - Read, "w" - Write, "d" - Delete
> vserver |  | string optional | The Vserver name on which the file listing is done. Attributes: key, non-creatable, non-modifiable

Element definition: cifs-share | [top]

> 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
> offline-files-mode |  | string optional | Mode of the offline file for the CIFS share. The default value is manual. Possible values: "none" - Clients are not permitted to cache files for offline access., "manual" - Clients may cache files that are explicitly selected by the user for offline use., "documents" - Clients may automatically cache files that are used by the user for offline access., "programs" - Clients may automatically cache files that are used by the user for offline access and may use those files in an offline mode even if the share is available.
> path |  | string optional | The file system path that is shared through this CIFS share. The path is the full, user visible path relative to the vserver root, and it might be crossing junction mount points. The path is in UTF8 and uses forward slash as directory separator. 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. "branchcache" - This specifies that clients connecting to this share can make requests using BranchCache technology that allows them to cache the content in an attempt to reduce WAN utilization from a remote office. "continuously_available" - This specifies that clients connecting to this share can open files in a persistent manner. Files opened this way are protected from disruptive events, such as failover and giveback. "shadowcopy" - This specifies that the share is pointing to a shadow copy. This attribute cannot be added nor removed from a share. "access_based_enumeration" - This specifies that Access Based Enumeration is enabled on this share. ABE-filtered shared folders are visible to a user based on that individual user's access rights, preventing the display of folders or other shared resources that the user does not have rights to access.
> 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"
> volume |  | string optional | The name of the volume where the root of the CIFS share resides.
> vscan-fileop-profile |  | vscan-fileop-profile optional | Profile-set of file-ops to which Vscan On-Access scanning is applicable. The default value is standard. Possible values: "no_scan" - Virus scans are never triggered for accesses to this share, "standard" - Virus scans can be triggered by open, close, and rename operations, "strict" - Virus scans can be triggered by open, read, close, and rename operations, "writes_only" - Virus scans can be triggered only when a file that has been modified is closed.
> vserver |  | string optional | The name of the Vserver. Attributes: key, required-for-create, non-modifiable

Element definition: cifs-share-access-control | [top]

> 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
> vserver |  | vserver-name optional | The name of the Vserver associated with this CIFS server. Attributes: key, non-creatable, 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

Element definition: cifs-symlink | [top]

> 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
> vserver |  | vserver-name optional | The name of the Vserver associated with this CIFS server. Attributes: key, non-creatable, non-modifiable

Element definition: aggr-name | [top]

> Name of the aggregate

> [none]

Element definition: anonymous-restriction-level | [top]

> Classification of the CIFS null user restriction. Possible values: "no_restriction" - No Access Restriction for NULL User., "no_enumeration" - Only Enumeration Is Restricted., "no_access" - Access Restricted for NULL User.

> [none]

Element definition: auth-mechanism | [top]

> The list of possible known authentication mechanisms supported by the CIFS server. Possible values: "None" - None "NTLMv1" - NTLMv1 "NTLMv2" - NTLMv2 "Kerberos" - Kerberos "Anonymous" - Anonymous

> [none]

Element definition: cifs-access-perms | [top]

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

> [none]

Element definition: cifs-auth-style | [top]

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

> [none]

Element definition: cifs-bc-version-control | [top]

> Versions of CIFS BranchCache that are currently supported.

> [none]

Element definition: cifs-ca-protection | [top]

> The list of possible protection levels. Open files are "Continuously Available" if they are opened from an SMB 3 client through a share with the "continuously_available" property set. These open files are capable of non-disruptively recovering from takeover and giveback as well as general aggregate relocation between partners in a high-availability relationship. This is in addition to the traditional SMB 2 capability allowing clients to recover from LIF migration and other brief network interruptions. Note: The CA protection levels depicts the continuous availability at the connection level so it might not be accurate for a session if the connection has multiple sessions. Streams opened through a continuously available share are permitted, but are not currently made continuously available. Directories may be opened through a continuously available share, but will not appear continuously available as clients do not open them that way by design. These protection levels are applicable to the sessions/files on read/write volumes on SFO aggregates. Possible values: "No" - The open file is not continuously available. For sessions, it contains one or more open files but none of them are continuously available. "Yes" - The open file is continuously available. For sessions, it contains one or more open files and all of them are continuously available. "Partial" - This value is used for sessions only. It contains at least one continuously available open file but other open files that are not.

> [none]

Element definition: cifs-dialects | [top]

> The list of possible known dialects Dialects negotiated by CIFS servers. Possible values: "SMB1" - SMB 1.0 "SMB2" - SMB 2.0 "SMB2_1" - SMB 2.1 "SMB3" - SMB 3.0

> [none]

Element definition: cifs-domain-discovered-server-status | [top]

> 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., "undetermined" - A connection to this server has not been attempted., "unreachable" - This server is currently unreachable.

> [none]

Element definition: cifs-domain-discovered-server-type | [top]

> 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]

Element definition: cifs-domain-server-prefer-type | [top]

> 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]

Element definition: cifs-file-type | [top]

> The list of possible types of files opened through CIFS servers. Possible values: "Regular" - Regular file "Symlink" - Symlink file "Stream" - Stream file "Directory" - Directory

> [none]

Element definition: cifs-filesystem-sector-size | [top]

> CIFS File System Sector sizes reported to SMB Clients (in bytes). Possible values: "512" - Reported file system sector size to SMB clients is 512 bytes, "4096" - Reported file system sector size to SMB clients is 4096 bytes

> [none]

Element definition: cifs-name | [top]

> [none]

Element definition: cifs-open-mode | [top]

> The list of possible modes used when opening files over CIFS servers. Possible values: "R" - The file opened for read operation. "W" - The file opened for write operation. "D" - The file opened for delete operation.

> [none]

Element definition: cifs-privilege-entries | [top]

> Privilege Possible values: "setcbprivilege" - Act as part of the operating system, "sebackupprivilege" - Back up files and directories, overriding any ACLs, "serestoreprivilege" - Restore files and directories, overriding any ACLs, "setakeownershipprivilege" - Take ownership of files or other objects, "sesecurityprivilege" - Manage auditing and viewing/dumping/clearing the security log

> [none]

Element definition: cifs-share-name | [top]

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

> [none]

Element definition: cifs-share-properties | [top]

> 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. "branchcache" - This specifies that clients connecting to this share can make requests using BranchCache technology that allows them to cache the content in an attempt to reduce WAN utilization from a remote office. "continuously_available" - This specifies that clients connecting to this share can open files in a persistent manner. Files opened this way are protected from disruptive events, such as failover and giveback. "shadowcopy" - This specifies that the share is pointing to a shadow copy. This attribute cannot be added nor removed from a share.

> [none]

Element definition: cifs-share-symlink-properties | [top]

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

> [none]

Element definition: cifs-symlink-locality | [top]

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

> [none]

Element definition: domain-name | [top]

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

> [none]

Element definition: elapsed-time | [top]

> The difference between the two points in time.

> [none]

Element definition: enable | [top]

> 'enabled' or 'disabled'

> [none]

Element definition: inet-address | [top]

> Internet Address

> [none]

Element definition: ip-address | [top]

> IPv4 and IPv6 address

> [none]

Element definition: netbios-name | [top]

> 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]

Element definition: node-name | [top]

> The node's name

> [none]

Element definition: realm-name | [top]

> [none]

Element definition: service-state | [top]

> down|up Possible values: "down" , "up"

> [none]

Element definition: size | [top]

> Size in bytes Range : [0..2^63-1].

> [none]

Element definition: volume-name | [top]

> The name of the volume. Volume names can contain letters, numbers, and the underscore character (_). The first character must be a letter or an underscore. When creating a Cluster-Mode volume, the user can specify at most 203 characters. If the prefix '/vol/' appears in the volume name, it is striped out and the characters that follow the prefix constitute the actual volume name. Volume names are scoped by their owning Vserver in a cluster, with each Vserver's volume namespace being totally independent. Thus, any Vserver 'S' in a cluster cannot have two volumes with the same name 'V'. However, two different Vservers in the same cluster can each have a volume named 'V'. For example, any given Vserver in a cluster can only have at most one volume named 'vol0'. However, two different Vservers S1 and S2 in the cluster may each have a volume named 'vol0'.

> [none]

Element definition: vscan-fileop-profile | [top]

> Profile-set of file-ops to which Vscan On-Access scanning is applicable. Possible values: "no_scan" - Virus scans are never triggered for accesses to this share, "standard" - Virus scans can be triggered by open, close, and rename operations, "strict" - Virus scans can be triggered by open, read, close, and rename operations, "writes_only" - Virus scans can be triggered only when a file that has been modified is closed.

> [none]

Element definition: vserver-name | [top]

> The name of the Vserver.

> [none]

Element definition: windows-sid | [top]

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

> [none]

Element definition: wins-entry-info | [top]

> 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

Element definition: ip-address | [top]

> IPv4 and IPv6 address

> [none]