Esx.Settings.Hosts.Configuration.PrecheckResult

The Esx.Settings.Hosts.Configuration.PrecheckResult schema contains properties that describe precheck status of applying the desired document to a group of hosts.

Warning: this schema is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

JSON Example

{
    "commit": "string",
    "software_commit": "string",
    "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",
    "remediation_summary": [
        "Vapi.Std.LocalizableMessage Object"
    ],
    "remediation_notes": [
        "Vapi.Std.LocalizableMessage Object"
    ],
    "validation_errors": [
        {
            "path": "string",
            "display_path": [
                "string"
            ],
            "messages": [
                "Vapi.Std.LocalizableMessage Object"
            ]
        }
    ],
    "host_info": {
        "name": "string",
        "is_vsan_witness": false
    },
    "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"
                    }
                ]
            }
        ]
    }
}

string

commit

Optional

This identifier refers to the commit action of importing the desired configuration document.

Warning: this property is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

This field is not set for a precheck of a draft configuration.

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

string

software_commit

Optional

The current commit ID for the software associated with the host.

Warning: this property is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

This field is set if the host is managed by vlcm.

status

Required

This field represents the status of the precheck request for this host. Esx.Settings.Hosts.Configuration.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.Hosts.Configuration.PrecheckResult.validation_errors. If precheck failed due to generic error, details are specified in the Esx.Settings.Hosts.Configuration.PrecheckResult.summary. Health check result is specified in Esx.Settings.Hosts.Configuration.PrecheckResult.precheck_result.

Warning: this property is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

summary

Required

Summarizing precheck operation on the host.

Warning: this property is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

array of Vapi.Std.LocalizableMessage

remediation_summary

Required

Summarizing remediation stating if host needs to be rebooted or put under maintenance mode during remediation and number of precheck errors on the host.

Warning: this property is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

array of Vapi.Std.LocalizableMessage

remediation_notes

Required

Static notes to the user describing steps that will be taken during remediation.

Warning: this property is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

array of Esx.Settings.Hosts.Configuration.ValidationError

validation_errors

Optional

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

Warning: this property is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

This field is set if Esx.Settings.Hosts.Configuration.HostStatus.status is ERROR due to validation errors.

host_info

Required

Hostname information of the host

Warning: this property is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

impact

Optional

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

Warning: this property is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

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

precheck_result

Optional

This field represents the precheck results on the host, if it needs to be put in maintenance mode or to be rebooted.

Warning: this property is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

This field is set if host prechecks are invoked.