Scripting Object - VcVsanUpgradeSystem

Scripting-object corresponding to
VsanUpgradeSystem

Scripting Object Description

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

Attributes

Name Type Description
idString

@since Unknown
morefVcManagedObjectReference

returns the ManagedObjectReference of this ManagedObject @since Unknown
sdkConnectionVcSdkConnection

@since Unknown
sdkIdString

@since Unknown
typeStringDeprecated.

Returns the name for the this managed object's vim type @since Unknown
vimHostVcSdkConnection

@since Unknown
vimIdString

@since Unknown
vimTypeString

@since Unknown

Methods

Methods defined in this Scripting Object
_getRef, createTrigger, performVsanUpgrade_Task, performVsanUpgradePreflightCheck, queryVsanUpgradeStatus

_getRef

@since Unknown

Parameters

NameTypeDescription
None

Return Value

Type Description
VcManagedObjectReference

createTrigger

@since Unknown

Parameters

NameTypeDescription
timeoutNumber

filterString

conditionString

filterToSyncString


Return Value

Type Description
Trigger

performVsanUpgradePreflightCheck

Perform an upgrade pre-flight check on a cluster. @since vSphere API 6.0

Parameters

NameTypeDescription
arg0VcClusterComputeResource

arg1Boolean


Return Value

Type Description
VcVsanUpgradeSystemPreflightCheckResult

queryVsanUpgradeStatus

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. @since vSphere API 6.0

Parameters

NameTypeDescription
arg0VcClusterComputeResource


Return Value

Type Description
VcVsanUpgradeSystemUpgradeStatus

performVsanUpgrade_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 @since vSphere API 6.0

Parameters

NameTypeDescription
arg0VcClusterComputeResource

arg1Boolean

arg2Boolean

arg3Boolean

arg4VcHostSystem []


Return Value

Type Description
VcTask