Vcenter NamespaceManagement Software Clusters upgrade

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

This operation was added in vSphere API 7.0.0.0.

Returns an authorization error if you do not have all of the privileges described as follows:

The resource ClusterComputeResource referenced by the parameter cluster requires Namespaces.Upgrade.

Request

URI

POST

https://{api_host}/api/vcenter/namespace-management/software/clusters/{cluster}?action=upgrade

COPY

Path Parameters

string

cluster

Required

Identifier for the cluster which will be upgraded.

The parameter must be an identifier for the resource type: ClusterComputeResource.

Request Body

Specification for upgrading the cluster.

Vcenter NamespaceManagement Software Clusters UpgradeSpec of type(s) application/json

Required

Show optional properties

{
    "desired_version": "string"
}

{
    "desired_version": "string",
    "ignore_precheck_warnings": false
}

string

desired_version

Required

Version number the cluster is going to be upgraded to.

This property was added in vSphere API 7.0.0.0.

boolean

ignore_precheck_warnings

Optional

If true, the upgrade workflow will ignore any pre-check warnings and proceed with the upgrade.

This property was added in vSphere API 7.0.0.0.

If missing or null, 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 missing or null to solely let the user decide whether to force the upgrade despite the warnings.

Authentication

This operation uses the following authentication methods.

api_key_auth

Responses

204

Success!

Operation doesn't return any data structure

400

if pre-check failed of the cluster.

Returns Vapi Std Errors Unsupported of type(s) application/json

This response body class contains all of the following: InlineVapi Std Errors Unsupported0

"Vapi Std Errors Unsupported Object"

401

if the user can not be authenticated.

Returns Vapi Std Errors Unauthenticated of type(s) application/json

This response body class contains all of the following: InlineVapi Std Errors Unauthenticated0

"Vapi Std Errors Unauthenticated Object"

string

challenge

Optional

Indicates the authentication challenges applicable to the target API provider. It can be used by a client to discover the correct authentication scheme to use. The exact syntax of the value is defined by the specific provider, the protocol and authentication schemes used.

For example, a provider using REST may adhere to the WWW-Authenticate HTTP header specification, RFC7235, section 4.1. In this case an example challenge value may be: SIGN realm="27da1358-2ba4-11e9-b210-d663bd873d93",sts="http://vcenter/sso?vsphere.local", Basic realm="vCenter"

This property was added in vSphere API 7.0.0.0.

This property is optional because it was added in a newer version than its parent node.

403

if the user does not have Namespaces.Upgrade privilege.

Returns Vapi Std Errors Unauthorized of type(s) application/json

This response body class contains all of the following: InlineVapi Std Errors Unauthorized0

"Vapi Std Errors Unauthorized Object"

404

if cluster could not be located.

Returns Vapi Std Errors NotFound of type(s) application/json

This response body class contains all of the following: InlineVapi Std Errors NotFound0

"Vapi Std Errors NotFound Object"

500

if the system reports an error while responding to the request.

Returns Vapi Std Errors Error of type(s) application/json

"Vapi Std Errors Error Object"

array of object

messages

Required

Stack of one or more localizable messages for human error consumers.

The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked.

Each subsequent message in the stack describes the "cause" of the prior message.

object

data

Optional

Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully.

Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports.

The Vapi Std Errors ArgumentLocations, Vapi Std Errors FileLocations, and Vapi Std Errors TransientIndication schemas are intended as possible values for this property. Vapi Std DynamicID may also be useful as a value for this property (although that is not its primary purpose). Some resources may provide their own specific schemas for use as the value of this property when reporting errors from their operations.

Some operations will not set this property when reporting errors.

string

error_type

Required

Discriminator field to help API consumers identify the structure type.

For more information see: Vapi Std Errors Error Type.

This property was added in vSphere API 6.7.2.

Can be missing or null for compatibility with preceding implementations.

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"desired_version:"string"}' https://{api_host}/api/vcenter/namespace-management/software/clusters/{cluster}?action=upgrade

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

204 Response Body

Errors

Vcenter Namespace Management Operations

POST

Vcenter NamespaceManagement Software Clusters upgrade