# Managed Object - VsanUpgradeSystem(vim.VsanUpgradeSystem)

See also
  ClusterComputeResource, HostSystem, VsanUpgradeSystemPreflightCheckResult, VsanUpgradeSystemUpgradeStatus
Since
  vSphere API 6.0

## Managed Object Description

VSAN Upgrade System. Used to perform and monitor VSAN on-disk format upgrades.

Properties

Name | Type | Description
--- | --- | ---
None

Methods

Methods defined in this Managed Object
PerformVsanUpgrade_Task, PerformVsanUpgradePreflightCheck, QueryVsanUpgradeStatus

# PerformVsanUpgrade_Task(performUpgrade)

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 PerformVsanUpgradePreflightCheck

Required Privileges
  System.Read

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the VsanUpgradeSystem used to make the method call.
cluster P | ManagedObjectReference to a ClusterComputeResource | The cluster to be upgraded See PerformVsanUpgradePreflightCheck Since vSphere API 6.0
performObjectUpgrade* P | 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. See PerformVsanUpgradePreflightCheck Since vSphere API 6.0
downgradeFormat* P | xsd:boolean | Perform a on-disk format downgrade instead of upgrade. Only possible if no upgraded objects exist. See PerformVsanUpgradePreflightCheck Since vSphere API 6.0
allowReducedRedundancy* P | xsd:boolean | Removes the need for one disk group worth of free space, by allowing reduced redundancy during disk upgrade. See PerformVsanUpgradePreflightCheck Since vSphere API 6.0
excludeHosts* P | 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. See PerformVsanUpgradePreflightCheck Since vSphere API 6.0

*Need not be set P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
ManagedObjectReference to a 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 | See PerformVsanUpgradePreflightCheck

Events

Type
None

# PerformVsanUpgradePreflightCheck(performUpgradePreflightCheck)

Perform an upgrade pre-flight check on a cluster.

Required Privileges
  System.Read

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the VsanUpgradeSystem used to make the method call.
cluster P | ManagedObjectReference to a ClusterComputeResource | The cluster for which to perform the check. Since vSphere API 6.0
downgradeFormat* P | xsd:boolean | Intend to perform a on-disk format downgrade instead of upgrade. Adds additional checks. Since vSphere API 6.0

*Need not be set P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
VsanUpgradeSystemPreflightCheckResult | 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.
VsanFault |

Events

Type
None

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="PerformVsanUpgradePreflightCheck" type="vsan:PerformVsanUpgradePreflightCheckRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="PerformVsanUpgradePreflightCheckResponse"> <complexType> <sequence> <element name="returnval" type="vsan:VsanUpgradeSystemPreflightCheckResult"/> </sequence> </complexType> </element>

# QueryVsanUpgradeStatus(queryUpgradeStatus)

Retrieve the latest status of a running, or the previously completed, upgrade process. Information about previous upgrade runs are not always, e.g. when VC gets restarted.

Required Privileges
  System.Read

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the VsanUpgradeSystem used to make the method call.
cluster P | ManagedObjectReference to a ClusterComputeResource | The cluster for which to retrieve the upgrade status. Since vSphere API 6.0

P Required privilege: cluster

Return Value

Type | Description
--- | ---
VsanUpgradeSystemUpgradeStatus | 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.
VsanFault |

Events

Type
None

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="QueryVsanUpgradeStatus" type="vsan:QueryVsanUpgradeStatusRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="QueryVsanUpgradeStatusResponse"> <complexType> <sequence> <element name="returnval" type="vsan:VsanUpgradeSystemUpgradeStatus"/> </sequence> </complexType> </element>