vSAN Management API


Data Object - VsanObjectSpaceSummary(vim.cluster.VsanObjectSpaceSummary)

Property of
VsanEntitySpaceUsage, VsanObjectIdentityAndHealth, VsanSpaceUsage, VsanSpaceUsageDetailResult
Extends
DynamicData
Since
vSphere API Release 5.5

Data Object Description

Describe the vSAN space usage aggregation by the object type defined in VsanObjectTypeEnum. There are multiple ways to breakdown the space usage of an object. One breakdown is about understanding the vSAN replication overhead, by separating user data, permanent overhead for failure tolerance and temporary overhead. A second breakdown is understanding how much data is physically written into disk and how much space is reserved and over-reserved for the vSAN object so that we can know the potentially wasted space due to object reservation.

Properties

Name Type Description
objType*xsd:string

The vSAN object type. It could be one of types defined in below enumerations: VsanObjectTypeEnum, VsanObjectTypeEnum90
objTypeExt*xsd:string

Extended type for extension object to identify different extension volume

Since 7.1
objTypeExtDesc*xsd:string

Description of extended type for extension object

Since 7.1
overheadB*xsd:long

The overhead for this type of vSAN object in byte. The overhead includes the space like replica data, witness metadata and RAID 5/6 parity data etc. The sum of overhead, temporary overhead and the primary data size will equal to the object total used size
overReservedB*xsd:long

The total over reserved capacity for this type of vSAN object in byte. It indicates how much capacity is over-reserved between the total reserved capacity and the actual user data written into disk. In other words, such space is potentially wasted, and reducing the reservation would free up space.
physicalUsedB*xsd:long

The total of physically used capacity for this type of vSAN object in byte. It indicates how much data are written into the physical disk.
primaryCapacityB*xsd:long

The primary capacity for this type of vSAN object in byte. The primary data is the actual user data written into physical disk which doesn't include any overhead, e.g. temporary overhead or replica data.
provisionCapacityB*xsd:long

The total provisioned capacity for this type of vSAN object in byte. It's the total user requested logical capacity from the vSAN data store
reservedCapacityB*xsd:long

The total reserved capacity for this type of vSAN object in byte. When user create the virtual disk from vSAN datastore, he/she can specify how many physical space should be reserved for the virtual disk through disk provisioning policy or legacy thick provisioning.
snapshotUsedB*xsd:long

The snapshot reclaimable size for this type of vSAN object in byte. The snaphsot reclaimable size is the size that can be freed after deleting the snapshot. It is only applicable for vSAN ESA objects.

Since 8.0.0.1
temporaryOverheadB*xsd:long

The temporary overhead for this type of vSAN object in byte. The temporary overhead include the space like used for data moving and will be released eventually.
usedB*xsd:long

The total of used capacity for this type of vSAN object in byte. It's the max value between physically used capacity and the reserved capacity.
Properties inherited from DynamicData
None
*Need not be set
Show WSDL type definition