com.vmware.vcenter.vm_template

Interface LibraryItems

All Superinterfaces:

LibraryItemsTypes, Service

All Known Implementing Classes:

LibraryItemsStub

public interface LibraryItems
extends Service, LibraryItemsTypes

The LibraryItems interface provides methods to deploy virtual machines from library items containing virtual machine templates, as well as methods to create library items containing virtual machine templates. The LibraryItems interface also provides an operation to retrieve information about the template contained in the library item. This interface was added in vSphere API 6.7 U1.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.vcenter.vm_template.LibraryItemsTypes

LibraryItemsTypes.CpuInfo, LibraryItemsTypes.CpuUpdateSpec, LibraryItemsTypes.CreatePlacementSpec, LibraryItemsTypes.CreateSpec, LibraryItemsTypes.CreateSpecDiskStorage, LibraryItemsTypes.CreateSpecDiskStoragePolicy, LibraryItemsTypes.CreateSpecVmHomeStorage, LibraryItemsTypes.CreateSpecVmHomeStoragePolicy, LibraryItemsTypes.DeployPlacementSpec, LibraryItemsTypes.DeploySpec, LibraryItemsTypes.DeploySpecDiskStorage, LibraryItemsTypes.DeploySpecDiskStoragePolicy, LibraryItemsTypes.DeploySpecVmHomeStorage, LibraryItemsTypes.DeploySpecVmHomeStoragePolicy, LibraryItemsTypes.DiskInfo, LibraryItemsTypes.DiskStorageInfo, LibraryItemsTypes.DiskUpdateSpec, LibraryItemsTypes.EthernetInfo, LibraryItemsTypes.EthernetUpdateSpec, LibraryItemsTypes.GuestCustomizationSpec, LibraryItemsTypes.HardwareCustomizationSpec, LibraryItemsTypes.Info, LibraryItemsTypes.MemoryInfo, LibraryItemsTypes.MemoryUpdateSpec, LibraryItemsTypes.VmHomeStorageInfo

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	create(LibraryItemsTypes.CreateSpec spec) Creates a library item in content library from a virtual machine.
void	create(LibraryItemsTypes.CreateSpec spec, AsyncCallback<java.lang.String> asyncCallback) Creates a library item in content library from a virtual machine.
void	create(LibraryItemsTypes.CreateSpec spec, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig) Creates a library item in content library from a virtual machine.
java.lang.String	create(LibraryItemsTypes.CreateSpec spec, InvocationConfig invocationConfig) Creates a library item in content library from a virtual machine.
java.lang.String	deploy(java.lang.String templateLibraryItem, LibraryItemsTypes.DeploySpec spec) Deploys a virtual machine as a copy of the source virtual machine template contained in the library item specified by templateLibraryItem.
void	deploy(java.lang.String templateLibraryItem, LibraryItemsTypes.DeploySpec spec, AsyncCallback<java.lang.String> asyncCallback) Deploys a virtual machine as a copy of the source virtual machine template contained in the library item specified by templateLibraryItem.
void	deploy(java.lang.String templateLibraryItem, LibraryItemsTypes.DeploySpec spec, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig) Deploys a virtual machine as a copy of the source virtual machine template contained in the library item specified by templateLibraryItem.
java.lang.String	deploy(java.lang.String templateLibraryItem, LibraryItemsTypes.DeploySpec spec, InvocationConfig invocationConfig) Deploys a virtual machine as a copy of the source virtual machine template contained in the library item specified by templateLibraryItem.
LibraryItemsTypes.Info	get(java.lang.String templateLibraryItem) Returns information about a virtual machine template contained in the library item specified by templateLibraryItem.
void	get(java.lang.String templateLibraryItem, AsyncCallback<LibraryItemsTypes.Info> asyncCallback) Returns information about a virtual machine template contained in the library item specified by templateLibraryItem.
void	get(java.lang.String templateLibraryItem, AsyncCallback<LibraryItemsTypes.Info> asyncCallback, InvocationConfig invocationConfig) Returns information about a virtual machine template contained in the library item specified by templateLibraryItem.
LibraryItemsTypes.Info	get(java.lang.String templateLibraryItem, InvocationConfig invocationConfig) Returns information about a virtual machine template contained in the library item specified by templateLibraryItem.

Method Detail

create

java.lang.String create(LibraryItemsTypes.CreateSpec spec)

Creates a library item in content library from a virtual machine. This method creates a library item in content library whose content is a virtual machine template created from the source virtual machine, using the supplied create specification. The virtual machine template is stored in a newly created library item. This method was added in vSphere API 6.7 U1.

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

Parameters:

spec - information used to create the library item from the source virtual machine.

Returns:

Identifier of the newly created library item. The return value will be an identifier for the resource type: com.vmware.content.library.Item.

Throws:

AlreadyExists - if an entity with the name specified by LibraryItemsTypes.CreateSpec.getName() already exists in the folder specified by LibraryItemsTypes.CreatePlacementSpec.getFolder().

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

InvalidArgument - if LibraryItemsTypes.CreateSpec contains invalid arguments.

NotAllowedInCurrentState - if the operation cannot be performed because of the source virtual machine's current state.

NotFound - if the source virtual machine specified by LibraryItemsTypes.CreateSpec.getSourceVm() does not exist.

NotFound - if the library specified by LibraryItemsTypes.CreateSpec.getLibrary() does not exist.

ResourceInaccessible - if there was an error accessing a file from the source virtual machine.

ResourceInUse - if the source virtual machine is busy.

ServiceUnavailable - if any of the services involved in the method are unavailable.

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

Unauthenticated - if the user that requested the method cannot be authenticated.

Unauthorized - if the user that requested the method is not authorized to perform the method.

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

• Method execution requires System.Read.
• The resource com.vmware.content.Library referenced by the property LibraryItemsTypes.CreateSpec.getLibrary() requires ContentLibrary.AddLibraryItem.
• The resource VirtualMachine referenced by the property LibraryItemsTypes.CreateSpec.getSourceVm() requires System.Read.
• The resource Datastore referenced by the property LibraryItemsTypes.CreateSpecVmHomeStorage.getDatastore() requires System.Read.
• The resource com.vmware.spbm.StorageProfile referenced by the property LibraryItemsTypes.CreateSpecVmHomeStoragePolicy.getPolicy() requires System.Read.
• The resource Datastore referenced by the property LibraryItemsTypes.CreateSpecDiskStorage.getDatastore() requires System.Read.
• The resource com.vmware.spbm.StorageProfile referenced by the property LibraryItemsTypes.CreateSpecDiskStoragePolicy.getPolicy() requires System.Read.
• The resource com.vmware.vcenter.vm.hardware.Disk referenced by the Map key of property LibraryItemsTypes.CreateSpec.getDiskStorageOverrides() requires System.Read.
• The resource Folder referenced by the property LibraryItemsTypes.CreatePlacementSpec.getFolder() requires System.Read.
• The resource ResourcePool referenced by the property LibraryItemsTypes.CreatePlacementSpec.getResourcePool() requires System.Read.
• The resource HostSystem referenced by the property LibraryItemsTypes.CreatePlacementSpec.getHost() requires System.Read.
• The resource ClusterComputeResource referenced by the property LibraryItemsTypes.CreatePlacementSpec.getCluster() requires System.Read.

create

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

Creates a library item in content library from a virtual machine. This method creates a library item in content library whose content is a virtual machine template created from the source virtual machine, using the supplied create specification. The virtual machine template is stored in a newly created library item. This method was added in vSphere API 6.7 U1.

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 - information used to create the library item from the source virtual machine.

invocationConfig - Configuration for the method invocation.

Returns:

Identifier of the newly created library item. The return value will be an identifier for the resource type: com.vmware.content.library.Item.

Throws:

AlreadyExists - if an entity with the name specified by LibraryItemsTypes.CreateSpec.getName() already exists in the folder specified by LibraryItemsTypes.CreatePlacementSpec.getFolder().

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

InvalidArgument - if LibraryItemsTypes.CreateSpec contains invalid arguments.

NotAllowedInCurrentState - if the operation cannot be performed because of the source virtual machine's current state.

NotFound - if the source virtual machine specified by LibraryItemsTypes.CreateSpec.getSourceVm() does not exist.

NotFound - if the library specified by LibraryItemsTypes.CreateSpec.getLibrary() does not exist.

ResourceInaccessible - if there was an error accessing a file from the source virtual machine.

ResourceInUse - if the source virtual machine is busy.

ServiceUnavailable - if any of the services involved in the method are unavailable.

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

Unauthenticated - if the user that requested the method cannot be authenticated.

Unauthorized - if the user that requested the method is not authorized to perform the method.

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

