com.vmware.vcenter.deployment

Interface Install

All Superinterfaces:

InstallTypes, Service

All Known Implementing Classes:

InstallStub

public interface Install
extends Service, InstallTypes

The Install interface provides methods to configure the installation of the appliance. This interface was added in vSphere API 6.7.

Nested Class Summary

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

InstallTypes.InstallSpec, InstallTypes.VcsaEmbeddedSpec

Field Summary

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

_VAPI_SERVICE_ID

Method Summary

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

Method Detail

get

InstallTypes.InstallSpec get()

Get the parameters used to configure the ongoing 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.

Returns:

InstallSpec parameters being used to configure appliance install.

Throws:

Unauthenticated - if the caller is not authenticated.

NotAllowedInCurrentState - if appliance is not in INSTALL_PROGRESS state.

get

InstallTypes.InstallSpec get(InvocationConfig invocationConfig)

Get the parameters used to configure the ongoing 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:

invocationConfig - Configuration for the method invocation.

Returns:

InstallSpec parameters being used to configure appliance install.

Throws:

Unauthenticated - if the caller is not authenticated.

NotAllowedInCurrentState - if appliance is not in INSTALL_PROGRESS state.

get

void get(AsyncCallback<InstallTypes.InstallSpec> asyncCallback)

Get the parameters used to configure the ongoing 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.

Invocation Result:
InstallSpec parameters being used to configure appliance install.

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

Parameters:

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

get

void get(AsyncCallback<InstallTypes.InstallSpec> asyncCallback,
         InvocationConfig invocationConfig)

Get the parameters used to configure the ongoing 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.

Invocation Result:
InstallSpec parameters being used to configure appliance install.

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

Parameters:

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

invocationConfig - Configuration for the method invocation.

check

CheckInfo check(InstallTypes.InstallSpec spec)

Run sanity checks using the InstallSpec 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 - InstallSpec parameters to run sanity check with.

Returns:

CheckInfo containing the check results.

Throws:

Unauthenticated - if the caller is not authenticated.

Unauthenticated - if external PSC credentials are not valid when configuring PSC to replicate with an external existing PSC.

Unauthenticated - if external PSC credentials are not valid when configuring a VCSA_EXTERNAL appliance.

InvalidArgument - if passed arguments are invalid.

NotAllowedInCurrentState - if the appliance is not in INITIALIZED state.

check

CheckInfo check(InstallTypes.InstallSpec spec,
                InvocationConfig invocationConfig)

Run sanity checks using the InstallSpec 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 - InstallSpec parameters to run sanity check with.

invocationConfig - Configuration for the method invocation.

Returns:

CheckInfo containing the check results.

Throws:

Unauthenticated - if the caller is not authenticated.

Unauthenticated - if external PSC credentials are not valid when configuring PSC to replicate with an external existing PSC.

Unauthenticated - if external PSC credentials are not valid when configuring a VCSA_EXTERNAL appliance.

InvalidArgument - if passed arguments are invalid.

NotAllowedInCurrentState - if the appliance is not in INITIALIZED state.

check

void check(InstallTypes.InstallSpec spec,
           AsyncCallback<CheckInfo> asyncCallback)

Run sanity checks using the InstallSpec 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 external PSC credentials are not valid when configuring PSC to replicate with an external existing PSC.
Unauthenticated - if external PSC credentials are not valid when configuring a VCSA_EXTERNAL appliance.
InvalidArgument - if passed arguments are invalid.
NotAllowedInCurrentState - if the appliance is not in INITIALIZED state.

Parameters:

spec - InstallSpec parameters to run sanity check with.

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

check

void check(InstallTypes.InstallSpec spec,
           AsyncCallback<CheckInfo> asyncCallback,
           InvocationConfig invocationConfig)

Run sanity checks using the InstallSpec 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 external PSC credentials are not valid when configuring PSC to replicate with an external existing PSC.
Unauthenticated - if external PSC credentials are not valid when configuring a VCSA_EXTERNAL appliance.
InvalidArgument - if passed arguments are invalid.
NotAllowedInCurrentState - if the appliance is not in INITIALIZED state.

Parameters:

spec - InstallSpec parameters to run sanity check with.

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

invocationConfig - Configuration for the method invocation.

start

void start(InstallTypes.InstallSpec 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 - InstallSpec parameters to configure the appliance install.

Throws:

Unauthenticated - if the caller is not authenticated.

Unauthenticated - if the partner PSC credentials are not valid when configuring PSC to replicate with partner PSC.

Unauthenticated - if external PSC credentials are not valid when configuring a VCSA_EXTERNAL appliance.

InvalidArgument - if passed arguments are invalid.

NotAllowedInCurrentState - if the appliance is not in INITIALIZED state.

start

void start(InstallTypes.InstallSpec 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 - InstallSpec parameters to configure the appliance install.

invocationConfig - Configuration for the method invocation.

Throws:

Unauthenticated - if the caller is not authenticated.

Unauthenticated - if the partner PSC credentials are not valid when configuring PSC to replicate with partner PSC.

Unauthenticated - if external PSC credentials are not valid when configuring a VCSA_EXTERNAL appliance.

InvalidArgument - if passed arguments are invalid.

NotAllowedInCurrentState - if the appliance is not in INITIALIZED state.

start

void start(InstallTypes.InstallSpec 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 the partner PSC credentials are not valid when configuring PSC to replicate with partner PSC.
Unauthenticated - if external PSC credentials are not valid when configuring a VCSA_EXTERNAL appliance.
InvalidArgument - if passed arguments are invalid.
NotAllowedInCurrentState - if the appliance is not in INITIALIZED state.

Parameters:

spec - InstallSpec parameters to configure the appliance install.

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

start

void start(InstallTypes.InstallSpec 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 the partner PSC credentials are not valid when configuring PSC to replicate with partner PSC.
Unauthenticated - if external PSC credentials are not valid when configuring a VCSA_EXTERNAL appliance.
InvalidArgument - if passed arguments are invalid.
NotAllowedInCurrentState - if the appliance is not in INITIALIZED state.

Parameters:

spec - InstallSpec parameters to configure the appliance install.

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

invocationConfig - Configuration for the method invocation.

cancel

void cancel()

Cancel the appliance installation 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 installation 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 installation 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 installation 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.