VsanClusterHealthGroup

VsanClusterHealthGroup
VsanClusterHealthGroup

This class defines vSAN cluster health group result.

The vSAN health check results with the same category will be grouped into a group result, which include the group name and ID, group health which is aggregated from each of health check item and the health check details

AllOf
This class requires all of the following:
JSON Example
{
    "_typeName": "string",
    "groupId": "string",
    "groupName": "string",
    "groupHealth": "string",
    "groupTests": [
        {
            "_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"
        }
    ],
    "groupDetails": [
        {
            "_typeName": "string",
            "label": "string"
        }
    ],
    "inProgress": false
}
string
groupId
Required

The health check group ID.

It's the identifier for a group of the vSAN health check result and will keep stable for future releases

string
groupName
Required

The health check group name.

It will be used as UI label to show the name of the grouped health check result

string
groupHealth
Required

The group health status aggregating from each of health check item.

All of possible health status ordering in severity level are "red, yellow, info, unknown, green". The aggregated group health status will be the most severe status in each of sub health check item

groupTests
Optional

The health check results for each of check item in the group

groupDetails
Optional

groupDetails

boolean
inProgress
Optional

True indicates health check of this group is still in progress.

It could return True for some health check groups if you are trying to get health summary via API VsanVcClusterHealthSystem.VsanQueryVcClusterHealthSummary. The health check result under this group will not be available until the flag is false.