Vsan Vc Cluster Health System Vsan Query Vc Cluster Health Summary
Perform a cluster wide health check across all types of health checks.
It's the primary API for fetching vSAN health status. This API runs a wide variety of health checks in many different categories against the cluster and returns both API-friendly and UI-friendly data. The 'fields' parameter should be used to return what the client is really interested in to limit the big result size for performance consideration. The API can either perform a health check against the up-to-date state of the hosts in the cluster and takes several seconds to return or it can retrieve the latest cached result to return in second. It's encouraged to fetch the cached data to get the quick response unless an update is required. Note: when this API is called directly from an ESXi host, following test groups are not supported: groupId = com.vmware.vsan.health.test.hcl
Querying vSAN cluster requires System.Read privilege on the cluster. If the API is called to have pre-flight health check on a bunch of hosts, System.Read privilege on all these hosts is required.
See also VsanHealthPerspectiveEnum, VsanHealthPerspective90Enum.
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 VsanVcClusterHealthSystem/{moId}.
The vSphere release schema. The current specification covers vSphere 9.0.0.0 APIs.
"VsanQueryVcClusterHealthSummaryRequestType Object"The target cluster
vmCreateTimeout
objUuids
Whether to include detailed per-object health in the result. Default to True. Set to false if this value is not of importance to save computing resources.
If set, only the properties listed in the array are returned in the result data object. Normally the output of this API can be quite large so this allows clients which are only interested in a subset to save network bandwidth and deserialization effort. The possible value is the field from the VsanClusterHealthSummary class like 'objectHealth', 'networkHealth' etc If unset, following properities are included in the result. 'clusterStatus', 'timestamp', 'clusterVersions', 'objectHealth', 'vmHealth', 'networkHealth', 'limitHealth', 'advCfgSync', 'createVmHealth', 'physicalDisksHealth', 'hclInfo', 'groups', 'overallHealth', 'overallHealthDescription', 'clomdLiveness', 'diskBalance'
True to return the result from cache directly instead of running the full health check. The cache will be updated and keep the latest vSAN health summary check result either triggering from user on-demand request or the periodical vSAN health check for triggering health event/alarm. Default is False.
The total amount of health checks is split into multiple different perspectives. This parameter controls which health checks are performed/returned. All supported values are defined in below enumerations: VsanHealthPerspectiveEnum, VsanHealthPerspective90Enum.
Include the individual host(s) into the health check, with other hosts specified with the cluster parameter.
Health summary query specification VsanClusterHealthQuerySpec.
Returns a health summary data object.
"VsanClusterHealthSummary Object"Structure which aggregates vSAN Health service installation status of all ESX hosts in cluster.
The timestamp for generating the health summary.
The timestamp will remain unchanged if the health summary is cached and fetched in future indicating when the health check was performed
Health system version information across the cluster.
Meant for programmatic consumption.
Object health information across the cluster.
Meant for programmatic consumption.
Ignore this value.
Network health information across the cluster.
Meant for programmatic consumption.
Limits health information across the cluster.
Meant for programmatic consumption.
Advanced configuration synchronization information across the cluster.
Meant for programmatic consumption.
VM creation results information across the cluster.
Meant for programmatic consumption. Will only be populated if the respective test was run.
Physical vSAN disk information across the cluster.
Meant for programmatic consumption.
Encryption information across the cluster.
Meant for programmatic consumption.
HCL check information across the cluster.
Meant for programmatic consumption.
Data driven structure to display all health findings for purpose of rendering a UI.
The health findings are grouped into "groups" of "tests". Each group and each test has a description, health, and optionally one or more "details" tables to display additional information about the test. Programmatic consumption of the health findings should avoid parsing this structure because it is meant for UI consumption and the content will change to improve user experience.
Health Enum.
Summarizes all groups and provides a high level status across all categories of health. This Enum defines sets labels for sets of health checks.
A human readable, short, description of the overallHealth status.
As there may be many issues detected, the most important one is selected to be described. This should be the one getting first customer attention.
CLOMD liveness on every vSAN host.
Meant for programmatic consumption
Balance of disk utilization across the cluster.
Generic cluster configuration best practices checks.
Network configuration best practices checks.
vSAN configuration checks.
Deprecated as of vSphere API 6.7.
vSAN burn in test checks.
vSAN performance service health check result.
The target cluster
File service health information across the cluster.
Meant for programmatic consumption. If the file service is not enabled, this field would not be set.
Data-in-transit encryption information across the cluster.
Meant for programmatic consumption.
The overall health score ranging from 0 to 100 based on the vSAN cluster health check result.
The global dedup health summary across the cluster.
Meant for programmatic consumption.
VsanFault: If the perspective validation failed, or the API is queried from vSAN witness node, or any unexpected runtime error.
"VimFault Object" curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/sdk/vim25/{release}/vsan/VsanVcClusterHealthSystem/{moId}/VsanQueryVcClusterHealthSummary