Get Upgrade Plan Settings

Get Upgrade Plan Settings

Get the upgrade plan settings for the component.

Request
URI
GET
https://nsxmanager.your.domain/api/v1/upgrade/plan/{component_type}/settings
COPY
Path Parameters
string
component_type
Required

component_type

Authentication
This operation uses the following authentication methods.
Responses
200

Success

Returns UpgradePlanSettings of type(s) application/json 
{
    "pause_after_each_group": false,
    "pause_on_error": false,
    "parallel": false
}
boolean
pause_after_each_group
Optional

pause_after_each_group

boolean
pause_on_error
Optional

pause_on_error

boolean
parallel
Optional

parallel


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