VsanClusterProactiveTestResult

VsanClusterProactiveTestResult
VsanClusterProactiveTestResult

The generic class for vSAN cluster proactive test result.

AllOf
This class requires all of the following:
JSON Example
{
    "_typeName": "string",
    "overallStatus": "string",
    "overallStatusDescription": "string",
    "timestamp": "string",
    "healthTest": {
        "_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"
    }
}
string
overallStatus
Required

The overall proactive test result status enumeration.

The all possible values are 'green', 'yellow', 'red', 'unknown', or 'info'.

string
overallStatusDescription
Required

A human readable, short description of the overall status result to let user know the potential problem in the first glance.

string As date-time As date-time
timestamp
Required

The time when the test was performed.

healthTest
Optional

It's the data driven structure to display the health test result for purpose of rendering a UI.

The structure has a description, health status, 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.