Vsan Cluster Health System Vsan Query Cluster Check Limits

Vsan Cluster Health System Vsan Query Cluster Check Limits

Queries the vSAN cluster component limits, disk space and read cache reservation assuming one host failure

Required privileges: System.Read

Request
URI
POST
https://{api_host}/sdk/vim25/{release}/vsan/VsanClusterHealthSystem/{moId}/VsanQueryClusterCheckLimits
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 VsanClusterHealthSystem/{moId}.

string
release
Required

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

Request Body
VsanQueryClusterCheckLimitsRequestType of type(s) application/json
Required 
"VsanQueryClusterCheckLimitsRequestType Object"
array of string
hosts
Required

The vSAN hosts

string
esxRootPassword
Required

The root password for the host. The password should be the same for all of hosts in the vSAN cluster

Authentication
This operation uses the following authentication methods.
Responses
200

The vSAN cluster limit health result

Returns VsanClusterLimitHealthResult of type(s) application/json 
"VsanClusterLimitHealthResult Object"
boolean
issueFound
Required

Whether any health issue was found

string
componentLimitHealth
Required

The component usage health status.

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

string
diskFreeSpaceHealth
Required

The aggregated result of the host level disk usage health status.

On one host, the status will be red if the used disk space is greater than 90% of the host's total space and the status will be yellow if the used percentage is greater than 70% and not greater than 90%. The status will be green if the used percentage is not greater than 70%.

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 70% of total space and it will be green if it's less than 70% of total space

array of object
hostResults
Optional

Per host results.

Hosts for which the limit check failed will not be included.

array of object
whatifHostFailures
Optional

Simulation results for 0, 1 or more host failures.

array of string
hostsCommFailure
Optional

Indicates names of hosts which are not able to communicate with


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/VsanClusterHealthSystem/{moId}/VsanQueryClusterCheckLimits
On This Page
V San Service Api Operations
POST
Vsan Cluster Health System Vsan Check Cluster Clomd Liveness
POST
Vsan Cluster Health System Vsan Cluster Get Hcl Info
POST
Vsan Cluster Health System Vsan Query Cluster Adv Cfg Sync
POST
Vsan Cluster Health System Vsan Query Cluster Capture Vsan Pcap
POST
Vsan Cluster Health System Vsan Query Cluster Check Limits
POST
Vsan Cluster Health System Vsan Query Cluster Create Vm Health Test
POST
Vsan Cluster Health System Vsan Query Cluster Health System Versions
POST
Vsan Cluster Health System Vsan Query Cluster Network Perf Test
POST
Vsan Cluster Health System Vsan Query Cluster Physical Disk Health Summary
POST
Vsan Cluster Health System Vsan Query Verify Cluster Network Settings
POST
Vsan Cluster Health System Vsan Repair Cluster Immediate Objects