com.vmware.vcenter.vm.guest

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 guest operating system power state of a virtual machine. This interface was added in vSphere API 6.7.

Nested Class Summary

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

PowerTypes.Info, PowerTypes.State

Field Summary

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

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
PowerTypes.Info	get(java.lang.String vm) Returns information about the guest operating system power state.
void	get(java.lang.String vm, AsyncCallback<PowerTypes.Info> asyncCallback) Returns information about the guest operating system power state.
void	get(java.lang.String vm, AsyncCallback<PowerTypes.Info> asyncCallback, InvocationConfig invocationConfig) Returns information about the guest operating system power state.
PowerTypes.Info	get(java.lang.String vm, InvocationConfig invocationConfig) Returns information about the guest operating system power state.
void	reboot(java.lang.String vm) Issues a request to the guest operating system asking it to perform a reboot.
void	reboot(java.lang.String vm, AsyncCallback<java.lang.Void> asyncCallback) Issues a request to the guest operating system asking it to perform a reboot.
void	reboot(java.lang.String vm, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Issues a request to the guest operating system asking it to perform a reboot.
void	reboot(java.lang.String vm, InvocationConfig invocationConfig) Issues a request to the guest operating system asking it to perform a reboot.
void	shutdown(java.lang.String vm) Issues a request to the guest operating system asking it to perform a clean shutdown of all services.
void	shutdown(java.lang.String vm, AsyncCallback<java.lang.Void> asyncCallback) Issues a request to the guest operating system asking it to perform a clean shutdown of all services.
void	shutdown(java.lang.String vm, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Issues a request to the guest operating system asking it to perform a clean shutdown of all services.
void	shutdown(java.lang.String vm, InvocationConfig invocationConfig) Issues a request to the guest operating system asking it to perform a clean shutdown of all services.
void	standby(java.lang.String vm) Issues a request to the guest operating system asking it to perform a suspend operation.
void	standby(java.lang.String vm, AsyncCallback<java.lang.Void> asyncCallback) Issues a request to the guest operating system asking it to perform a suspend operation.
void	standby(java.lang.String vm, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Issues a request to the guest operating system asking it to perform a suspend operation.
void	standby(java.lang.String vm, InvocationConfig invocationConfig) Issues a request to the guest operating system asking it to perform a suspend operation.

Method Detail

get

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

Returns information about the guest operating system power state. 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:

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

Returns:

Guest OS powerstate information.

Throws:

Error - if the system reports an error while responding to the request.

NotFound - if the virtual machine is not found.

get

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

Returns information about the guest operating system power state. 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:

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

invocationConfig - Configuration for the method invocation.

Returns:

Guest OS powerstate information.

Throws:

Error - if the system reports an error while responding to the request.

NotFound - if the virtual machine is not found.

get

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

Returns information about the guest operating system power state. 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:
Guest OS powerstate information.

Operation Errors:
Error - if the system reports an error while responding to the request.
NotFound - if the virtual machine is not found.

Parameters:

vm - Identifier of the virtual machine. 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(java.lang.String vm,
         AsyncCallback<PowerTypes.Info> asyncCallback,
         InvocationConfig invocationConfig)

Returns information about the guest operating system power state. 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:
Guest OS powerstate information.

Operation Errors:
Error - if the system reports an error while responding to the request.
NotFound - if the virtual machine is not found.

Parameters:

vm - Identifier of the virtual machine. 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.

shutdown

void shutdown(java.lang.String vm)

Issues a request to the guest operating system asking it to perform a clean shutdown of all services. This request returns immediately and does not wait for the guest operating system to complete the operation. 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:

vm - Identifier of the virtual machine. 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 not powered on.

ServiceUnavailable - if VMware Tools is not running.

NotAllowedInCurrentState - if the virtual machine is suspended.

ResourceBusy - if the virtual machine is performing another operation.

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

shutdown

void shutdown(java.lang.String vm,
              InvocationConfig invocationConfig)

Issues a request to the guest operating system asking it to perform a clean shutdown of all services. This request returns immediately and does not wait for the guest operating system to complete the operation. 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:

vm - Identifier of the virtual machine. 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 not powered on.

ServiceUnavailable - if VMware Tools is not running.

NotAllowedInCurrentState - if the virtual machine is suspended.

ResourceBusy - if the virtual machine is performing another operation.

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

shutdown

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

Issues a request to the guest operating system asking it to perform a clean shutdown of all services. This request returns immediately and does not wait for the guest operating system to complete the operation. 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 - 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 not powered on.
ServiceUnavailable - if VMware Tools is not running.
NotAllowedInCurrentState - if the virtual machine is suspended.
ResourceBusy - if the virtual machine is performing another operation.
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).

Parameters:

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

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

shutdown

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

Issues a request to the guest operating system asking it to perform a clean shutdown of all services. This request returns immediately and does not wait for the guest operating system to complete the operation. 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 - 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 not powered on.
ServiceUnavailable - if VMware Tools is not running.
NotAllowedInCurrentState - if the virtual machine is suspended.
ResourceBusy - if the virtual machine is performing another operation.
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).

Parameters:

vm - Identifier of the virtual machine. 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.

reboot

void reboot(java.lang.String vm)

Issues a request to the guest operating system asking it to perform a reboot. This request returns immediately and does not wait for the guest operating system to complete the operation. 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:

vm - Identifier of the virtual machine. 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 not powered on.

ServiceUnavailable - if VMware Tools is not running.

ResourceBusy - if the virtual machine is performing another operation.

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

reboot

void reboot(java.lang.String vm,
            InvocationConfig invocationConfig)

Issues a request to the guest operating system asking it to perform a reboot. This request returns immediately and does not wait for the guest operating system to complete the operation. 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:

vm - Identifier of the virtual machine. 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 not powered on.

ServiceUnavailable - if VMware Tools is not running.

ResourceBusy - if the virtual machine is performing another operation.

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

reboot

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

Issues a request to the guest operating system asking it to perform a reboot. This request returns immediately and does not wait for the guest operating system to complete the operation. 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 - 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 not powered on.
ServiceUnavailable - if VMware Tools is not running.
ResourceBusy - if the virtual machine is performing another operation.
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).

