NSX-T Data Center Global Manager REST API

Return aggregate information of upgrade unit groups filtered using given query.

Return information of upgrade unit groups filtered by given query
in the upgrade plan.

Request:

Method:
POST
URI Path(s):
/api/v1/upgrade/filter/upgrade-unit-groups
Request Headers:
n/a
Query Parameters:
ListRequestParameters+
Request Body:
UpgradeResourcesFilterListRequestParameters+

Example Request:

{ "component_type": "HOST", "sync": false, "query": [ { "resource_type" : "UPGRADE_GROUP", "filters": [ { "field_name" : "id", "values": ["*domain*74"] } ] } ] }

Successful Response:

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

Example Response:

{ "results": [ { "type": "HOST", "parallel": false, "enabled": true, "upgrade_unit_count": 1, "upgrade_units": [ { "id": "b5e91e23-3407-4178-a46b-6cf43866958a", "display_name": "10.212.34.38", "type": "HOST", "current_version": "4.1.1.0.0.21118455", "group": { "id": "96f3313b-da5e-44e8-b5cb-56ca9c79a3ec:domain-c74", "display_name": "Group for Jio" }, "warnings": [], "metadata": [ { "key": "DEPLOYMENT_STATUS", "value": "INSTALL_SUCCESSFUL" } ] } ], "status": "NOT_STARTED", "failed_count": 0, "percent_complete": 0.0, "post_upgrade_status": { "status": "NOT_STARTED", "node_with_issues_count": 0 }, "extended_configuration": [ { "key": "upgrade_mode", "value": "maintenance_mode" }, { "key": "rebootless_upgrade", "value": "true" }, { "key": "vlcm_cluster", "value": "false" } ], "resource_type": "UpgradeUnitGroup", "id": "96f3313b-da5e-44e8-b5cb-56ca9c79a3ec:domain-c74", "display_name": "Group for Lio" } ], "result_count": 1 }

Required Permissions:

read

Feature:

utilities_upgrade

Additional Errors: