Esx.Settings.Hosts.Software.CheckResult

The Esx.Settings.Hosts.Software.CheckResult schema contains properties that describe aggregated status of all checks performed.

This schema was added in vSphere API 8.0.0.1.

JSON Example

{
    "status": "string",
    "start_time": "string",
    "end_time": "string",
    "commit": "string",
    "host_info": {
        "name": "string",
        "is_vsan_witness": false
    },
    "entity_result": {
        "type": "string",
        "host": "string",
        "status": "string",
        "check_statuses": [
            {
                "check": {
                    "check": "string",
                    "name": "Vapi.Std.LocalizableMessage Object",
                    "description": "Vapi.Std.LocalizableMessage Object",
                    "originator": "string"
                },
                "status": "string",
                "check_issues": [
                    {
                        "description": "Vapi.Std.LocalizableMessage Object",
                        "resolution": "Vapi.Std.LocalizableMessage Object"
                    }
                ]
            }
        ]
    }
}

string

status

Required

Aggregated status from all checks performed.

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.
RETRY: The check failed because of an intermittent error, for example a service is overloaded. The client can choose to retry the health check before considering the check as failed.

For more information see: Esx.Settings.Hosts.Software.Status.