com.vmware.vcenter.deployment

Interface Migrate

All Superinterfaces:

MigrateTypes, Service

All Known Implementing Classes:

MigrateStub

public interface Migrate
extends Service, MigrateTypes

The Migrate interface provides methods to configure the migration of this appliance from an existing vCenter for Windows. This interface was added in vSphere API 7.0.0.

Nested Class Summary

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

MigrateTypes.MigrateSpec, MigrateTypes.MigrationAssistantSpec, MigrateTypes.PscSpec, MigrateTypes.SourceVcWindows, MigrateTypes.VcsaEmbeddedSpec

Field Summary

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

_VAPI_SERVICE_ID

Method Summary

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

Method Detail

get

MigrateTypes.MigrateSpec get()

Get the MigrateSpec parameters used to configure the ongoing appliance migration. This method was added in vSphere API 7.0.0.

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

Returns:

MigrateSpec parameters being used to configure appliance migration.

Throws:

Unauthenticated - if the caller is not authenticated.

NotAllowedInCurrentState - if appliance is not in MIGRATE_PROGRESS state.

get

MigrateTypes.MigrateSpec get(InvocationConfig invocationConfig)

Get the MigrateSpec parameters used to configure the ongoing appliance migration. This method was added in vSphere API 7.0.0.

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:

MigrateSpec parameters being used to configure appliance migration.

Throws:

Unauthenticated - if the caller is not authenticated.

NotAllowedInCurrentState - if appliance is not in MIGRATE_PROGRESS state.

get

void get(AsyncCallback<MigrateTypes.MigrateSpec> asyncCallback)

Get the MigrateSpec parameters used to configure the ongoing appliance migration. This method was added in vSphere API 7.0.0.

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

Invocation Result:
MigrateSpec parameters being used to configure appliance migration.

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

Parameters:

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

get

void get(AsyncCallback<MigrateTypes.MigrateSpec> asyncCallback,
         InvocationConfig invocationConfig)

Get the MigrateSpec parameters used to configure the ongoing appliance migration. This method was added in vSphere API 7.0.0.

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:
MigrateSpec parameters being used to configure appliance migration.

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

Parameters:

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

invocationConfig - Configuration for the method invocation.

check

CheckInfo check(MigrateTypes.MigrateSpec spec)

Run sanity checks using the MigrateSpec parameters passed. This method was added in vSphere API 7.0.0.

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

Parameters:

spec - MigrateSpec parameters to run sanity check on.

Returns:

CheckInfo containing the check results.

Throws:

Unauthenticated - if the caller is not authenticated.

Unauthenticated - if migration assistant credentials are not valid.

InvalidArgument - if passed arguments are invalid.

NotAllowedInCurrentState - if the appliance is not in INITIALIZED state.

check

CheckInfo check(MigrateTypes.MigrateSpec spec,
                InvocationConfig invocationConfig)

Run sanity checks using the MigrateSpec parameters passed. This method was added in vSphere API 7.0.0.

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 - MigrateSpec 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 migration assistant credentials are not valid.

InvalidArgument - if passed arguments are invalid.

NotAllowedInCurrentState - if the appliance is not in INITIALIZED state.

check

void check(MigrateTypes.MigrateSpec spec,
           AsyncCallback<CheckInfo> asyncCallback)

Run sanity checks using the MigrateSpec parameters passed. This method was added in vSphere API 7.0.0.

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 migration assistant credentials are not valid.
InvalidArgument - if passed arguments are invalid.
NotAllowedInCurrentState - if the appliance is not in INITIALIZED state.

Parameters:

spec - MigrateSpec parameters to run sanity check on.

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

check

void check(MigrateTypes.MigrateSpec spec,
           AsyncCallback<CheckInfo> asyncCallback,
           InvocationConfig invocationConfig)

Run sanity checks using the MigrateSpec parameters passed. This method was added in vSphere API 7.0.0.

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 migration assistant credentials are not valid.
InvalidArgument - if passed arguments are invalid.
NotAllowedInCurrentState - if the appliance is not in INITIALIZED state.

Parameters:

spec - MigrateSpec 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(MigrateTypes.MigrateSpec spec)

Start the appliance migration. This method was added in vSphere API 7.0.0.

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

Parameters:

spec - MigrateSpec parameters to configure the appliance migration.

Throws:

Unauthenticated - if the caller is not authenticated.

Unauthenticated - if migration assistant credentials are not valid.

InvalidArgument - if passed arguments are invalid.

NotAllowedInCurrentState - if the appliance is not in INITIALIZED state.

start

void start(MigrateTypes.MigrateSpec spec,
           InvocationConfig invocationConfig)

Start the appliance migration. This method was added in vSphere API 7.0.0.

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 - MigrateSpec parameters to configure the appliance migration.

invocationConfig - Configuration for the method invocation.

Throws:

Unauthenticated - if the caller is not authenticated.

Unauthenticated - if migration assistant credentials are not valid.

InvalidArgument - if passed arguments are invalid.

NotAllowedInCurrentState - if the appliance is not in INITIALIZED state.

start

void start(MigrateTypes.MigrateSpec spec,
           AsyncCallback<java.lang.Void> asyncCallback)

Start the appliance migration. This method was added in vSphere API 7.0.0.

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 migration assistant credentials are not valid.
InvalidArgument - if passed arguments are invalid.
NotAllowedInCurrentState - if the appliance is not in INITIALIZED state.

Parameters:

spec - MigrateSpec parameters to configure the appliance migration.

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

start

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

Start the appliance migration. This method was added in vSphere API 7.0.0.

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 migration assistant credentials are not valid.
InvalidArgument - if passed arguments are invalid.
NotAllowedInCurrentState - if the appliance is not in INITIALIZED state.

Parameters:

spec - MigrateSpec parameters to configure the appliance migration.

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

invocationConfig - Configuration for the method invocation.

cancel

void cancel()

Cancel the appliance migration that is in progress. This method was added in vSphere API 7.0.0.

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 migration that is in progress. This method was added in vSphere API 7.0.0.

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 migration that is in progress. This method was added in vSphere API 7.0.0.

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 migration that is in progress. This method was added in vSphere API 7.0.0.

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.