esx health clusters: check spec
Defines the context for a cluster-level health query. This structure was added in vSphere API 7.0.1.0.
Representation:
{
"exclude_checks" : [
"obj-103",
"obj-103"
],
"perspective" : "BEFORE_ENTER_MAINTENANCE"
}
"exclude_checks" : [
"obj-103",
"obj-103"
],
"perspective" : "BEFORE_ENTER_MAINTENANCE"
}
Attributes:
Name | Type | Description |
---|---|---|
Required | ||
perspective | string | The cluster-level perspective for the health query. This attribute was added in vSphere API 7.0.1.0. Defines the available cluster-level health perspectives. A perspective represents specific state transitions in the cluster's lifecycle. Health checks that are part of a given perspective should evaluate whether the cluster can proceed to the next state in its lifecycle without this resulting in service health degradation. Typically, a cluster goes through the following steps during its lifecycle: - The cluster is operating normally. - The cluster is being applied a new desired specification. - The cluster is going to have some of its hosts into maintenance mode as part of applying the new desired specification. This enumeration was added in vSphere API 7.0.1.0. Value is one of: BEFORE_ENTER_MAINTENANCE: A health perspective relating to the cluster being ready to support some of its host to enter maintenance mode. This perspective should be called only if any of the hosts will enter maintenance mode. This constant was added in vSphere API 7.0.1.0. BEFORE_START_APPLY: A health perspective related the cluster being ready for its desired configuration to be applied. This constant was added in vSphere API 7.0.1.0. |
exclude_checks | string[] | The set of IDs of the health checks that should not be considered in the overall health status. This attribute was added in vSphere API 7.0.1.0. When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: com.vmware.esx.health.check . When operations return a value of this structure as a result, the field will contain identifiers for the resource type: com.vmware.esx.health.check . |