Esx.Settings.Clusters.Software.StageStatus

Esx.Settings.Clusters.Software.StageStatus
Esx.Settings.Clusters.Software.StageStatus

The Esx.Settings.Clusters.Software.StageStatus schema contains properties that describe the status of a POST /esx/settings/clusters/{cluster}/software?action=stage operation.

This schema was added in vSphere API 8.0.0.1.

JSON Example
{
    "status": "string",
    "progress": "Cis.Task.Progress Object",
    "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
            }
        ]
    }
}
string
status
Required

The status of the 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.

For more information see: Esx.Settings.Clusters.Software.StageStatus.Status.

This property was added in vSphere API 8.0.0.1.

progress
Optional

Progress of the operation.

This property was added in vSphere API 8.0.0.1.

missing or null for cluster StageStatus

string As date-time As date-time
start_time
Required

Time when the operation started.

This property was added in vSphere API 8.0.0.1.

string As date-time As date-time
end_time
Required

Time when the operation completed.

This property was added in vSphere API 8.0.0.1.

notifications
Required

Notifications providing additional information about the status of the operation.

This property was added in vSphere API 8.0.0.1.