Get Upgrade Summary

Get Upgrade Summary

Get upgrade summary

Request
URI
GET
https://nsxmanager.your.domain/api/v1/upgrade/summary
COPY
Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns UpgradeSummary of type(s) application/json 
{
    "upgrade_coordinator_updated": false,
    "target_version": "string",
    "upgrade_coordinator_version": "string",
    "upgrade_status": "string",
    "component_target_versions": [
        {
            "target_version": "string",
            "component_type": "string"
        }
    ],
    "system_version": "string",
    "upgrade_bundle_file_name": "string"
}
boolean
upgrade_coordinator_updated
Optional

Has upgrade coordinator been updated after upload of upgrade bundle file

string
target_version
Optional

Target system version

string
upgrade_coordinator_version
Optional

Current version of upgrade coordinator

string
upgrade_status
Optional

Status of upgrade

Possible values are : SUCCESS, FAILED, IN_PROGRESS, NOT_STARTED, PAUSED,
array of ComponentTargetVersion
component_target_versions
Optional

component_target_versions

string
system_version
Optional

Current system version

string
upgrade_bundle_file_name
Optional

Name of the last successfully uploaded upgrade bundle file


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