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._VAPI_OPERATIONS, VMTypes.ClonePlacementSpec, VMTypes.CloneSpec, VMTypes.ComputePlacementSpec, VMTypes.CreateSpec, VMTypes.DiskCloneSpec, VMTypes.DiskRelocateSpec, VMTypes.FilterSpec, VMTypes.GuestCustomizationSpec, VMTypes.Info, VMTypes.InstantClonePlacementSpec, VMTypes.InstantCloneSpec, VMTypes.InventoryPlacementSpec, VMTypes.PlacementSpec, VMTypes.RegisterPlacementSpec, VMTypes.RegisterSpec, VMTypes.RelocatePlacementSpec, VMTypes.RelocateSpec, VMTypes.StoragePlacementSpec, VMTypes.StoragePolicySpec, VMTypes.Summary

Field Summary

Fields inherited from interface com.vmware.vcenter.VMTypes

_VAPI_SERVICE_ID, RESOURCE_TYPE

Method Summary

Modifier and Type	Method and Description
java.lang.String	clone_Task(VMTypes.CloneSpec spec) Creates a virtual machine from an existing virtual machine.
void	clone_Task(VMTypes.CloneSpec spec, AsyncCallback<java.lang.String> asyncCallback) Creates a virtual machine from an existing virtual machine.
void	clone_Task(VMTypes.CloneSpec spec, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig) Creates a virtual machine from an existing virtual machine.
java.lang.String	clone_Task(VMTypes.CloneSpec spec, InvocationConfig invocationConfig) Creates a virtual machine from an existing virtual machine.
java.lang.String	clone(VMTypes.CloneSpec spec) Creates a virtual machine from an existing virtual machine.
void	clone(VMTypes.CloneSpec spec, AsyncCallback<java.lang.String> asyncCallback) Creates a virtual machine from an existing virtual machine.
void	clone(VMTypes.CloneSpec spec, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig) Creates a virtual machine from an existing virtual machine.
java.lang.String	clone(VMTypes.CloneSpec spec, InvocationConfig invocationConfig) Creates a virtual machine from an existing virtual machine.
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.lang.String	instantClone(VMTypes.InstantCloneSpec spec) Create an instant clone of an existing virtual machine.
void	instantClone(VMTypes.InstantCloneSpec spec, AsyncCallback<java.lang.String> asyncCallback) Create an instant clone of an existing virtual machine.
void	instantClone(VMTypes.InstantCloneSpec spec, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig) Create an instant clone of an existing virtual machine.
java.lang.String	instantClone(VMTypes.InstantCloneSpec spec, InvocationConfig invocationConfig) Create an instant clone of an existing virtual machine.
java.util.List<VMTypes.Summary>	list(VMTypes.FilterSpec filter) Returns information about at most 4000 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 4000 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 4000 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 4000 visible (subject to permission checks) virtual machines in vCenter matching the VMTypes.FilterSpec.
java.lang.String	register(VMTypes.RegisterSpec spec) Creates a virtual machine from existing virtual machine files on storage.
void	register(VMTypes.RegisterSpec spec, AsyncCallback<java.lang.String> asyncCallback) Creates a virtual machine from existing virtual machine files on storage.
void	register(VMTypes.RegisterSpec spec, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig) Creates a virtual machine from existing virtual machine files on storage.
java.lang.String	register(VMTypes.RegisterSpec spec, InvocationConfig invocationConfig) Creates a virtual machine from existing virtual machine files on storage.
java.lang.String	relocate_Task(java.lang.String vm, VMTypes.RelocateSpec spec) Relocates a virtual machine based on the specification.
void	relocate_Task(java.lang.String vm, VMTypes.RelocateSpec spec, AsyncCallback<java.lang.String> asyncCallback) Relocates a virtual machine based on the specification.
void	relocate_Task(java.lang.String vm, VMTypes.RelocateSpec spec, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig) Relocates a virtual machine based on the specification.
java.lang.String	relocate_Task(java.lang.String vm, VMTypes.RelocateSpec spec, InvocationConfig invocationConfig) Relocates a virtual machine based on the specification.
void	relocate(java.lang.String vm, VMTypes.RelocateSpec spec) Relocates a virtual machine based on the specification.
void	relocate(java.lang.String vm, VMTypes.RelocateSpec spec, AsyncCallback<java.lang.Void> asyncCallback) Relocates a virtual machine based on the specification.
void	relocate(java.lang.String vm, VMTypes.RelocateSpec spec, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Relocates a virtual machine based on the specification.
void	relocate(java.lang.String vm, VMTypes.RelocateSpec spec, InvocationConfig invocationConfig) Relocates a virtual machine based on the specification.
void	unregister(java.lang.String vm) Removes the virtual machine corresponding to vm from the vCenter inventory without removing any of the virtual machine's files from storage.
void	unregister(java.lang.String vm, AsyncCallback<java.lang.Void> asyncCallback) Removes the virtual machine corresponding to vm from the vCenter inventory without removing any of the virtual machine's files from storage.
void	unregister(java.lang.String vm, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Removes the virtual machine corresponding to vm from the vCenter inventory without removing any of the virtual machine's files from storage.
void	unregister(java.lang.String vm, InvocationConfig invocationConfig) Removes the virtual machine corresponding to vm from the vCenter inventory without removing any of the virtual machine's files from storage.

Method Detail

create

java.lang.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, NVMe) 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.

Unauthorized - if you do not have all of the privileges described as follows:

• The resource Folder referenced by the property VMTypes.InventoryPlacementSpec.getFolder() requires VirtualMachine.Inventory.Create.
• The resource ResourcePool referenced by the property VMTypes.ComputePlacementSpec.getResourcePool() requires Resource.AssignVMToPool.
• The resource Datastore referenced by the property VMTypes.StoragePlacementSpec.getDatastore() requires Datastore.AllocateSpace.
• The resource Network referenced by the property EthernetTypes.BackingSpec.getNetwork() requires Network.Assign.

create

java.lang.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, NVMe) 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.

Unauthorized - if you do not have all of the privileges described as follows:

• The resource Folder referenced by the property VMTypes.InventoryPlacementSpec.getFolder() requires VirtualMachine.Inventory.Create.
• The resource ResourcePool referenced by the property VMTypes.ComputePlacementSpec.getResourcePool() requires Resource.AssignVMToPool.
• The resource Datastore referenced by the property VMTypes.StoragePlacementSpec.getDatastore() requires Datastore.AllocateSpace.
• The resource Network referenced by the property EthernetTypes.BackingSpec.getNetwork() requires Network.Assign.

create

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

Creates a virtual machine.

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

Invocation 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, NVMe) 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.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource Folder referenced by the property VMTypes.InventoryPlacementSpec.getFolder() requires VirtualMachine.Inventory.Create.
• The resource ResourcePool referenced by the property VMTypes.ComputePlacementSpec.getResourcePool() requires Resource.AssignVMToPool.
• The resource Datastore referenced by the property VMTypes.StoragePlacementSpec.getDatastore() requires Datastore.AllocateSpace.
• The resource Network referenced by the property EthernetTypes.BackingSpec.getNetwork() requires Network.Assign.

Parameters:

spec - Virtual machine specification.

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

create

void create(VMTypes.CreateSpec spec,
            AsyncCallback<java.lang.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.

Invocation 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, NVMe) 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.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource Folder referenced by the property VMTypes.InventoryPlacementSpec.getFolder() requires VirtualMachine.Inventory.Create.
• The resource ResourcePool referenced by the property VMTypes.ComputePlacementSpec.getResourcePool() requires Resource.AssignVMToPool.
• The resource Datastore referenced by the property VMTypes.StoragePlacementSpec.getDatastore() requires Datastore.AllocateSpace.
• The resource Network referenced by the property EthernetTypes.BackingSpec.getNetwork() requires Network.Assign.

Parameters:

spec - Virtual machine specification.

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

invocationConfig - Configuration for the method invocation.

clone

java.lang.String clone(VMTypes.CloneSpec spec)

Creates a virtual machine from an existing virtual machine.

. This method was added in vSphere API 7.0.0.

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

Parameters:

spec - Virtual machine clone 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.

ServiceUnavailable - if the system is unable to communicate with a service to complete the request.

UnableToAllocateResource - if any of the resources needed to clone 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.

Unauthorized - if you do not have all of the privileges described as follows:

• The resource Datastore referenced by the property VMTypes.DiskCloneSpec.getDatastore() requires Datastore.AllocateSpace.
• The resource Datastore referenced by the property VMTypes.ClonePlacementSpec.getDatastore() requires Datastore.AllocateSpace.
• The resource Folder referenced by the property VMTypes.ClonePlacementSpec.getFolder() requires VirtualMachine.Inventory.CreateFromExisting.
• The resource ResourcePool referenced by the property VMTypes.ClonePlacementSpec.getResourcePool() requires Resource.AssignVMToPool.
• The resource VirtualMachine referenced by the property VMTypes.CloneSpec.getSource() requires VirtualMachine.Provisioning.Clone.

clone

java.lang.String clone(VMTypes.CloneSpec spec,
                       InvocationConfig invocationConfig)

Creates a virtual machine from an existing virtual machine.

. This method was added in vSphere API 7.0.0.

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

ServiceUnavailable - if the system is unable to communicate with a service to complete the request.

UnableToAllocateResource - if any of the resources needed to clone 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.

Unauthorized - if you do not have all of the privileges described as follows:

• The resource Datastore referenced by the property VMTypes.DiskCloneSpec.getDatastore() requires Datastore.AllocateSpace.
• The resource Datastore referenced by the property VMTypes.ClonePlacementSpec.getDatastore() requires Datastore.AllocateSpace.
• The resource Folder referenced by the property VMTypes.ClonePlacementSpec.getFolder() requires VirtualMachine.Inventory.CreateFromExisting.
• The resource ResourcePool referenced by the property VMTypes.ClonePlacementSpec.getResourcePool() requires Resource.AssignVMToPool.
• The resource VirtualMachine referenced by the property VMTypes.CloneSpec.getSource() requires VirtualMachine.Provisioning.Clone.

clone_Task

java.lang.String clone_Task(VMTypes.CloneSpec spec)

Creates a virtual machine from an existing virtual machine.

. This method was added in vSphere API 7.0.0.

Synchronous method overload. Result of the invocation is a task identifier which will be returned by this method.

Parameters:

spec - Virtual machine clone specification.

Returns:

identifier for the task created by this API invocation

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.

ServiceUnavailable - if the system is unable to communicate with a service to complete the request.

UnableToAllocateResource - if any of the resources needed to clone 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.

Unauthorized - if you do not have all of the privileges described as follows:

• The resource Datastore referenced by the property VMTypes.DiskCloneSpec.getDatastore() requires Datastore.AllocateSpace.
• The resource Datastore referenced by the property VMTypes.ClonePlacementSpec.getDatastore() requires Datastore.AllocateSpace.
• The resource Folder referenced by the property VMTypes.ClonePlacementSpec.getFolder() requires VirtualMachine.Inventory.CreateFromExisting.
• The resource ResourcePool referenced by the property VMTypes.ClonePlacementSpec.getResourcePool() requires Resource.AssignVMToPool.
• The resource VirtualMachine referenced by the property VMTypes.CloneSpec.getSource() requires VirtualMachine.Provisioning.Clone.

clone_Task

java.lang.String clone_Task(VMTypes.CloneSpec spec,
                            InvocationConfig invocationConfig)

Creates a virtual machine from an existing virtual machine.

. This method was added in vSphere API 7.0.0.

Synchronous method overload. Result of the invocation is a task identifier which will be returned by this method. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

spec - Virtual machine clone specification.

invocationConfig - Configuration for the method invocation.

Returns:

identifier for the task created by this API invocation

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.

ServiceUnavailable - if the system is unable to communicate with a service to complete the request.

UnableToAllocateResource - if any of the resources needed to clone 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.

Unauthorized - if you do not have all of the privileges described as follows:

• The resource Datastore referenced by the property VMTypes.DiskCloneSpec.getDatastore() requires Datastore.AllocateSpace.
• The resource Datastore referenced by the property VMTypes.ClonePlacementSpec.getDatastore() requires Datastore.AllocateSpace.
• The resource Folder referenced by the property VMTypes.ClonePlacementSpec.getFolder() requires VirtualMachine.Inventory.CreateFromExisting.
• The resource ResourcePool referenced by the property VMTypes.ClonePlacementSpec.getResourcePool() requires Resource.AssignVMToPool.
• The resource VirtualMachine referenced by the property VMTypes.CloneSpec.getSource() requires VirtualMachine.Provisioning.Clone.

clone_Task

void clone_Task(VMTypes.CloneSpec spec,
                AsyncCallback<java.lang.String> asyncCallback)

Creates a virtual machine from an existing virtual machine.

. This method was added in vSphere API 7.0.0.

Asynchronous method overload. Result of the invocation which is a task identifier will be reported via the specified asyncCallback.

Invocation Result:
identifier for the task created by this API invocation

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.
ServiceUnavailable - if the system is unable to communicate with a service to complete the request.
UnableToAllocateResource - if any of the resources needed to clone 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.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource Datastore referenced by the property VMTypes.DiskCloneSpec.getDatastore() requires Datastore.AllocateSpace.
• The resource Datastore referenced by the property VMTypes.ClonePlacementSpec.getDatastore() requires Datastore.AllocateSpace.
• The resource Folder referenced by the property VMTypes.ClonePlacementSpec.getFolder() requires VirtualMachine.Inventory.CreateFromExisting.
• The resource ResourcePool referenced by the property VMTypes.ClonePlacementSpec.getResourcePool() requires Resource.AssignVMToPool.
• The resource VirtualMachine referenced by the property VMTypes.CloneSpec.getSource() requires VirtualMachine.Provisioning.Clone.

Parameters:

spec - Virtual machine clone specification.

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

clone_Task

void clone_Task(VMTypes.CloneSpec spec,
                AsyncCallback<java.lang.String> asyncCallback,
                InvocationConfig invocationConfig)

Creates a virtual machine from an existing virtual machine.

. This method was added in vSphere API 7.0.0.

Asynchronous method overload. Result of the invocation which is a task identifier will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Invocation Result:
identifier for the task created by this API invocation

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.
ServiceUnavailable - if the system is unable to communicate with a service to complete the request.
UnableToAllocateResource - if any of the resources needed to clone 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.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource Datastore referenced by the property VMTypes.DiskCloneSpec.getDatastore() requires Datastore.AllocateSpace.
• The resource Datastore referenced by the property VMTypes.ClonePlacementSpec.getDatastore() requires Datastore.AllocateSpace.
• The resource Folder referenced by the property VMTypes.ClonePlacementSpec.getFolder() requires VirtualMachine.Inventory.CreateFromExisting.
• The resource ResourcePool referenced by the property VMTypes.ClonePlacementSpec.getResourcePool() requires Resource.AssignVMToPool.
• The resource VirtualMachine referenced by the property VMTypes.CloneSpec.getSource() requires VirtualMachine.Provisioning.Clone.

Parameters:

spec - Virtual machine clone specification.

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

invocationConfig - Configuration for the method invocation.

clone

void clone(VMTypes.CloneSpec spec,
           AsyncCallback<java.lang.String> asyncCallback)

Creates a virtual machine from an existing virtual machine.

. This method was added in vSphere API 7.0.0.

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

Invocation 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.
ServiceUnavailable - if the system is unable to communicate with a service to complete the request.
UnableToAllocateResource - if any of the resources needed to clone 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.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource Datastore referenced by the property VMTypes.DiskCloneSpec.getDatastore() requires Datastore.AllocateSpace.
• The resource Datastore referenced by the property VMTypes.ClonePlacementSpec.getDatastore() requires Datastore.AllocateSpace.
• The resource Folder referenced by the property VMTypes.ClonePlacementSpec.getFolder() requires VirtualMachine.Inventory.CreateFromExisting.
• The resource ResourcePool referenced by the property VMTypes.ClonePlacementSpec.getResourcePool() requires Resource.AssignVMToPool.
• The resource VirtualMachine referenced by the property VMTypes.CloneSpec.getSource() requires VirtualMachine.Provisioning.Clone.

Parameters:

spec - Virtual machine clone specification.

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

clone

void clone(VMTypes.CloneSpec spec,
           AsyncCallback<java.lang.String> asyncCallback,
           InvocationConfig invocationConfig)

Creates a virtual machine from an existing virtual machine.

. This method was added in vSphere API 7.0.0.

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:
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.
ServiceUnavailable - if the system is unable to communicate with a service to complete the request.
UnableToAllocateResource - if any of the resources needed to clone 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.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource Datastore referenced by the property VMTypes.DiskCloneSpec.getDatastore() requires Datastore.AllocateSpace.
• The resource Datastore referenced by the property VMTypes.ClonePlacementSpec.getDatastore() requires Datastore.AllocateSpace.
• The resource Folder referenced by the property VMTypes.ClonePlacementSpec.getFolder() requires VirtualMachine.Inventory.CreateFromExisting.
• The resource ResourcePool referenced by the property VMTypes.ClonePlacementSpec.getResourcePool() requires Resource.AssignVMToPool.
• The resource VirtualMachine referenced by the property VMTypes.CloneSpec.getSource() requires VirtualMachine.Provisioning.Clone.

Parameters:

spec - Virtual machine clone specification.

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

invocationConfig - Configuration for the method invocation.

relocate

void relocate(java.lang.String vm,
              VMTypes.RelocateSpec spec)

Relocates a virtual machine based on the specification. The parts of the virtual machine that can move are: FOLDER, RESOURCE_POOL, HOST, CLUSTER and DATASTORE of home of the virtual machine and disks.

. This method was added in vSphere API 7.0.0.

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

Parameters:

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

spec - Relocate specification.

Throws:

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 or the given "vm" could not be found

ResourceInaccessible - if a specified resource (eg. host) is not accessible.

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.

Unauthorized - if you do not have all of the privileges described as follows:

• The resource VirtualMachine referenced by the parameter vm requires Resource.ColdMigrate.
• The resource ResourcePool referenced by the property VMTypes.RelocatePlacementSpec.getResourcePool() requires Resource.AssignVMToPool.

relocate

void relocate(java.lang.String vm,
              VMTypes.RelocateSpec spec,
              InvocationConfig invocationConfig)

Relocates a virtual machine based on the specification. The parts of the virtual machine that can move are: FOLDER, RESOURCE_POOL, HOST, CLUSTER and DATASTORE of home of the virtual machine and disks.

. This method was added in vSphere API 7.0.0.

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 - Existing Virtual machine to relocate. The parameter must be an identifier for the resource type: VirtualMachine.

spec - Relocate specification.

invocationConfig - Configuration for the method invocation.

Throws:

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 or the given "vm" could not be found

ResourceInaccessible - if a specified resource (eg. host) is not accessible.

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.

Unauthorized - if you do not have all of the privileges described as follows:

• The resource VirtualMachine referenced by the parameter vm requires Resource.ColdMigrate.
• The resource ResourcePool referenced by the property VMTypes.RelocatePlacementSpec.getResourcePool() requires Resource.AssignVMToPool.

relocate_Task

java.lang.String relocate_Task(java.lang.String vm,
                               VMTypes.RelocateSpec spec)

Relocates a virtual machine based on the specification. The parts of the virtual machine that can move are: FOLDER, RESOURCE_POOL, HOST, CLUSTER and DATASTORE of home of the virtual machine and disks.

. This method was added in vSphere API 7.0.0.

Synchronous method overload. Result of the invocation is a task identifier which will be returned by this method.

Parameters:

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

spec - Relocate specification.

Returns:

identifier for the task created by this API invocation

Throws:

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 or the given "vm" could not be found

ResourceInaccessible - if a specified resource (eg. host) is not accessible.

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.

Unauthorized - if you do not have all of the privileges described as follows:

• The resource VirtualMachine referenced by the parameter vm requires Resource.ColdMigrate.
• The resource ResourcePool referenced by the property VMTypes.RelocatePlacementSpec.getResourcePool() requires Resource.AssignVMToPool.

relocate_Task

java.lang.String relocate_Task(java.lang.String vm,
                               VMTypes.RelocateSpec spec,
                               InvocationConfig invocationConfig)

Relocates a virtual machine based on the specification. The parts of the virtual machine that can move are: FOLDER, RESOURCE_POOL, HOST, CLUSTER and DATASTORE of home of the virtual machine and disks.

. This method was added in vSphere API 7.0.0.

Synchronous method overload. Result of the invocation is a task identifier which will be returned by this method. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

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

spec - Relocate specification.

invocationConfig - Configuration for the method invocation.

Returns:

identifier for the task created by this API invocation

Throws:

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 or the given "vm" could not be found

ResourceInaccessible - if a specified resource (eg. host) is not accessible.

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.

Unauthorized - if you do not have all of the privileges described as follows:

• The resource VirtualMachine referenced by the parameter vm requires Resource.ColdMigrate.
• The resource ResourcePool referenced by the property VMTypes.RelocatePlacementSpec.getResourcePool() requires Resource.AssignVMToPool.

relocate_Task

void relocate_Task(java.lang.String vm,
                   VMTypes.RelocateSpec spec,
                   AsyncCallback<java.lang.String> asyncCallback)

Relocates a virtual machine based on the specification. The parts of the virtual machine that can move are: FOLDER, RESOURCE_POOL, HOST, CLUSTER and DATASTORE of home of the virtual machine and disks.

. This method was added in vSphere API 7.0.0.

Asynchronous method overload. Result of the invocation which is a task identifier will be reported via the specified asyncCallback.

Invocation Result:
identifier for the task created by this API invocation

Operation Errors:
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 or the given "vm" could not be found
ResourceInaccessible - if a specified resource (eg. host) is not accessible.
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.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource VirtualMachine referenced by the parameter vm requires Resource.ColdMigrate.
• The resource ResourcePool referenced by the property VMTypes.RelocatePlacementSpec.getResourcePool() requires Resource.AssignVMToPool.

Parameters:

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

spec - Relocate specification.

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

relocate_Task

void relocate_Task(java.lang.String vm,
                   VMTypes.RelocateSpec spec,
                   AsyncCallback<java.lang.String> asyncCallback,
                   InvocationConfig invocationConfig)

Relocates a virtual machine based on the specification. The parts of the virtual machine that can move are: FOLDER, RESOURCE_POOL, HOST, CLUSTER and DATASTORE of home of the virtual machine and disks.

. This method was added in vSphere API 7.0.0.

Asynchronous method overload. Result of the invocation which is a task identifier will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Invocation Result:
identifier for the task created by this API invocation

Operation Errors:
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 or the given "vm" could not be found
ResourceInaccessible - if a specified resource (eg. host) is not accessible.
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.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource VirtualMachine referenced by the parameter vm requires Resource.ColdMigrate.
• The resource ResourcePool referenced by the property VMTypes.RelocatePlacementSpec.getResourcePool() requires Resource.AssignVMToPool.

Parameters:

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

spec - Relocate specification.

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

invocationConfig - Configuration for the method invocation.

relocate

void relocate(java.lang.String vm,
              VMTypes.RelocateSpec spec,
              AsyncCallback<java.lang.Void> asyncCallback)

Relocates a virtual machine based on the specification. The parts of the virtual machine that can move are: FOLDER, RESOURCE_POOL, HOST, CLUSTER and DATASTORE of home of the virtual machine and disks.

. This method was added in vSphere API 7.0.0.

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.
InvalidArgument - if any of the specified parameters are invalid.
NotFound - if any of the resources specified in spec or the given "vm" could not be found
ResourceInaccessible - if a specified resource (eg. host) is not accessible.
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.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource VirtualMachine referenced by the parameter vm requires Resource.ColdMigrate.
• The resource ResourcePool referenced by the property VMTypes.RelocatePlacementSpec.getResourcePool() requires Resource.AssignVMToPool.

Parameters:

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

spec - Relocate specification.

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

relocate

void relocate(java.lang.String vm,
              VMTypes.RelocateSpec spec,
              AsyncCallback<java.lang.Void> asyncCallback,
              InvocationConfig invocationConfig)

Relocates a virtual machine based on the specification. The parts of the virtual machine that can move are: FOLDER, RESOURCE_POOL, HOST, CLUSTER and DATASTORE of home of the virtual machine and disks.

. This method was added in vSphere API 7.0.0.

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.
InvalidArgument - if any of the specified parameters are invalid.
NotFound - if any of the resources specified in spec or the given "vm" could not be found
ResourceInaccessible - if a specified resource (eg. host) is not accessible.
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.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource VirtualMachine referenced by the parameter vm requires Resource.ColdMigrate.
• The resource ResourcePool referenced by the property VMTypes.RelocatePlacementSpec.getResourcePool() requires Resource.AssignVMToPool.

Parameters:

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

spec - Relocate specification.

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

invocationConfig - Configuration for the method invocation.

instantClone

java.lang.String instantClone(VMTypes.InstantCloneSpec spec)

Create an instant clone of an existing virtual machine. This method was added in vSphere API 6.7.1.

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

Parameters:

spec - Virtual machine InstantCloneSpec.

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.

ServiceUnavailable - if the system is unable to communicate with a service to complete the request.

UnableToAllocateResource - if any of the resources needed to create an instant clone could not be allocated.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user doesn't have the required privileges.

Unauthorized - if you do not have all of the privileges described as follows:

• The resource VirtualMachine referenced by the property VMTypes.InstantCloneSpec.getSource() requires VirtualMachine.Provisioning.Clone and VirtualMachine.Inventory.CreateFromExisting.
• The resource Folder referenced by the property VMTypes.InstantClonePlacementSpec.getFolder() requires VirtualMachine.Interact.PowerOn.
• The resource ResourcePool referenced by the property VMTypes.InstantClonePlacementSpec.getResourcePool() requires Resource.AssignVMToPool.
• The resource Datastore referenced by the property VMTypes.InstantClonePlacementSpec.getDatastore() requires Datastore.AllocateSpace.
• The resource Network referenced by the property EthernetTypes.BackingSpec.getNetwork() requires Network.Assign.

instantClone

java.lang.String instantClone(VMTypes.InstantCloneSpec spec,
                              InvocationConfig invocationConfig)

Create an instant clone of an existing virtual machine. This method was added in vSphere API 6.7.1.

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

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.

ServiceUnavailable - if the system is unable to communicate with a service to complete the request.

UnableToAllocateResource - if any of the resources needed to create an instant clone could not be allocated.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user doesn't have the required privileges.

Unauthorized - if you do not have all of the privileges described as follows:

• The resource VirtualMachine referenced by the property VMTypes.InstantCloneSpec.getSource() requires VirtualMachine.Provisioning.Clone and VirtualMachine.Inventory.CreateFromExisting.
• The resource Folder referenced by the property VMTypes.InstantClonePlacementSpec.getFolder() requires VirtualMachine.Interact.PowerOn.
• The resource ResourcePool referenced by the property VMTypes.InstantClonePlacementSpec.getResourcePool() requires Resource.AssignVMToPool.
• The resource Datastore referenced by the property VMTypes.InstantClonePlacementSpec.getDatastore() requires Datastore.AllocateSpace.
• The resource Network referenced by the property EthernetTypes.BackingSpec.getNetwork() requires Network.Assign.

instantClone

void instantClone(VMTypes.InstantCloneSpec spec,
                  AsyncCallback<java.lang.String> asyncCallback)

Create an instant clone of an existing virtual machine. This method was added in vSphere API 6.7.1.

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

Invocation 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.
ServiceUnavailable - if the system is unable to communicate with a service to complete the request.
UnableToAllocateResource - if any of the resources needed to create an instant clone could not be allocated.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user doesn't have the required privileges.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource VirtualMachine referenced by the property VMTypes.InstantCloneSpec.getSource() requires VirtualMachine.Provisioning.Clone and VirtualMachine.Inventory.CreateFromExisting.
• The resource Folder referenced by the property VMTypes.InstantClonePlacementSpec.getFolder() requires VirtualMachine.Interact.PowerOn.
• The resource ResourcePool referenced by the property VMTypes.InstantClonePlacementSpec.getResourcePool() requires Resource.AssignVMToPool.
• The resource Datastore referenced by the property VMTypes.InstantClonePlacementSpec.getDatastore() requires Datastore.AllocateSpace.
• The resource Network referenced by the property EthernetTypes.BackingSpec.getNetwork() requires Network.Assign.

Parameters:

spec - Virtual machine InstantCloneSpec.

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

instantClone

void instantClone(VMTypes.InstantCloneSpec spec,
                  AsyncCallback<java.lang.String> asyncCallback,
                  InvocationConfig invocationConfig)

Create an instant clone of an existing virtual machine. This method was added in vSphere API 6.7.1.

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:
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.
ServiceUnavailable - if the system is unable to communicate with a service to complete the request.
UnableToAllocateResource - if any of the resources needed to create an instant clone could not be allocated.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user doesn't have the required privileges.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource VirtualMachine referenced by the property VMTypes.InstantCloneSpec.getSource() requires VirtualMachine.Provisioning.Clone and VirtualMachine.Inventory.CreateFromExisting.
• The resource Folder referenced by the property VMTypes.InstantClonePlacementSpec.getFolder() requires VirtualMachine.Interact.PowerOn.
• The resource ResourcePool referenced by the property VMTypes.InstantClonePlacementSpec.getResourcePool() requires Resource.AssignVMToPool.
• The resource Datastore referenced by the property VMTypes.InstantClonePlacementSpec.getDatastore() requires Datastore.AllocateSpace.
• The resource Network referenced by the property EthernetTypes.BackingSpec.getNetwork() requires Network.Assign.

Parameters:

spec - Virtual machine InstantCloneSpec.

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

invocationConfig - Configuration for the method invocation.

get

VMTypes.Info get(java.lang.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.

Unauthorized - if you do not have all of the privileges described as follows:

• The resource VirtualMachine referenced by the parameter vm requires System.Read.

get

VMTypes.Info get(java.lang.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.

Unauthorized - if you do not have all of the privileges described as follows:

• The resource VirtualMachine referenced by the parameter vm requires System.Read.

get

void get(java.lang.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.

Invocation 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.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource VirtualMachine referenced by the parameter vm requires System.Read.

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(java.lang.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.

Invocation 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.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource VirtualMachine referenced by the parameter vm requires System.Read.

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(java.lang.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.

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.

Unauthorized - if you do not have all of the privileges described as follows:

• The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.Inventory.Delete.

delete

void delete(java.lang.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.

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.

Unauthorized - if you do not have all of the privileges described as follows:

• The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.Inventory.Delete.

delete

void delete(java.lang.String vm,
            AsyncCallback<java.lang.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.
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.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.Inventory.Delete.

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(java.lang.String vm,
            AsyncCallback<java.lang.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.
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.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.Inventory.Delete.

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

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

Returns information about at most 4000 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 4000 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

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

Returns information about at most 4000 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 4000 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<java.util.List<VMTypes.Summary>> asyncCallback)

Returns information about at most 4000 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.

Invocation 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 4000 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<java.util.List<VMTypes.Summary>> asyncCallback,
          InvocationConfig invocationConfig)

Returns information about at most 4000 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.

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

register

java.lang.String register(VMTypes.RegisterSpec spec)

Creates a virtual machine from existing virtual machine files on storage. This method was added in vSphere API 6.8.7.

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

Parameters:

spec - Specification of the location of the virtual machine files and the placement of the new virtual machine.

Returns:

Identifier of the 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 or if a virtual machine using the specified virtual machine files 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.

ServiceUnavailable - if the system is unable to communicate with a service to complete the request.

UnableToAllocateResource - if any of the resources needed to register the virtual machine could not be allocated.

Unauthenticated - if the user cannot be authenticated.

Unauthorized - if the user doesn't have the required privileges.

Unauthorized - if you do not have all of the privileges described as follows:

• The resource Datastore referenced by the property VMTypes.RegisterSpec.getDatastore() requires System.Read.
• The resource Folder referenced by the property VMTypes.InventoryPlacementSpec.getFolder() requires VirtualMachine.Inventory.Register.
• The resource ResourcePool referenced by the property VMTypes.ComputePlacementSpec.getResourcePool() requires Resource.AssignVMToPool.

register

java.lang.String register(VMTypes.RegisterSpec spec,
                          InvocationConfig invocationConfig)

Creates a virtual machine from existing virtual machine files on storage. This method was added in vSphere API 6.8.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:

spec - Specification of the location of the virtual machine files and the placement of the new virtual machine.

invocationConfig - Configuration for the method invocation.

Returns:

Identifier of the 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 or if a virtual machine using the specified virtual machine files 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.

ServiceUnavailable - if the system is unable to communicate with a service to complete the request.

UnableToAllocateResource - if any of the resources needed to register the virtual machine could not be allocated.

Unauthenticated - if the user cannot be authenticated.

Unauthorized - if the user doesn't have the required privileges.

Unauthorized - if you do not have all of the privileges described as follows:

• The resource Datastore referenced by the property VMTypes.RegisterSpec.getDatastore() requires System.Read.
• The resource Folder referenced by the property VMTypes.InventoryPlacementSpec.getFolder() requires VirtualMachine.Inventory.Register.
• The resource ResourcePool referenced by the property VMTypes.ComputePlacementSpec.getResourcePool() requires Resource.AssignVMToPool.

register

void register(VMTypes.RegisterSpec spec,
              AsyncCallback<java.lang.String> asyncCallback)

Creates a virtual machine from existing virtual machine files on storage. This method was added in vSphere API 6.8.7.

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

Invocation Result:
Identifier of the 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 or if a virtual machine using the specified virtual machine files 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.
ServiceUnavailable - if the system is unable to communicate with a service to complete the request.
UnableToAllocateResource - if any of the resources needed to register the virtual machine could not be allocated.
Unauthenticated - if the user cannot be authenticated.
Unauthorized - if the user doesn't have the required privileges.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource Datastore referenced by the property VMTypes.RegisterSpec.getDatastore() requires System.Read.
• The resource Folder referenced by the property VMTypes.InventoryPlacementSpec.getFolder() requires VirtualMachine.Inventory.Register.
• The resource ResourcePool referenced by the property VMTypes.ComputePlacementSpec.getResourcePool() requires Resource.AssignVMToPool.

Parameters:

spec - Specification of the location of the virtual machine files and the placement of the new virtual machine.

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

register

void register(VMTypes.RegisterSpec spec,
              AsyncCallback<java.lang.String> asyncCallback,
              InvocationConfig invocationConfig)

Creates a virtual machine from existing virtual machine files on storage. This method was added in vSphere API 6.8.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:
Identifier of the 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 or if a virtual machine using the specified virtual machine files 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.
ServiceUnavailable - if the system is unable to communicate with a service to complete the request.
UnableToAllocateResource - if any of the resources needed to register the virtual machine could not be allocated.
Unauthenticated - if the user cannot be authenticated.
Unauthorized - if the user doesn't have the required privileges.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource Datastore referenced by the property VMTypes.RegisterSpec.getDatastore() requires System.Read.
• The resource Folder referenced by the property VMTypes.InventoryPlacementSpec.getFolder() requires VirtualMachine.Inventory.Register.
• The resource ResourcePool referenced by the property VMTypes.ComputePlacementSpec.getResourcePool() requires Resource.AssignVMToPool.

Parameters:

spec - Specification of the location of the virtual machine files and the placement of the new virtual machine.

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

invocationConfig - Configuration for the method invocation.

unregister

void unregister(java.lang.String vm)

Removes the virtual machine corresponding to vm from the vCenter inventory without removing any of the virtual machine's files from storage. All high-level information stored with the management server (ESXi or vCenter) is removed, including information such as statistics, resource pool association, permissions, and alarms. This method was added in vSphere API 6.8.7.

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

Parameters:

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

Throws:

NotAllowedInCurrentState - if the virtual machine is running (powered on).

NotFound - if there is no virtual machine associated with vm in the system.

ResourceBusy - if the virtual machine is busy 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.

Unauthorized - if you do not have all of the privileges described as follows:

• The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.Inventory.Unregister.

unregister

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

Removes the virtual machine corresponding to vm from the vCenter inventory without removing any of the virtual machine's files from storage. All high-level information stored with the management server (ESXi or vCenter) is removed, including information such as statistics, resource pool association, permissions, and alarms. This method was added in vSphere API 6.8.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 to be unregistered. The parameter must be an identifier for the resource type: VirtualMachine.

invocationConfig - Configuration for the method invocation.

Throws:

NotAllowedInCurrentState - if the virtual machine is running (powered on).

NotFound - if there is no virtual machine associated with vm in the system.

ResourceBusy - if the virtual machine is busy 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.

Unauthorized - if you do not have all of the privileges described as follows:

• The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.Inventory.Unregister.

unregister

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

Removes the virtual machine corresponding to vm from the vCenter inventory without removing any of the virtual machine's files from storage. All high-level information stored with the management server (ESXi or vCenter) is removed, including information such as statistics, resource pool association, permissions, and alarms. This method was added in vSphere API 6.8.7.

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

Operation Errors:
NotAllowedInCurrentState - if the virtual machine is running (powered on).
NotFound - if there is no virtual machine associated with vm in the system.
ResourceBusy - if the virtual machine is busy 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.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.Inventory.Unregister.

Parameters:

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

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

unregister

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

Removes the virtual machine corresponding to vm from the vCenter inventory without removing any of the virtual machine's files from storage. All high-level information stored with the management server (ESXi or vCenter) is removed, including information such as statistics, resource pool association, permissions, and alarms. This method was added in vSphere API 6.8.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:
NotAllowedInCurrentState - if the virtual machine is running (powered on).
NotFound - if there is no virtual machine associated with vm in the system.
ResourceBusy - if the virtual machine is busy 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.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.Inventory.Unregister.

Parameters:

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