Get upgrade status for group

Get upgrade status for upgrade units in the specified group. User can
specify whether to show only the upgrade units with errors.

Request:

Method:

GET

URI Path(s):

/api/v1/upgrade/upgrade-unit-groups/<group-id>/status

Request Headers:

n/a

Query Parameters:

GroupStatusListRequestParameters+

Name	Description	Type	Notes
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
has_errors	Flag to indicate whether to return only upgrade units with errors	boolean	Default: "False"
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-unit-groups/d00d6a39-5ff2-4ddc-a63f-672b4e9ecc5/status

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

UpgradeUnitStatusListResult+

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	Paged Collection of upgrade units status	array of UpgradeUnitStatus	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:

{ "cursor" : "0036c5a1531e-9145-4818-bdb3-cf299a6558a5nnuullll", "result_count" : 2, "results": [ { "id": "a95be8d6-4a76-46fe-9c9c-341e89973da7", "display_name": "esx551", "status": "SUCCESS", "percent_complete": 100, "errors": [] }, { "id": "1f64e9f4-eeb3-4ebd-af78-e08757e593cf", "display_name": "esx552", "status": "IN_PROGRESS", "percent_complete": 50, "errors": [] } ] }

Get upgrade status for group

Request:

GroupStatusListRequestParameters (schema)

Example Request:

Successful Response:

UpgradeUnitStatusListResult (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: