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
+
StatusSummaryRequestParameters
(
schema
)
Name
Description
Type
Notes
component_type
Component type based on which upgrade units to be filtered
string
selection_status
Flag to indicate whether to return status for only selected, only deselected or both type of upgrade units
string
Enum: SELECTED, DESELECTED, ALL
Default: "ALL"
show_history
Get upgrade activity for a given component
Get details of the last 16 operations performed during the upgrade of a given component.
boolean
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
+
UpgradeStatus
(
schema
)
Name
Description
Type
Notes
ccp_status
CCP upgrade status
CCPUpgradeStatus
Readonly
component_status
List of component statuses
array of
ComponentUpgradeStatus
Required
Readonly
edge_status
Edge upgrade status
EdgeUpgradeStatus
Readonly
host_status
Host upgrade status
HostUpgradeStatus
Readonly
overall_upgrade_status
Status of upgrade
string
Required
Readonly
Enum: SUCCESS, FAILED, IN_PROGRESS, NOT_STARTED, PAUSING, PAUSED
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:
301 Moved Permanently
307 Temporary Redirect
400 Bad Request
403 Forbidden
409 Conflict
500 Internal Server Error
503 Service Unavailable