Host Vsan Health System Vsan Host Query Check Limits

Host Vsan Health System Vsan Host Query Check Limits

Determines limit health, i.e.

if any system resources (free disk space, vSAN component counts, etc.) are exhausted, or would be exhausted after simulated failures. All information is as seen by this host, which under network partitions is not the global view.

Required privileges: System.Read

Request
URI
POST
https://{api_host}/sdk/vim25/{release}/vsan/HostVsanHealthSystem/{moId}/VsanHostQueryCheckLimits
COPY
Path Parameters
string
moId
Required

The unique identifier for the managed object to which the method attaches; the serialized managed object reference for a request has the form moType/moId, in this case HostVsanHealthSystem/{moId}.

string
release
Required

The vSphere release schema. The current specification covers vSphere 9.0.0.0 APIs.


Request Body
VsanHostQueryCheckLimitsRequestType of type(s) application/json
Required
"VsanHostQueryCheckLimitsRequestType Object"
spec
Optional

Please refer to VsanHostQueryCheckLimitsSpec for more details.

Authentication
This operation uses the following authentication methods.
Responses
200

Summarized limit health as seen by this host

Returns VsanLimitHealthResult of type(s) application/json
"VsanLimitHealthResult Object"
string
hostname
Optional

The host name

boolean
issueFound
Required

Whether any issue found in the vSAN limit health check.

integer As int32 As int32
maxComponents
Required

The maximum number of supported vSAN components in the host.

integer As int32 As int32
freeComponents
Required

The number of remaining vSAN components can be created in the host.

It equals to the maximum supported components minus the used components.

string
componentLimitHealth
Required

The host component usage health status.

The status will be red if the used components exceeds 90% of total component number, the status will be yellow if it exceeds 75% of total components and it will be green if it's less than 75% of total component.

integer As int32 As int32
lowestFreeDiskSpacePct
Required

The lowest free disk space percentage among all of disks in the host.

This value will be 100 if there is no disk found in the host.

integer As int64 As int64
usedDiskSpaceB
Required

The total used disk space in byte, which is the larger value between reserved capacity and the data physically written into the disk.

integer As int64 As int64
totalDiskSpaceB
Required

The total vSAN capacity in byte.

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

string
diskFreeSpaceHealth
Required

The disk free space health status.

The status will be red if the used disk space is larger than 90% of total space, the status will be yellow if it's larger than 70% of total space and it will be green if it's less than 70% of total space.

integer As int64 As int64
reservedRcSizeB
Required

The reserved read cache size in byte.

integer As int64 As int64
totalRcSizeB
Required

The total read cache size in byte.

string
rcFreeReservationHealth
Required

The read cache reservation health status.

The status will be red if the reserved read cache space is larger than 90% of total space, the status will be yellow if it's larger than 80% of total space and it will be green if it's less than 80% of total space.

integer As int64 As int64
totalLogicalSpaceB
Optional

The total logical capacity in byte.

integer As int64 As int64
logicalSpaceUsedB
Optional

The logical capacity used in byte.

integer As int64 As int64
dedupMetadataSizeB
Optional

The dedupMetadataSize used in byte.

integer As int64 As int64
diskTransientCapacityUsedB
Optional

The disk transient used in byte.

integer As int64 As int64
dgTransientCapacityUsedB
Optional

The disk group transient used in byte.

integer As int64 As int64
slackSpaceCapRequired
Optional

The space required by the vSAN internal operations like policy reconfiguration and we expect user to reserve this in cluster.

integer As int64 As int64
resyncPauseThreshold
Optional

The space threshold to pause vSAN data resync operation, e.g., the reserved space for storage policy related object reconfigurations.

spaceEfficiencyMetadataSizeB
Optional

vSAN space efficiency metadata size in byte.

integer As int64 As int64
hostRebuildCapacity
Optional

The space required for host rebuild if one of the host is down

integer As int64 As int64
minSpaceRequiredForVsanOp
Optional

The space required by the vSAN internal operations like policy reconfiguration at cluster level.

integer As int64 As int64
enforceCapResrvSpace
Optional

The additional space reserved by the vSAN internal operation at cluster level when vSAN operation capacity is enforced.

integer As int64 As int64
cdReservedSizeB
Optional

The total reserved capacity size in byte for all the capacity disks on a host.


500

Failure

Returns NotFound of type(s) application/json
"NotFound Object"

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/sdk/vim25/{release}/vsan/HostVsanHealthSystem/{moId}/VsanHostQueryCheckLimits
                
V San Service Api Operations
POST
Host Vsan Health System Vsan Host Clomd Liveness
POST
Host Vsan Health System Vsan Host Cleanup Vmdk Load Test
Deprecated
POST
Host Vsan Health System Vsan Host Create Vm Health Test
POST
Host Vsan Health System Vsan Flash Scsi Controller Firmware Task
Deprecated
POST
Host Vsan Health System Vsan Get Hcl Info
POST
Host Vsan Health System Vsan Get Network Diagnostics Health Info
POST
Host Vsan Health System Vsan Get Proactive Rebalance Info
POST
Host Vsan Health System Vsan Host Prepare Vmdk Load Test
Deprecated
POST
Host Vsan Health System Vsan Host Query Adv Cfg
POST
Host Vsan Health System Vsan Host Query Check Limits
POST
Host Vsan Health System Vsan Host Query Encryption Health Summary
POST
Host Vsan Health System Vsan Host Query File Service Health Summary
POST
Host Vsan Health System Vsan Query Host EMM State
POST
Host Vsan Health System Vsan Host Query Host Info By Uuids
POST
Host Vsan Health System Vsan Host Query Object Health Summary
POST
Host Vsan Health System Vsan Host Query Physical Disk Health Summary
POST
Host Vsan Health System Vsan Host Query Run Iperf Client
POST
Host Vsan Health System Vsan Host Query Run Iperf Server
POST
Host Vsan Health System Vsan Host Query Smart Stats
POST
Host Vsan Health System Vsan Host Query Verify Network Settings
POST
Host Vsan Health System Vsan Host Query Health System Version
POST
Host Vsan Health System Vsan Host Repair Immediate Objects
POST
Host Vsan Health System Vsan Host Run Vmdk Load Test
Deprecated
POST
Host Vsan Health System Vsan Start Proactive Rebalance
POST
Host Vsan Health System Vsan Stop Proactive Rebalance
POST
Host Vsan Health System Vsan Wait For Vsan Health Generation Id Change