com.vmware.vcenter.vm

Class PowerStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.vcenter.vm.PowerStub

All Implemented Interfaces:

Service, Power, PowerTypes

public class PowerStub
extends com.vmware.vapi.internal.bindings.Stub
implements Power

Remote stub implementation of the Power API service.

WARNING: Internal class, subject to change in future versions.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.vcenter.vm.PowerTypes

PowerTypes.Info, PowerTypes.State

Field Summary

Fields inherited from class com.vmware.vapi.internal.bindings.Stub

apiProvider, converter, ifaceId, retryPolicy, securityContext

Fields inherited from interface com.vmware.vcenter.vm.PowerTypes

_VAPI_SERVICE_ID

Constructor Summary

Constructors

Constructor and Description
PowerStub(ApiProvider apiProvider, StubConfigurationBase config)
PowerStub(ApiProvider apiProvider, com.vmware.vapi.internal.bindings.TypeConverter typeConverter, StubConfigurationBase config)

Method Summary

Modifier and Type	Method and Description
PowerTypes.Info	get(java.lang.String vm) Returns the power state information of a virtual machine.
void	get(java.lang.String vm, AsyncCallback<PowerTypes.Info> asyncCallback) Returns the power state information of a virtual machine.
void	get(java.lang.String vm, AsyncCallback<PowerTypes.Info> asyncCallback, InvocationConfig invocationConfig) Returns the power state information of a virtual machine.
PowerTypes.Info	get(java.lang.String vm, InvocationConfig invocationConfig) Returns the power state information of a virtual machine.
void	reset(java.lang.String vm) Resets a powered-on virtual machine.
void	reset(java.lang.String vm, AsyncCallback<java.lang.Void> asyncCallback) Resets a powered-on virtual machine.
void	reset(java.lang.String vm, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Resets a powered-on virtual machine.
void	reset(java.lang.String vm, InvocationConfig invocationConfig) Resets a powered-on virtual machine.
void	start(java.lang.String vm) Powers on a powered-off or suspended virtual machine.
void	start(java.lang.String vm, AsyncCallback<java.lang.Void> asyncCallback) Powers on a powered-off or suspended virtual machine.
void	start(java.lang.String vm, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Powers on a powered-off or suspended virtual machine.
void	start(java.lang.String vm, InvocationConfig invocationConfig) Powers on a powered-off or suspended virtual machine.
void	stop(java.lang.String vm) Powers off a powered-on or suspended virtual machine.
void	stop(java.lang.String vm, AsyncCallback<java.lang.Void> asyncCallback) Powers off a powered-on or suspended virtual machine.
void	stop(java.lang.String vm, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Powers off a powered-on or suspended virtual machine.
void	stop(java.lang.String vm, InvocationConfig invocationConfig) Powers off a powered-on or suspended virtual machine.
void	suspend(java.lang.String vm) Suspends a powered-on virtual machine.
void	suspend(java.lang.String vm, AsyncCallback<java.lang.Void> asyncCallback) Suspends a powered-on virtual machine.
void	suspend(java.lang.String vm, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Suspends a powered-on virtual machine.
void	suspend(java.lang.String vm, InvocationConfig invocationConfig) Suspends a powered-on virtual machine.

Methods inherited from class com.vmware.vapi.internal.bindings.Stub

invokeMethod, invokeMethodAsync, invokeStreamMethod, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PowerStub

public PowerStub(ApiProvider apiProvider,
                 com.vmware.vapi.internal.bindings.TypeConverter typeConverter,
                 StubConfigurationBase config)

PowerStub

public PowerStub(ApiProvider apiProvider,
                 StubConfigurationBase config)

Method Detail

get

public PowerTypes.Info get(java.lang.String vm)

Description copied from interface: Power

Returns the power state information of a virtual machine.

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

Specified by:

get in interface Power

Parameters:

vm - Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.

Returns:

Power state information for the specified virtual machine.

get

public PowerTypes.Info get(java.lang.String vm,
                           InvocationConfig invocationConfig)

Description copied from interface: Power

Returns the power state information of a virtual machine.

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

Specified by:

get in interface Power

Parameters:

vm - Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.

invocationConfig - Configuration for the method invocation.

Returns:

Power state information for the specified virtual machine.

get

public void get(java.lang.String vm,
                AsyncCallback<PowerTypes.Info> asyncCallback)

Description copied from interface: Power

Returns the power state information of a virtual machine.

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

Invocation Result:
Power state information for the specified virtual machine.

Operation Errors:
Error - if the system reports an error while responding to the request.
NotFound - if the virtual machine is not found.
ResourceInaccessible - if the virtual machine's configuration or execution state cannot be accessed.
ServiceUnavailable - if the system is unable to communicate with a service to complete the request.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user doesn't have the required privileges.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource VirtualMachine referenced by the parameter vm requires System.Read.

Specified by:

get in interface Power

Parameters:

vm - Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.

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

get

public void get(java.lang.String vm,
                AsyncCallback<PowerTypes.Info> asyncCallback,
                InvocationConfig invocationConfig)

Description copied from interface: Power

Returns the power state information of a virtual machine.

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:
Power state information for the specified virtual machine.

Operation Errors:
Error - if the system reports an error while responding to the request.
NotFound - if the virtual machine is not found.
ResourceInaccessible - if the virtual machine's configuration or execution state cannot be accessed.
ServiceUnavailable - if the system is unable to communicate with a service to complete the request.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user doesn't have the required privileges.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource VirtualMachine referenced by the parameter vm requires System.Read.

Specified by:

get in interface Power

Parameters:

vm - Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.

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

invocationConfig - Configuration for the method invocation.

start

public void start(java.lang.String vm)

Description copied from interface: Power

Powers on a powered-off or suspended virtual machine.

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

Specified by:

start in interface Power

Parameters:

vm - Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.

start

public void start(java.lang.String vm,
                  InvocationConfig invocationConfig)

Description copied from interface: Power

Powers on a powered-off or suspended virtual machine.

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

Specified by:

start in interface Power

Parameters:

vm - Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.

invocationConfig - Configuration for the method invocation.

start

public void start(java.lang.String vm,
                  AsyncCallback<java.lang.Void> asyncCallback)

Description copied from interface: Power

Powers on a powered-off or suspended virtual machine.

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

Operation Errors:
Error - if the system reports an error while responding to the request.
NotFound - if the virtual machine is not found.
AlreadyInDesiredState - if the virtual machine is already powered on.
Unsupported - if the virtual machine does not support being powered on (e.g. marked as a template, serving as a fault-tolerance secondary virtual machine).
UnableToAllocateResource - if resources cannot be allocated for the virtual machine (e.g. physical resource allocation policy cannot be satisfied, insufficient licenses are available to run the virtual machine).
ResourceInaccessible - if resources required by the virtual machine are not accessible (e.g. virtual machine configuration files or virtual disks are on inaccessible storage, no hosts are available to run the virtual machine).
ResourceInUse - if resources required by the virtual machine are in use (e.g. virtual machine configuration files or virtual disks are locked, host containing the virtual machine is an HA failover host).
ResourceBusy - if the virtual machine is performing another operation.
ServiceUnavailable - if the system is unable to communicate with a service to complete the request.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user doesn't have the required privileges.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.Interact.PowerOn.

Specified by:

start in interface Power

Parameters:

vm - Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.

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

start

public void start(java.lang.String vm,
                  AsyncCallback<java.lang.Void> asyncCallback,
                  InvocationConfig invocationConfig)

Description copied from interface: Power

Powers on a powered-off or suspended virtual machine.

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 - if the system reports an error while responding to the request.
NotFound - if the virtual machine is not found.
AlreadyInDesiredState - if the virtual machine is already powered on.
Unsupported - if the virtual machine does not support being powered on (e.g. marked as a template, serving as a fault-tolerance secondary virtual machine).
UnableToAllocateResource - if resources cannot be allocated for the virtual machine (e.g. physical resource allocation policy cannot be satisfied, insufficient licenses are available to run the virtual machine).
ResourceInaccessible - if resources required by the virtual machine are not accessible (e.g. virtual machine configuration files or virtual disks are on inaccessible storage, no hosts are available to run the virtual machine).
ResourceInUse - if resources required by the virtual machine are in use (e.g. virtual machine configuration files or virtual disks are locked, host containing the virtual machine is an HA failover host).
ResourceBusy - if the virtual machine is performing another operation.
ServiceUnavailable - if the system is unable to communicate with a service to complete the request.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user doesn't have the required privileges.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.Interact.PowerOn.

Specified by:

start in interface Power

Parameters:

vm - Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.

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

invocationConfig - Configuration for the method invocation.

stop

public void stop(java.lang.String vm)

Description copied from interface: Power

Powers off a powered-on or suspended virtual machine.

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

Specified by:

stop in interface Power

Parameters:

vm - Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.

stop

public void stop(java.lang.String vm,
                 InvocationConfig invocationConfig)

Description copied from interface: Power

Powers off a powered-on or suspended virtual machine.

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

Specified by:

stop in interface Power

Parameters:

vm - Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.

invocationConfig - Configuration for the method invocation.

stop

public void stop(java.lang.String vm,
                 AsyncCallback<java.lang.Void> asyncCallback)

Description copied from interface: Power

Powers off a powered-on or suspended virtual machine.

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

Operation Errors:
Error - if the system reports an error while responding to the request.
NotFound - if the virtual machine is not found.
AlreadyInDesiredState - if the virtual machine is already powered off.
ResourceBusy - if the virtual machine is performing another operation.
ServiceUnavailable - if the system is unable to communicate with a service to complete the request.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user doesn't have the required privileges.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.Interact.PowerOff.

Specified by:

stop in interface Power

Parameters:

vm - Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.

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

stop

public void stop(java.lang.String vm,
                 AsyncCallback<java.lang.Void> asyncCallback,
                 InvocationConfig invocationConfig)

Description copied from interface: Power

Powers off a powered-on or suspended virtual machine.

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 - if the system reports an error while responding to the request.
NotFound - if the virtual machine is not found.
AlreadyInDesiredState - if the virtual machine is already powered off.
ResourceBusy - if the virtual machine is performing another operation.
ServiceUnavailable - if the system is unable to communicate with a service to complete the request.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user doesn't have the required privileges.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.Interact.PowerOff.

Specified by:

stop in interface Power

Parameters:

vm - Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.

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

invocationConfig - Configuration for the method invocation.

suspend

public void suspend(java.lang.String vm)

Description copied from interface: Power

Suspends a powered-on virtual machine.

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

Specified by:

suspend in interface Power

Parameters:

vm - Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.

suspend

public void suspend(java.lang.String vm,
                    InvocationConfig invocationConfig)

Description copied from interface: Power

Suspends a powered-on virtual machine.

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

Specified by:

suspend in interface Power

Parameters:

vm - Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.

invocationConfig - Configuration for the method invocation.

suspend

public void suspend(java.lang.String vm,
                    AsyncCallback<java.lang.Void> asyncCallback)

Description copied from interface: Power

Suspends a powered-on virtual machine.

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

Operation Errors:
Error - if the system reports an error while responding to the request.
NotFound - if the virtual machine is not found.
AlreadyInDesiredState - if the virtual machine is already suspended.
NotAllowedInCurrentState - if the virtual machine is powered off.
ResourceBusy - if the virtual machine is performing another operation.
ServiceUnavailable - if the system is unable to communicate with a service to complete the request.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user doesn't have the required privileges.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.Interact.Suspend.

Specified by:

suspend in interface Power

Parameters:

vm - Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.

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

suspend

public void suspend(java.lang.String vm,
                    AsyncCallback<java.lang.Void> asyncCallback,
                    InvocationConfig invocationConfig)

Description copied from interface: Power

Suspends a powered-on virtual machine.

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 - if the system reports an error while responding to the request.
NotFound - if the virtual machine is not found.
AlreadyInDesiredState - if the virtual machine is already suspended.
NotAllowedInCurrentState - if the virtual machine is powered off.
ResourceBusy - if the virtual machine is performing another operation.
ServiceUnavailable - if the system is unable to communicate with a service to complete the request.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user doesn't have the required privileges.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.Interact.Suspend.

Specified by:

suspend in interface Power

Parameters:

vm - Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.

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

invocationConfig - Configuration for the method invocation.

reset

public void reset(java.lang.String vm)

Description copied from interface: Power

Resets a powered-on virtual machine.

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

Specified by:

reset in interface Power

Parameters:

vm - Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.

reset

public void reset(java.lang.String vm,
                  InvocationConfig invocationConfig)

Description copied from interface: Power

Resets a powered-on virtual machine.

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

Specified by:

reset in interface Power

Parameters:

vm - Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.

invocationConfig - Configuration for the method invocation.

reset

public void reset(java.lang.String vm,
                  AsyncCallback<java.lang.Void> asyncCallback)

Description copied from interface: Power

Resets a powered-on virtual machine.

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

Operation Errors:
Error - if the system reports an error while responding to the request.
NotFound - if the virtual machine is not found.
NotAllowedInCurrentState - if the virtual machine is powered off or suspended.
ResourceBusy - if the virtual machine is performing another operation
ServiceUnavailable - if the system is unable to communicate with a service to complete the request.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user doesn't have the required privileges.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.Interact.Reset.

Specified by:

reset in interface Power

Parameters:

vm - Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.

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

reset

public void reset(java.lang.String vm,
                  AsyncCallback<java.lang.Void> asyncCallback,
                  InvocationConfig invocationConfig)

Description copied from interface: Power

Resets a powered-on virtual machine.

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 - if the system reports an error while responding to the request.
NotFound - if the virtual machine is not found.
NotAllowedInCurrentState - if the virtual machine is powered off or suspended.
ResourceBusy - if the virtual machine is performing another operation
ServiceUnavailable - if the system is unable to communicate with a service to complete the request.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user doesn't have the required privileges.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.Interact.Reset.

Specified by:

reset in interface Power

Parameters:

vm - Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.

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

invocationConfig - Configuration for the method invocation.