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

cursor

Optional

Opaque cursor to be used for getting next page of records (supplied by current result page)

string

included_fields

Optional

Comma separated list of fields that should be included to result of query

integer

page_size

Optional

Maximum number of results to return in this page (server may return fewer)

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

sort_ascending

Optional

sort_ascending

string

sort_by

Optional

Field by which records are sorted

Authentication

This operation uses the following authentication methods.

BasicAuth

Responses

200

Success

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