Vsan Upgrade System Perform Vsan Upgrade Task
Start VSAN on-disk format upgrade process on a particular cluster.
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. This is a long running (hours to days) task. In addition to normal task progress reporting, use the queryUpgradeStatus() API which allows to retrieve in-depth status updates from the upgrade process. In there will be a detailed log of every operation the upgrade process has taken or issues it encountered. Some are simple log messages, others refer to operations like evacuating a disk group. For such log entries, the task object of the evacuation task is provided to allow "sub-task" tracking. Before starting, the upgrade process will perform a pre-flight check, and abort if any of the pre-conditions are not met. See
See also PerformVsanUpgradePreflightCheckfor details on the pre-conditions being checked for. The upgrade process performs additional "pre-flight checks" before proceeding to upgrade the next host. The upgrade process will be halted if any of those pre-flight 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 pre-flight check results indicate such a condition. The upgrade process will however only re-add those disks if the restoreBackup parameter is passed in as true. Privilege "Host.Config.Storage" on all hosts under specified cluster is required..
Required privileges: System.Read
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 VsanUpgradeSystem/{moId}.
The vSphere release schema. The current specification covers vSphere 8.0.3.0 APIs.
Show optional properties
{
"cluster": {}
}{
"cluster": {
"_typeName": "string",
"type": "string",
"value": "string"
},
"performObjectUpgrade": false,
"downgradeFormat": false,
"allowReducedRedundancy": false,
"excludeHosts": [
{
"_typeName": "string",
"type": "string",
"value": "string"
}
]
}Reference to an instance of the ClusterComputeResource managed object.
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.
Perform a on-disk format downgrade instead of upgrade. Only possible if no upgraded objects exist.
Removes the need for one disk group worth of free space, by allowing reduced redundancy during disk upgrade.
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.
OK
{
"_typeName": "string",
"type": "string",
"value": "string"
}Failure
{
"_typeName": "string",
"faultCause": "MethodFault Object",
"faultMessage": [
{
"_typeName": "string",
"key": "string",
"arg": [
{
"_typeName": "string",
"key": "string",
"value": {
"_typeName": "string"
}
}
],
"message": "string"
}
]
}