Get Upgrade Unit Group
Return upgrade unit group information
Request
URI
GET
https://nsxmanager.your.domain/api/v1/upgrade/upgrade-unit-groups/{group-id}
COPY
Path Parameters
string
group-id
Required
group-id
Query Parameters
boolean
summary
Optional
Flag indicating whether to return the summary
Responses
200
Success
Returns UpgradeUnitGroup of type(s) application/json
This response body class contains all of the following: ManagedResource , InlineUpgradeUnitGroup1
{
"_self": {
"rel": "string"
},
"_system_owned": false,
"display_name": "string",
"description": "string",
"tags": [
{
"scope": "string",
"tag": "string"
}
],
"_revision": 0,
"_create_user": "string",
"_schema": "string",
"_create_time": 0,
"_links": [
{
"action": "string",
"href": "string",
"rel": "string"
}
],
"_last_modified_time": 0,
"_last_modified_user": "string",
"id": "string",
"resource_type": "string",
"enabled": false,
"upgrade_unit_count": 0,
"type": "string",
"upgrade_units": [
{
"_self": {
"rel": "string"
},
"_links": [
{
"action": "string",
"href": "string",
"rel": "string"
}
],
"_schema": "string",
"group": {
"display_name": "string",
"id": "string"
},
"warnings": [
"string"
],
"current_version": "string",
"metadata": [
{
"value": "string",
"key": "string"
}
],
"type": "string",
"id": "string",
"display_name": "string"
}
],
"extended_configuration": [
{
"value": "string",
"key": "string"
}
],
"parallel": false
}
default
Unexpected error
Returns ApiError of type(s) application/json
{
"module_name": "string",
"error_message": "string",
"error_code": 0
}string
module_name
Optional
module_name
string
error_message
Optional
error_message
integer As int64 As int64
error_code
Optional
error_code
On This Page
Upgrade Operations
POST
Add Upgrade Units To Group
POST
Continue Upgrade
POST
Create Upgrade Unit Group
DELETE
Delete Upgrade Unit Group
GET
Get Nodes
GET
Get Nodes Summary
GET
Get Upgrade History
GET
Get Upgrade Plan Settings
GET
Get Upgrade Status Summary
GET
Get Upgrade Summary
GET
Get Upgrade Unit
GET
Get Upgrade Unit Aggregate Info
GET
Get Upgrade Unit Group
GET
Get Upgrade Unit Group Aggregate Info
GET
Get Upgrade Unit Groups
GET
Get Upgrade Unit Groups Status
GET
Get Upgrade Unit Group Status
GET
Get Upgrade Units
GET
Get Upgrade Units Stats
GET
Get Version Whitelist
GET
Get Version Whitelist By Component
POST
Pause Upgrade
POST
Reorder Upgrade Unit
POST
Reorder Upgrade Unit Group
POST
Reset Upgrade Plan
POST
Start Upgrade
POST
Trigger Uc Upgrade
PUT
Update Upgrade Plan Settings
PUT
Update Upgrade Unit Group
PUT
Update Version Whitelist
POST
Upload Upgrade Bundle