vSAN Management API
| Local Properties | ||
Managed Object Types | Data Object Types | All Properties | All Methods |
Data Object - VsanFileShareQuerySpec(vim.vsan.FileShareQuerySpec)
- Parameter to
- VsanClusterQueryFileShares
- Extends
- DynamicData
- See also
- VsanFileShareQueryProperties
- Since
- 7.0
Data Object Description
Specification for querying vSAN file share information. If no information other than the domain name has been provided then all the share information under this domain will be returned. If any field is present, then only the shares matching the field query will be returned from the query spec. Due to the pagination mechanism, the file shares loaded through different API calls are not guaranteed to be atomic.Properties
Name | Type | Description |
---|---|---|
domainName* | xsd:string |
The name of the domain which the share belongs to. If not specified, the file
shares under all the domains will be queried.
|
limit* | xsd:long |
This field sets the upper limit for the maximum number of shares to be
returned per page. Default and maximum value for pagination limit is 64.
If the limit is larger than the allowed pagination size or is a negative
number, an InvalidArgument exception will be thrown.
|
managedBy* | xsd:string[] |
The filter for the managing entity of the file share. Valid values are in the
VsanFileShareManagingEntity field. See VsanFileShareManagingEntity Since vSAN 7.0U1 |
names* | xsd:string[] |
List of vSAN file share names to be queried.
|
offset* | xsd:string |
All file shares are sorted in alphabetical order. The offset indicates
the starting element of the file share name. For the query of multiple pages
the value should be the nextOffset of the return value of the last query. For
more explanation, see {@vim.vsan.FileShareQueryResult#nextOffset}. If the
offset cannot be found in the list, the next file share in alphabetical order
will be returned as the first element.
|
pageNumber* | xsd:long |
The page number to be returned. The page number can be used to browse the
pages of file shares returned between different pages. The page number starts
from 1, and defaults to 1. An InvalidArgument will be thrown if the page
number is set to a negative number or exceeds the maximum number of pages
to be returned.
The shares in the pagination starts from the offset specified by the
{@vim.vsan.FileShareQuerySpec#offset} parameter.
Since vSAN 7.0U1 |
properties* | VsanFileShareQueryProperties |
Specify the share properties to be returend. If not specified, all the
properties will be queried and returned. It is highly recommended to include
the needed properties only to improve the query performance.
Since vSAN 7.0U1 |
protocols* | xsd:string[] |
The protocol types to be queried. See VsanFileProtocol Since vSAN 7.0U1 |
uuids* | xsd:string[] |
List of the vSAN file share UUIDs to be queried.
|
Properties inherited from DynamicData | ||
None |
Show WSDL type definition
Top of page | Local Properties | ||
Managed Object Types | Data Object Types | All Properties | All Methods |