com.vmware.vcenter.deployment

Interface Upgrade

All Superinterfaces:

Service, UpgradeTypes

All Known Implementing Classes:

UpgradeStub

public interface Upgrade
extends Service, UpgradeTypes

The Upgrade interface provides methods to configure the upgrade of this appliance from an existing vCenter appliance. This interface was added in vSphere API 6.7.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.vcenter.deployment.UpgradeTypes

UpgradeTypes.PscSpec, UpgradeTypes.SourceApplianceSpec, UpgradeTypes.UpgradeSpec, UpgradeTypes.VcsaEmbeddedSpec

Field Summary

Fields inherited from interface com.vmware.vcenter.deployment.UpgradeTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
void	cancel() Cancel the appliance upgrade that is in progress.
void	cancel(AsyncCallback<java.lang.Void> asyncCallback) Cancel the appliance upgrade that is in progress.
void	cancel(AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Cancel the appliance upgrade that is in progress.
void	cancel(InvocationConfig invocationConfig) Cancel the appliance upgrade that is in progress.
CheckInfo	check(UpgradeTypes.UpgradeSpec spec) Run sanity checks using the UpgradeSpec parameters passed.
void	check(UpgradeTypes.UpgradeSpec spec, AsyncCallback<CheckInfo> asyncCallback) Run sanity checks using the UpgradeSpec parameters passed.
void	check(UpgradeTypes.UpgradeSpec spec, AsyncCallback<CheckInfo> asyncCallback, InvocationConfig invocationConfig) Run sanity checks using the UpgradeSpec parameters passed.
CheckInfo	check(UpgradeTypes.UpgradeSpec spec, InvocationConfig invocationConfig) Run sanity checks using the UpgradeSpec parameters passed.
UpgradeTypes.UpgradeSpec	get() Get the UpgradeSpec parameters used to configure the ongoing appliance upgrade.
void	get(AsyncCallback<UpgradeTypes.UpgradeSpec> asyncCallback) Get the UpgradeSpec parameters used to configure the ongoing appliance upgrade.
void	get(AsyncCallback<UpgradeTypes.UpgradeSpec> asyncCallback, InvocationConfig invocationConfig) Get the UpgradeSpec parameters used to configure the ongoing appliance upgrade.
UpgradeTypes.UpgradeSpec	get(InvocationConfig invocationConfig) Get the UpgradeSpec parameters used to configure the ongoing appliance upgrade.
void	start(UpgradeTypes.UpgradeSpec spec) Start the appliance installation.
void	start(UpgradeTypes.UpgradeSpec spec, AsyncCallback<java.lang.Void> asyncCallback) Start the appliance installation.
void	start(UpgradeTypes.UpgradeSpec spec, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Start the appliance installation.
void	start(UpgradeTypes.UpgradeSpec spec, InvocationConfig invocationConfig) Start the appliance installation.

Method Detail

get

UpgradeTypes.UpgradeSpec get()

Get the UpgradeSpec parameters used to configure the ongoing appliance upgrade. This method was added in vSphere API 6.7.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Returns:

UpgradeSpec parameters being used to configure appliance upgrade.

Throws:

Unauthenticated - if the caller is not authenticated.

NotAllowedInCurrentState - if appliance is not in UPGRADE_PROGRESS state.

get

UpgradeTypes.UpgradeSpec get(InvocationConfig invocationConfig)

Get the UpgradeSpec parameters used to configure the ongoing appliance upgrade. This method was added in vSphere API 6.7.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

invocationConfig - Configuration for the method invocation.

Returns:

UpgradeSpec parameters being used to configure appliance upgrade.

Throws:

Unauthenticated - if the caller is not authenticated.

NotAllowedInCurrentState - if appliance is not in UPGRADE_PROGRESS state.

get

void get(AsyncCallback<UpgradeTypes.UpgradeSpec> asyncCallback)

Get the UpgradeSpec parameters used to configure the ongoing appliance upgrade. This method was added in vSphere API 6.7.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Invocation Result:
UpgradeSpec parameters being used to configure appliance upgrade.

Operation Errors:
Unauthenticated - if the caller is not authenticated.
NotAllowedInCurrentState - if appliance is not in UPGRADE_PROGRESS state.

Parameters:

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

get

void get(AsyncCallback<UpgradeTypes.UpgradeSpec> asyncCallback,
         InvocationConfig invocationConfig)

Get the UpgradeSpec parameters used to configure the ongoing appliance upgrade. This method was added in vSphere API 6.7.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Invocation Result:
UpgradeSpec parameters being used to configure appliance upgrade.

Operation Errors:
Unauthenticated - if the caller is not authenticated.
NotAllowedInCurrentState - if appliance is not in UPGRADE_PROGRESS state.

Parameters:

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

check

CheckInfo check(UpgradeTypes.UpgradeSpec spec)

Run sanity checks using the UpgradeSpec parameters passed. This method was added in vSphere API 6.7.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

spec - UpgradeSpec parameters to run sanity check on.

Returns:

CheckInfo containing the check results.

Throws:

Unauthenticated - if the caller is not authenticated.

Unauthenticated - if source credentials are not valid.

Unauthenticated - if source container credentials are not valid.

InvalidArgument - if passed arguments are invalid.

NotAllowedInCurrentState - if the appliance is not in INITIALIZED state.

check

CheckInfo check(UpgradeTypes.UpgradeSpec spec,
                InvocationConfig invocationConfig)

Run sanity checks using the UpgradeSpec parameters passed. This method was added in vSphere API 6.7.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

spec - UpgradeSpec parameters to run sanity check on.

invocationConfig - Configuration for the method invocation.

Returns:

CheckInfo containing the check results.

Throws:

Unauthenticated - if the caller is not authenticated.

Unauthenticated - if source credentials are not valid.

Unauthenticated - if source container credentials are not valid.

InvalidArgument - if passed arguments are invalid.

NotAllowedInCurrentState - if the appliance is not in INITIALIZED state.

check

void check(UpgradeTypes.UpgradeSpec spec,
           AsyncCallback<CheckInfo> asyncCallback)

Run sanity checks using the UpgradeSpec parameters passed. This method was added in vSphere API 6.7.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Invocation Result:
CheckInfo containing the check results.

Operation Errors:
Unauthenticated - if the caller is not authenticated.
Unauthenticated - if source credentials are not valid.
Unauthenticated - if source container credentials are not valid.
InvalidArgument - if passed arguments are invalid.
NotAllowedInCurrentState - if the appliance is not in INITIALIZED state.

Parameters:

spec - UpgradeSpec parameters to run sanity check on.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

check

void check(UpgradeTypes.UpgradeSpec spec,
           AsyncCallback<CheckInfo> asyncCallback,
           InvocationConfig invocationConfig)

Run sanity checks using the UpgradeSpec parameters passed. This method was added in vSphere API 6.7.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Invocation Result:
CheckInfo containing the check results.

Operation Errors:
Unauthenticated - if the caller is not authenticated.
Unauthenticated - if source credentials are not valid.
Unauthenticated - if source container credentials are not valid.
InvalidArgument - if passed arguments are invalid.
NotAllowedInCurrentState - if the appliance is not in INITIALIZED state.

Parameters:

spec - UpgradeSpec parameters to run sanity check on.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

start

void start(UpgradeTypes.UpgradeSpec spec)

Start the appliance installation. This method was added in vSphere API 6.7.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

spec - UpgradeSpec parameters to configure the appliance upgrade.

Throws:

Unauthenticated - if the caller is not authenticated.

Unauthenticated - if source credentials are not valid.

Unauthenticated - if source container credentials are not valid.

InvalidArgument - if passed arguments are invalid.

NotAllowedInCurrentState - if the appliance is not in INITIALIZED state.

start

void start(UpgradeTypes.UpgradeSpec spec,
           InvocationConfig invocationConfig)

Start the appliance installation. This method was added in vSphere API 6.7.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

spec - UpgradeSpec parameters to configure the appliance upgrade.

invocationConfig - Configuration for the method invocation.

Throws:

Unauthenticated - if the caller is not authenticated.

Unauthenticated - if source credentials are not valid.

Unauthenticated - if source container credentials are not valid.

InvalidArgument - if passed arguments are invalid.

NotAllowedInCurrentState - if the appliance is not in INITIALIZED state.

start

void start(UpgradeTypes.UpgradeSpec spec,
           AsyncCallback<java.lang.Void> asyncCallback)

Start the appliance installation. This method was added in vSphere API 6.7.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Operation Errors:
Unauthenticated - if the caller is not authenticated.
Unauthenticated - if source credentials are not valid.
Unauthenticated - if source container credentials are not valid.
InvalidArgument - if passed arguments are invalid.
NotAllowedInCurrentState - if the appliance is not in INITIALIZED state.

Parameters:

spec - UpgradeSpec parameters to configure the appliance upgrade.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

start

void start(UpgradeTypes.UpgradeSpec spec,
           AsyncCallback<java.lang.Void> asyncCallback,
           InvocationConfig invocationConfig)

Start the appliance installation. This method was added in vSphere API 6.7.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Operation Errors:
Unauthenticated - if the caller is not authenticated.
Unauthenticated - if source credentials are not valid.
Unauthenticated - if source container credentials are not valid.
InvalidArgument - if passed arguments are invalid.
NotAllowedInCurrentState - if the appliance is not in INITIALIZED state.

Parameters:

spec - UpgradeSpec parameters to configure the appliance upgrade.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

cancel

void cancel()

Cancel the appliance upgrade that is in progress. This method was added in vSphere API 6.7.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Throws:

Unauthenticated - if the caller is not authenticated.

NotAllowedInCurrentState - if the appliance is not in CONFIG_IN_PROGRESS state and if the operation is not INSTALL.

cancel

void cancel(InvocationConfig invocationConfig)

Cancel the appliance upgrade that is in progress. This method was added in vSphere API 6.7.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

invocationConfig - Configuration for the method invocation.

Throws:

Unauthenticated - if the caller is not authenticated.

NotAllowedInCurrentState - if the appliance is not in CONFIG_IN_PROGRESS state and if the operation is not INSTALL.

cancel

void cancel(AsyncCallback<java.lang.Void> asyncCallback)

Cancel the appliance upgrade that is in progress. This method was added in vSphere API 6.7.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Operation Errors:
Unauthenticated - if the caller is not authenticated.
NotAllowedInCurrentState - if the appliance is not in CONFIG_IN_PROGRESS state and if the operation is not INSTALL.

Parameters:

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

cancel

void cancel(AsyncCallback<java.lang.Void> asyncCallback,
            InvocationConfig invocationConfig)

Cancel the appliance upgrade that is in progress. This method was added in vSphere API 6.7.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Operation Errors:
Unauthenticated - if the caller is not authenticated.
NotAllowedInCurrentState - if the appliance is not in CONFIG_IN_PROGRESS state and if the operation is not INSTALL.

Parameters:

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.