Get Upgrade Unit Groups

Return information of all upgrade unit groups in the upgrade plan. If request parameter summary is set to true, then only count of upgrade units will be returned, upgrade units list will be empty. If request parameter component type is specified, then all upgrade unit groups for that component will be returned.

Request

URI

GET

https://nsxmanager.your.domain/api/v1/upgrade/upgrade-unit-groups

COPY

Query Parameters

string

component_type

Optional

Component type based on which upgrade unit groups 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 in query result

integer

page_size

Optional

Constraints: minimum: 0 maximum: 1000 default: 1000

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

boolean

sort_ascending

Optional

sort_ascending

string

sort_by

Optional

Field by which records are sorted

boolean

summary

Optional

Constraints: default: false

Flag indicating whether to return summary

boolean

sync

Optional

Constraints: default: false

Synchronize before returning upgrade unit groups

Authentication

This operation uses the following authentication methods.

BasicAuth

Responses

200

Returns UpgradeUnitGroupListResult of type(s) application/json

This response body class contains all of the following: InlineUpgradeUnitGroupListResult1

{
    "_links": [
        {
            "action": "string",
            "href": "string",
            "rel": "string"
        }
    ],
    "_schema": "string",
    "_self": {},
    "cursor": "string",
    "result_count": 0,
    "sort_ascending": false,
    "sort_by": "string",
    "results": [
        {
            "_links": [
                {
                    "action": "string",
                    "href": "string",
                    "rel": "string"
                }
            ],
            "_schema": "string",
            "_self": {},
            "_revision": 0,
            "_create_time": 0,
            "_create_user": "string",
            "_last_modified_time": 0,
            "_last_modified_user": "string",
            "_protection": "string",
            "_system_owned": false,
            "description": "string",
            "display_name": "string",
            "id": "string",
            "resource_type": "string",
            "tags": [
                {
                    "scope": "string",
                    "tag": "string"
                }
            ],
            "enabled": false,
            "extended_configuration": [
                {
                    "key": "string",
                    "value": "string"
                }
            ],
            "parallel": false,
            "pause_after_each_upgrade_unit": false,
            "type": "string",
            "upgrade_unit_count": 0,
            "upgrade_units": [
                {
                    "_links": [
                        {
                            "action": "string",
                            "href": "string",
                            "rel": "string"
                        }
                    ],
                    "_schema": "string",
                    "_self": {},
                    "current_version": "string",
                    "display_name": "string",
                    "group": {
                        "display_name": "string",
                        "id": "string"
                    },
                    "id": "string",
                    "metadata": [
                        {
                            "key": "string",
                            "value": "string"
                        }
                    ],
                    "type": "string",
                    "warnings": [
                        "string"
                    ]
                }
            ]
        }
    ]
}

400

Returns BadRequest of type(s) application/json