| Local Methods | ||
Managed Object Types | Data Object Types | All Properties | All Methods |
It deprecates vim.VsanUpgradeSystem, to take care of vSAN upgrade process.
It has capability to support additional advanced disk format conversion specification, to help on configuration of latest vSAN advanced features.
It supports following vSAN on-disk format versions:Properties
Name | Type | Description |
---|---|---|
None |
Methods
Methods defined in this Managed Object |
---|
PerformVsanUpgradeEx, PerformVsanUpgradePreflightAsyncCheck_Task, PerformVsanUpgradePreflightCheckEx, RetrieveSupportedVsanFormatVersion, VsanQueryUpgradeStatusEx |
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.
Combined Privileges Required (on vSphere ManagedEntity):Privileges | Required on |
---|---|
Host.Config.Storage | ClusterComputeResource |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VsanUpgradeSystemEx used to make the method call. |
cluster | ManagedObjectReference
to a ClusterComputeResource |
The cluster to be upgraded
|
performObjectUpgrade* | xsd:boolean |
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.
Since vSphere API 6.0 |
downgradeFormat* | xsd:boolean |
Perform a on-disk format downgrade instead of
upgrade. Only possible if no upgraded objects exist.
Since vSphere API 6.0 |
allowReducedRedundancy* | xsd:boolean |
Removes the need for one disk group worth of
free space, by allowing reduced redundancy
during disk upgrade.
Since vSphere API 6.0 |
excludeHosts* | ManagedObjectReference[]
to a HostSystem[] |
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.
Since vSphere API 6.0 |
spec* | VsanDiskFormatConversionSpec |
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.
Since vSphere API 6.0 |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a Task | vim.Task |
Faults
Type | Description |
---|---|
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
VsanFault |
Events
Type | |
---|---|
None |
Privileges | Required on |
---|---|
Host.Config.Storage | ClusterComputeResource |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VsanUpgradeSystemEx used to make the method call. |
cluster | ManagedObjectReference
to a ClusterComputeResource |
The target cluster to process conversion.
|
downgradeFormat* | xsd:boolean |
Intend to perform a on-disk format downgrade
instead of upgrade. Adds additional checks.
Since vSphere API 6.5 |
spec* | VsanDiskFormatConversionSpec |
The specification of advanced disk format configuration.
Adds additional checks. The specification cannot be
supported in downgrade process, for now we don't
have any advanced features supported by lower disk format.
Since vSphere API 6.5 |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a Task | A task to monitor progress. Results should be obtains by VsanQueryUpgradeStatusEx |
Faults
Type | Description |
---|---|
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
VsanFault |
Events
Type | |
---|---|
None |
It deprecates API vim.VsanUpgradeSystem.PerformVsanUpgradePreflightCheck, and helps to check following issues which would break vSAN upgrade process:
Privileges | Required on |
---|---|
Host.Config.Storage | ClusterComputeResource |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VsanUpgradeSystemEx used to make the method call. |
cluster | ManagedObjectReference
to a ClusterComputeResource |
The target cluster to be converted.
|
downgradeFormat* | xsd:boolean |
Intend to perform a on-disk format downgrade
instead of upgrade. Adds additional checks.
Since vSphere API 6.0 |
spec* | VsanDiskFormatConversionSpec |
The specification of advanced disk format configuration.
Adds additional checks. The specification cannot be
supported in downgrade process, for now we don't
have any advanced features supported by lower disk format.
Since vSphere API 6.0 |
Return Value
Type | Description |
---|---|
VsanDiskFormatConversionCheckResult | Preflight check result. |
Faults
Type | Description |
---|---|
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Privileges | Required on |
---|---|
System.Read | ClusterComputeResource |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VsanUpgradeSystemEx used to make the method call. |
cluster | ManagedObjectReference
to a ClusterComputeResource |
The target cluster to process scan.
|
Return Value
Type | Description |
---|---|
xsd:int | int To present the highest supported disk format version. |
Faults
Type | Description |
---|---|
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Privileges | Required on |
---|---|
System.Read | ClusterComputeResource |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VsanUpgradeSystemEx used to make the method call. |
cluster | ManagedObjectReference
to a ClusterComputeResource |
The cluster for which to retrieve the upgrade status.
|
Return Value
Type | Description |
---|---|
VsanUpgradeStatusEx | Status |
Faults
Type | Description |
---|---|
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Top of page | Local Methods | ||
Managed Object Types | Data Object Types | All Properties | All Methods |