Parameters:

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

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

reboot

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

Issues a request to the guest operating system asking it to perform a reboot. This request returns immediately and does not wait for the guest operating system to complete the operation. 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 - 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 not powered on.
ServiceUnavailable - if VMware Tools is not running.
ResourceBusy - if the virtual machine is performing another operation.
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).

Parameters:

vm - Identifier of the virtual machine. 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.

standby

void standby(java.lang.String vm)

Issues a request to the guest operating system asking it to perform a suspend operation. 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:

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

Throws:

Error - if the system reports an error while responding to the request.

AlreadyInDesiredState - if the virtual machine is suspended.

NotFound - if the virtual machine is not found.

ServiceUnavailable - if VMware Tools is not running.

NotAllowedInCurrentState - if the virtual machine is not powered on.

ResourceBusy - if the virtual machine is performing another operation.

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

standby

void standby(java.lang.String vm,
             InvocationConfig invocationConfig)

Issues a request to the guest operating system asking it to perform a suspend operation. 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:

vm - Identifier of the virtual machine. 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.

AlreadyInDesiredState - if the virtual machine is suspended.

NotFound - if the virtual machine is not found.

ServiceUnavailable - if VMware Tools is not running.

NotAllowedInCurrentState - if the virtual machine is not powered on.

ResourceBusy - if the virtual machine is performing another operation.

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

standby

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

Issues a request to the guest operating system asking it to perform a suspend operation. 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 - if the system reports an error while responding to the request.
AlreadyInDesiredState - if the virtual machine is suspended.
NotFound - if the virtual machine is not found.
ServiceUnavailable - if VMware Tools is not running.
NotAllowedInCurrentState - if the virtual machine is not powered on.
ResourceBusy - if the virtual machine is performing another operation.
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).

Parameters:

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

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

standby

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

Issues a request to the guest operating system asking it to perform a suspend operation. 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 - if the system reports an error while responding to the request.
AlreadyInDesiredState - if the virtual machine is suspended.
NotFound - if the virtual machine is not found.
ServiceUnavailable - if VMware Tools is not running.
NotAllowedInCurrentState - if the virtual machine is not powered on.
ResourceBusy - if the virtual machine is performing another operation.
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).

Parameters:

vm - Identifier of the virtual machine. 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.