Get Pre-upgrade Check Failures

Get failures resulting from the last execution of pre-upgrade checks. If
the execution of checks is in progress, the response has the list of
failures observed so far.

Request:

Method:

GET

URI Path(s):

/api/v1/upgrade/pre-upgrade-checks/failures

Request Headers:

n/a

Query Parameters:

UpgradeCheckFailureListRequestParameters+

UpgradeCheckFailureListRequestParameters (schema)

Name	Description	Type	Notes
component_type	Component type Component type on which upgrade check failures are to be filtered	string
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
filter_text	Filter text Text to filter the results on. The filter text is matched with origin name and failure message. String matching for the filter is case-insensitive.	string
included_fields	Comma separated list of fields that should be included in query result	string
origin_type	Type of origin of failure Type of origin of pre/post-upgrade check failure	string	Enum: COMPONENT, UPGRADE_UNIT
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
type	Status of the upgrade check Status of the pre/post-upgrade check to filter the results on	string	Enum: FAILURE, WARNING

Request Body:

n/a

Example Request:

POST https://<nsx-mgr>/api/v1/upgrade/pre-upgrade-checks/failures

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

UpgradeCheckFailureListResult+

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 pre/post-upgrade check failures	array of UpgradeCheckFailure	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:

{ "results": [ { "type": "FAILURE", "message": { "message": "DRS should be Enabled and Fully automated for the cluster containing host 5e7aabc6-daea-11e9-938d-e34b48b12d44. Alternatively, put the host in vSphere maintenance mode manually.", "error_code": 30120 }, "component_type": "HOST", "origin_id": "5e7aabc6-daea-11e9-938d-e34b48b12d44", "origin_name": "wdc-rdops-vm05-dhcp-65-47.eng.vmware.com", "origin_type": "UPGRADE_UNIT" }, { "type": "FAILURE", "message": { "message": "DRS should be Enabled and Fully automated for the cluster containing host 35fd8964-daea-11e9-b67e-471c10dc6657. Alternatively, put the host in vSphere maintenance mode manually.", "error_code": 30120 }, "component_type": "HOST", "origin_id": "35fd8964-daea-11e9-b67e-471c10dc6657", "origin_name": "wdc-rdops-vm05-dhcp-77-244.eng.vmware.com", "origin_type": "UPGRADE_UNIT" }, { "type": "WARNING", "message": { "message": "If an external firewall is present, please ensure that communication on port 1234 is open between management nodes and hosts. Ignore if done already.", "error_code": 30171 }, "component_type": "MP", "origin_id": "MP", "origin_name": "MP Component", "origin_type": "COMPONENT" } ], "result_count": 3, "sort_ascending": true }

Get Pre-upgrade Check Failures

Request:

UpgradeCheckFailureListRequestParameters (schema)

Example Request:

Successful Response:

UpgradeCheckFailureListResult (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: