Esx.Settings.Inventory.Reports.Summary.Clusters.PrecheckResult

Esx.Settings.Inventory.Reports.Summary.Clusters.PrecheckResult
Esx.Settings.Inventory.Reports.Summary.Clusters.PrecheckResult

The Esx.Settings.Inventory.Reports.Summary.Clusters.PrecheckResult schema contains properties that describe aggregated status of all prechecks performed.

This schema was added in vSphere API 9.0.0.0.

JSON Example
{
    "task_status": "string",
    "precheck_status": "string",
    "last_precheck_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
            }
        ]
    }
}
string
task_status
Required

Provides the status of the precheck task.

Possible values:

  • PENDING: The operation is not performed yet.
  • RUNNING: The operation is in progress.
  • CANCELED: The operation is canceled.
  • SUCCEEDED: The operation indicates a success.
  • FAILED: The operation encountered an unspecified error.
  • SKIPPED: The operation was skipped.
  • UNKNOWN: The operation is in an unknown state.

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.

For more information see: Esx.Settings.Inventory.Reports.Summary.Clusters.TaskStatus.

This property was added in vSphere API 9.0.0.0.

string
precheck_status
Required

Aggregated status from all prechecks performed.

Possible values:

  • OK: The precheck indicates a success.
  • WARNING: The precheck indicates a warning.
  • TIMEOUT: The precheck did not return in a timely manner.
  • ERROR: The precheck indicates an error.
  • RETRY: The precheck failed because of an intermittent error, for example a service is overloaded. The client can choose to retry the health precheck before considering the precheck as failed.
  • UNKNOWN: The precheck is in an unknown state.

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.

For more information see: Esx.Settings.Inventory.Reports.Summary.Clusters.PrecheckStatus.

This property was added in vSphere API 9.0.0.0.

string As date-time As date-time
last_precheck_time
Optional

Time when the operation performed last time.

This property was added in vSphere API 9.0.0.0.

If missing or null, the operation has not been run yet.

notifications
Required

Notifications returned by the stage operation.

This property was added in vSphere API 9.0.0.0.