EntityResourceCheckDetails

EntityResourceCheckDetails
EntityResourceCheckDetails

Details about the resource check result for a given entity.

The result contains information of current and predicted usage the various resources, like capacity, for the entity. For example, for a host result contains current and predicted capacity usage and component counts.

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

AllOf
This class requires all of the following:
JSON Example
{
    "_typeName": "string",
    "name": "string",
    "uuid": "string",
    "isNew": false,
    "capacity": 0,
    "postOperationCapacity": 0,
    "usedCapacity": 0,
    "postOperationUsedCapacity": 0,
    "additionalRequiredCapacity": 0,
    "maxComponents": 0,
    "components": 0
}
string
name
Optional

The friendly name for this entity.

This is the name specified by user when the entity is created or updated.

string
uuid
Optional

The vSAN UUID of the entity.

boolean
isNew
Optional

The flag indicates whether this is a new resource entity that is recommended to be added for more resources in order to make the operation succeed.

For example, for a disk group entity the flag indicates whether this is a new disk group that is recommended to be added for more resources in order to make the operation succeed.

integer As int64 As int64
capacity
Optional

The total physical capacity of the entity in bytes.

For example, host capacity will be sum of all disk-group's capacity on the host. If isNew is true, the currentUsage is set to 0 since this a recommendation for adding new resource.

integer As int64 As int64
postOperationCapacity
Optional

The predicted total physical capacity of the resource entity in bytes after the operation is done.

For example, if the resource check is for host enter maintenance mode operation the capacity which host was contributing will be removed from the fault domain's total physical capacity.

integer As int64 As int64
usedCapacity
Optional

The current physical usage of the entity in bytes.

If isNew is true, the currentUsage is set to 0.

integer As int64 As int64
postOperationUsedCapacity
Optional

The predicted physical usage of the resource entity in bytes after the operation is done.

For example, if the resource check is for host enter maintenance mode operation, vSAN will simulate the disk usage after the given host enters maintenance mode. If vSAN deduplication and compression is enabled during the operation, vSAN simulation will not take this into consideration and thus will make a conservative estimation of the post-operation disk usage with data non-deduplicated and uncompressed. If vSAN deduplication and compression is disabled during the operation, vSAN simulation will use the average of current deduplication/compression rate of all disk-groups in the cluster to estimate the inflation of data for a rough calculation of the post-operation disk usage.

integer As int64 As int64
additionalRequiredCapacity
Optional

vSAN's recommendation for additional capacity for this entity to be added in order to make the operation succeed.

This will be sum of all child entitie's additionalRequiredCapacity required. For example, host's additional capacity will be sum of all disk-group's additional capacity on the host.

integer As int64 As int64
maxComponents
Optional

Number of maximum vSAN components this entity can hold.

integer As int64 As int64
components
Optional

Predicted number of vSAN components on this entity post operation.

Property Of
Used By