com.vmware.vcenter

Interface VM

All Superinterfaces:

Service, VMTypes

All Known Implementing Classes:

VMStub

public interface VM
extends Service, VMTypes

The VM interface provides methods for managing the lifecycle of a virtual machine.

Nested Class Summary

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

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

Method Summary

Methods

Modifier and Type	Method and Description
String	create(VMTypes.CreateSpec spec) Creates a virtual machine.
void	create(VMTypes.CreateSpec spec, AsyncCallback<String> asyncCallback) Creates a virtual machine.
void	create(VMTypes.CreateSpec spec, AsyncCallback<String> asyncCallback, InvocationConfig invocationConfig) Creates a virtual machine.
String	create(VMTypes.CreateSpec spec, InvocationConfig invocationConfig) Creates a virtual machine.
void	delete(String vm) Deletes a virtual machine.
void	delete(String vm, AsyncCallback<Void> asyncCallback) Deletes a virtual machine.
void	delete(String vm, AsyncCallback<Void> asyncCallback, InvocationConfig invocationConfig) Deletes a virtual machine.
void	delete(String vm, InvocationConfig invocationConfig) Deletes a virtual machine.
VMTypes.Info	get(String vm) Returns information about a virtual machine.
void	get(String vm, AsyncCallback<VMTypes.Info> asyncCallback) Returns information about a virtual machine.
void	get(String vm, AsyncCallback<VMTypes.Info> asyncCallback, InvocationConfig invocationConfig) Returns information about a virtual machine.
VMTypes.Info	get(String vm, InvocationConfig invocationConfig) Returns information about a virtual machine.
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<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<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.
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.

Method Detail

create

String create(VMTypes.CreateSpec spec)

Creates a virtual machine.

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

Parameters:

spec - Virtual machine specification.

Returns:

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

Throws:

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.

create

String create(VMTypes.CreateSpec spec,
            InvocationConfig invocationConfig)

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.

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.

Throws:

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.

create

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

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.

Parameters:

spec - Virtual machine specification.

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

create

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

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.

Parameters:

spec - Virtual machine specification.

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

invocationConfig - Configuration for the method invocation.

get

VMTypes.Info get(String vm)

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

Information about 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 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

VMTypes.Info get(String vm,
               InvocationConfig invocationConfig)

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.

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.

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

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.

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

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.

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

void delete(String vm)

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

Throws:

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

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.

delete

void delete(String vm,
          InvocationConfig invocationConfig)

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.

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.

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.

delete

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

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

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

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

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

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

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.

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

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.

Throws:

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.

list

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.

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:

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.

Throws:

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.

list

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

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.

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

void list(VMTypes.FilterSpec filter,
        AsyncCallback<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.

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.

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.