com.vmware.vcenter.vm

Interface Power

All Superinterfaces:

PowerTypes, Service

All Known Implementing Classes:

PowerStub

public interface Power
extends Service, PowerTypes

The Power interface provides methods for managing the power state of a virtual machine.

Nested Class Summary

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

PowerTypes.Info, PowerTypes.State

Method Summary

Methods

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

Method Detail

get

PowerTypes.Info get(String vm)

Returns the power state information of a virtual machine.

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

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.

Throws:

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.

get

PowerTypes.Info get(String vm,
                  InvocationConfig invocationConfig)

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.

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.

Throws:

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.

get

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

Returns the power state information of a virtual machine.

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

Operation 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.

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

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

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.

Operation 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.

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

void start(String vm)

Powers on a powered-off or suspended virtual machine.

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

Parameters:

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

Throws:

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.

start

void start(String vm,
         InvocationConfig invocationConfig)

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.

Parameters:

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

invocationConfig - Configuration for the method invocation.

Throws:

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.

start

void start(String vm,
         AsyncCallback<Void> asyncCallback)

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.

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

void start(String vm,
         AsyncCallback<Void> asyncCallback,
         InvocationConfig invocationConfig)

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.

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

void stop(String vm)

Powers off a powered-on or suspended virtual machine.

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

Parameters:

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

Throws:

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.

stop

void stop(String vm,
        InvocationConfig invocationConfig)

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.

Parameters:

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

invocationConfig - Configuration for the method invocation.

Throws:

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.

stop

void stop(String vm,
        AsyncCallback<Void> asyncCallback)

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.

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

void stop(String vm,
        AsyncCallback<Void> asyncCallback,
        InvocationConfig invocationConfig)

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.

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

void suspend(String vm)

Suspends a powered-on virtual machine.

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

Parameters:

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

Throws:

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.

suspend

void suspend(String vm,
           InvocationConfig invocationConfig)

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.

Parameters:

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

invocationConfig - Configuration for the method invocation.

Throws:

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.

suspend

void suspend(String vm,
           AsyncCallback<Void> asyncCallback)

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.

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

void suspend(String vm,
           AsyncCallback<Void> asyncCallback,
           InvocationConfig invocationConfig)

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.

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

void reset(String vm)

Resets a powered-on virtual machine.

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

Parameters:

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

Throws:

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.

reset

void reset(String vm,
         InvocationConfig invocationConfig)

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.

Parameters:

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

invocationConfig - Configuration for the method invocation.

Throws:

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.

reset

void reset(String vm,
         AsyncCallback<Void> asyncCallback)

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.

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

void reset(String vm,
         AsyncCallback<Void> asyncCallback,
         InvocationConfig invocationConfig)

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.

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.