Esx.Settings.Hosts.Configuration.HostStatus

Esx.Settings.Hosts.Configuration.HostStatus
Esx.Settings.Hosts.Configuration.HostStatus

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

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",
    "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.
  • RUNNING: The operation is in progress.
  • RETRY_PENDING: The operation is pending a retry.
  • CANCELED: The operation was canceled.
  • TIMED_OUT: The operation timed out.
  • ERROR: The operation encountered an unspecified error.

For more information see: Esx.Settings.Hosts.Configuration.HostStatus.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.

integer As int64 As int64
attempts
Optional

Number of the performed attempts of the 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 missing or null if it is not applicable.

integer As int64 As int64
remaining_retries
Optional

Number of the remaining attempts of the 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 missing or null if it is not applicable.

string As date-time As date-time
start_time
Required

Time when the operation started.

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.

string As date-time As date-time
end_time
Required

Time when the operation completed.

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
Required

Notifications providing additional information about the status of the 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.