VsanQueryVcClusterHealthSummaryRequestType

VsanQueryVcClusterHealthSummaryRequestType
VsanQueryVcClusterHealthSummaryRequestType

The parameters of VsanQueryVcClusterHealthSummary.

JSON Example
{
    "cluster": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "vmCreateTimeout": 0,
    "objUuids": [
        "string"
    ],
    "includeObjUuids": false,
    "fields": [
        "string"
    ],
    "fetchFromCache": false,
    "perspective": "string",
    "hosts": [
        {
            "_typeName": "string",
            "type": "string",
            "value": "string"
        }
    ],
    "spec": {
        "_typeName": "string",
        "task": {
            "_typeName": "string",
            "type": "string",
            "value": "string"
        },
        "diskNames": [
            "string"
        ],
        "includeHealthRemediation": false
    }
}
cluster
Optional

The target cluster

integer As int32 As int32
vmCreateTimeout
Optional

vmCreateTimeout

array of string
objUuids
Optional

objUuids

boolean
includeObjUuids
Optional

Whether to include detailed per-object health in the result. Default to True. Set to false if this value is not of importance to save computing resources.

array of string
fields
Optional

If set, only the properties listed in the array are returned in the result data object. Normally the output of this API can be quite large so this allows clients which are only interested in a subset to save network bandwidth and deserialization effort. The possible value is the field from the VsanClusterHealthSummary class like 'objectHealth', 'networkHealth' etc If unset, following properities are included in the result. 'clusterStatus', 'timestamp', 'clusterVersions', 'objectHealth', 'vmHealth', 'networkHealth', 'limitHealth', 'advCfgSync', 'createVmHealth', 'physicalDisksHealth', 'hclInfo', 'groups', 'overallHealth', 'overallHealthDescription', 'clomdLiveness', 'diskBalance'

boolean
fetchFromCache
Optional

True to return the result from cache directly instead of running the full health check. The cache will be updated and keep the latest vSAN health summary check result either triggering from user on-demand request or the periodical vSAN health check for triggering health event/alarm. Default is False.

string
perspective
Optional

The total amount of health checks is split into multiple different perspectives. This parameter controls which health checks are performed/returned. All supported values are defined in below enumerations: VsanHealthPerspectiveEnum, VsanHealthPerspective90Enum.

array of MoRefHostSystem
hosts
Optional

Include the individual host(s) into the health check, with other hosts specified with the cluster parameter.

spec
Optional

Health summary query specification VsanClusterHealthQuerySpec.

Parameter To