Get Upgrade Status Summary

Get Upgrade Status Summary

Get upgrade status summary

Request
URI
GET
https://nsxmanager.your.domain/api/v1/upgrade/status-summary
COPY
Query Parameters
string
component_type
Optional

Component type based on which upgrade units to be filtered

string
selection_status
Optional

Flag to indicate whether to return status for only selected, only deselected or both type of upgrade units

Possible values are : SELECTED, DESELECTED, ALL,
boolean
show_history
Optional

Get upgrade activity for a given component

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns UpgradeStatus of type(s) application/json 
{
    "host_status": {
        "status": "string",
        "percent_complete": "number",
        "can_skip": false,
        "details": "string",
        "component_type": "string"
    },
    "ccp_status": {
        "status": "string",
        "percent_complete": "number",
        "can_skip": false,
        "details": "string",
        "component_type": "string"
    },
    "edge_status": {
        "status": "string",
        "percent_complete": "number",
        "can_skip": false,
        "details": "string",
        "component_type": "string"
    },
    "overall_upgrade_status": "string",
    "component_status": [
        {
            "status": "string",
            "percent_complete": "number",
            "can_skip": false,
            "details": "string",
            "component_type": "string"
        }
    ]
}
HostUpgradeStatus
host_status
Optional

host_status

CCPUpgradeStatus
ccp_status
Optional

ccp_status

EdgeUpgradeStatus
edge_status
Optional

edge_status

string
overall_upgrade_status
Optional

Status of upgrade

Possible values are : SUCCESS, FAILED, IN_PROGRESS, NOT_STARTED, PAUSED,
array of ComponentUpgradeStatus
component_status
Optional

List of component statuses


400
Returns BadRequest of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1 
{
    "module_name": "string",
    "error_message": "string",
    "error_code": 0,
    "details": "string",
    "related_errors": [
        {
            "module_name": "string",
            "error_message": "string",
            "error_code": 0,
            "details": "string"
        }
    ]
}

403
Returns Forbidden of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1 
{
    "module_name": "string",
    "error_message": "string",
    "error_code": 0,
    "details": "string",
    "related_errors": [
        {
            "module_name": "string",
            "error_message": "string",
            "error_code": 0,
            "details": "string"
        }
    ]
}

404
Returns NotFound of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1 
{
    "module_name": "string",
    "error_message": "string",
    "error_code": 0,
    "details": "string",
    "related_errors": [
        {
            "module_name": "string",
            "error_message": "string",
            "error_code": 0,
            "details": "string"
        }
    ]
}

412
Returns PreconditionFailed of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1 
{
    "module_name": "string",
    "error_message": "string",
    "error_code": 0,
    "details": "string",
    "related_errors": [
        {
            "module_name": "string",
            "error_message": "string",
            "error_code": 0,
            "details": "string"
        }
    ]
}

500
Returns InternalServerError of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1 
{
    "module_name": "string",
    "error_message": "string",
    "error_code": 0,
    "details": "string",
    "related_errors": [
        {
            "module_name": "string",
            "error_message": "string",
            "error_code": 0,
            "details": "string"
        }
    ]
}

503
Returns ServiceUnavailable of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1 
{
    "module_name": "string",
    "error_message": "string",
    "error_code": 0,
    "details": "string",
    "related_errors": [
        {
            "module_name": "string",
            "error_message": "string",
            "error_code": 0,
            "details": "string"
        }
    ]
}

On This Page
Upgrade Operations
POST
Add Upgrade Units To Group Add Upgrade Units
POST
Continue Upgrade Continue
POST
Create Upgrade Unit Group
DELETE
Delete Upgrade Unit Group
POST
Fetch Upgrade Bundle From Url
GET
Get Nodes
GET
Get Nodes Summary
GET
Get Upgrade Bundle Info
GET
Get Upgrade Bundle Upload Status
GET
Get Upgrade History
GET
Get Upgrade Plan Settings
GET
Get Upgrade Status Summary
GET
Get Upgrade Summary
GET
Get Upgrade Unit
GET
Get Upgrade Unit Aggregate Info
GET
Get Upgrade Unit Group
GET
Get Upgrade Unit Group Aggregate Info
GET
Get Upgrade Unit Groups
GET
Get Upgrade Unit Groups Status
GET
Get Upgrade Unit Group Status
GET
Get Upgrade Units
GET
Get Upgrade Units Stats
GET
Get Version Whitelist
GET
Get Version Whitelist By Component
POST
Pause Upgrade Pause
POST
Reorder Upgrade Unit Group Reorder
POST
Reorder Upgrade Unit Reorder
POST
Reset Upgrade Plan Reset
POST
Start Upgrade Start
POST
Trigger Uc Upgrade Upgrade Uc
PUT
Update Upgrade Plan Settings
PUT
Update Upgrade Unit Group
PUT
Update Version Whitelist
POST
Upgrade Selected Units Upgrade Selected Units