Esx.Settings.Clusters.Configuration.HostStatus

Esx.Settings.Clusters.Configuration.HostStatus
Esx.Settings.Clusters.Configuration.HostStatus

The Esx.Settings.Clusters.Configuration.HostStatus schema contains properties that describe the status of an operation.

This schema was added in vSphere API 8.0.1.0.

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

The status of the operation.

Possible values:

  • OK: The operation completed successfully.
  • PENDING: The operation is pending.
  • RUNNING: The operation is in progress.
  • RETRY_PENDING: The operation is pending a retry.
  • SKIPPED: The operation was skipped.
  • CANCELED: The operation was canceled.
  • TIMED_OUT: The operation timed out.
  • ERROR: The operation encountered an unspecified error.

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

This property was added in vSphere API 8.0.1.0.

integer As int64 As int64
attempts
Optional

Number of the performed attempts of the operation.

This property was added in vSphere API 8.0.1.0.

This field is missing or null if it is not applicable.

integer As int64 As int64
remaining_retries
Optional

Number of the remaining attempts of the operation.

This property was added in vSphere API 8.0.1.0.

This field is missing or null if it is not applicable.

string As date-time As date-time
start_time
Required

Time when the operation started.

This property was added in vSphere API 8.0.1.0.

string As date-time As date-time
end_time
Required

Time when the operation completed.

This property was added in vSphere API 8.0.1.0.

notifications
Required

Notifications providing additional information about the status of the operation.

This property was added in vSphere API 8.0.1.0.