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+

Name	Description	Type	Notes
component_type	Component type based on which upgrade checks are to be filtered	string
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

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+

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Collection of info of pre/post-upgrade checks for components	array of ComponentUpgradeChecksInfo	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

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" } ] } ] }

Returns information about upgrade checks

Request:

UpgradeCheckInfoListRequestParameters (schema)

Example Request:

Successful Response:

ComponentUpgradeChecksInfoListResult (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: