NSX-T Data Center REST API

Return information of all 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:

Method:
GET
URI Path(s):
/api/v1/upgrade/upgrade-unit-groups
Request Headers:
n/a
Query Parameters:
UpgradeUnitGroupListRequestParameters+
Request Body:
n/a

Example Request:

GET https://<nsx-mgr>/api/v1/upgrade/upgrade-unit-groups?component_type=HOST

Successful Response:

Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
UpgradeUnitGroupListResult+

Example Response:

{ "cursor" : "0036cd429462-4716-4ada-a66b-e4c78504a399nnuullll", "result_count" : 1, "results": [ { "id": "d00d6a39-5ff2-4ddc-a63f-672b4e9ecc5", "display_name": "esx55Hosts", "type": "HOST", "parallel": "false", "enabled": "true", "upgrade_unit_count": 2, "upgrade_units": [ { "id": "a95be8d6-4a76-46fe-9c9c-341e89973da7", "display_name": "esx551", "type": "HOST", "current_version": "1.0.0.1444456", "group": { "id": "d00d6a39-5ff2-4ddc-a63f-672b4e9ecc5", "display_name": "esx55Hosts" }, "warnings": [], "metadata": [] }, { "id": "1f64e9f4-eeb3-4ebd-af78-e08757e593cf", "display_name": "esx552", "type": "HOST", "current_version": "1.0.0.1444456", "group": { "id": "d00d6a39-5ff2-4ddc-a63f-672b4e9ecc5", "display_name": "esx55Hosts" }, "warnings": [], "metadata": [] } ], "extended_configuration": [ { "key": "upgrade_mode", "value": "in_place" } ] } ] }

Required Permissions:

read

Feature:

utilities_upgrade

Additional Errors: