NSX-T Data Center REST API

Returns information about upgrade checks

Returns information of pre-upgrade and post-upgrade checks. If request
parameter component type is specified, then returns information about
all pre-upgrade and post-upgrade for the component. Otherwise returns
information of checks across all component types.

Request:

Method:
GET
URI Path(s):
/api/v1/upgrade/upgrade-checks-info
Request Headers:
n/a
Query Parameters:
UpgradeCheckInfoListRequestParameters+
Request Body:
n/a

Example Request:

GET https://<nsx-mgr>/api/v1/upgrade/upgrade-checks-info?component_type=EDGE

Successful Response:

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

Example Response:

{ "result_count": 1, "results": [ { "component_type": "EDGE", "post_upgrade_checks_info": [ { "component_type": "EDGE", "name": "Check on edge version", "description": "Check on edge version" }, { "component_type": "EDGE", "name": "Check status of upgrade agent", "description": "Check status of upgrade agent" }, { "component_type": "EDGE", "name": "Check management plane connectivity", "description": "Check management plane connectivity" }, { "component_type": "EDGE", "name": "Check central control plane connectivity", "description": "Check central control plane connectivity" }, { "component_type": "EDGE", "name": "Check status of PNIC/Bonds", "description": "Check status of PNIC/Bonds" }, { "component_type": "EDGE", "name": "Check overall transport node status", "description": "Check overall transport node status" }, { "component_type": "EDGE", "name": "Check status of tunnels between transport nodes", "description": "Check status of tunnels between transport nodes" } ], "pre_upgrade_checks_info": [ { "component_type": "EDGE", "name": "Check health and status of edge nodes", "description": "Check health and status of edge nodes" } ] } ] }

Required Permissions:

read

Feature:

utilities_upgrade

Additional Errors: