Esx.Settings.Inventory.Reports.Summary.Hosts.ApplyResult

Esx.Settings.Inventory.Reports.Summary.Hosts.ApplyResult
Esx.Settings.Inventory.Reports.Summary.Hosts.ApplyResult

The Esx.Settings.Inventory.Reports.Summary.Hosts.ApplyResult schema contains properties that describe the result of an apply operation.

This schema was added in vSphere API 9.0.0.0.

JSON Example
{
    "task_status": "string",
    "apply_status": "string",
    "last_apply_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 apply 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.Hosts.TaskStatus.

This property was added in vSphere API 9.0.0.0.

string
apply_status
Required

Specifies the aggregated status of the apply operation.

Possible values:

  • RUNNING: The operation is in progress.
  • OK: The operation completed successfully.
  • SKIPPED: The operation was skipped.
  • TIMED_OUT: The operation timed out.
  • ERROR: The operation encountered an unspecified error.
  • RETRY_PENDING: The operation is being scheduled for retry.
  • 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.Hosts.ApplyStatus.

This property was added in vSphere API 9.0.0.0.

string As date-time As date-time
last_apply_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.