• Method execution requires System.Read.
• The resource com.vmware.content.Library referenced by the property LibraryItemsTypes.CreateSpec.getLibrary() requires ContentLibrary.AddLibraryItem.
• The resource VirtualMachine referenced by the property LibraryItemsTypes.CreateSpec.getSourceVm() requires System.Read.
• The resource Datastore referenced by the property LibraryItemsTypes.CreateSpecVmHomeStorage.getDatastore() requires System.Read.
• The resource com.vmware.spbm.StorageProfile referenced by the property LibraryItemsTypes.CreateSpecVmHomeStoragePolicy.getPolicy() requires System.Read.
• The resource Datastore referenced by the property LibraryItemsTypes.CreateSpecDiskStorage.getDatastore() requires System.Read.
• The resource com.vmware.spbm.StorageProfile referenced by the property LibraryItemsTypes.CreateSpecDiskStoragePolicy.getPolicy() requires System.Read.
• The resource com.vmware.vcenter.vm.hardware.Disk referenced by the Map key of property LibraryItemsTypes.CreateSpec.getDiskStorageOverrides() requires System.Read.
• The resource Folder referenced by the property LibraryItemsTypes.CreatePlacementSpec.getFolder() requires System.Read.
• The resource ResourcePool referenced by the property LibraryItemsTypes.CreatePlacementSpec.getResourcePool() requires System.Read.
• The resource HostSystem referenced by the property LibraryItemsTypes.CreatePlacementSpec.getHost() requires System.Read.
• The resource ClusterComputeResource referenced by the property LibraryItemsTypes.CreatePlacementSpec.getCluster() requires System.Read.

create

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

Creates a library item in content library from a virtual machine. This method creates a library item in content library whose content is a virtual machine template created from the source virtual machine, using the supplied create specification. The virtual machine template is stored in a newly created library item. This method was added in vSphere API 6.7 U1.

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

Operation Result:
Identifier of the newly created library item. The return value will be an identifier for the resource type: com.vmware.content.library.Item.

Operation Errors:
AlreadyExists - if an entity with the name specified by LibraryItemsTypes.CreateSpec.getName() already exists in the folder specified by LibraryItemsTypes.CreatePlacementSpec.getFolder().
Error - if the system reports an error while responding to the request.
InvalidArgument - if LibraryItemsTypes.CreateSpec contains invalid arguments.
NotAllowedInCurrentState - if the operation cannot be performed because of the source virtual machine's current state.
NotFound - if the source virtual machine specified by LibraryItemsTypes.CreateSpec.getSourceVm() does not exist.
NotFound - if the library specified by LibraryItemsTypes.CreateSpec.getLibrary() does not exist.
ResourceInaccessible - if there was an error accessing a file from the source virtual machine.
ResourceInUse - if the source virtual machine is busy.
ServiceUnavailable - if any of the services involved in the method are unavailable.
UnableToAllocateResource - if any of the resources needed to create the virtual machine template could not be allocated.
Unauthenticated - if the user that requested the method cannot be authenticated.
Unauthorized - if the user that requested the method is not authorized to perform the method.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires System.Read.
• The resource com.vmware.content.Library referenced by the property LibraryItemsTypes.CreateSpec.getLibrary() requires ContentLibrary.AddLibraryItem.
• The resource VirtualMachine referenced by the property LibraryItemsTypes.CreateSpec.getSourceVm() requires System.Read.
• The resource Datastore referenced by the property LibraryItemsTypes.CreateSpecVmHomeStorage.getDatastore() requires System.Read.
• The resource com.vmware.spbm.StorageProfile referenced by the property LibraryItemsTypes.CreateSpecVmHomeStoragePolicy.getPolicy() requires System.Read.
• The resource Datastore referenced by the property LibraryItemsTypes.CreateSpecDiskStorage.getDatastore() requires System.Read.
• The resource com.vmware.spbm.StorageProfile referenced by the property LibraryItemsTypes.CreateSpecDiskStoragePolicy.getPolicy() requires System.Read.
• The resource com.vmware.vcenter.vm.hardware.Disk referenced by the Map key of property LibraryItemsTypes.CreateSpec.getDiskStorageOverrides() requires System.Read.
• The resource Folder referenced by the property LibraryItemsTypes.CreatePlacementSpec.getFolder() requires System.Read.
• The resource ResourcePool referenced by the property LibraryItemsTypes.CreatePlacementSpec.getResourcePool() requires System.Read.
• The resource HostSystem referenced by the property LibraryItemsTypes.CreatePlacementSpec.getHost() requires System.Read.
• The resource ClusterComputeResource referenced by the property LibraryItemsTypes.CreatePlacementSpec.getCluster() requires System.Read.

Parameters:

spec - information used to create the library item from the source virtual machine.

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

create

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

Creates a library item in content library from a virtual machine. This method creates a library item in content library whose content is a virtual machine template created from the source virtual machine, using the supplied create specification. The virtual machine template is stored in a newly created library item. This method was added in vSphere API 6.7 U1.

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:
Identifier of the newly created library item. The return value will be an identifier for the resource type: com.vmware.content.library.Item.

