REST API - upgrade_multiple
  1. Operations
  2. vcenter
  3. namespace management
  4. software
  5. clusters

vcenter namespace management software clusters: upgrade multiple

Upgrade a set of clusters to its corresponding specific version.

Request:

HTTP request

POST https://{server}/api/vcenter/namespace-management/software/clusters

?action=upgradeMultiple
{
    "obj-103" : {
        "desired_version" : "string",
        "ignore_precheck_warnings" : true
    }
}

Body Parameters:

Name Type Description
bold = required
- object Specifications for upgrading selected clusters.Object with element values of type upgrade_spec.
-.* upgrade_spec
-.*.desired_version string Version number the cluster is going to be upgraded to.
-.*.ignore_precheck_warnings boolean If true, the upgrade workflow will ignore any pre-check warnings and proceed with the upgrade.

Optional. 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:

HTTP Status Code: 200

Response Body Structure:

{
    "obj-103" : {
        "exception" : {},
        "res" : "STARTED"
    }
}

Headers:

None

Type:

Name Type Description
bold = required
- object Pre-check result when invoking upgrade for each cluster.Object with element values of type result.
-.* result
-.*.res string The result of batch upgrade method.

Represents the upgrade invocation result for each cluster. Value is one of:
STARTED: Upgrade is started.
REJECTED: Upgrade is rejected. This implies pre-check failed when invoking upgrade of the cluster.
-.*.exception exception Exception when cluster pre-check failed during upgrade invocation.

Optional. It is only relevant when res has value REJECTED. This field is optional and it is only relevant when the value of res is REJECTED.

Errors:

HTTP Status Code Type Description
500 error if the system reports an error while responding to the request.
401 unauthenticated if the user can not be authenticated.
403 unauthorized if the user does not have Namespaces.Manage privilege on all specified clusters.