# Data Object - VsanClusterHealthSummary(vim.cluster.VsanClusterHealthSummary)

Property of
  VsanResourceCheckResult
Returned by
  VsanQueryClusterHistoricalHealth, VsanQueryVcClusterHealthSummary
Extends
  DynamicData
See also
  ClusterComputeResource, VsanBurnInTestCheckResult, VsanClusterAdvCfgSyncResult, VsanClusterBalanceSummary, VsanClusterClomdLivenessResult, VsanClusterDitEncryptionHealthSummary, VsanClusterEncryptionHealthSummary, VsanClusterFileServiceHealthSummary, VsanClusterHclInfo, VsanClusterHealthGroup, VsanClusterHealthSystemStatusResult, VsanClusterHealthSystemVersionResult, VsanClusterLimitHealthResult, VsanClusterNetworkHealthResult, VsanClusterVMsHealthOverallResult, VsanConfigCheckResult, VsanGenericClusterBestPracticeHealth, VsanHostCreateVmHealthTestResult, VsanNetworkConfigBestPracticeHealth, VsanObjectOverallHealth, VsanPerfsvcHealthResult, VsanPhysicalDiskHealthSummary
Since
  vSphere API 5.5

## Data Object Description

Cluster vSAN health summary, which aggregates all individual health results. Includes data structures both for data driven UIs, as well as programmatic access by non-UI consumers.

Properties

Name | Type | Description
--- | --- | ---
advCfgSync* | VsanClusterAdvCfgSyncResult[] | Advanced configuration synchronization information across the cluster. Meant for programmatic consumption.
burnInTest* | VsanBurnInTestCheckResult | Deprecated. As of vSphere API 6.7. vSAN burn in test checks. Since vSAN API 6.6
clomdLiveness* | VsanClusterClomdLivenessResult | CLOMD liveness on every vSAN host. Meant for programmatic consumption
cluster* | ManagedObjectReference to a ClusterComputeResource | The target cluster Since vSAN API 7.0
clusterStatus* | VsanClusterHealthSystemStatusResult |
clusterVersions* | VsanClusterHealthSystemVersionResult | Health system version information across the cluster. Meant for programmatic consumption.
createVmHealth* | VsanHostCreateVmHealthTestResult[] | VM creation results information across the cluster. Meant for programmatic consumption. Will only be populated if the respective test was run.
diskBalance* | VsanClusterBalanceSummary | Balance of disk utilization across the cluster.
ditEncryptionHealth* | VsanClusterDitEncryptionHealthSummary | Data-in-transit encryption information across the cluster. Meant for programmatic consumption. Since vSAN API vSAN 7.0U1
encryptionHealth* | VsanClusterEncryptionHealthSummary | Encryption information across the cluster. Meant for programmatic consumption. Since vSAN API 6.6
fileServiceHealth* | VsanClusterFileServiceHealthSummary | File service health information across the cluster. Meant for programmatic consumption. If the file service is not enabled, this field would not be set. Since vSAN API 7.0
genericCluster* | VsanGenericClusterBestPracticeHealth | Generic cluster configuration best practices checks. Since vSAN API 6.6
groups* | VsanClusterHealthGroup[] | Data driven structure to display all health results for purpose of rendering a UI. The health results 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 results should avoid parsing this structure because it is meant for UI consumption and the content will change to improve user experience.
hclInfo* | VsanClusterHclInfo | HCL check information across the cluster. Meant for programmatic consumption.
limitHealth* | VsanClusterLimitHealthResult | Limits health information across the cluster. Meant for programmatic consumption.
networkConfig* | VsanNetworkConfigBestPracticeHealth | Network configuration best practices checks. Since vSAN API 6.6
networkHealth* | VsanClusterNetworkHealthResult | Network health information across the cluster. Meant for programmatic consumption.
objectHealth* | VsanObjectOverallHealth | Object health information across the cluster. Meant for programmatic consumption.
overallHealth | xsd:string | Health Enum. Summarizes all groups and provides a high level status across all categories of health. This essentially says "is there anything to worry about?"
overallHealthDescription | xsd:string | 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.
perfsvcHealth* | VsanPerfsvcHealthResult | vSAN performance service health check result. Since vSAN API 6.7
physicalDisksHealth* | VsanPhysicalDiskHealthSummary[] | Physical vSAN disk information across the cluster. Meant for programmatic consumption.
timestamp* | xsd:dateTime | 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
vmHealth* | VsanClusterVMsHealthOverallResult | Ignore this value.
vsanConfig* | VsanConfigCheckResult | vSAN configuration checks. Since vSAN API 6.6
Properties inherited from DynamicData
None

*Need not be set
Show WSDL type definition
<complexType xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanClusterHealthSummary"> <complexContent> <extension base="vsan:DynamicData"> <sequence> <element name="clusterStatus" type="vsan:VsanClusterHealthSystemStatusResult" minOccurs="0"/> <element name="timestamp" type="xsd:dateTime" minOccurs="0"/> <element name="clusterVersions" type="vsan:VsanClusterHealthSystemVersionResult" minOccurs="0"/> <element name="objectHealth" type="vsan:VsanObjectOverallHealth" minOccurs="0"/> <element name="vmHealth" type="vsan:VsanClusterVMsHealthOverallResult" minOccurs="0"/> <element name="networkHealth" type="vsan:VsanClusterNetworkHealthResult" minOccurs="0"/> <element name="limitHealth" type="vsan:VsanClusterLimitHealthResult" minOccurs="0"/> <element name="advCfgSync" type="vsan:VsanClusterAdvCfgSyncResult" minOccurs="0" maxOccurs="unbounded"/> <element name="createVmHealth" type="vsan:VsanHostCreateVmHealthTestResult" minOccurs="0" maxOccurs="unbounded"/> <element name="physicalDisksHealth" type="vsan:VsanPhysicalDiskHealthSummary" minOccurs="0" maxOccurs="unbounded"/> <element name="encryptionHealth" type="vsan:VsanClusterEncryptionHealthSummary" minOccurs="0"/> <element name="hclInfo" type="vsan:VsanClusterHclInfo" minOccurs="0"/> <element name="groups" type="vsan:VsanClusterHealthGroup" minOccurs="0" maxOccurs="unbounded"/> <element name="overallHealth" type="xsd:string"/> <element name="overallHealthDescription" type="xsd:string"/> <element name="clomdLiveness" type="vsan:VsanClusterClomdLivenessResult" minOccurs="0"/> <element name="diskBalance" type="vsan:VsanClusterBalanceSummary" minOccurs="0"/> <element name="genericCluster" type="vsan:VsanGenericClusterBestPracticeHealth" minOccurs="0"/> <element name="networkConfig" type="vsan:VsanNetworkConfigBestPracticeHealth" minOccurs="0"/> <element name="vsanConfig" type="vsan:VsanConfigCheckResult" minOccurs="0"/> <element name="burnInTest" type="vsan:VsanBurnInTestCheckResult" minOccurs="0"/> <element name="perfsvcHealth" type="vsan:VsanPerfsvcHealthResult" minOccurs="0"/> <element name="cluster" type="vsan:ManagedObjectReference" minOccurs="0"/> <element name="fileServiceHealth" type="vsan:VsanClusterFileServiceHealthSummary" minOccurs="0"/> <element name="ditEncryptionHealth" type="vsan:VsanClusterDitEncryptionHealthSummary" minOccurs="0"/> </sequence> </extension> </complexContent> </complexType>