| API Description | API Path |
|---|---|
Abort pre-upgrade checksAborts execution of pre-upgrade checks if already in progress. Halts the execution of checks awaiting execution at this point and makes best-effort attempts to stop checks already in execution. Returns without action if execution of pre-upgrade checks is not in progress. |
POST /api/v1/upgrade?action=abort_pre_upgrade_checks
|
Execute pre-upgrade checksRun pre-defined checks to identify potential issues which can be encountered during an upgrade or can cause an upgrade to fail. The results of the checks are added to the respective upgrade units aggregate-info. The progress and status of operation is part of upgrade status summary of individual components. Returns HTTP status 500 with error code 30953 if execution of pre-upgrade checks is already in progress. |
POST /api/v1/upgrade?action=execute_pre_upgrade_checks
|
Execute post-upgrade checksRun pre-defined checks to identify issues after upgrade of a component. The results of the checks are added to the respective upgrade units aggregate-info. The progress and status of post-upgrade checks is part of aggregate-info of individual upgrade unit groups. Returns HTTP status 500 with error code 30953 if execution of post-upgrade checks is already in progress. |
POST /api/v1/upgrade/<component-type>?action=execute_post_upgrade_checks
|
Upgrade selected unitsUpgrades, Resumes the upgrade of a selected set of units. |
POST /api/v1/upgrade/plan?action=upgrade_selected_units
|
Stage the upgrade bitsThis will stage the upgrade bits so that upgrade can be driven from outside NSX upgrade-coordinator. If component type is not provided as a request parameter then upgrade staging will be performed on all the components. |
POST /api/v1/upgrade/plan?action=stage-upgrade
|
Start upgradeStart the upgrade. Upgrade will start as per the upgrade plan. |
POST /api/v1/upgrade/plan?action=start
|
Pause upgradePause the upgrade. Upgrade will be paused after upgrade of all the nodes currently in progress is completed either successfully or with failure. User can make changes in the upgrade plan when the upgrade is paused. |
POST /api/v1/upgrade/plan?action=pause
|
Reset upgrade plan to default planReset the upgrade plan to default plan. User has an option to change the default plan. But if after making changes, user wants to go back to the default plan, this is the way to do so. |
POST /api/v1/upgrade/plan?action=reset
|
Continue upgradeContinue the upgrade. Resumes the upgrade from the point where it was paused. |
POST /api/v1/upgrade/plan?action=continue
|
Get upgrade plan settings for the componentGet the upgrade plan settings for the component. |
GET /api/v1/upgrade/plan/<component_type>/settings
|
Update upgrade plan settings for the componentUpdate the upgrade plan settings for the component. |
PUT /api/v1/upgrade/plan/<component_type>/settings
|
Returns pre-upgrade checks in csv formatReturns pre-upgrade checks in csv format |
GET /api/v1/upgrade/pre-upgrade-checks?format=csv
|
Get Pre-upgrade Check FailuresGet 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. |
GET /api/v1/upgrade/pre-upgrade-checks/failures
|
Returns information about upgrade checksReturns information of pre-upgrade and post-upgrade checks. If request parameter component type is specified, then returns information about all pre-upgrade and post-upgrade for the component. Otherwise returns information of checks across all component types. |
GET /api/v1/upgrade/upgrade-checks-info
|