Operation Errors:
AlreadyExists - if an entity with the name specified by LibraryItemsTypes.CreateSpec.getName() already exists in the folder specified by LibraryItemsTypes.CreatePlacementSpec.getFolder().
Error - if the system reports an error while responding to the request.
InvalidArgument - if LibraryItemsTypes.CreateSpec contains invalid arguments.
NotAllowedInCurrentState - if the operation cannot be performed because of the source virtual machine's current state.
NotFound - if the source virtual machine specified by LibraryItemsTypes.CreateSpec.getSourceVm() does not exist.
NotFound - if the library specified by LibraryItemsTypes.CreateSpec.getLibrary() does not exist.
ResourceInaccessible - if there was an error accessing a file from the source virtual machine.
ResourceInUse - if the source virtual machine is busy.
ServiceUnavailable - if any of the services involved in the method are unavailable.
UnableToAllocateResource - if any of the resources needed to create the virtual machine template could not be allocated.
Unauthenticated - if the user that requested the method cannot be authenticated.
Unauthorized - if the user that requested the method is not authorized to perform the method.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires System.Read.
• The resource com.vmware.content.Library referenced by the property LibraryItemsTypes.CreateSpec.getLibrary() requires ContentLibrary.AddLibraryItem.
• The resource VirtualMachine referenced by the property LibraryItemsTypes.CreateSpec.getSourceVm() requires System.Read.
• The resource Datastore referenced by the property LibraryItemsTypes.CreateSpecVmHomeStorage.getDatastore() requires System.Read.
• The resource com.vmware.spbm.StorageProfile referenced by the property LibraryItemsTypes.CreateSpecVmHomeStoragePolicy.getPolicy() requires System.Read.
• The resource Datastore referenced by the property LibraryItemsTypes.CreateSpecDiskStorage.getDatastore() requires System.Read.
• The resource com.vmware.spbm.StorageProfile referenced by the property LibraryItemsTypes.CreateSpecDiskStoragePolicy.getPolicy() requires System.Read.
• The resource com.vmware.vcenter.vm.hardware.Disk referenced by the Map key of property LibraryItemsTypes.CreateSpec.getDiskStorageOverrides() requires System.Read.
• The resource Folder referenced by the property LibraryItemsTypes.CreatePlacementSpec.getFolder() requires System.Read.
• The resource ResourcePool referenced by the property LibraryItemsTypes.CreatePlacementSpec.getResourcePool() requires System.Read.
• The resource HostSystem referenced by the property LibraryItemsTypes.CreatePlacementSpec.getHost() requires System.Read.
• The resource ClusterComputeResource referenced by the property LibraryItemsTypes.CreatePlacementSpec.getCluster() requires System.Read.

Parameters:

spec - information used to create the library item from the source virtual machine.

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

invocationConfig - Configuration for the method invocation.

deploy

java.lang.String deploy(java.lang.String templateLibraryItem,
                      LibraryItemsTypes.DeploySpec spec)

Deploys a virtual machine as a copy of the source virtual machine template contained in the library item specified by templateLibraryItem. It uses the deployment specification in spec. If LibraryItemsTypes.DeploySpec.getPoweredOn() and/or LibraryItemsTypes.DeploySpec.getGuestCustomization() are specified, the server triggers the power on and/or guest customization operations, which are executed asynchronously. This method was added in vSphere API 6.7 U1.

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

Parameters:

templateLibraryItem - identifier of the content library item containing the source virtual machine template to be deployed. The parameter must be an identifier for the resource type: com.vmware.content.library.Item.

spec - specification of how the virtual machine should be deployed.

Returns:

Identifier of the deployed virtual machine. The return value will be an identifier for the resource type: VirtualMachine.

Throws:

AlreadyExists - if a virtual machine with the name specified by LibraryItemsTypes.DeploySpec.getName() already exists.

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

InvalidArgument - if spec contains invalid arguments.

NotAllowedInCurrentState - if either a specified host or a specified datastore is in an invalid state for the deployment, such as maintenance mode.

NotFound - if the library item specified by templateLibraryItem cannot be found.

NotFound - if any resource specified by a property of the LibraryItemsTypes.DeploySpec class, specified by spec cannot be found.

ResourceInaccessible - if there was an error accessing the source virtual machine template contained in the library item specified by templateLibraryItem.

ResourceInaccessible - if there an error accessing any of the resources specified in the spec.

ServiceUnavailable - if any of the services involved in the method are unavailable.

UnableToAllocateResource - if there was an error in allocating any of the resources required by the method.

Unauthenticated - if the user that requested the method cannot be authenticated.

Unauthorized - if the user that requested the method is not authorized to perform the method.

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

• Method execution requires System.Read.
• The resource com.vmware.content.library.Item referenced by the parameter templateLibraryItem requires VirtualMachine.Provisioning.DeployTemplate.
• The resource Datastore referenced by the property LibraryItemsTypes.DeploySpecVmHomeStorage.getDatastore() requires System.Read.
• The resource com.vmware.spbm.StorageProfile referenced by the property LibraryItemsTypes.DeploySpecVmHomeStoragePolicy.getPolicy() requires System.Read.
• The resource Datastore referenced by the property LibraryItemsTypes.DeploySpecDiskStorage.getDatastore() requires System.Read.
• The resource com.vmware.spbm.StorageProfile referenced by the property LibraryItemsTypes.DeploySpecDiskStoragePolicy.getPolicy() requires System.Read.
• The resource com.vmware.vcenter.vm.hardware.Disk referenced by the Map key of property LibraryItemsTypes.DeploySpec.getDiskStorageOverrides() requires System.Read.
• The resource Folder referenced by the property LibraryItemsTypes.DeployPlacementSpec.getFolder() requires System.Read.
• The resource ResourcePool referenced by the property LibraryItemsTypes.DeployPlacementSpec.getResourcePool() requires System.Read.
• The resource HostSystem referenced by the property LibraryItemsTypes.DeployPlacementSpec.getHost() requires System.Read.
• The resource ClusterComputeResource referenced by the property LibraryItemsTypes.DeployPlacementSpec.getCluster() requires System.Read.
• The resource com.vmware.vcenter.vm.hardware.Ethernet referenced by the Map key of property LibraryItemsTypes.HardwareCustomizationSpec.getNics() requires System.Read.
• The resource Network referenced by the property LibraryItemsTypes.EthernetUpdateSpec.getNetwork() requires System.Read.
• The resource com.vmware.vcenter.vm.hardware.Disk referenced by the property LibraryItemsTypes.HardwareCustomizationSpec.getDisksToRemove() requires System.Read.
• The resource com.vmware.vcenter.vm.hardware.Disk referenced by the Map key of property LibraryItemsTypes.HardwareCustomizationSpec.getDisksToUpdate() requires System.Read.

deploy

java.lang.String deploy(java.lang.String templateLibraryItem,
                      LibraryItemsTypes.DeploySpec spec,
                      InvocationConfig invocationConfig)

Deploys a virtual machine as a copy of the source virtual machine template contained in the library item specified by templateLibraryItem. It uses the deployment specification in spec. If LibraryItemsTypes.DeploySpec.getPoweredOn() and/or LibraryItemsTypes.DeploySpec.getGuestCustomization() are specified, the server triggers the power on and/or guest customization operations, which are executed asynchronously. This method was added in vSphere API 6.7 U1.

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:

templateLibraryItem - identifier of the content library item containing the source virtual machine template to be deployed. The parameter must be an identifier for the resource type: com.vmware.content.library.Item.

spec - specification of how the virtual machine should be deployed.

invocationConfig - Configuration for the method invocation.

Returns:

Identifier of the deployed virtual machine. The return value will be an identifier for the resource type: VirtualMachine.

Throws:

AlreadyExists - if a virtual machine with the name specified by LibraryItemsTypes.DeploySpec.getName() already exists.

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

InvalidArgument - if spec contains invalid arguments.

NotAllowedInCurrentState - if either a specified host or a specified datastore is in an invalid state for the deployment, such as maintenance mode.

NotFound - if the library item specified by templateLibraryItem cannot be found.

NotFound - if any resource specified by a property of the LibraryItemsTypes.DeploySpec class, specified by spec cannot be found.

ResourceInaccessible - if there was an error accessing the source virtual machine template contained in the library item specified by templateLibraryItem.

ResourceInaccessible - if there an error accessing any of the resources specified in the spec.

ServiceUnavailable - if any of the services involved in the method are unavailable.

UnableToAllocateResource - if there was an error in allocating any of the resources required by the method.

Unauthenticated - if the user that requested the method cannot be authenticated.

Unauthorized - if the user that requested the method is not authorized to perform the method.

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

• Method execution requires System.Read.
• The resource com.vmware.content.library.Item referenced by the parameter templateLibraryItem requires VirtualMachine.Provisioning.DeployTemplate.
• The resource Datastore referenced by the property LibraryItemsTypes.DeploySpecVmHomeStorage.getDatastore() requires System.Read.
• The resource com.vmware.spbm.StorageProfile referenced by the property LibraryItemsTypes.DeploySpecVmHomeStoragePolicy.getPolicy() requires System.Read.
• The resource Datastore referenced by the property LibraryItemsTypes.DeploySpecDiskStorage.getDatastore() requires System.Read.
• The resource com.vmware.spbm.StorageProfile referenced by the property LibraryItemsTypes.DeploySpecDiskStoragePolicy.getPolicy() requires System.Read.
• The resource com.vmware.vcenter.vm.hardware.Disk referenced by the Map key of property LibraryItemsTypes.DeploySpec.getDiskStorageOverrides() requires System.Read.
• The resource Folder referenced by the property LibraryItemsTypes.DeployPlacementSpec.getFolder() requires System.Read.
• The resource ResourcePool referenced by the property LibraryItemsTypes.DeployPlacementSpec.getResourcePool() requires System.Read.
• The resource HostSystem referenced by the property LibraryItemsTypes.DeployPlacementSpec.getHost() requires System.Read.
• The resource ClusterComputeResource referenced by the property LibraryItemsTypes.DeployPlacementSpec.getCluster() requires System.Read.
• The resource com.vmware.vcenter.vm.hardware.Ethernet referenced by the Map key of property LibraryItemsTypes.HardwareCustomizationSpec.getNics() requires System.Read.
• The resource Network referenced by the property LibraryItemsTypes.EthernetUpdateSpec.getNetwork() requires System.Read.
• The resource com.vmware.vcenter.vm.hardware.Disk referenced by the property LibraryItemsTypes.HardwareCustomizationSpec.getDisksToRemove() requires System.Read.
• The resource com.vmware.vcenter.vm.hardware.Disk referenced by the Map key of property LibraryItemsTypes.HardwareCustomizationSpec.getDisksToUpdate() requires System.Read.

deploy

void deploy(java.lang.String templateLibraryItem,
          LibraryItemsTypes.DeploySpec spec,
          AsyncCallback<java.lang.String> asyncCallback)

Deploys a virtual machine as a copy of the source virtual machine template contained in the library item specified by templateLibraryItem. It uses the deployment specification in spec. If LibraryItemsTypes.DeploySpec.getPoweredOn() and/or LibraryItemsTypes.DeploySpec.getGuestCustomization() are specified, the server triggers the power on and/or guest customization operations, which are executed asynchronously. This method was added in vSphere API 6.7 U1.

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

Operation Result:
Identifier of the deployed virtual machine. The return value will be an identifier for the resource type: VirtualMachine.

Operation Errors:
AlreadyExists - if a virtual machine with the name specified by LibraryItemsTypes.DeploySpec.getName() already exists.
Error - if the system reports an error while responding to the request.
InvalidArgument - if spec contains invalid arguments.
NotAllowedInCurrentState - if either a specified host or a specified datastore is in an invalid state for the deployment, such as maintenance mode.
NotFound - if the library item specified by templateLibraryItem cannot be found.
NotFound - if any resource specified by a property of the LibraryItemsTypes.DeploySpec class, specified by spec cannot be found.
ResourceInaccessible - if there was an error accessing the source virtual machine template contained in the library item specified by templateLibraryItem.
ResourceInaccessible - if there an error accessing any of the resources specified in the spec.
ServiceUnavailable - if any of the services involved in the method are unavailable.
UnableToAllocateResource - if there was an error in allocating any of the resources required by the method.
Unauthenticated - if the user that requested the method cannot be authenticated.
Unauthorized - if the user that requested the method is not authorized to perform the method.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires System.Read.
• The resource com.vmware.content.library.Item referenced by the parameter templateLibraryItem requires VirtualMachine.Provisioning.DeployTemplate.
• The resource Datastore referenced by the property LibraryItemsTypes.DeploySpecVmHomeStorage.getDatastore() requires System.Read.
• The resource com.vmware.spbm.StorageProfile referenced by the property LibraryItemsTypes.DeploySpecVmHomeStoragePolicy.getPolicy() requires System.Read.
• The resource Datastore referenced by the property LibraryItemsTypes.DeploySpecDiskStorage.getDatastore() requires System.Read.
• The resource com.vmware.spbm.StorageProfile referenced by the property LibraryItemsTypes.DeploySpecDiskStoragePolicy.getPolicy() requires System.Read.
• The resource com.vmware.vcenter.vm.hardware.Disk referenced by the Map key of property LibraryItemsTypes.DeploySpec.getDiskStorageOverrides() requires System.Read.
• The resource Folder referenced by the property LibraryItemsTypes.DeployPlacementSpec.getFolder() requires System.Read.
• The resource ResourcePool referenced by the property LibraryItemsTypes.DeployPlacementSpec.getResourcePool() requires System.Read.
• The resource HostSystem referenced by the property LibraryItemsTypes.DeployPlacementSpec.getHost() requires System.Read.
• The resource ClusterComputeResource referenced by the property LibraryItemsTypes.DeployPlacementSpec.getCluster() requires System.Read.
• The resource com.vmware.vcenter.vm.hardware.Ethernet referenced by the Map key of property LibraryItemsTypes.HardwareCustomizationSpec.getNics() requires System.Read.
• The resource Network referenced by the property LibraryItemsTypes.EthernetUpdateSpec.getNetwork() requires System.Read.
• The resource com.vmware.vcenter.vm.hardware.Disk referenced by the property LibraryItemsTypes.HardwareCustomizationSpec.getDisksToRemove() requires System.Read.
• The resource com.vmware.vcenter.vm.hardware.Disk referenced by the Map key of property LibraryItemsTypes.HardwareCustomizationSpec.getDisksToUpdate() requires System.Read.

