vSAN Management API


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, VsanClusterGlobalDedupHealthSummary, VsanClusterHclInfo, VsanClusterHealthGroup, VsanClusterHealthSystemStatusResult, VsanClusterHealthSystemVersionResult, VsanClusterLimitHealthResult, VsanClusterNetworkHealthResult, VsanClusterVMsHealthOverallResult, VsanConfigCheckResult, VsanGenericClusterBestPracticeHealth, VsanHostCreateVmHealthTestResult, VsanNetworkConfigBestPracticeHealth, VsanObjectOverallHealth, VsanPerfsvcHealthResult, VsanPhysicalDiskHealthSummary
Since
vSphere API Release 5.5

Data Object Description

Cluster vSAN health summary, which aggregates all individual health findings. 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 6.6
clomdLiveness*VsanClusterClomdLivenessResult

CLOMD liveness on every vSAN host. Meant for programmatic consumption
cluster*ManagedObjectReference
to a ClusterComputeResource

The target cluster

Since 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 7.0U1
encryptionHealth*VsanClusterEncryptionHealthSummary

Encryption information across the cluster. Meant for programmatic consumption.

Since 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 7.0
genericCluster*VsanGenericClusterBestPracticeHealth

Generic cluster configuration best practices checks.

Since 6.6
globalDedupHealth*VsanClusterGlobalDedupHealthSummary

The global dedup health summary across the cluster. Meant for programmatic consumption.

Since 9.0.0.0
groups*VsanClusterHealthGroup[]

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.
hclInfo*VsanClusterHclInfo

HCL check information across the cluster. Meant for programmatic consumption.
healthScore*xsd:int

The overall health score ranging from 0 to 100 based on the vSAN cluster health check result.

Since 8.0.0.2
limitHealth*VsanClusterLimitHealthResult

Limits health information across the cluster. Meant for programmatic consumption.
networkConfig*VsanNetworkConfigBestPracticeHealth

Network configuration best practices checks.

Since 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.
overallHealthxsd:string

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.
overallHealthDescriptionxsd: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 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 6.6
Properties inherited from DynamicData
None
*Need not be set
Show WSDL type definition