NvdsUpgradeHostState (schema)

Individual host upgrade state

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.
array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.
int
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set
string Maximum length: 255
Sortable
dn_ext_id DiscoveredNode identifier string Readonly
host TransportNode identifier string Required
Readonly
id Unique identifier of this resource string Sortable
ip_address TransportNode ip address string Readonly
overall_state Overall state of N-VDSes on the TransportNodes string Required
Readonly
Enum: UPGRADE_READY, UPGRADE_PROCESSING, UPGRADE_QUEUED, UPGRADE_IN_PROGRESS, UPGRADE_FAILED, SUCCESS
resource_type Must be set to the value NvdsUpgradeHostState string
state_details Details of the N-VDS upgrade state on the host array of string Readonly
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30
upgrade_stage Current migration task stage

This field returns current stage of Migration task. Here is a sequence
of stages the task cycles through,
TN_MIGRATION_TASK_IN_QUEUE
RETRIEVE_SAVED_CONFIG,
TN_VALIDATE,
VMS_RETRIVAL,
VMS_UNREGISTRATION,
TN_STATELESS_WAIT_FOR_HP,
DETACH_TNP,
TNP_WAIT,
TN_SEND_HS_MIGRATION_MSG,
TN_ADD_HOST_TO_VDS,
TN_UPDATE,
TN_UPDATE_WAIT,
TN_DELETE,
TN_DELETE_WAIT,
FN_DELETE_WAIT,
TN_RECONFIG_HOST,
TN_CREATE,
TN_CREATE_WAIT,
UPDATE_TNP_AND_APPLY,
TN_EXIT_MM,
VMS_REGISTRATION,
VMS_REGISTRATION_WAIT,
TN_MIGRATION_COMPLETED
Depending on the type of host (stateful, stateless, Sddc, etc.) migration
task may not cycle through all stages but in will follow above sequence.
If stage is TN_MIGRATION_COMPLETED refer to field overall_state for SUCCESS
or UPGRADE_FAILURE and state_details for details on same.
string Readonly