VsanSpaceUsage

VsanSpaceUsage
VsanSpaceUsage

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: VsanObjectTypeEnumEnum, VsanObjectTypeEnum90Enum

AllOf
This class requires all of the following:
JSON Example
{
    "_typeName": "string",
    "totalCapacityB": 0,
    "freeCapacityB": 0,
    "spaceOverview": {
        "_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
    },
    "spaceDetail": {
        "_typeName": "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
            }
        ]
    },
    "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
    },
    "whatifCapacities": [
        {
            "_typeName": "string",
            "totalWhatifCapacityB": 0,
            "freeWhatifCapacityB": 0,
            "storagePolicy": {
                "_typeName": "string"
            },
            "isSatisfiable": false
        }
    ],
    "uncommittedB": 0,
    "capacityHealthThreshold": {
        "_typeName": "string",
        "yellowValue": 0,
        "redValue": 0,
        "target": "string",
        "enabled": false
    },
    "spaceEfficiencyRatio": {
        "_typeName": "string",
        "overallRatio": "number",
        "compressionRatio": "number",
        "dedupRatio": "number"
    }
}
integer As int64 As int64
totalCapacityB
Required

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.

integer As int64 As int64
freeCapacityB
Optional

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.

spaceOverview
Optional

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.

spaceDetail
Optional

The vSAN space usage detail by breakdown the usage into different vSAN object type.

efficientCapacity
Optional

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

array of VsanWhatifCapacity
whatifCapacities
Optional

The vSAN capacity details if all objects are stored with the specified storage policy.

integer As int64 As int64
uncommittedB
Optional

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 VsanSpaceReportSystem.VsanQuerySpaceUsage by specifying whatifCapacityOnly as False.

capacityHealthThreshold
Optional

Indicates the yellow or red threshold, in bytes, for capacity usage based on current cluster capacityReservationInfo.

spaceEfficiencyRatio
Optional

Indicates the vSAN space efficiency ratio, it exists only when vSAN efficiency feature is enabled, including dedup and compression.

Since: 8.0.0.4

Property Of
Returned By