Managed Object - VsanUpgradeSystemEx(vim.VsanUpgradeSystemEx)

See also: ClusterComputeResource, HostSystem, Task, VsanDiskFormatConversionCheckResult, VsanDiskFormatConversionSpec
Since: vSphere API 6.0

Managed Object Description

It deprecates vim.VsanUpgradeSystem, to take care of Virtual SAN upgrade process.

It has capability to support additional advanced disk format conversion specification, to help on configuration of latest Virtual SAN advanced features.

It supports following Virtual SAN on-disk format versions:

version 1, released by Virtual SAN 1.0, vSphere ESX 5.5u1;
version 2, released by Virtual SAN 6.0, which supports Virsto file system;
version 3, released by Virtual SAN 6.2, which supports Virtual SAN deduplication and compression.

It can be accessed with MOID vsan-upgrade-systemex through Virtual SAN service at vCenter server side.

Properties

Name	Type	Description
None

Methods

Methods defined in this Managed Object
PerformVsanUpgradeEx, PerformVsanUpgradePreflightCheckEx, RetrieveSupportedVsanFormatVersion

PerformVsanUpgradeEx(performUpgrade)

Start Virtual SAN 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 Virtual SAN disk format to support corresponding Virtual SAN advanced features, such as Virtual SAN 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 Virtual SAN 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 Virtual SAN features.

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 Virtual SAN from a disk group, but before re-adding those disks to Virtual SAN, the upgrade process can recover from that. The pre-flight check results indicate such a condition.

Required Privileges: System.Read

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

*Need not be set

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.

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="PerformVsanUpgradeEx" type="vim25:PerformVsanUpgradeExRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="PerformVsanUpgradeExResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vim25:ManagedObjectReference"/>
               </sequence>
            </complexType>
         </element>

PerformVsanUpgradePreflightCheckEx(performUpgradePreflightCheck)

Perform an upgrade pre-flight check on a cluster.

It deprecates API vim.VsanUpgradeSystem.PerformVsanUpgradePreflightCheck, and helps to check following issues which would break Virtual SAN upgrade process:

1. any Virtual SAN host is disconnected from vCenter server;
2. ESX host before vSphere 6.0 exists in Virtual SAN cluster, of which on-disk format cannot be upgraded;
3. any Virtual SAN host enables auto-mode to claim disk;
4. network issue exists in Virtual SAN cluster, which leads to communication problem among Virtual SAN hosts;
5. not all Virtual SAN member hosts reside in specified vCenter cluster;
6. any Virtual SAN host contributes in the other Virtual SAN cluster;
7. there is inaccessible Virtual SAN object in Virtual SAN datastore;
8. any in-use Virtual SAN disk is in unhealth status, such as physical disk lost;
9. hybrid disk group exists in Virtual SAN cluster, if Virtual deduplication and compression is srequested to enable;
10. if Virtual deduplication and compression is srequested to enable, but there is Virtual SAN host doesn't have vSphere ESX 6.0u2 software;
11. Virtual SAN downgrade is requested, but Virtual SAN objects have already been upgraded;

Any issue detected by pre-flight check, requires manual fix by end user, before trigger Virtual SAN upgrade process through PerformVsanUpgradeEx.

Required Privileges: System.Read

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

*Need not be set

Return Value

Type	Description
VsanDiskFormatConversionCheckResult	Pre-flight 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

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="PerformVsanUpgradePreflightCheckEx" type="vim25:PerformVsanUpgradePreflightCheckExRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="PerformVsanUpgradePreflightCheckExResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vim25:VsanDiskFormatConversionCheckResult"/>
               </sequence>
            </complexType>
         </element>

RetrieveSupportedVsanFormatVersion(retrieveSupportedFormatVersion)

Process a scan and retrieve the highest Virtual SAN disk format version that given cluster supports, the version is up to version of ESX host in specified cluster: ESX of vSphere6.0u2 and latter, support version is 4; ESX of vSphere6.0 series before vSphere6.0u2, support version is 2; ESX of lower version, is not supported;

Required Privileges: System.Read

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

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="RetrieveSupportedVsanFormatVersion" type="vim25:RetrieveSupportedVsanFormatVersionRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="RetrieveSupportedVsanFormatVersionResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="xsd:int"/>
               </sequence>
            </complexType>
         </element>