VsanClusterHealthQuerySpec

VsanClusterHealthQuerySpec

This structure may be used only with operations rendered under /vsan.

AllOf

This class requires all of the following:

DataObject

JSON Example

{
    "_typeName": "string",
    "task": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "diskNames": [
        "string"
    ],
    "includeHealthRemediation": false,
    "excludeChecks": [
        "string"
    ]
}

task

Optional

Task ID returned from API VsanQueryVcClusterHealthSummaryTask.

This is used to get the health summary performed by the given task. If the task is still running, VsanQueryVcClusterHealthSummary returns health check groups which are already completed. If the task is completed, VsanQueryVcClusterHealthSummary returns full health summary from cache (Notes: fetchFromCache should be True). VsanQueryVcClusterHealthSummary returns VsanFault if task ID is invalid or task state is 'error'.

array of string

diskNames

Optional

A list of disks to be validated for hardware compatibility.

If this field is set, the hardware compatibility check will only return the result of the disks in list. Both disk canonical name (e.g. 'mpx.vmhba0:C0:T0:L0') and UUID are supported. The field only takes effect with perspective 'vcsaInstallerForVsanEsa'.

boolean

includeHealthRemediation

Optional

True to include vSAN health remediation and troubleshooting information in the data driven health test result.

It's false by default or when it's not set.

array of string

excludeChecks

Optional

A list of health checks to be excluded in this health query.

Each health check item in this list is a testId string. If this field is set, the health checks in this list will not be included in the health query result. This is mainly used to support skipping some health checks in vLCM upgrade precheck workflow.

Property Of

ArrayOfVsanClusterHealthQuerySpec