Esx.Settings.Clusters.Configuration.ClusterPrecheckResult

Esx.Settings.Clusters.Configuration.ClusterPrecheckResult
Esx.Settings.Clusters.Configuration.ClusterPrecheckResult

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

This schema was added in vSphere API 8.0.1.0.

JSON Example
{
    "status": "string",
    "commit": "string",
    "software_commit": "string",
    "end_time": "string",
    "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": {
        "host_info": {
            "name": "string",
            "is_vsan_witness": false
        }
    },
    "host_precheck": {
        "host_precheck": {
            "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"
                            }
                        ]
                    }
                ]
            }
        }
    },
    "solutions_precheck_result": {
        "solutions_precheck_result": {
            "status": "string",
            "display_name": "Vapi.Std.LocalizableMessage Object",
            "summary": "Vapi.Std.LocalizableMessage Object",
            "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
                    }
                ]
            },
            "drift_reviews": [
                {
                    "property_paths": [
                        "string"
                    ],
                    "drift_review_policy": {
                        "type": "string",
                        "name": "string",
                        "possible_values": [
                            "string"
                        ],
                        "value_string": "string",
                        "value_long": 0,
                        "value_boolean": false
                    },
                    "notification": {
                        "type": "string",
                        "id": "string",
                        "time": "string",
                        "message": "Vapi.Std.LocalizableMessage Object",
                        "resolution": "Vapi.Std.LocalizableMessage Object",
                        "originator": "string",
                        "retriable": false
                    }
                }
            ]
        }
    },
    "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"
                    }
                ]
            }
        ]
    },
    "successful_hosts": [
        "string"
    ],
    "failed_hosts": [
        "string"
    ],
    "skipped_hosts": [
        "string"
    ]
}
string
status
Required

Overall status of precheck on the cluster. Operation is successful when precheck is run on all hosts successfully and no validation or precheck errors are detected.

Possible values:

  • RUNNING: The task is in-progress.
  • OK: The operation completed successfully.
  • OK_REVIEW_REQUIRED: The operation completed successfully. There are one or more solutions whose results #SolutionPrecheckResult indicate that the remediation of the drift is a destructive operation. Such drifts are specified in #SolutionPrecheckResult#driftReviews property. The #DriftReview need to be provided in the ApplySpec to acknowledge the remediation of these drifts. If the #SolutionPrecheckResult#driftReviews returned by PreCheck API is not provided as input to ApplySpec, these drifts will not be remediated.

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

  • ERROR: The operation failed with errors.

For more information see: Esx.Settings.Clusters.Configuration.ClusterPrecheckResult.Status.

This property was added in vSphere API 8.0.1.0.

string
commit
Optional

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

This property was added in vSphere API 8.0.1.0.

This field is s 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
Required

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

This property was added in vSphere API 8.0.1.0.

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 As date-time As date-time
end_time
Required

Precheck completion time.

This property was added in vSphere API 8.0.1.0.

summary
Required

Summarizing precheck operation on the host and cluster.

This property was added in vSphere API 8.0.1.0.

array of Vapi.Std.LocalizableMessage
remediation_summary
Required

Summarizing remediation stating number of hosts needing reboot and maintenance mode during remediation and number of precheck errors on host and cluster.

This property was added in vSphere API 8.0.1.0.

array of Vapi.Std.LocalizableMessage
remediation_notes
Required

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

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.3.0.

This field is set if Esx.Settings.Clusters.Configuration.ClusterPrecheckResult.Status is ERROR due to validation errors.

object
host_info
Required

Map of host IDs to hostname

This property was added in vSphere API 8.0.1.0.

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

object
host_precheck
Required

Map of host IDs to their precheck results. If Esx.Settings.Clusters.Configuration.ClusterPrecheckResult.status is ERROR, This field will contain Validation errors or Host Impact and Health Check errors. If Esx.Settings.Clusters.Configuration.ClusterPrecheckResult.status is OK, This field will contain Impact and Health Check information.

This property was added in vSphere API 8.0.1.0.

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

object
solutions_precheck_result
Optional

Map of Solution IDs to their precheck results.

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 property is optional because it was added in a newer version than its parent node.

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

precheck_result
Optional

This field represents the precheck results on the cluster, if any one host in the cluster 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 cluster prechecks are invoked.

array of string
successful_hosts
Required

Hosts in this cluster where the precheck was successfully run.

This property was added in vSphere API 8.0.1.0.

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

array of string
failed_hosts
Required

Hosts in this cluster where the precheck failed to run.

This property was added in vSphere API 8.0.1.0.

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

array of string
skipped_hosts
Required

Hosts in this cluster where the precheck was not tried because the host was disconnected.

This property was added in vSphere API 8.0.1.0.

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