Parameters:

templateLibraryItem - identifier of the content library item containing the source virtual machine template to be deployed. The parameter must be an identifier for the resource type: com.vmware.content.library.Item.

spec - specification of how the virtual machine should be deployed.

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

deploy

void deploy(java.lang.String templateLibraryItem,
          LibraryItemsTypes.DeploySpec spec,
          AsyncCallback<java.lang.String> asyncCallback,
          InvocationConfig invocationConfig)

Deploys a virtual machine as a copy of the source virtual machine template contained in the library item specified by templateLibraryItem. It uses the deployment specification in spec. If LibraryItemsTypes.DeploySpec.getPoweredOn() and/or LibraryItemsTypes.DeploySpec.getGuestCustomization() are specified, the server triggers the power on and/or guest customization operations, which are executed asynchronously. This method was added in vSphere API 6.7 U1.

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

Operation Errors:
AlreadyExists - if a virtual machine with the name specified by LibraryItemsTypes.DeploySpec.getName() already exists.
Error - if the system reports an error while responding to the request.
InvalidArgument - if spec contains invalid arguments.
NotAllowedInCurrentState - if either a specified host or a specified datastore is in an invalid state for the deployment, such as maintenance mode.
NotFound - if the library item specified by templateLibraryItem cannot be found.
NotFound - if any resource specified by a property of the LibraryItemsTypes.DeploySpec class, specified by spec cannot be found.
ResourceInaccessible - if there was an error accessing the source virtual machine template contained in the library item specified by templateLibraryItem.
ResourceInaccessible - if there an error accessing any of the resources specified in the spec.
ServiceUnavailable - if any of the services involved in the method are unavailable.
UnableToAllocateResource - if there was an error in allocating any of the resources required by the method.
Unauthenticated - if the user that requested the method cannot be authenticated.
Unauthorized - if the user that requested the method is not authorized to perform the method.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires System.Read.
• The resource com.vmware.content.library.Item referenced by the parameter templateLibraryItem requires VirtualMachine.Provisioning.DeployTemplate.
• The resource Datastore referenced by the property LibraryItemsTypes.DeploySpecVmHomeStorage.getDatastore() requires System.Read.
• The resource com.vmware.spbm.StorageProfile referenced by the property LibraryItemsTypes.DeploySpecVmHomeStoragePolicy.getPolicy() requires System.Read.
• The resource Datastore referenced by the property LibraryItemsTypes.DeploySpecDiskStorage.getDatastore() requires System.Read.
• The resource com.vmware.spbm.StorageProfile referenced by the property LibraryItemsTypes.DeploySpecDiskStoragePolicy.getPolicy() requires System.Read.
• The resource com.vmware.vcenter.vm.hardware.Disk referenced by the Map key of property LibraryItemsTypes.DeploySpec.getDiskStorageOverrides() requires System.Read.
• The resource Folder referenced by the property LibraryItemsTypes.DeployPlacementSpec.getFolder() requires System.Read.
• The resource ResourcePool referenced by the property LibraryItemsTypes.DeployPlacementSpec.getResourcePool() requires System.Read.
• The resource HostSystem referenced by the property LibraryItemsTypes.DeployPlacementSpec.getHost() requires System.Read.
• The resource ClusterComputeResource referenced by the property LibraryItemsTypes.DeployPlacementSpec.getCluster() requires System.Read.
• The resource com.vmware.vcenter.vm.hardware.Ethernet referenced by the Map key of property LibraryItemsTypes.HardwareCustomizationSpec.getNics() requires System.Read.
• The resource Network referenced by the property LibraryItemsTypes.EthernetUpdateSpec.getNetwork() requires System.Read.
• The resource com.vmware.vcenter.vm.hardware.Disk referenced by the property LibraryItemsTypes.HardwareCustomizationSpec.getDisksToRemove() requires System.Read.
• The resource com.vmware.vcenter.vm.hardware.Disk referenced by the Map key of property LibraryItemsTypes.HardwareCustomizationSpec.getDisksToUpdate() requires System.Read.

