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, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Request Body
Request Body
InlineApiVcenterNamespaceManagementSoftwareClustersActionUpgradeMultipleRequestBody 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 request body parameter is missing description)
Request data structure does not contain any properties!
Authentication
This operation uses the following authentication methods.
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.
{
"exception": {},
"res": "STARTED"
}
res
Required
The Clusters.Result.Res enumerated type represents the upgrade invocation result for each cluster.
STARTED : Upgrade is started.
REJECTED : Upgrade is rejected. This implies pre-check failed when invoking upgrade of the cluster.
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.
Errors
403
com.vmware.vapi.std.errors.unauthorized : if the user does not have Namespaces.Upgrade privilege on all specified clusters.
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
Invoke-UpgradeMultipleSoftwareClusters -RequestBody $NamespaceManagementSoftwareClustersUpgradeSpec = Initialize-NamespaceManagementSoftwareClustersUpgradeSpec -DesiredVersion "MyDesiredVersion" -IgnorePrecheckWarnings $false
$RequestBody = @{ key_example = $NamespaceManagementSoftwareClustersUpgradeSpec }
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{}' https://{api_host}/api/vcenter/namespace-management/software/clusters?action=upgradeMultiple
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: upgrade_multiple
Availability
Added in 7.0.0.0
