Esx.Settings.Clusters.Software.Reports.LastCheckResult.EntityCheckResult

Esx.Settings.Clusters.Software.Reports.LastCheckResult.EntityCheckResult
Esx.Settings.Clusters.Software.Reports.LastCheckResult.EntityCheckResult

The Esx.Settings.Clusters.Software.Reports.LastCheckResult.EntityCheckResult schema contains properties that describe aggregated status of all checks performed on a specific entity.

This schema was added in vSphere API 7.0.0.0.

JSON Example
{
    "type": "string",
    "cluster": "string",
    "host": "string",
    "status": "string",
    "check_statuses": [
        {
            "check": {
                "check": "string",
                "name": "Vapi.Std.LocalizableMessage Object",
                "description": "Vapi.Std.LocalizableMessage Object"
            },
            "status": "string",
            "issues": [
                "Vapi.Std.LocalizableMessage Object"
            ],
            "check_issues": [
                {
                    "description": "Vapi.Std.LocalizableMessage Object",
                    "resolution": "Vapi.Std.LocalizableMessage Object"
                }
            ]
        }
    ]
}
string
type
Required

The entity type for which these checks are being run.

Possible values:

  • CLUSTER: Entity type Cluster
  • HOST: Entity type Host

For more information see: Esx.Settings.Clusters.Software.Reports.LastCheckResult.EntityCheckResult.EntityType.

This property was added in vSphere API 7.0.0.0.

string
cluster
Optional

If the entity type is CLUSTER then the cluster identifier for which the checks have been run.

This property was added in vSphere API 7.0.0.0.

This property is optional and it is only relevant when the value of type is Esx.Settings.Clusters.Software.Reports.LastCheckResult.EntityCheckResult.EntityType.CLUSTER.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: ClusterComputeResource. When operations return a value of this schema as a response, the property will be an identifier for the resource type: ClusterComputeResource.

string
host
Optional

If the entity type is HOST then the host identifier for which the checks have been run.

This property was added in vSphere API 7.0.0.0.

This property is optional and it is only relevant when the value of type is Esx.Settings.Clusters.Software.Reports.LastCheckResult.EntityCheckResult.EntityType.HOST.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: HostSystem. When operations return a value of this schema as a response, the property will be an identifier for the resource type: HostSystem.

string
status
Required

Aggregated status from all checks performed on this entity.

Possible values:

  • OK: The check indicates a success.
  • WARNING: The check indicates a warning.
  • TIMEOUT: The check did not return in a timely manner.
  • ERROR: The check indicates an error.

For more information see: Esx.Settings.Clusters.Software.Reports.LastCheckResult.Status.

This property was added in vSphere API 7.0.0.0.

array of Esx.Settings.Clusters.Software.Reports.LastCheckResult.CheckStatus
check_statuses
Required

List of Esx.Settings.Clusters.Software.Reports.LastCheckResult.CheckStatus for all checks performed.

This property was added in vSphere API 7.0.0.0.

Property Of