Upgrade Multiple Software Clusters
Upgrade a set of clusters to its corresponding specific version.
Request
URLURL
https://{api_host}/api/vcenter/namespace-management/software/clusters?action=upgradeMultiple
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, obtained by first calling Create Session API
Request Body
Request Body
map of
NamespaceManagementSoftwareClustersUpgradeSpec of mimetype application/json
Required
Specifications for upgrading selected clusters. The key in the parameter map must be an identifier for the resource type: ClusterComputeResource. The Clusters.UpgradeSpec structure contains the specification required to upgrade a cluster.
(The request body parameter is missing description)
{
"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.
Response
Response
Response BodyResponse Body
200 OK returns
map of
NamespaceManagementSoftwareClustersResult of type application/json
Pre-check result when invoking upgrade for each cluster. The key in the result map will be an identifier for the resource type: ClusterComputeResource.
{
"res": "enum"
}
res
Required
The result of batch upgrade method.
Possible values are: STARTED , REJECTED
object
exception
Optional
Exception when cluster pre-check failed during upgrade invocation. This field is optional and it is only relevant when the value of Clusters.Result.res is REJECTED.
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?action=upgradeMultiple
Errors
403
com.vmware.vapi.std.errors.unauthorized : if the user does not have Namespaces.Manage privilege on all specified clusters.
500
com.vmware.vapi.std.errors.error : if the system reports an error while responding to the request.
Availability
Added in 7.0.0.0
