vSAN Management API


Data Object - VsanFileShareQueryProperties(vim.vsan.FileShareQueryProperties)

Property of
VsanFileShareQuerySpec
Extends
DynamicData
Since
vSAN 7.0U1

Data Object Description

Defines the set of share properties returned from the VsanClusterQueryFileShares API. The properties {@vim.vsan.FileShare#uuid}, {@vim.vsan.FileShareConfig#name} and {@vim.vsan.FileShareConfig#domainName} are always included as they are the identifiers of the file share.

Properties

Name Type Description
includeAllLabels*xsd:boolean

Specify whether to return {@vim.vsan.FileShareConfig#labels} property of the share. The default value is False. If this field is True, all share labels will be returned.
includeBasic*xsd:boolean

Basic share properties include all properties for a file share, except {@vim.vsan.FileShareConfig#labels}, {@vim.vsan.FileShareRuntimeInfo#usedCapacity} and {@vim.vsan.FileShareRuntimeInfo#vsanObjectUuids}. The default value is True.
includeUsedCapacity*xsd:boolean

Specify whether to return {@vim.vsan.FileShareRuntimeInfo#usedCapacity} property of the share. The default value is False.
includeVsanObjectUuids*xsd:boolean

Specify whether to return {@vim.vsan.FileShareRuntimeInfo#vsanObjectUuids} property of the share. The default value is False.
labelKeys*xsd:string[]

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.
Properties inherited from DynamicData
None
*Need not be set
Show WSDL type definition