Upgrade Software Clusters
Upgrade 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
string
cluster
Required
Identifier for the cluster which will be upgraded. The parameter must be an identifier for the resource type: ClusterComputeResource.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Request Body
Request Body
NamespaceManagementSoftwareClustersUpgradeSpec of mimetype application/json
Required
Specification for upgrading the cluster.
{
"desired_version": "string"
}
string
desired_version
Required
Version number the cluster is going to be upgraded to.
boolean
ignore_precheck_warnings
Optional
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.
Authentication
This operation uses the following authentication methods.
Errors
Errors
403
com.vmware.vapi.std.errors.unauthorized : if the user does not have Namespaces.Upgrade privilege.
500
com.vmware.vapi.std.errors.error : if the system reports an error while responding to the request.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
$NamespaceManagementSoftwareClustersUpgradeSpec = Initialize-NamespaceManagementSoftwareClustersUpgradeSpec -DesiredVersion "MyDesiredVersion"
Invoke-UpgradeCluster -Cluster "MyCluster" -NamespaceManagementSoftwareClustersUpgradeSpec $NamespaceManagementSoftwareClustersUpgradeSpec
PowerCLI Client SDK All Parameters Example
$NamespaceManagementSoftwareClustersUpgradeSpec = Initialize-NamespaceManagementSoftwareClustersUpgradeSpec -DesiredVersion "MyDesiredVersion" -IgnorePrecheckWarnings $false
Invoke-UpgradeCluster -Cluster "MyCluster" -NamespaceManagementSoftwareClustersUpgradeSpec $NamespaceManagementSoftwareClustersUpgradeSpec
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"desired_version":"string","ignore_precheck_warnings":false}' https://{api_host}/api/vcenter/namespace-management/software/clusters/{cluster}?action=upgrade
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: upgrade
Availability
Added in 7.0.0.0
