Developer Documentation
Upgrade Software Clusters
Released in v7.0.0.0Upgrade the cluster to a specific version. This operation upgrades the components on control plane VMs and worker plane hosts based on the selected version. Before upgrading, this operation performs pre-checks and sets the evaluation response in Info.UpgradeStatus.messages with various Message.Severity levels. Depending on the severity, the upgrade may or may not proceed beyond prechecks. Here is a list of severities and corresponding behavior: - ERROR: Upgrade does not proceed beyond precheck operation - WARNING: Upgrade proceeds beyond precheck operation only if UpgradeSpec.ignorePrecheckWarnings is set to true - INFO: Upgrade proceeds beyond precheck operation uninterrupted
Request
URLURL
https://{api_host}/api/vcenter/namespace-management/software/clusters/{cluster}?action=upgrade
Path Parameters
Path Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Identifier for the cluster which will be upgraded. The parameter must be an identifier for the resource type: ClusterComputeResource. |
Request Body
Request Body
Contains
ClustersUpgradeSpec
of type application/json
(required)
{
"desired_version": "string"
}| Required | Property Name | Type | Description |
|---|---|---|---|
| required | desired_version | string |
Version number the cluster is going to be upgraded to. |
| optional | ignore_precheck_warnings | boolean |
If true, the upgrade workflow will ignore any pre-check warnings and proceed with the upgrade. If unset, the upgrade workflow will not ignore pre-check warnings and fail the upgrade. It is equivalent to setting the value to false. The workflow adopts a conservative approach of failing the upgrade if unset to solely let the user decide whether to force the upgrade despite the warnings. |
Errors
| Code | Returns | Description |
|---|---|---|
| 404 | Error | com.vmware.vapi.std.errors.error : if the system reports an error while responding to the request. | com.vmware.vapi.std.errors.not_found : if cluster could not be located. |
| 405 | Error | com.vmware.vapi.std.errors.unsupported : if pre-check failed of the cluster. |
| default | Error | Not available |
| 401 | Error | com.vmware.vapi.std.errors.unauthenticated : if the user can not be authenticated. | com.vmware.vapi.std.errors.unauthorized : if the user does not have Namespaces.Manage privilege. |
