Get summary of N-VDS to VDS migration

Request:

Method:

GET

URI Path(s):

/api/v1/nvds-urt/status-summary/<precheck-id>

Request Headers:

n/a

Query Parameters:

NvdsUpgradeSummaryParameters+

Name	Description	Type	Notes
cluster_id	cluster identifier	string

Request Body:

n/a

Example Request:

GET https://<nsx-mgr>/api/v1/nvds-urt/status-summary

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

NvdsUpgradeStatusSummary+

Name	Description	Type	Notes
migration_state	Overall state of migration across all TransportNodes	array of NvdsUpgradeHostState	Required Readonly
precheck_id	Tracking ID of nvds upgrade precheck	string	Readonly
precheck_issue	Config issue in pre-check	array of NvdsUpgradeConfigIssue	Required Readonly
precheck_status	Overall status of pre-check	string	Required Readonly Enum: IN_PROGRESS, FAILED, PENDING_TOPOLOGY, APPLYING_TOPOLOGY, APPLY_TOPOLOGY_FAILED, READY

Required Permissions:

read

Feature:

nodes_transport_nodes Description:

Provides overall status for Precheck as well as actual NVDS to CVDS upgrade status per host. Precheck statuses are as follows 1. IN_PROGRESS: Precheck is in progress 2. FAILED: Precheck is failed, error can be found in precheck_issue field 3. PENDING_TOPOLOGY: Precheck is successful, recommended topology is generated 4. APPLYING_TOPOLOGY: SetTargetToplogy is in progress 5. APPLY_TOPOLOGY_FAILED: SetTargetTopology is failed 6. REDAY: SetTargetTopology is successful and TransportNodes provided as part of topology are ready for upgrade from NVDS to CVDS

Get summary of N-VDS to VDS migration

Request:

NvdsUpgradeSummaryParameters (schema)

Example Request:

Successful Response:

NvdsUpgradeStatusSummary (schema)

Required Permissions:

Feature:

Additional Errors: