com.vmware.vcenter.ovf

Interface LibraryItem

All Superinterfaces:

LibraryItemTypes, Service

All Known Implementing Classes:

LibraryItemStub

public interface LibraryItem
extends Service, LibraryItemTypes

The LibraryItem interface provides methods to deploy virtual machines and virtual appliances from library items containing Open Virtualization Format (OVF) packages in content library, as well as methods to create library items in content library from virtual machines and virtual appliances.

To deploy a virtual machine or a virtual appliance from a library item:

1. Create a LibraryItemTypes.DeploymentTarget to specify the target deployment type and target deployment designation.
2. Create a LibraryItemTypes.ResourcePoolDeploymentSpec to specify the parameters for the target deployment.
3. Use the deploy() method with the created target and parameter specifications, along with the identifier of the specified source content library item. See deploy(java.lang.String, java.lang.String, com.vmware.vcenter.ovf.LibraryItemTypes.DeploymentTarget, com.vmware.vcenter.ovf.LibraryItemTypes.ResourcePoolDeploymentSpec).

To create a library item in content library from a virtual machine or virtual appliance:

1. Create a LibraryItemTypes.DeployableIdentity to specify the source virtual machine or virtual appliance to be used as the OVF template source.
2. Create a LibraryItemTypes.CreateTarget to specify the target library and library item.
3. Create a LibraryItemTypes.CreateSpec to specify the settings for the OVF package to be created.
4. Use the create() method with the created target and parameter specifications, along with the specified source entity. See create(java.lang.String, com.vmware.vcenter.ovf.LibraryItemTypes.DeployableIdentity, com.vmware.vcenter.ovf.LibraryItemTypes.CreateTarget, com.vmware.vcenter.ovf.LibraryItemTypes.CreateSpec).

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.vcenter.ovf.LibraryItemTypes

LibraryItemTypes.CreateResult, LibraryItemTypes.CreateSpec, LibraryItemTypes.CreateTarget, LibraryItemTypes.DeployableIdentity, LibraryItemTypes.DeploymentResult, LibraryItemTypes.DeploymentTarget, LibraryItemTypes.OvfSummary, LibraryItemTypes.ResourcePoolDeploymentSpec, LibraryItemTypes.ResultInfo, LibraryItemTypes.StorageGroupMapping

Field Summary

Fields inherited from interface com.vmware.vcenter.ovf.LibraryItemTypes

DEPLOYABLE

Method Summary

Methods

Modifier and Type	Method and Description
LibraryItemTypes.CreateResult	create(String clientToken, LibraryItemTypes.DeployableIdentity source, LibraryItemTypes.CreateTarget target, LibraryItemTypes.CreateSpec createSpec) Creates a library item in content library from a virtual machine or virtual appliance.
void	create(String clientToken, LibraryItemTypes.DeployableIdentity source, LibraryItemTypes.CreateTarget target, LibraryItemTypes.CreateSpec createSpec, AsyncCallback<LibraryItemTypes.CreateResult> asyncCallback) Creates a library item in content library from a virtual machine or virtual appliance.
void	create(String clientToken, LibraryItemTypes.DeployableIdentity source, LibraryItemTypes.CreateTarget target, LibraryItemTypes.CreateSpec createSpec, AsyncCallback<LibraryItemTypes.CreateResult> asyncCallback, InvocationConfig invocationConfig) Creates a library item in content library from a virtual machine or virtual appliance.
LibraryItemTypes.CreateResult	create(String clientToken, LibraryItemTypes.DeployableIdentity source, LibraryItemTypes.CreateTarget target, LibraryItemTypes.CreateSpec createSpec, InvocationConfig invocationConfig) Creates a library item in content library from a virtual machine or virtual appliance.
LibraryItemTypes.DeploymentResult	deploy(String clientToken, String ovfLibraryItemId, LibraryItemTypes.DeploymentTarget target, LibraryItemTypes.ResourcePoolDeploymentSpec deploymentSpec) Deploys an OVF package stored in content library to a newly created virtual machine or virtual appliance.
void	deploy(String clientToken, String ovfLibraryItemId, LibraryItemTypes.DeploymentTarget target, LibraryItemTypes.ResourcePoolDeploymentSpec deploymentSpec, AsyncCallback<LibraryItemTypes.DeploymentResult> asyncCallback) Deploys an OVF package stored in content library to a newly created virtual machine or virtual appliance.
void	deploy(String clientToken, String ovfLibraryItemId, LibraryItemTypes.DeploymentTarget target, LibraryItemTypes.ResourcePoolDeploymentSpec deploymentSpec, AsyncCallback<LibraryItemTypes.DeploymentResult> asyncCallback, InvocationConfig invocationConfig) Deploys an OVF package stored in content library to a newly created virtual machine or virtual appliance.
LibraryItemTypes.DeploymentResult	deploy(String clientToken, String ovfLibraryItemId, LibraryItemTypes.DeploymentTarget target, LibraryItemTypes.ResourcePoolDeploymentSpec deploymentSpec, InvocationConfig invocationConfig) Deploys an OVF package stored in content library to a newly created virtual machine or virtual appliance.
LibraryItemTypes.OvfSummary	filter(String ovfLibraryItemId, LibraryItemTypes.DeploymentTarget target) Queries an OVF package stored in content library to retrieve information to use when deploying the package.
void	filter(String ovfLibraryItemId, LibraryItemTypes.DeploymentTarget target, AsyncCallback<LibraryItemTypes.OvfSummary> asyncCallback) Queries an OVF package stored in content library to retrieve information to use when deploying the package.
void	filter(String ovfLibraryItemId, LibraryItemTypes.DeploymentTarget target, AsyncCallback<LibraryItemTypes.OvfSummary> asyncCallback, InvocationConfig invocationConfig) Queries an OVF package stored in content library to retrieve information to use when deploying the package.
LibraryItemTypes.OvfSummary	filter(String ovfLibraryItemId, LibraryItemTypes.DeploymentTarget target, InvocationConfig invocationConfig) Queries an OVF package stored in content library to retrieve information to use when deploying the package.

Method Detail

deploy

LibraryItemTypes.DeploymentResult deploy(String clientToken,
                                       String ovfLibraryItemId,
                                       LibraryItemTypes.DeploymentTarget target,
                                       LibraryItemTypes.ResourcePoolDeploymentSpec deploymentSpec)

Deploys an OVF package stored in content library to a newly created virtual machine or virtual appliance.

This method deploys an OVF package which is stored in the library item specified by ovfLibraryItemId. It uses the deployment specification in deploymentSpec to deploy the OVF package to the location specified by target.

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

Parameters:

clientToken - Client-generated token used to retry a request if the client fails to get a response from the server. If the original request succeeded, the result of that request will be returned, otherwise the operation will be retried. If null, the server will create a token.

ovfLibraryItemId - Identifier of the content library item containing the OVF package to be deployed. The parameter must be an identifier for the resource type: com.vmware.content.library.Item.

target - Specification of the deployment target.

deploymentSpec - Specification of how the OVF package should be deployed to the target.

Returns:

Information about the success or failure of the method, along with the details of the result or failure.

Throws:

InvalidArgument - if target contains invalid arguments.

InvalidArgument - if deploymentSpec contains invalid arguments or has properties that are inconsistent with target.

NotFound - if the library item specified by ovfLibraryItemId does not exist.

NotFound - if any resource specified by a property of the LibraryItemTypes.DeploymentTarget class, specified by target, does not exist.

ResourceInaccessible - if there was an error accessing the OVF package stored in the library item specified by ovfLibraryItemId.

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

• Method execution requires VirtualMachine.Config.AddNewDisk if the OVF descriptor has a disk drive (type 17) section.
• Method execution requires VirtualMachine.Config.AdvancedConfig if the OVF descriptor has an ExtraConfig section.
• Method execution requires Extension.Register for specified resource group if the OVF descriptor has a vServiceDependency section.
• Method execution requires Network.Assign for target network if specified.
• Method execution requires Datastore.AllocateSpace for target datastore if specified.

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 ovfLibraryItemId requires System.Read.
• The resource HostSystem referenced by the property LibraryItemTypes.DeploymentTarget.getHostId() requires System.Read.
• The resource Network referenced by the Map value of property LibraryItemTypes.ResourcePoolDeploymentSpec.getNetworkMappings() requires System.Read.
• The resource StorageProfile referenced by the property LibraryItemTypes.ResourcePoolDeploymentSpec.getStorageProfileId() requires System.Read.
• The resource Datastore referenced by the property LibraryItemTypes.ResourcePoolDeploymentSpec.getDefaultDatastoreId() requires System.Read.
• The resource ResourcePool referenced by the property LibraryItemTypes.DeploymentTarget.getResourcePoolId() requires VApp.Import.
• The resource Folder referenced by the property LibraryItemTypes.DeploymentTarget.getFolderId() requires VApp.Import.

deploy

LibraryItemTypes.DeploymentResult deploy(String clientToken,
                                       String ovfLibraryItemId,
                                       LibraryItemTypes.DeploymentTarget target,
                                       LibraryItemTypes.ResourcePoolDeploymentSpec deploymentSpec,
                                       InvocationConfig invocationConfig)

Deploys an OVF package stored in content library to a newly created virtual machine or virtual appliance.

This method deploys an OVF package which is stored in the library item specified by ovfLibraryItemId. It uses the deployment specification in deploymentSpec to deploy the OVF package to the location specified by target.

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:

clientToken - Client-generated token used to retry a request if the client fails to get a response from the server. If the original request succeeded, the result of that request will be returned, otherwise the operation will be retried. If null, the server will create a token.

ovfLibraryItemId - Identifier of the content library item containing the OVF package to be deployed. The parameter must be an identifier for the resource type: com.vmware.content.library.Item.

target - Specification of the deployment target.

deploymentSpec - Specification of how the OVF package should be deployed to the target.

invocationConfig - Configuration for the method invocation.

Returns:

Information about the success or failure of the method, along with the details of the result or failure.

Throws:

InvalidArgument - if target contains invalid arguments.

InvalidArgument - if deploymentSpec contains invalid arguments or has properties that are inconsistent with target.

NotFound - if the library item specified by ovfLibraryItemId does not exist.

NotFound - if any resource specified by a property of the LibraryItemTypes.DeploymentTarget class, specified by target, does not exist.

ResourceInaccessible - if there was an error accessing the OVF package stored in the library item specified by ovfLibraryItemId.

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

• Method execution requires VirtualMachine.Config.AddNewDisk if the OVF descriptor has a disk drive (type 17) section.
• Method execution requires VirtualMachine.Config.AdvancedConfig if the OVF descriptor has an ExtraConfig section.
• Method execution requires Extension.Register for specified resource group if the OVF descriptor has a vServiceDependency section.
• Method execution requires Network.Assign for target network if specified.
• Method execution requires Datastore.AllocateSpace for target datastore if specified.

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 ovfLibraryItemId requires System.Read.
• The resource HostSystem referenced by the property LibraryItemTypes.DeploymentTarget.getHostId() requires System.Read.
• The resource Network referenced by the Map value of property LibraryItemTypes.ResourcePoolDeploymentSpec.getNetworkMappings() requires System.Read.
• The resource StorageProfile referenced by the property LibraryItemTypes.ResourcePoolDeploymentSpec.getStorageProfileId() requires System.Read.
• The resource Datastore referenced by the property LibraryItemTypes.ResourcePoolDeploymentSpec.getDefaultDatastoreId() requires System.Read.
• The resource ResourcePool referenced by the property LibraryItemTypes.DeploymentTarget.getResourcePoolId() requires VApp.Import.
• The resource Folder referenced by the property LibraryItemTypes.DeploymentTarget.getFolderId() requires VApp.Import.

deploy

void deploy(String clientToken,
          String ovfLibraryItemId,
          LibraryItemTypes.DeploymentTarget target,
          LibraryItemTypes.ResourcePoolDeploymentSpec deploymentSpec,
          AsyncCallback<LibraryItemTypes.DeploymentResult> asyncCallback)

Deploys an OVF package stored in content library to a newly created virtual machine or virtual appliance.

This method deploys an OVF package which is stored in the library item specified by ovfLibraryItemId. It uses the deployment specification in deploymentSpec to deploy the OVF package to the location specified by target.

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

Operation Result:
Information about the success or failure of the method, along with the details of the result or failure.

Operation Errors:
InvalidArgument - if target contains invalid arguments.
InvalidArgument - if deploymentSpec contains invalid arguments or has properties that are inconsistent with target.
NotFound - if the library item specified by ovfLibraryItemId does not exist.
NotFound - if any resource specified by a property of the LibraryItemTypes.DeploymentTarget class, specified by target, does not exist.
ResourceInaccessible - if there was an error accessing the OVF package stored in the library item specified by ovfLibraryItemId.
Unauthorized - if you do not have all of the privileges described as follows :

• Method execution requires VirtualMachine.Config.AddNewDisk if the OVF descriptor has a disk drive (type 17) section.
• Method execution requires VirtualMachine.Config.AdvancedConfig if the OVF descriptor has an ExtraConfig section.
• Method execution requires Extension.Register for specified resource group if the OVF descriptor has a vServiceDependency section.
• Method execution requires Network.Assign for target network if specified.
• Method execution requires Datastore.AllocateSpace for target datastore if specified.

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 ovfLibraryItemId requires System.Read.
• The resource HostSystem referenced by the property LibraryItemTypes.DeploymentTarget.getHostId() requires System.Read.
• The resource Network referenced by the Map value of property LibraryItemTypes.ResourcePoolDeploymentSpec.getNetworkMappings() requires System.Read.
• The resource StorageProfile referenced by the property LibraryItemTypes.ResourcePoolDeploymentSpec.getStorageProfileId() requires System.Read.
• The resource Datastore referenced by the property LibraryItemTypes.ResourcePoolDeploymentSpec.getDefaultDatastoreId() requires System.Read.
• The resource ResourcePool referenced by the property LibraryItemTypes.DeploymentTarget.getResourcePoolId() requires VApp.Import.
• The resource Folder referenced by the property LibraryItemTypes.DeploymentTarget.getFolderId() requires VApp.Import.

Parameters:

clientToken - Client-generated token used to retry a request if the client fails to get a response from the server. If the original request succeeded, the result of that request will be returned, otherwise the operation will be retried. If null, the server will create a token.

ovfLibraryItemId - Identifier of the content library item containing the OVF package to be deployed. The parameter must be an identifier for the resource type: com.vmware.content.library.Item.

target - Specification of the deployment target.

deploymentSpec - Specification of how the OVF package should be deployed to the target.

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

deploy

void deploy(String clientToken,
          String ovfLibraryItemId,
          LibraryItemTypes.DeploymentTarget target,
          LibraryItemTypes.ResourcePoolDeploymentSpec deploymentSpec,
          AsyncCallback<LibraryItemTypes.DeploymentResult> asyncCallback,
          InvocationConfig invocationConfig)

Deploys an OVF package stored in content library to a newly created virtual machine or virtual appliance.

This method deploys an OVF package which is stored in the library item specified by ovfLibraryItemId. It uses the deployment specification in deploymentSpec to deploy the OVF package to the location specified by target.

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 success or failure of the method, along with the details of the result or failure.

Operation Errors:
InvalidArgument - if target contains invalid arguments.
InvalidArgument - if deploymentSpec contains invalid arguments or has properties that are inconsistent with target.
NotFound - if the library item specified by ovfLibraryItemId does not exist.
NotFound - if any resource specified by a property of the LibraryItemTypes.DeploymentTarget class, specified by target, does not exist.
ResourceInaccessible - if there was an error accessing the OVF package stored in the library item specified by ovfLibraryItemId.
Unauthorized - if you do not have all of the privileges described as follows :

• Method execution requires VirtualMachine.Config.AddNewDisk if the OVF descriptor has a disk drive (type 17) section.
• Method execution requires VirtualMachine.Config.AdvancedConfig if the OVF descriptor has an ExtraConfig section.
• Method execution requires Extension.Register for specified resource group if the OVF descriptor has a vServiceDependency section.
• Method execution requires Network.Assign for target network if specified.
• Method execution requires Datastore.AllocateSpace for target datastore if specified.

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 ovfLibraryItemId requires System.Read.
• The resource HostSystem referenced by the property LibraryItemTypes.DeploymentTarget.getHostId() requires System.Read.
• The resource Network referenced by the Map value of property LibraryItemTypes.ResourcePoolDeploymentSpec.getNetworkMappings() requires System.Read.
• The resource StorageProfile referenced by the property LibraryItemTypes.ResourcePoolDeploymentSpec.getStorageProfileId() requires System.Read.
• The resource Datastore referenced by the property LibraryItemTypes.ResourcePoolDeploymentSpec.getDefaultDatastoreId() requires System.Read.
• The resource ResourcePool referenced by the property LibraryItemTypes.DeploymentTarget.getResourcePoolId() requires VApp.Import.
• The resource Folder referenced by the property LibraryItemTypes.DeploymentTarget.getFolderId() requires VApp.Import.

Parameters:

clientToken - Client-generated token used to retry a request if the client fails to get a response from the server. If the original request succeeded, the result of that request will be returned, otherwise the operation will be retried. If null, the server will create a token.

ovfLibraryItemId - Identifier of the content library item containing the OVF package to be deployed. The parameter must be an identifier for the resource type: com.vmware.content.library.Item.

target - Specification of the deployment target.

deploymentSpec - Specification of how the OVF package should be deployed to the target.

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

invocationConfig - Configuration for the method invocation.

filter

LibraryItemTypes.OvfSummary filter(String ovfLibraryItemId,
                                 LibraryItemTypes.DeploymentTarget target)

Queries an OVF package stored in content library to retrieve information to use when deploying the package. See deploy(java.lang.String, java.lang.String, com.vmware.vcenter.ovf.LibraryItemTypes.DeploymentTarget, com.vmware.vcenter.ovf.LibraryItemTypes.ResourcePoolDeploymentSpec).

This method retrieves information from the descriptor of the OVF package stored in the library item specified by ovfLibraryItemId. The information returned by the method can be used to populate the deployment specification (see LibraryItemTypes.ResourcePoolDeploymentSpec when deploying the OVF package to the deployment target specified by target.

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

Parameters:

ovfLibraryItemId - Identifier of the content library item containing the OVF package to query. The parameter must be an identifier for the resource type: com.vmware.content.library.Item.

target - Specification of the deployment target.

Returns:

Information that can be used to populate the deployment specification (see LibraryItemTypes.ResourcePoolDeploymentSpec) when deploying the OVF package to the deployment target specified by target.

Throws:

InvalidArgument - if target contains invalid arguments.

NotFound - if the library item specified by ovfLibraryItemId does not exist.

NotFound - if any resource specified by a property of the LibraryItemTypes.DeploymentTarget class, specified by target, does not exist.

ResourceInaccessible - if there was an error accessing the OVF package at the specified ovfLibraryItemId.

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 ovfLibraryItemId requires System.Read.
• The resource ResourcePool referenced by the property LibraryItemTypes.DeploymentTarget.getResourcePoolId() requires System.Read.
• The resource HostSystem referenced by the property LibraryItemTypes.DeploymentTarget.getHostId() requires System.Read.
• The resource Folder referenced by the property LibraryItemTypes.DeploymentTarget.getFolderId() requires System.Read.

filter

LibraryItemTypes.OvfSummary filter(String ovfLibraryItemId,
                                 LibraryItemTypes.DeploymentTarget target,
                                 InvocationConfig invocationConfig)

Queries an OVF package stored in content library to retrieve information to use when deploying the package. See deploy(java.lang.String, java.lang.String, com.vmware.vcenter.ovf.LibraryItemTypes.DeploymentTarget, com.vmware.vcenter.ovf.LibraryItemTypes.ResourcePoolDeploymentSpec).

This method retrieves information from the descriptor of the OVF package stored in the library item specified by ovfLibraryItemId. The information returned by the method can be used to populate the deployment specification (see LibraryItemTypes.ResourcePoolDeploymentSpec when deploying the OVF package to the deployment target specified by target.

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:

ovfLibraryItemId - Identifier of the content library item containing the OVF package to query. The parameter must be an identifier for the resource type: com.vmware.content.library.Item.

target - Specification of the deployment target.

invocationConfig - Configuration for the method invocation.

Returns:

Information that can be used to populate the deployment specification (see LibraryItemTypes.ResourcePoolDeploymentSpec) when deploying the OVF package to the deployment target specified by target.

Throws:

InvalidArgument - if target contains invalid arguments.

NotFound - if the library item specified by ovfLibraryItemId does not exist.

NotFound - if any resource specified by a property of the LibraryItemTypes.DeploymentTarget class, specified by target, does not exist.

ResourceInaccessible - if there was an error accessing the OVF package at the specified ovfLibraryItemId.

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 ovfLibraryItemId requires System.Read.
• The resource ResourcePool referenced by the property LibraryItemTypes.DeploymentTarget.getResourcePoolId() requires System.Read.
• The resource HostSystem referenced by the property LibraryItemTypes.DeploymentTarget.getHostId() requires System.Read.
• The resource Folder referenced by the property LibraryItemTypes.DeploymentTarget.getFolderId() requires System.Read.

filter

void filter(String ovfLibraryItemId,
          LibraryItemTypes.DeploymentTarget target,
          AsyncCallback<LibraryItemTypes.OvfSummary> asyncCallback)

Queries an OVF package stored in content library to retrieve information to use when deploying the package. See deploy(java.lang.String, java.lang.String, com.vmware.vcenter.ovf.LibraryItemTypes.DeploymentTarget, com.vmware.vcenter.ovf.LibraryItemTypes.ResourcePoolDeploymentSpec).

This method retrieves information from the descriptor of the OVF package stored in the library item specified by ovfLibraryItemId. The information returned by the method can be used to populate the deployment specification (see LibraryItemTypes.ResourcePoolDeploymentSpec when deploying the OVF package to the deployment target specified by target.

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

Operation Result:
Information that can be used to populate the deployment specification (see LibraryItemTypes.ResourcePoolDeploymentSpec) when deploying the OVF package to the deployment target specified by target.

Operation Errors:
InvalidArgument - if target contains invalid arguments.
NotFound - if the library item specified by ovfLibraryItemId does not exist.
NotFound - if any resource specified by a property of the LibraryItemTypes.DeploymentTarget class, specified by target, does not exist.
ResourceInaccessible - if there was an error accessing the OVF package at the specified ovfLibraryItemId.
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 ovfLibraryItemId requires System.Read.
• The resource ResourcePool referenced by the property LibraryItemTypes.DeploymentTarget.getResourcePoolId() requires System.Read.
• The resource HostSystem referenced by the property LibraryItemTypes.DeploymentTarget.getHostId() requires System.Read.
• The resource Folder referenced by the property LibraryItemTypes.DeploymentTarget.getFolderId() requires System.Read.

Parameters:

ovfLibraryItemId - Identifier of the content library item containing the OVF package to query. The parameter must be an identifier for the resource type: com.vmware.content.library.Item.

target - Specification of the deployment target.

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

filter

void filter(String ovfLibraryItemId,
          LibraryItemTypes.DeploymentTarget target,
          AsyncCallback<LibraryItemTypes.OvfSummary> asyncCallback,
          InvocationConfig invocationConfig)

Queries an OVF package stored in content library to retrieve information to use when deploying the package. See deploy(java.lang.String, java.lang.String, com.vmware.vcenter.ovf.LibraryItemTypes.DeploymentTarget, com.vmware.vcenter.ovf.LibraryItemTypes.ResourcePoolDeploymentSpec).

This method retrieves information from the descriptor of the OVF package stored in the library item specified by ovfLibraryItemId. The information returned by the method can be used to populate the deployment specification (see LibraryItemTypes.ResourcePoolDeploymentSpec when deploying the OVF package to the deployment target specified by target.

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 that can be used to populate the deployment specification (see LibraryItemTypes.ResourcePoolDeploymentSpec) when deploying the OVF package to the deployment target specified by target.

Operation Errors:
InvalidArgument - if target contains invalid arguments.
NotFound - if the library item specified by ovfLibraryItemId does not exist.
NotFound - if any resource specified by a property of the LibraryItemTypes.DeploymentTarget class, specified by target, does not exist.
ResourceInaccessible - if there was an error accessing the OVF package at the specified ovfLibraryItemId.
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 ovfLibraryItemId requires System.Read.
• The resource ResourcePool referenced by the property LibraryItemTypes.DeploymentTarget.getResourcePoolId() requires System.Read.
• The resource HostSystem referenced by the property LibraryItemTypes.DeploymentTarget.getHostId() requires System.Read.
• The resource Folder referenced by the property LibraryItemTypes.DeploymentTarget.getFolderId() requires System.Read.

Parameters:

ovfLibraryItemId - Identifier of the content library item containing the OVF package to query. The parameter must be an identifier for the resource type: com.vmware.content.library.Item.

target - Specification of the deployment target.

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

invocationConfig - Configuration for the method invocation.

create

LibraryItemTypes.CreateResult create(String clientToken,
                                   LibraryItemTypes.DeployableIdentity source,
                                   LibraryItemTypes.CreateTarget target,
                                   LibraryItemTypes.CreateSpec createSpec)

Creates a library item in content library from a virtual machine or virtual appliance.

This method creates a library item in content library whose content is an OVF package derived from a source virtual machine or virtual appliance, using the supplied create specification. The OVF package may be stored as in a newly created library item or in an in an existing library item. For an existing library item whose content is updated by this method, the original content is overwritten.

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

Parameters:

clientToken - Client-generated token used to retry a request if the client fails to get a response from the server. If the original request succeeded, the result of that request will be returned, otherwise the operation will be retried. If null, the server will create a token.

source - Identifier of the virtual machine or virtual appliance to use as the source.

target - Specification of the target content library and library item.

createSpec - Information used to create the OVF package from the source virtual machine or virtual appliance.

Returns:

Information about the success or failure of the method, along with the details of the result or failure.

Throws:

InvalidArgument - if createSpec contains invalid arguments.

InvalidArgument - if source describes an unexpected resource type.

NotFound - if the virtual machine or virtual appliance specified by source does not exist.

NotFound - if the library or library item specified by target does not exist.

NotAllowedInCurrentState - if the operation cannot be performed because of the specified virtual machine or virtual appliance's current state. For example, if the virtual machine configuration information is not available, or if the virtual appliance is running.

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

ResourceBusy - if the specified virtual machine or virtual appliance is busy.

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

• Method execution requires System.Read.
• The property LibraryItemTypes.DeployableIdentity.getId() requires VApp.Export.
• The resource com.vmware.content.Library referenced by the property LibraryItemTypes.CreateTarget.getLibraryId() requires ContentLibrary.AddLibraryItem.
• The resource com.vmware.content.library.Item referenced by the property LibraryItemTypes.CreateTarget.getLibraryItemId() requires System.Read.

create

LibraryItemTypes.CreateResult create(String clientToken,
                                   LibraryItemTypes.DeployableIdentity source,
                                   LibraryItemTypes.CreateTarget target,
                                   LibraryItemTypes.CreateSpec createSpec,
                                   InvocationConfig invocationConfig)

Creates a library item in content library from a virtual machine or virtual appliance.

This method creates a library item in content library whose content is an OVF package derived from a source virtual machine or virtual appliance, using the supplied create specification. The OVF package may be stored as in a newly created library item or in an in an existing library item. For an existing library item whose content is updated by this method, the original content is overwritten.

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:

clientToken - Client-generated token used to retry a request if the client fails to get a response from the server. If the original request succeeded, the result of that request will be returned, otherwise the operation will be retried. If null, the server will create a token.

source - Identifier of the virtual machine or virtual appliance to use as the source.

target - Specification of the target content library and library item.

createSpec - Information used to create the OVF package from the source virtual machine or virtual appliance.

invocationConfig - Configuration for the method invocation.

Returns:

Information about the success or failure of the method, along with the details of the result or failure.

Throws:

InvalidArgument - if createSpec contains invalid arguments.

InvalidArgument - if source describes an unexpected resource type.

NotFound - if the virtual machine or virtual appliance specified by source does not exist.

NotFound - if the library or library item specified by target does not exist.

NotAllowedInCurrentState - if the operation cannot be performed because of the specified virtual machine or virtual appliance's current state. For example, if the virtual machine configuration information is not available, or if the virtual appliance is running.

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

ResourceBusy - if the specified virtual machine or virtual appliance is busy.

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

• Method execution requires System.Read.
• The property LibraryItemTypes.DeployableIdentity.getId() requires VApp.Export.
• The resource com.vmware.content.Library referenced by the property LibraryItemTypes.CreateTarget.getLibraryId() requires ContentLibrary.AddLibraryItem.
• The resource com.vmware.content.library.Item referenced by the property LibraryItemTypes.CreateTarget.getLibraryItemId() requires System.Read.

create

void create(String clientToken,
          LibraryItemTypes.DeployableIdentity source,
          LibraryItemTypes.CreateTarget target,
          LibraryItemTypes.CreateSpec createSpec,
          AsyncCallback<LibraryItemTypes.CreateResult> asyncCallback)

Creates a library item in content library from a virtual machine or virtual appliance.

This method creates a library item in content library whose content is an OVF package derived from a source virtual machine or virtual appliance, using the supplied create specification. The OVF package may be stored as in a newly created library item or in an in an existing library item. For an existing library item whose content is updated by this method, the original content is overwritten.

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

Operation Result:
Information about the success or failure of the method, along with the details of the result or failure.

Operation Errors:
InvalidArgument - if createSpec contains invalid arguments.
InvalidArgument - if source describes an unexpected resource type.
NotFound - if the virtual machine or virtual appliance specified by source does not exist.
NotFound - if the library or library item specified by target does not exist.
NotAllowedInCurrentState - if the operation cannot be performed because of the specified virtual machine or virtual appliance's current state. For example, if the virtual machine configuration information is not available, or if the virtual appliance is running.
ResourceInaccessible - if there was an error accessing a file from the source virtual machine or virtual appliance.
ResourceBusy - if the specified virtual machine or virtual appliance is busy.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires System.Read.
• The property LibraryItemTypes.DeployableIdentity.getId() requires VApp.Export.
• The resource com.vmware.content.Library referenced by the property LibraryItemTypes.CreateTarget.getLibraryId() requires ContentLibrary.AddLibraryItem.
• The resource com.vmware.content.library.Item referenced by the property LibraryItemTypes.CreateTarget.getLibraryItemId() requires System.Read.

Parameters:

clientToken - Client-generated token used to retry a request if the client fails to get a response from the server. If the original request succeeded, the result of that request will be returned, otherwise the operation will be retried. If null, the server will create a token.

source - Identifier of the virtual machine or virtual appliance to use as the source.

target - Specification of the target content library and library item.

createSpec - Information used to create the OVF package from the source virtual machine or virtual appliance.

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

create

void create(String clientToken,
          LibraryItemTypes.DeployableIdentity source,
          LibraryItemTypes.CreateTarget target,
          LibraryItemTypes.CreateSpec createSpec,
          AsyncCallback<LibraryItemTypes.CreateResult> asyncCallback,
          InvocationConfig invocationConfig)

Creates a library item in content library from a virtual machine or virtual appliance.

This method creates a library item in content library whose content is an OVF package derived from a source virtual machine or virtual appliance, using the supplied create specification. The OVF package may be stored as in a newly created library item or in an in an existing library item. For an existing library item whose content is updated by this method, the original content is overwritten.

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 success or failure of the method, along with the details of the result or failure.

Operation Errors:
InvalidArgument - if createSpec contains invalid arguments.
InvalidArgument - if source describes an unexpected resource type.
NotFound - if the virtual machine or virtual appliance specified by source does not exist.
NotFound - if the library or library item specified by target does not exist.
NotAllowedInCurrentState - if the operation cannot be performed because of the specified virtual machine or virtual appliance's current state. For example, if the virtual machine configuration information is not available, or if the virtual appliance is running.
ResourceInaccessible - if there was an error accessing a file from the source virtual machine or virtual appliance.
ResourceBusy - if the specified virtual machine or virtual appliance is busy.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires System.Read.
• The property LibraryItemTypes.DeployableIdentity.getId() requires VApp.Export.
• The resource com.vmware.content.Library referenced by the property LibraryItemTypes.CreateTarget.getLibraryId() requires ContentLibrary.AddLibraryItem.
• The resource com.vmware.content.library.Item referenced by the property LibraryItemTypes.CreateTarget.getLibraryItemId() requires System.Read.

Parameters:

clientToken - Client-generated token used to retry a request if the client fails to get a response from the server. If the original request succeeded, the result of that request will be returned, otherwise the operation will be retried. If null, the server will create a token.

source - Identifier of the virtual machine or virtual appliance to use as the source.

target - Specification of the target content library and library item.

createSpec - Information used to create the OVF package from the source virtual machine or virtual appliance.

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

invocationConfig - Configuration for the method invocation.