Get upgrade summary

Request:

Method:

GET

URI Path(s):

/api/v1/upgrade/summary

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

n/a

Example Request:

GET https://<nsx-mgr>/api/v1/upgrade/summary

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

UpgradeSummary+

Name	Description	Type	Notes
component_target_versions		array of ComponentTargetVersion	Readonly
system_version	Current system version	string	Required Readonly
target_version	Target system version	string	Required Readonly
upgrade_bundle_file_name	Name of the last successfully uploaded upgrade bundle file	string	Readonly
upgrade_coordinator_updated	Has upgrade coordinator been updated after upload of upgrade bundle file	boolean	Readonly
upgrade_coordinator_version	Current version of upgrade coordinator	string	Required Readonly
upgrade_status	Status of upgrade	string	Required Readonly Enum: SUCCESS, FAILED, IN_PROGRESS, NOT_STARTED, PAUSING, PAUSED

Example Response:

{ "upgrade_status" : "PAUSED", "component_target_versions" : [ { "component_type" : "HOST", "target_version" : "2.0.0.0.0.5963423" }, { "component_type" : "EDGE", "target_version" : "2.0.0.0.0.5963333" }, { "component_type" : "CCP", "target_version" : "2.0.0.0.0.5963327" }, { "component_type" : "MP", "target_version" : "2.0.0.0.0.5963330" } ], "upgrade_coordinator_updated": true, "upgrade_coordinator_version" : "1.2.3.0.0.456789", "system_version" : "1.1.0.0.0.4787411", "target_version" : "2.0.0.0.0.5963330", "upgrade_bundle_file_name" : "VMware-NSX-upgrade-bundle-2.0.0.0.0.5963330.mub" }

Get upgrade summary

Request:

Example Request:

Successful Response:

UpgradeSummary (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: