VsanEntitySpaceUsage

VsanEntitySpaceUsage
VsanEntitySpaceUsage

This is base class describing the vSAN space usage for the general vSAN entity like virtual machine.

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

AllOf
This class requires all of the following:
JSON Example
{
    "_typeName": "string",
    "entityId": "string",
    "spaceUsageByObjectType": [
        {
            "_typeName": "string",
            "objType": "string",
            "overheadB": 0,
            "temporaryOverheadB": 0,
            "primaryCapacityB": 0,
            "provisionCapacityB": 0,
            "reservedCapacityB": 0,
            "overReservedB": 0,
            "physicalUsedB": 0,
            "usedB": 0,
            "objTypeExt": "string",
            "objTypeExtDesc": "string",
            "snapshotUsedB": 0
        }
    ],
    "totalCapacityB": 0,
    "freeCapacityB": 0,
    "efficientCapacity": {
        "_typeName": "string",
        "logicalCapacity": 0,
        "logicalCapacityUsed": 0,
        "physicalCapacity": 0,
        "physicalCapacityUsed": 0,
        "dedupMetadataSize": 0,
        "spaceEfficiencyMetadataSize": {
            "_typeName": "string",
            "dedupMetadataSize": 0,
            "compressionMetadataSize": 0
        },
        "esaDedupSpaceSaving": 0,
        "esaCompressionSpaceSaving": 0,
        "totalSpaceUsedWithoutOverhead": 0
    }
}
string
entityId
Optional

The vSAN object entity ID.

For the entity like virtual machine, it's the managed object ID like 'vm-1'.

spaceUsageByObjectType
Optional

The vSAN space usage breakdown by object type for all of vSAN objects belonging to the entity.

integer As int64 As int64
totalCapacityB
Optional

The total 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.

integer As int64 As int64
freeCapacityB
Optional

The free capacity in byte.

It's the total of free physical space which can be used for writing data including any of user data, metadata and the overhead data.

efficientCapacity
Optional

The efficient capacity breakdown details when the vSAN cluster enables data efficiency.