System Administration > Lifecycle Management > Upgrade > Status

Get upgrade status summary

Get upgrade status summary

Request:

Method:
GET
URI Path(s):
/api/v1/upgrade/status-summary
Request Headers:
n/a
Query Parameters:
StatusSummaryRequestParameters+
Request Body:
n/a

Example Request:

GET https://<nsx-mgr>/api/v1/upgrade/status-summary?component_type=EDGE&selection_status=ALL

Successful Response:

Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
UpgradeStatus+

Example Response:

{ "host_status": { "status": "SUCCESS", "percent_complete": 100, "details": "All hosts upgraded successfully", "can_skip": false }, "edge_status": { "status": "IN_PROGRESS", "percent_complete": 40, "details": "Upgrade of edgeGroup1 in progress", "can_skip": false }, "ccp_status": { "status": "NOT_STARTED", "percent_complete": 0, "details": "Upgrade not started", "can_skip": false } "component_status": [{ "component_type": "EDGE", "status": "IN_PROGRESS", "percent_complete": 40, "details": "Upgrade of edgeGroup1 in progress", "can_skip": false } }

Required Permissions:

read

Feature:

utilities_upgrade

Additional Errors: