com.vmware.vcenter

Class VMStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.vcenter.VMStub

All Implemented Interfaces:

Service, VM, VMTypes

public class VMStub
extends com.vmware.vapi.internal.bindings.Stub
implements VM

Remote stub implementation of the VM API service.

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

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.vcenter.VMTypes

VMTypes.CreateSpec, VMTypes.FilterSpec, VMTypes.Info, VMTypes.PlacementSpec, VMTypes.StoragePolicySpec, VMTypes.Summary

Field Summary

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

apiProvider, converter, ifaceId, securityContext

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	create(VMTypes.CreateSpec spec) Creates a virtual machine.
void	create(VMTypes.CreateSpec spec, AsyncCallback<java.lang.String> asyncCallback) Creates a virtual machine.
void	create(VMTypes.CreateSpec spec, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig) Creates a virtual machine.
java.lang.String	create(VMTypes.CreateSpec spec, InvocationConfig invocationConfig) Creates a virtual machine.
void	delete(java.lang.String vm) Deletes a virtual machine.
void	delete(java.lang.String vm, AsyncCallback<java.lang.Void> asyncCallback) Deletes a virtual machine.
void	delete(java.lang.String vm, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Deletes a virtual machine.
void	delete(java.lang.String vm, InvocationConfig invocationConfig) Deletes a virtual machine.
VMTypes.Info	get(java.lang.String vm) Returns information about a virtual machine.
void	get(java.lang.String vm, AsyncCallback<VMTypes.Info> asyncCallback) Returns information about a virtual machine.
void	get(java.lang.String vm, AsyncCallback<VMTypes.Info> asyncCallback, InvocationConfig invocationConfig) Returns information about a virtual machine.
VMTypes.Info	get(java.lang.String vm, InvocationConfig invocationConfig) Returns information about a virtual machine.
java.util.List<VMTypes.Summary>	list(VMTypes.FilterSpec filter) Returns information about at most 1000 visible (subject to permission checks) virtual machines in vCenter matching the VMTypes.FilterSpec.
void	list(VMTypes.FilterSpec filter, AsyncCallback<java.util.List<VMTypes.Summary>> asyncCallback) Returns information about at most 1000 visible (subject to permission checks) virtual machines in vCenter matching the VMTypes.FilterSpec.
void	list(VMTypes.FilterSpec filter, AsyncCallback<java.util.List<VMTypes.Summary>> asyncCallback, InvocationConfig invocationConfig) Returns information about at most 1000 visible (subject to permission checks) virtual machines in vCenter matching the VMTypes.FilterSpec.
java.util.List<VMTypes.Summary>	list(VMTypes.FilterSpec filter, InvocationConfig invocationConfig) Returns information about at most 1000 visible (subject to permission checks) virtual machines in vCenter matching the VMTypes.FilterSpec.

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

VMStub

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

VMStub

public VMStub(ApiProvider apiProvider,
      StubConfigurationBase config)

Method Detail

create

public java.lang.String create(VMTypes.CreateSpec spec)

Description copied from interface: VM

Creates a virtual machine.

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

Specified by:

create in interface VM

Parameters:

spec - Virtual machine specification.

Returns:

ID of newly-created virtual machine. The return value will be an identifier for the resource type: VirtualMachine.

create

public java.lang.String create(VMTypes.CreateSpec spec,
                      InvocationConfig invocationConfig)

Description copied from interface: VM

Creates 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:

create in interface VM

Parameters:

spec - Virtual machine specification.

invocationConfig - Configuration for the method invocation.

Returns:

ID of newly-created virtual machine. The return value will be an identifier for the resource type: VirtualMachine.

create

public void create(VMTypes.CreateSpec spec,
          AsyncCallback<java.lang.String> asyncCallback)

Description copied from interface: VM

Creates a virtual machine.

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

Operation Result:
ID of newly-created virtual machine. The return value will be an identifier for the resource type: VirtualMachine.

Operation Errors:
AlreadyExists - if a virtual machine with the specified name already exists.
Error - if the system reports an error while responding to the request.
InvalidArgument - if any of the specified parameters are invalid.
NotFound - if any of the resources specified in spec could not be found
ResourceInaccessible - if a specified resource (eg. host) is not accessible.
ResourceInUse - if any of the specified storage addresses (eg. IDE, SATA, SCSI) result in a storage address conflict.
ServiceUnavailable - if the system is unable to communicate with a service to complete the request.
UnableToAllocateResource - if any of the resources needed to create the virtual machine could not be allocated.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user doesn't have the required privileges.
Unsupported - if getGuestOS() is not supported for the requested virtual hardware version and spec includes null properties that default to guest-specific values.

Specified by:

create in interface VM

Parameters:

spec - Virtual machine specification.

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

create

public void create(VMTypes.CreateSpec spec,
          AsyncCallback<java.lang.String> asyncCallback,
          InvocationConfig invocationConfig)

Description copied from interface: VM

Creates 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:
ID of newly-created virtual machine. The return value will be an identifier for the resource type: VirtualMachine.

Operation Errors:
AlreadyExists - if a virtual machine with the specified name already exists.
Error - if the system reports an error while responding to the request.
InvalidArgument - if any of the specified parameters are invalid.
NotFound - if any of the resources specified in spec could not be found
ResourceInaccessible - if a specified resource (eg. host) is not accessible.
ResourceInUse - if any of the specified storage addresses (eg. IDE, SATA, SCSI) result in a storage address conflict.
ServiceUnavailable - if the system is unable to communicate with a service to complete the request.
UnableToAllocateResource - if any of the resources needed to create the virtual machine could not be allocated.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user doesn't have the required privileges.
Unsupported - if getGuestOS() is not supported for the requested virtual hardware version and spec includes null properties that default to guest-specific values.

Specified by:

create in interface VM

Parameters:

spec - Virtual machine specification.

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

invocationConfig - Configuration for the method invocation.

get

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

Description copied from interface: VM

Returns information about a virtual machine.

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

Specified by:

get in interface VM

Parameters:

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

Returns:

Information about the specified virtual machine.

get

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

Description copied from interface: VM

Returns information about 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 VM

Parameters:

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

invocationConfig - Configuration for the method invocation.

Returns:

Information about the specified virtual machine.

get

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

Description copied from interface: VM

Returns information about a virtual machine.

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

Operation Result:
Information about 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 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.

Specified by:

get in interface VM

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

Description copied from interface: VM

Returns information about 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:
Information about 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 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.

Specified by:

get in interface VM

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.

delete

public void delete(java.lang.String vm)

Description copied from interface: VM

Deletes a virtual machine.

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

Specified by:

delete in interface VM

Parameters:

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

delete

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

Description copied from interface: VM

Deletes 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:

delete in interface VM

Parameters:

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

invocationConfig - Configuration for the method invocation.

delete

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

Description copied from interface: VM

Deletes a 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.
NotAllowedInCurrentState - if the virtual machine is running (powered on).
NotFound - if the virtual machine is not found.
ResourceBusy - if the virtual machine is busy performing another operation.
ResourceInaccessible - if the virtual machine's configuration 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.

Specified by:

delete in interface VM

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.

delete

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

Description copied from interface: VM

Deletes 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 Errors:
Error - if the system reports an error while responding to the request.
NotAllowedInCurrentState - if the virtual machine is running (powered on).
NotFound - if the virtual machine is not found.
ResourceBusy - if the virtual machine is busy performing another operation.
ResourceInaccessible - if the virtual machine's configuration 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.

Specified by:

delete in interface VM

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.

list

public java.util.List<VMTypes.Summary> list(VMTypes.FilterSpec filter)

Description copied from interface: VM

Returns information about at most 1000 visible (subject to permission checks) virtual machines in vCenter matching the VMTypes.FilterSpec.

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

Specified by:

list in interface VM

Parameters:

filter - Specification of matching virtual machines for which information should be returned. If null, the behavior is equivalent to a VMTypes.FilterSpec with all properties null which means all virtual machines match the filter.

Returns:

Commonly used information about the virtual machines matching the VMTypes.FilterSpec.

list

public java.util.List<VMTypes.Summary> list(VMTypes.FilterSpec filter,
                                   InvocationConfig invocationConfig)

Description copied from interface: VM

Returns information about at most 1000 visible (subject to permission checks) virtual machines in vCenter matching the VMTypes.FilterSpec.

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:

list in interface VM

Parameters:

filter - Specification of matching virtual machines for which information should be returned. If null, the behavior is equivalent to a VMTypes.FilterSpec with all properties null which means all virtual machines match the filter.

invocationConfig - Configuration for the method invocation.

Returns:

Commonly used information about the virtual machines matching the VMTypes.FilterSpec.

list

public void list(VMTypes.FilterSpec filter,
        AsyncCallback<java.util.List<VMTypes.Summary>> asyncCallback)

Description copied from interface: VM

Returns information about at most 1000 visible (subject to permission checks) virtual machines in vCenter matching the VMTypes.FilterSpec.

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

Operation Result:
Commonly used information about the virtual machines matching the VMTypes.FilterSpec.

Operation Errors:
InvalidArgument - if the VMTypes.FilterSpec.getPowerStates() property contains a value that is not supported by the server.
UnableToAllocateResource - if more than 1000 virtual machines match the VMTypes.FilterSpec.
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.

Specified by:

list in interface VM

Parameters:

filter - Specification of matching virtual machines for which information should be returned. If null, the behavior is equivalent to a VMTypes.FilterSpec with all properties null which means all virtual machines match the filter.

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

list

public void list(VMTypes.FilterSpec filter,
        AsyncCallback<java.util.List<VMTypes.Summary>> asyncCallback,
        InvocationConfig invocationConfig)

Description copied from interface: VM

Returns information about at most 1000 visible (subject to permission checks) virtual machines in vCenter matching the VMTypes.FilterSpec.

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:
Commonly used information about the virtual machines matching the VMTypes.FilterSpec.

Operation Errors:
InvalidArgument - if the VMTypes.FilterSpec.getPowerStates() property contains a value that is not supported by the server.
UnableToAllocateResource - if more than 1000 virtual machines match the VMTypes.FilterSpec.
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.

Specified by:

list in interface VM

Parameters:

filter - Specification of matching virtual machines for which information should be returned. If null, the behavior is equivalent to a VMTypes.FilterSpec with all properties null which means all virtual machines match the filter.

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

invocationConfig - Configuration for the method invocation.