System Administration >
Lifecycle Management
>
Upgrade
>
Plan
Get upgrade plan settings for the component
Get the upgrade plan settings for the component.
Request:
Method:
GET
URI Path(s):
/api/v1/upgrade/plan/<component_type>/settings
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a
Example Request:
GET https://<nsx-mgr>/api/v1/upgrade/plan/host/settings
Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
UpgradePlanSettings
+
UpgradePlanSettings
(
schema
)
Name
Description
Type
Notes
parallel
Upgrade Method to specify whether the upgrade is to be performed serially or in parallel
boolean
Default: "True"
pause_after_each_group
Flag to indicate whether to pause the upgrade after upgrade of each group is completed
boolean
Default: "False"
pause_on_error
Flag to indicate whether to pause the upgrade plan execution when an error occurs
boolean
Default: "False"
Example Response:
{ "parallel" : "true", "pause_on_error" : "true", "pause_after_each_group" : "false" }
Required Permissions:
read
Feature:
utilities_upgrade
Additional Errors:
301 Moved Permanently
307 Temporary Redirect
400 Bad Request
403 Forbidden
409 Conflict
500 Internal Server Error
503 Service Unavailable