Vsan Upgrade System Ex Perform Vsan Upgrade Ex

Vsan Upgrade System Ex Perform Vsan Upgrade Ex

Start vSAN disk format conversion on a particular cluster.

It deprecates API vim.VsanUpgradeSystem.PerformVsanUpgrade, besides supporting original basic upgrade options, it also supports advanced disk format conversion spec, to convert vSAN disk format to support corresponding vSAN advanced features, such as vSAN deduplication and compression, etc.

In order to perform this on-disk format upgrade, the upgrade process will perform a rolling evacuation/remove/re-add operation to accomplish the upgrade. In other words, one disk group at a time, it will evacuate the data from the disk group, then remove the old format from the now empty disk group, then reformat the disk group with the new format. Once all disk groups have been upgraded, and if the performObjectUpgrade parameter is set, the vSAN object version is also upgraded. Before the object version is upgraded, it is possible to downgrade the cluster by passing the downgradeFormat parameter. Once objects are of the new object version however, downgrade (and thus rollback) are no longer possible. The new object version is required to allow objects to benefit from new vSAN features.

The upgrade process performs additional "preflight checks" before proceeding to upgrade the next host. The upgrade process will be halted if any of those preflight checks fail.

If the upgrade process has been halted due to a problem, or even due to a crash or other failure, it can be re-started at any point in time. The upgrade will resume where it left off and only do the parts that are still outstanding. If the upgrade process stopped after removing vSAN from a disk group, but before re-adding those disks to vSAN, the upgrade process can recover from that. The preflight check results indicate such a condition.

Request
URI
POST
https://{api_host}/sdk/vim25/{release}/vsan/VsanUpgradeSystemEx/{moId}/PerformVsanUpgradeEx
COPY
Path Parameters
string
moId
Required

The unique identifier for the managed object to which the method attaches; the serialized managed object reference for a request has the form moType/moId, in this case VsanUpgradeSystemEx/{moId}.

string
release
Required

The vSphere release schema. The current specification covers vSphere 9.0.0.0 APIs.


Request Body
PerformVsanUpgradeExRequestType of type(s) application/json
Required
"PerformVsanUpgradeExRequestType Object"
cluster
Required

The cluster to be upgraded

Required privileges: Host.Config.Storage

boolean
performObjectUpgrade
Optional

After all disk groups have been updated, also upgrade all objects. Once started, rollback of the on disk format is no longer possible. Object upgrade unlocks new vSAN features. The default behavior is upgrading objects is this parameter is not specified.

boolean
downgradeFormat
Optional

Perform a on-disk format downgrade instead of upgrade. Only possible if no upgraded objects exist.

boolean
allowReducedRedundancy
Optional

Removes the need for one disk group worth of free space, by allowing reduced redundancy during disk upgrade.

array of object
excludeHosts
Optional

Internal debug option meant for functional testing of vSAN upgrades. Skips upgrade on certain hosts and implies performObjectUpgrade being false. Should not be used by customers.

spec
Optional

The specification of advanced disk format configuration. The spec cannot be supported in downgrade process, for now we don't have any advanced features supported by lower disk format.

Authentication
This operation uses the following authentication methods.
Responses
200

vim.Task

Returns MoRefTask of type(s) application/json
"MoRefTask Object"

500

VsanFault: If a current upgrade or precheck is already in progress

Returns VsanFault of type(s) application/json
"VsanFault Object"

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/sdk/vim25/{release}/vsan/VsanUpgradeSystemEx/{moId}/PerformVsanUpgradeEx