Data Object - VsanClusterHealthTest(vim.cluster.VsanClusterHealthTest)

Property of
VsanClusterHealthGroup, VsanClusterProactiveTestResult, VsanHealthExtMgmtPreCheckResult
Extends
DynamicData
See also
VsanClusterHealthAction, VsanClusterHealthResultBase, VsanHealthCorrelation, VsanHistoricalHealthTest
Since
vSphere API 5.5

Data Object Description

The generic class for the vSAN cluster health test result. All of the text message in this class will be localized except for test ID.

Properties

Name Type Description
category*xsd:string

The health category of this health test when it's not green. Notice the same health test may belong to the different category according to its actual health status since it may have different user impact.
See VsanClusterHealthCategoryEnum

Since vSAN API 8.0.0.2
historicalResults*VsanHistoricalHealthTest[]

The historical check results for this test.

Since vSAN API vSAN 7.0U2
lastStatusChangeTime*xsd:dateTime

The last time when the health status was changed. For example, if the current health status is green, then it will be the last time when the health status was changed from non-green status and vice versa. It will be unset if the health status has never been changed.

Since vSAN API 8.0.0.2
reducedScore*xsd:int

The reduced health score when it is not green. It will be 0 if it's green.

Since vSAN API 8.0.0.2
riskIfNotFix*xsd:string

The potential risk if this vSAN health warning is not resolved from user perspective. The main purpose for this field is to let user understand the possible impact for this health finding and then decide the proper remediation plan.

Since vSAN API 8.0.0.2
testActions*VsanClusterHealthAction[]

The actions needed by user for potential vSAN health problem.
testAllEntities*xsd:int

The number of entities examined by the current test. Each test can set this field to the number of examined entities. For example if the test checks the connectivity of the hosts, this field should be set to the number of hosts that are being tested.

Since vSAN API 6.7
testCorrelation*VsanHealthCorrelation

The health correlation for the current health test

Since vSAN API vSAN 7.0U3
testDescription*xsd:string

The full test description.
testDetails*VsanClusterHealthResultBase[]

The test result data. Each data item include the UI presentation structure and the actual value.
testHealth*xsd:string

The test result enumeration. The possible values are 'green', 'yellow', 'red', 'unknown', or 'info'.
testHealthyEntities*xsd:int

The number of entities considered healthy in the context of the current test. Each test can set this field to the number of entities that are heatlhy in the context of its execution. For example if the test examines the connectivity state of the hosts, the healthy entities in its context are the "connected" hosts. This field is optional as not all tests can have "healthy" objects. An example for such tests are the tests that contain only errors. In such context there is no "healthy" entity so the test should leave this field unset.

Since vSAN API 6.7
testId*xsd:string

A unique ID for this test (i.e., In the vsphere web client, this is used as a ID for composing the AskVmware link, for example: http://www.vmware.com/esx/support/askvmware/index.php?eventtype=<id>&language=en_US).
testName*xsd:string

The name for this health test.
testShortDescription*xsd:string

The short test description.
Properties inherited from DynamicData
None
*Need not be set
Show WSDL type definition