Parameters:

templateLibraryItem - identifier of the content library item containing the source virtual machine template to be deployed. The parameter must be an identifier for the resource type: com.vmware.content.library.Item.

spec - specification of how the virtual machine should be deployed.

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

invocationConfig - Configuration for the method invocation.

get

LibraryItemsTypes.Info get(java.lang.String templateLibraryItem)

Returns information about a virtual machine template contained in the library item specified by templateLibraryItem. This method was added in vSphere API 6.7 U1.

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

Parameters:

templateLibraryItem - identifier of the library item containing the virtual machine template. The parameter must be an identifier for the resource type: com.vmware.content.library.Item.

Returns:

Information about the virtual machine template item contained in the library item. If null, the library item specified by templateLibraryItem does not contain a virtual machine template.

Throws:

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

NotFound - if the library item could not be found.

ResourceInaccessible - if the virtual machine template's configuration state cannot be accessed.

ServiceUnavailable - if any of the services involved in the method are unavailable.

Unauthenticated - if the user that requested the method cannot be authenticated.

Unauthorized - if the user that requested the method is not authorized to perform the method.

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

• Method execution requires System.Read.
• The resource com.vmware.content.library.Item referenced by the parameter templateLibraryItem requires System.Read.

get

LibraryItemsTypes.Info get(java.lang.String templateLibraryItem,
                         InvocationConfig invocationConfig)

Returns information about a virtual machine template contained in the library item specified by templateLibraryItem. This method was added in vSphere API 6.7 U1.

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:

templateLibraryItem - identifier of the library item containing the virtual machine template. The parameter must be an identifier for the resource type: com.vmware.content.library.Item.

invocationConfig - Configuration for the method invocation.

Returns:

Information about the virtual machine template item contained in the library item. If null, the library item specified by templateLibraryItem does not contain a virtual machine template.

Throws:

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

NotFound - if the library item could not be found.

ResourceInaccessible - if the virtual machine template's configuration state cannot be accessed.

ServiceUnavailable - if any of the services involved in the method are unavailable.

Unauthenticated - if the user that requested the method cannot be authenticated.

Unauthorized - if the user that requested the method is not authorized to perform the method.

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

• Method execution requires System.Read.
• The resource com.vmware.content.library.Item referenced by the parameter templateLibraryItem requires System.Read.

get

void get(java.lang.String templateLibraryItem,
       AsyncCallback<LibraryItemsTypes.Info> asyncCallback)

Returns information about a virtual machine template contained in the library item specified by templateLibraryItem. This method was added in vSphere API 6.7 U1.

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

Operation Result:
Information about the virtual machine template item contained in the library item. If null, the library item specified by templateLibraryItem does not contain a virtual machine template.

Operation Errors:
Error - if the system reports an error while responding to the request.
NotFound - if the library item could not be found.
ResourceInaccessible - if the virtual machine template's configuration state cannot be accessed.
ServiceUnavailable - if any of the services involved in the method are unavailable.
Unauthenticated - if the user that requested the method cannot be authenticated.
Unauthorized - if the user that requested the method is not authorized to perform the method.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires System.Read.
• The resource com.vmware.content.library.Item referenced by the parameter templateLibraryItem requires System.Read.

Parameters:

templateLibraryItem - identifier of the library item containing the virtual machine template. The parameter must be an identifier for the resource type: com.vmware.content.library.Item.

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

get

void get(java.lang.String templateLibraryItem,
       AsyncCallback<LibraryItemsTypes.Info> asyncCallback,
       InvocationConfig invocationConfig)

Returns information about a virtual machine template contained in the library item specified by templateLibraryItem. This method was added in vSphere API 6.7 U1.

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 virtual machine template item contained in the library item. If null, the library item specified by templateLibraryItem does not contain a virtual machine template.

Operation Errors:
Error - if the system reports an error while responding to the request.
NotFound - if the library item could not be found.
ResourceInaccessible - if the virtual machine template's configuration state cannot be accessed.
ServiceUnavailable - if any of the services involved in the method are unavailable.
Unauthenticated - if the user that requested the method cannot be authenticated.
Unauthorized - if the user that requested the method is not authorized to perform the method.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires System.Read.
• The resource com.vmware.content.library.Item referenced by the parameter templateLibraryItem requires System.Read.

Parameters:

templateLibraryItem - identifier of the library item containing the virtual machine template. The parameter must be an identifier for the resource type: com.vmware.content.library.Item.

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

invocationConfig - Configuration for the method invocation.