NSX-T Data Center REST API

Get upgrade unit based on the filter

Get all the upgrade unit groups based in the filter applied. The
filter can be on component type, group name, id,enabled, status, unit name, unit IP,
status, Hypervisor.

Request:

Method:
GET
URI Path(s):
/api/v1/upgrade/filterUnits
Request Headers:
n/a
Query Parameters:
UpgradeUnitFilterListRequestParameters+
Request Body:
n/a

Example Request:

GET https://<nsx-mgr>/api/v1/upgrade/filterUnits?component_type=HOST&status=NOT_STARTED

Successful Response:

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

Example Response:

{ "results": [{ "id": "47e4baf6-0dba-48b2-a46d-09f6b629984f", "display_name": "10.187.98.202", "type": "HOST", "current_version": "4.0.0.2.0.19923469", "group": { "id": "00a87ee2-1cb7-41c9-b744-661964c63cbe:domain-c24", "display_name": "Group for New Cluster" }, "warnings": [], "metadata": [ { "key": "HYPERVISOR_OS", "value": "ESXI" }, { "key": "HYPERVISOR_IP", "value": "10.187.98.202" }], "status": "NOT_STARTED", "percent_complete": 0.0, "pre_upgrade_checks": { "successful_checks": { "checks": [ { "display_name": "Restore Operation Check", "status": "SUCCESS", "component_type": "HOST" }, { "display_name": "Check to validate staging on vLCM enabled cluster", "status": "SUCCESS", "component_type": "HOST" }], "result_count": 7 }}}], "result_count": 1, "sort_ascending": true }

Required Permissions:

read

Feature:

utilities_upgrade

Additional Errors: