Esx.Settings.Clusters.Configuration.HostPrecheckResult

Esx.Settings.Clusters.Configuration.HostPrecheckResult
Esx.Settings.Clusters.Configuration.HostPrecheckResult

This Esx.Settings.Clusters.Configuration.HostPrecheckResult schema contains properties that describes the Precheck API result on a host.

This schema was added in vSphere API 8.0.1.0.

JSON Example
{
    "status": {
        "status": "string",
        "attempts": 0,
        "remaining_retries": 0,
        "start_time": "string",
        "end_time": "string",
        "notifications": {
            "info": [
                {
                    "type": "string",
                    "id": "string",
                    "time": "string",
                    "message": "Vapi.Std.LocalizableMessage Object",
                    "resolution": "Vapi.Std.LocalizableMessage Object",
                    "originator": "string",
                    "retriable": false
                }
            ],
            "warnings": [
                {
                    "type": "string",
                    "id": "string",
                    "time": "string",
                    "message": "Vapi.Std.LocalizableMessage Object",
                    "resolution": "Vapi.Std.LocalizableMessage Object",
                    "originator": "string",
                    "retriable": false
                }
            ],
            "errors": [
                {
                    "type": "string",
                    "id": "string",
                    "time": "string",
                    "message": "Vapi.Std.LocalizableMessage Object",
                    "resolution": "Vapi.Std.LocalizableMessage Object",
                    "originator": "string",
                    "retriable": false
                }
            ]
        }
    },
    "summary": "Vapi.Std.LocalizableMessage Object",
    "validation_errors": [
        {
            "path": "string",
            "display_path": [
                "string"
            ],
            "messages": [
                "Vapi.Std.LocalizableMessage Object"
            ]
        }
    ],
    "impact": {
        "impact": "string",
        "info": [
            "Vapi.Std.LocalizableMessage Object"
        ]
    },
    "precheck_result": {
        "status": "string",
        "check_statuses": [
            {
                "check": {
                    "check": "string",
                    "name": "Vapi.Std.LocalizableMessage Object",
                    "description": "Vapi.Std.LocalizableMessage Object"
                },
                "status": "string",
                "originator": "string",
                "errors": [
                    {
                        "description": "Vapi.Std.LocalizableMessage Object",
                        "resolution": "Vapi.Std.LocalizableMessage Object"
                    }
                ]
            }
        ]
    }
}
status
Required

This field represents the status of the precheck request for this host. {link HostStatus#status} is ERROR or SKIPPED, if precheck was not completed on the host due to some error or if health checks failed. If precheck failed due to host validation errors, details are specified in Esx.Settings.Clusters.Configuration.HostPrecheckResult.validation_errors. If precheck failed due to generic error, details are specified in the Esx.Settings.Clusters.Configuration.HostPrecheckResult.summary. Health check result is specified in Esx.Settings.Clusters.Configuration.HostPrecheckResult.precheck_result.

This property was added in vSphere API 8.0.1.0.

summary
Required

Summarizing precheck operation on the host.

This property was added in vSphere API 8.0.1.0.

array of Esx.Settings.Clusters.Configuration.ValidationError
validation_errors
Optional

This field represents the validation errors if the desired configuration specified is not valid.

This property was added in vSphere API 8.0.1.0.

This field is set if #HostStatus#status is ERROR due to host returning validation errors.

impact
Optional

This field represents the impact on the host to reach the desired configuration state.

This property was added in vSphere API 8.0.1.0.

This field is set if there are no validation errors on the host. The Esx.Settings.Clusters.Configuration.HostStatus.status may be OK or ERROR.

precheck_result
Optional

This field represents the health check results from the host, if the host needs to be put in maintenance mode or to be rebooted.

This property was added in vSphere API 8.0.1.0.

This field is set if there are not validation errors and health checks are run on the host. The Esx.Settings.Clusters.Configuration.HostStatus.status may be OK or ERROR.