com.vmware.vcenter.vm.guest

Class PowerStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.vcenter.vm.guest.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.guest.PowerTypes

PowerTypes.Info, PowerTypes.State

Field Summary

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

apiProvider, converter, ifaceId, securityContext

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

Methods

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.

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

invokeMethod, invokeMethodAsync, 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 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.

Specified by:

get in interface Power

Parameters:

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

Returns:

Guest OS powerstate information.

get

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

Description copied from interface: Power

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.

Specified by:

get in interface Power

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.

get

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

Description copied from interface: Power

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.

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

Specified by:

get in interface Power

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

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

Description copied from interface: Power

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.

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

Specified by:

get in interface Power

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

public void shutdown(java.lang.String vm)

Description copied from interface: Power

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.

Specified by:

shutdown in interface Power

Parameters:

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

shutdown

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

Description copied from interface: Power

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.

Specified by:

shutdown in interface Power

Parameters:

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

invocationConfig - Configuration for the method invocation.

shutdown

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

Description copied from interface: Power

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

Specified by:

shutdown in interface Power

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

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

Description copied from interface: Power

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

Specified by:

shutdown in interface Power

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

public void reboot(java.lang.String vm)

Description copied from interface: Power

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.

Specified by:

reboot in interface Power

Parameters:

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

reboot

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

Description copied from interface: Power

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.

Specified by:

reboot in interface Power

Parameters:

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

invocationConfig - Configuration for the method invocation.

reboot

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

Description copied from interface: Power

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

Specified by:

reboot in interface Power

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

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

Description copied from interface: Power

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

Specified by:

reboot in interface Power

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

public void standby(java.lang.String vm)

Description copied from interface: Power

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.

Specified by:

standby in interface Power

Parameters:

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

standby

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

Description copied from interface: Power

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.

Specified by:

standby in interface Power

Parameters:

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

invocationConfig - Configuration for the method invocation.

standby

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

Description copied from interface: Power

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

Specified by:

standby in interface Power

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

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

Description copied from interface: Power

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

Specified by:

standby in interface Power

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.