VsanFileShareQuerySpec

VsanFileShareQuerySpec

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.

This structure may be used only with operations rendered under /vsan.

AllOf

This class requires all of the following:

DataObject

JSON Example

{
    "_typeName": "string",
    "domainName": "string",
    "uuids": [
        "string"
    ],
    "names": [
        "string"
    ],
    "offset": "string",
    "limit": 0,
    "managedBy": [
        "string"
    ],
    "protocols": [
        "string"
    ],
    "pageNumber": 0,
    "properties": {
        "_typeName": "string",
        "includeBasic": false,
        "includeUsedCapacity": false,
        "includeVsanObjectUuids": false,
        "includeAllLabels": false,
        "labelKeys": [
            "string"
        ]
    }
}

string

domainName

Optional

The name of the domain which the share belongs to.

If not specified, the file shares under all the domains will be queried.

array of string

uuids

Optional

List of the vSAN file share UUIDs to be queried.

array of string

names

Optional

List of vSAN file share names to be queried.

string

offset

Optional

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 #nextOffset. If the offset cannot be found in the list, the next file share in alphabetical order will be returned as the first element.

integer As int64 As int64

limit

Optional

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.

array of string

managedBy

Optional

The filter for the managing entity of the file share.

Valid values are in the VsanFileShareManagingEntityEnum field.

See also VsanFileShareManagingEntityEnum.

array of string

protocols

Optional

The protocol types to be queried.

See also VsanFileProtocolEnum.

integer As int64 As int64

pageNumber

Optional

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 #offset parameter.

properties

Optional

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.

Property Of

ArrayOfVsanFileShareQuerySpec