NSX-T Data Center REST API

Associated URIs:

API Description API Path

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.
GET /api/v1/upgrade/upgrade-unit-groups

Create a group


Create a group of upgrade units.
POST /api/v1/upgrade/upgrade-unit-groups

Get upgrade status for upgrade unit groups


Get upgrade status for upgrade unit groups
GET /api/v1/upgrade/upgrade-unit-groups-status

Delete the upgrade unit group


Delete the specified group.
NOTE - A group can be deleted only if it is empty.
If user tries to delete a group containing one
or more upgrade units, the operation will fail and an error
will be returned.
DELETE /api/v1/upgrade/upgrade-unit-groups/<group-id>

Return upgrade unit group information


Returns information about a specific upgrade unit group 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.
GET /api/v1/upgrade/upgrade-unit-groups/<group-id>

Add upgrade units to specified upgrade unit group


Add upgrade units to specified upgrade unit group. The upgrade
units will be added at the end of the upgrade unit list.
POST /api/v1/upgrade/upgrade-unit-groups/<group-id>?action=add_upgrade_units

Reorder upgrade unit group


Reorder an upgrade unit group by placing it before/after
the specified upgrade unit group.
POST /api/v1/upgrade/upgrade-unit-groups/<group-id>?action=reorder

Update the upgrade unit group


Update the specified upgrade unit group. Removal of upgrade units from the
group using this is not allowed. An error will be returned in that case.
PUT /api/v1/upgrade/upgrade-unit-groups/<group-id>

Get upgrade status for group


Get upgrade status for upgrade units in the specified group. User can
specify whether to show only the upgrade units with errors.
GET /api/v1/upgrade/upgrade-unit-groups/<group-id>/status

Reorder an upgrade unit within the upgrade unit group


Reorder an upgrade unit within the upgrade unit group by placing it
before/after the specified upgrade unit
POST /api/v1/upgrade/upgrade-unit-groups/<group-id>/upgrade-unit/<upgrade-unit-id>?action=reorder

Return aggregate 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.
GET /api/v1/upgrade/upgrade-unit-groups/aggregate-info