Esx.Settings.Clusters.Configuration.SolutionPrecheckResult

Esx.Settings.Clusters.Configuration.SolutionPrecheckResult
Esx.Settings.Clusters.Configuration.SolutionPrecheckResult

This Esx.Settings.Clusters.Configuration.SolutionPrecheckResult schema contains properties that describes the Precheck API result for a cluster solution.

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
{
    "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
            }
        }
    ]
}
string
status
Required

Overall solution precheck status for the cluster solution. Operation is successful when precheck is run for cluster solution successfully with no validation or precheck errors.

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.

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.

display_name
Required

Display name of Cluster Solution.

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 for the cluster solution.

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.

notifications
Optional

This field contains the impact information for a cluster solution to reach the desired configuration state. It shall also contain the errors set during impact operation.

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 for cluster solution. The Esx.Settings.Clusters.Configuration.SolutionPrecheckResult.status may be OK or ERROR.

drift_reviews
Optional

This field contains the drifts that need review from the user before apply.

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.