| API Description | API Path |
|---|---|
Return information of all upgrade unit groupsReturn 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 groupCreate a group of upgrade units. |
POST /api/v1/upgrade/upgrade-unit-groups
|
Get upgrade status for upgrade unit groupsGet upgrade status for upgrade unit groups |
GET /api/v1/upgrade/upgrade-unit-groups-status
|
Delete the upgrade unit groupDelete 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 informationReturns 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 groupAdd 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 groupReorder 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 groupUpdate 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. Following extended_configuration is supported: Key: upgrade_mode Supported values: maintenance_mode,in_place Default: maintenance_mode Key: maintenance_mode_config_vsan_mode Supported values: evacuate_all_data, ensure_object_accessibility, no_action Default: ensure_object_accessibility Key: maintenance_mode_config_evacuate_powered_off_vms Supported values: true, false Default: false Key: rebootless_upgrade Supported values: true, false Default: true |
PUT /api/v1/upgrade/upgrade-unit-groups/<group-id>
|
Get upgrade status for groupGet 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 groupReorder 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 groupsReturn 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
|