Package com.vmware.vim25.mo

Class VsanUpgradeSystem

java.lang.Object

com.vmware.vim25.mo.ManagedObject

com.vmware.vim25.mo.VsanUpgradeSystem

public class VsanUpgradeSystem
extends ManagedObject

Constructor Summary

Constructors

Constructor	Description
VsanUpgradeSystem(ServerConnection serverConnection, ManagedObjectReference mor)

Method Summary

Modifier and Type	Method	Description
Task	performVsanUpgrade_Task(ClusterComputeResource cluster)	Start VSAN on-disk format upgrade process on a particular cluster.
Task	performVsanUpgrade_Task(ClusterComputeResource cluster, Boolean performObjectUpgrade)	Start VSAN on-disk format upgrade process on a particular cluster.
Task	performVsanUpgrade_Task(ClusterComputeResource cluster, Boolean performObjectUpgrade, Boolean downgradeFormat)	Start VSAN on-disk format upgrade process on a particular cluster.
Task	performVsanUpgrade_Task(ClusterComputeResource cluster, Boolean performObjectUpgrade, Boolean downgradeFormat, Boolean allowReducedRedundancy)	Start VSAN on-disk format upgrade process on a particular cluster.
Task	performVsanUpgrade_Task(ClusterComputeResource cluster, Boolean performObjectUpgrade, Boolean downgradeFormat, Boolean allowReducedRedundancy, HostSystem[] excludeHosts)	Start VSAN on-disk format upgrade process on a particular cluster.
VsanUpgradeSystemPreflightCheckResult	performVsanUpgradePreflightCheck(ClusterComputeResource cluster)	Perform an upgrade pre-flight check on a cluster.
VsanUpgradeSystemPreflightCheckResult	performVsanUpgradePreflightCheck(ClusterComputeResource cluster, Boolean downgradeFormat)	Perform an upgrade pre-flight check on a cluster.
VsanUpgradeSystemUpgradeStatus	queryVsanUpgradeStatus(ClusterComputeResource cluster)	Retrieve the latest status of a running, or the previously completed, upgrade process.

Methods inherited from class com.vmware.vim25.mo.ManagedObject

convertMors, getCurrentProperty, getDatastores, getFilter, getHosts, getManagedObject, getManagedObjects, getManagedObjects, getMOR, getNetworks, getPropertiesByPaths, getPropertyByPath, getResourcePools, getScheduledTasks, getServerConnection, getTasks, getViews, getVimService, getVms, retrieveObjectProperties, setCachedProperty, setMOR, setServerConnection, toString, waitForValues

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

VsanUpgradeSystem

public VsanUpgradeSystem(ServerConnection serverConnection,
 ManagedObjectReference mor)

Method Details

performVsanUpgrade_Task

public Task performVsanUpgrade_Task(ClusterComputeResource cluster,
 Boolean performObjectUpgrade,
 Boolean downgradeFormat,
 Boolean allowReducedRedundancy,
 HostSystem[] excludeHosts)
                             throws RuntimeFault,
VsanFault,
RemoteException

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.

Parameters:

cluster - The cluster to be upgraded

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

downgradeFormat - Perform a on-disk format downgrade instead of upgrade. Only possible if no upgraded objects exist.

allowReducedRedundancy - Removes the need for one disk group worth of free space, by allowing reduced redundancy during disk upgrade.

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

Returns:

Task to monitor for status.

Throws:

RuntimeFault

VsanFault

RemoteException

See Also:

• performVsanUpgradePreflightCheck

performVsanUpgrade_Task

public Task performVsanUpgrade_Task(ClusterComputeResource cluster,
 Boolean performObjectUpgrade,
 Boolean downgradeFormat,
 Boolean allowReducedRedundancy)
                             throws RuntimeFault,
VsanFault,
RemoteException

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.

Parameters:

cluster - The cluster to be upgraded

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

downgradeFormat - Perform a on-disk format downgrade instead of upgrade. Only possible if no upgraded objects exist.

allowReducedRedundancy - Removes the need for one disk group worth of free space, by allowing reduced redundancy during disk upgrade.

Returns:

Task to monitor

Throws:

RuntimeFault

VsanFault

RemoteException

See Also:

• performVsanUpgradePreflightCheck

performVsanUpgrade_Task

public Task performVsanUpgrade_Task(ClusterComputeResource cluster,
 Boolean performObjectUpgrade,
 Boolean downgradeFormat)
                             throws RuntimeFault,
VsanFault,
RemoteException

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.

Parameters:

cluster - The cluster to be upgraded

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

downgradeFormat - Perform a on-disk format downgrade instead of upgrade. Only possible if no upgraded objects exist.

Returns:

Task to monitor

Throws:

RuntimeFault

VsanFault

RemoteException

See Also:

• performVsanUpgradePreflightCheck

performVsanUpgrade_Task

public Task performVsanUpgrade_Task(ClusterComputeResource cluster,
 Boolean performObjectUpgrade)
                             throws RuntimeFault,
VsanFault,
RemoteException

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.

Parameters:

cluster - The cluster to be upgraded

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

Returns:

Task to monitor

Throws:

RuntimeFault

VsanFault

RemoteException

See Also:

• performVsanUpgradePreflightCheck

performVsanUpgrade_Task

public Task performVsanUpgrade_Task(ClusterComputeResource cluster)
                             throws RuntimeFault,
VsanFault,
RemoteException

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.

Parameters:

cluster - The cluster to be upgraded

Returns:

Task to monitor

Throws:

RuntimeFault

VsanFault

RemoteException

See Also:

• performVsanUpgradePreflightCheck

performVsanUpgradePreflightCheck

public VsanUpgradeSystemPreflightCheckResult performVsanUpgradePreflightCheck(ClusterComputeResource cluster,
 Boolean downgradeFormat)
                                                                       throws RuntimeFault,
VsanFault,
RemoteException

Perform an upgrade pre-flight check on a cluster.

Parameters:

cluster - The cluster for which to perform the check.

downgradeFormat - Intend to perform a on-disk format downgrade instead of upgrade. Adds additional checks.

Returns:

Pre-flight check result.

Throws:

RuntimeFault

VsanFault

RemoteException

performVsanUpgradePreflightCheck

public VsanUpgradeSystemPreflightCheckResult performVsanUpgradePreflightCheck(ClusterComputeResource cluster)
                                                                       throws RuntimeFault,
VsanFault,
RemoteException

Perform an upgrade pre-flight check on a cluster.

Parameters:

cluster - The cluster for which to perform the check.

Returns:

Pre-flight check result.

Throws:

RuntimeFault

VsanFault

RemoteException

queryVsanUpgradeStatus

public VsanUpgradeSystemUpgradeStatus queryVsanUpgradeStatus(ClusterComputeResource cluster)
                                                      throws RuntimeFault,
VsanFault,
RemoteException

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.

Parameters:

cluster - The cluster for which to retrieve the upgrade status.

Returns:

Status

Throws:

RuntimeFault

VsanFault

RemoteException