com.vmware.appliance

Interface Shutdown

All Superinterfaces:

Service, ShutdownTypes

All Known Implementing Classes:

ShutdownStub

public interface Shutdown
extends Service, ShutdownTypes

Shutdown interface provides methods Performs reboot/shutdown operations on appliance. This interface was added in vSphere API 6.7.

Nested Class Summary

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

ShutdownTypes.ShutdownConfig

Method Summary

Methods

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

Method Detail

cancel

void cancel()

Cancel pending shutdown action. 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:

Error - Generic error

cancel

void cancel(InvocationConfig invocationConfig)

Cancel pending shutdown action. 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:

Error - Generic error

cancel

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

Cancel pending shutdown action. 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:
Error - Generic error

Parameters:

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

cancel

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

Cancel pending shutdown action. 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:
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(long delay,
            java.lang.String reason)

Power off the appliance. 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:

delay - Minutes after which poweroff should start. If 0 is specified, poweroff will start immediately.

reason - Reason for peforming poweroff.

Throws:

Error - Generic error

poweroff

void poweroff(long delay,
            java.lang.String reason,
            InvocationConfig invocationConfig)

Power off the appliance. 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:

delay - Minutes after which poweroff should start. If 0 is specified, poweroff will start immediately.

reason - Reason for peforming poweroff.

invocationConfig - Configuration for the method invocation.

Throws:

Error - Generic error

poweroff

void poweroff(long delay,
            java.lang.String reason,
            AsyncCallback<java.lang.Void> asyncCallback)

Power off the appliance. 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:
Error - Generic error

Parameters:

delay - Minutes after which poweroff should start. If 0 is specified, poweroff will start immediately.

reason - Reason for peforming poweroff.

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

poweroff

void poweroff(long delay,
            java.lang.String reason,
            AsyncCallback<java.lang.Void> asyncCallback,
            InvocationConfig invocationConfig)

Power off the appliance. 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:
Error - Generic error

Parameters:

delay - Minutes after which poweroff should start. If 0 is specified, poweroff will start immediately.

reason - Reason for peforming poweroff.

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

invocationConfig - Configuration for the method invocation.

reboot

void reboot(long delay,
          java.lang.String reason)

Reboot the appliance. 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:

delay - Minutes after which reboot should start. If 0 is specified, reboot will start immediately.

reason - Reason for peforming reboot.

Throws:

Error - Generic error

reboot

void reboot(long delay,
          java.lang.String reason,
          InvocationConfig invocationConfig)

Reboot the appliance. 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:

delay - Minutes after which reboot should start. If 0 is specified, reboot will start immediately.

reason - Reason for peforming reboot.

invocationConfig - Configuration for the method invocation.

Throws:

Error - Generic error

reboot

void reboot(long delay,
          java.lang.String reason,
          AsyncCallback<java.lang.Void> asyncCallback)

Reboot the appliance. 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:
Error - Generic error

Parameters:

delay - Minutes after which reboot should start. If 0 is specified, reboot will start immediately.

reason - Reason for peforming reboot.

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

reboot

void reboot(long delay,
          java.lang.String reason,
          AsyncCallback<java.lang.Void> asyncCallback,
          InvocationConfig invocationConfig)

Reboot the appliance. 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:
Error - Generic error

Parameters:

delay - Minutes after which reboot should start. If 0 is specified, reboot will start immediately.

reason - Reason for peforming reboot.

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

invocationConfig - Configuration for the method invocation.

get

ShutdownTypes.ShutdownConfig get()

Get details about the pending shutdown action. 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:

Configuration of pending shutdown action.

Throws:

Error - Generic error

get

ShutdownTypes.ShutdownConfig get(InvocationConfig invocationConfig)

Get details about the pending shutdown action. 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:

Configuration of pending shutdown action.

Throws:

Error - Generic error

get

void get(AsyncCallback<ShutdownTypes.ShutdownConfig> asyncCallback)

Get details about the pending shutdown action. This method was added in vSphere API 6.7.

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.ShutdownConfig> asyncCallback,
       InvocationConfig invocationConfig)

Get details about the pending shutdown action. 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 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.