VsanFileShareQueryProperties

VsanFileShareQueryProperties

Defines the set of share properties returned from the VsanClusterQueryFileShares API.

The properties #uuid, #name and #domainName are always included as they are the identifiers of the file share.

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

AllOf

This class requires all of the following:

DataObject

JSON Example

{
    "_typeName": "string",
    "includeBasic": false,
    "includeUsedCapacity": false,
    "includeVsanObjectUuids": false,
    "includeAllLabels": false,
    "labelKeys": [
        "string"
    ]
}

boolean

includeBasic

Optional

Basic share properties include all properties for a file share, except #labels, #usedCapacity and #vsanObjectUuids.

The default value is True.

boolean

includeUsedCapacity

Optional

Specify whether to return #usedCapacity property of the share.

The default value is False.

boolean

includeVsanObjectUuids

Optional

Specify whether to return #vsanObjectUuids property of the share.

The default value is False.

boolean

includeAllLabels

Optional

Specify whether to return #labels property of the share.

The default value is False. If this field is True, all share labels will be returned.

array of string

labelKeys

Optional

Specify the label keys to be returned.

This field will be ignored if includeAllLabels is set to True. If a label key does not exist in a share, the label will not be returned with the share. An InvalidArgument will be thrown if the number of label keys exceeds 5.

Property Of

ArrayOfVsanFileShareQueryProperties