com.vmware.appliance.techpreview

Interface Shutdown

All Superinterfaces:

Service, ShutdownTypes

All Known Implementing Classes:

ShutdownStub

public interface Shutdown
extends Service, ShutdownTypes

Shutdown interface provides methods Performs reboot/shutdow operations on appliance.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.appliance.techpreview.ShutdownTypes

ShutdownTypes.ShutdownConfig, ShutdownTypes.ShutdownGetConfig

Method Summary

Methods

Modifier and Type	Method and Description
void	cancel() Cancel pending shutdown action.
void	cancel(AsyncCallback<Void> asyncCallback) Cancel pending shutdown action.
void	cancel(AsyncCallback<Void> asyncCallback, InvocationConfig invocationConfig) Cancel pending shutdown action.
void	cancel(InvocationConfig invocationConfig) Cancel pending shutdown action.
ShutdownTypes.ShutdownGetConfig	get() Get details about the pending shutdown action.
void	get(AsyncCallback<ShutdownTypes.ShutdownGetConfig> asyncCallback) Get details about the pending shutdown action.
void	get(AsyncCallback<ShutdownTypes.ShutdownGetConfig> asyncCallback, InvocationConfig invocationConfig) Get details about the pending shutdown action.
ShutdownTypes.ShutdownGetConfig	get(InvocationConfig invocationConfig) Get details about the pending shutdown action.
void	poweroff(ShutdownTypes.ShutdownConfig config) Power off the appliance.
void	poweroff(ShutdownTypes.ShutdownConfig config, AsyncCallback<Void> asyncCallback) Power off the appliance.
void	poweroff(ShutdownTypes.ShutdownConfig config, AsyncCallback<Void> asyncCallback, InvocationConfig invocationConfig) Power off the appliance.
void	poweroff(ShutdownTypes.ShutdownConfig config, InvocationConfig invocationConfig) Power off the appliance.
void	reboot(ShutdownTypes.ShutdownConfig config) Reboot the appliance.
void	reboot(ShutdownTypes.ShutdownConfig config, AsyncCallback<Void> asyncCallback) Reboot the appliance.
void	reboot(ShutdownTypes.ShutdownConfig config, AsyncCallback<Void> asyncCallback, InvocationConfig invocationConfig) Reboot the appliance.
void	reboot(ShutdownTypes.ShutdownConfig config, InvocationConfig invocationConfig) Reboot the appliance.

Method Detail

cancel

void cancel()

Cancel pending shutdown action.

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

Throws:

Error - Generic error

cancel

void cancel(InvocationConfig invocationConfig)

Cancel pending shutdown action.

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:

Error - Generic error

cancel

void cancel(AsyncCallback<Void> asyncCallback)

Cancel pending shutdown action.

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

Operation Errors:
Error - Generic error

Parameters:

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

cancel

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

Cancel pending shutdown action.

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:
Error - Generic error

Parameters:

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

invocationConfig - Configuration for the method invocation.

poweroff

void poweroff(ShutdownTypes.ShutdownConfig config)

Power off the appliance.

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

Parameters:

config - Configuration of poweroff action

Throws:

Error - Generic error

poweroff

void poweroff(ShutdownTypes.ShutdownConfig config,
            InvocationConfig invocationConfig)

Power off the appliance.

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:

config - Configuration of poweroff action

invocationConfig - Configuration for the method invocation.

Throws:

Error - Generic error

poweroff

void poweroff(ShutdownTypes.ShutdownConfig config,
            AsyncCallback<Void> asyncCallback)

Power off the appliance.

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

Operation Errors:
Error - Generic error

Parameters:

config - Configuration of poweroff action

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

poweroff

void poweroff(ShutdownTypes.ShutdownConfig config,
            AsyncCallback<Void> asyncCallback,
            InvocationConfig invocationConfig)

Power off the appliance.

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:
Error - Generic error

Parameters:

config - Configuration of poweroff action

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

invocationConfig - Configuration for the method invocation.

reboot

void reboot(ShutdownTypes.ShutdownConfig config)

Reboot the appliance.

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

Parameters:

config - Configuration of reboot action

Throws:

Error - Generic error

reboot

void reboot(ShutdownTypes.ShutdownConfig config,
          InvocationConfig invocationConfig)

Reboot the appliance.

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:

config - Configuration of reboot action

invocationConfig - Configuration for the method invocation.

Throws:

Error - Generic error

reboot

void reboot(ShutdownTypes.ShutdownConfig config,
          AsyncCallback<Void> asyncCallback)

Reboot the appliance.

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

Operation Errors:
Error - Generic error

Parameters:

config - Configuration of reboot action

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

reboot

void reboot(ShutdownTypes.ShutdownConfig config,
          AsyncCallback<Void> asyncCallback,
          InvocationConfig invocationConfig)

Reboot the appliance.

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:
Error - Generic error

Parameters:

config - Configuration of reboot action

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

invocationConfig - Configuration for the method invocation.

get

ShutdownTypes.ShutdownGetConfig get()

Get details about the pending shutdown action.

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

Returns:

Configuration of pending shutdown action.

Throws:

Error - Generic error

get

ShutdownTypes.ShutdownGetConfig get(InvocationConfig invocationConfig)

Get details about the pending shutdown action.

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:

Configuration of pending shutdown action.

Throws:

Error - Generic error

get

void get(AsyncCallback<ShutdownTypes.ShutdownGetConfig> asyncCallback)

Get details about the pending shutdown action.

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

Operation Result:
Configuration of pending shutdown action.

Operation Errors:
Error - Generic error

Parameters:

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

get

void get(AsyncCallback<ShutdownTypes.ShutdownGetConfig> asyncCallback,
       InvocationConfig invocationConfig)

Get details about the pending shutdown action.

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

Operation Result:
Configuration of pending shutdown action.

Operation Errors:
Error - Generic error

Parameters:

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

invocationConfig - Configuration for the method invocation.