vSAN Management API

		Local Properties
Managed Object Types	Data Object Types	All Properties	All Methods

Data Object - VsanSpaceUsage(vim.cluster.VsanSpaceUsage)

Property of

VsanSpaceUsageWithDatastoreType

Returned by

VsanQuerySpaceUsage

Extends

DynamicData

See also

VimVsanDataEfficiencyCapacityState, VsanHealthThreshold, VsanObjectSpaceSummary, VsanSpaceEfficiencyRatio, VsanSpaceUsageDetailResult, VsanWhatifCapacity

Since

vSphere API Release 5.5

Data Object Description

Describes the vSAN space usage. There are multiple ways to present the space usage. One way is presenting the overall vSAN cluster system space usage like total used space in which how much data is physically written into disk and how much is the over-reserved space size. A second is listing the space usage breakdown per vSAN object type defined in below enumerations: VsanObjectTypeEnum, VsanObjectTypeEnum90

Properties

Name	Type	Description
capacityHealthThreshold*	VsanHealthThreshold	Indicates the yellow or red threshold, in bytes, for capacity usage based on current cluster capacityReservationInfo. Since vSAN 7.0U1
efficientCapacity*	VimVsanDataEfficiencyCapacityState	The vSAN efficient capacity breakdown details when the vSAN cluster enables data efficiency. Since 6.7
freeCapacityB*	xsd:long	The free vSAN capacity in byte. It's the total of free vSAN physical space which can be used for writing data including any of user data, metadata and the overhead data.
spaceDetail*	VsanSpaceUsageDetailResult	The vSAN space usage detail by breakdown the usage into different vSAN object type.
spaceEfficiencyRatio*	VsanSpaceEfficiencyRatio	Indicates the vSAN space efficiency ratio, it exists only when vSAN efficiency feature is enabled, including dedup and compression. Since 8.0.0.4
spaceOverview*	VsanObjectSpaceSummary	The vSAN space usage overview including the vSAN physically written capacity, the reserved and over-reserved capacity and the total used capacity. It shares the same data structure as the per vSAN object type space usage summary VsanObjectSpaceSummary without setting the object type.
totalCapacityB	xsd:long	The total vSAN capacity in byte, which is the total used and free capacity combined. It's the total of physical space which can be use for writing data including any of user data, metadata and the overhead data.
uncommittedB*	xsd:long	Total additional storage space, in bytes, potentially used by all vSAN objects except for the virtual machine swap objects and namespace objects on this vSAN datastore. It can be retrieved through VsanQuerySpaceUsage by specifying whatifCapacityOnly as False. Since VMC M5
whatifCapacities*	VsanWhatifCapacity[]	The vSAN capacity details if all objects are stored with the specified storage policy. Since vSAN 6.7U1
Properties inherited from DynamicData
None

*Need not be set
Show WSDL type definition

<complexType xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanSpaceUsage"> <complexContent> <extension base="vsan:DynamicData"> <sequence> <element name="totalCapacityB" type="xsd:long"/> <element name="freeCapacityB" type="xsd:long" minOccurs="0"/> <element name="spaceOverview" type="vsan:VsanObjectSpaceSummary" minOccurs="0"/> <element name="spaceDetail" type="vsan:VsanSpaceUsageDetailResult" minOccurs="0"/> <element name="efficientCapacity" type="vsan:VimVsanDataEfficiencyCapacityState" minOccurs="0"/> <element name="whatifCapacities" type="vsan:VsanWhatifCapacity" minOccurs="0" maxOccurs="unbounded"/> <element name="uncommittedB" type="xsd:long" minOccurs="0"/> <element name="capacityHealthThreshold" type="vsan:VsanHealthThreshold" minOccurs="0"/> <element name="spaceEfficiencyRatio" type="vsan:VsanSpaceEfficiencyRatio" minOccurs="0"/> </sequence> </extension> </complexContent> </complexType>

Top of page		Local Properties
Managed Object Types	Data Object Types	All Properties	All Methods