VsanClusterHealthTest
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.
{
"_typeName": "string",
"testId": "string",
"testName": "string",
"testDescription": "string",
"testShortDescription": "string",
"testHealthyEntities": 0,
"testAllEntities": 0,
"testHealth": "string",
"testDetails": [
{
"_typeName": "string",
"label": "string"
}
],
"testActions": [
{
"_typeName": "string",
"actionId": "string",
"actionLabel": {
"_typeName": "string",
"key": "string",
"arg": [
{
"_typeName": "string",
"key": "string",
"value": {
"_typeName": "string"
}
}
],
"message": "string"
},
"actionDescription": {
"_typeName": "string",
"key": "string",
"arg": [
{
"_typeName": "string",
"key": "string",
"value": {
"_typeName": "string"
}
}
],
"message": "string"
},
"enabled": false,
"parameters": [
{
"_typeName": "string",
"key": "string",
"value": "string"
}
]
}
],
"historicalResults": [
{
"_typeName": "string",
"timestamp": "string",
"health": "string",
"testDetails": [
{
"_typeName": "string",
"label": "string"
}
],
"testCorrelation": {
"_typeName": "string",
"primaryHealthTests": [
"string"
],
"relatedHealthTests": [
"string"
],
"skippedHealthTests": [
"string"
]
}
}
],
"testCorrelation": {
"_typeName": "string",
"primaryHealthTests": [
"string"
],
"relatedHealthTests": [
"string"
],
"skippedHealthTests": [
"string"
]
},
"reducedScore": 0,
"category": "string",
"riskIfNotFix": "string",
"lastStatusChangeTime": "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).
The name for this health test.
The full test description.
The short test description.
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.
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.
The test result enumeration.
The possible values are 'green', 'yellow', 'red', 'unknown', or 'info'.
The test result data.
Each data item include the UI presentation structure and the actual value.
The actions needed by user for potential vSAN health problem.
The historical check results for this test.
The health correlation for the current health test
The reduced health score when it is not green.
It will be 0 if it's green.
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 also VsanClusterHealthCategoryEnumEnum.
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.
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.