Ovf APIs
The vcenter ovf package provides services to capture and deploy Open Virtualization Format (OVF) packages to and from the content library. It provides the ability to deploy OVF packages from the content library with support for advanced network topologies, network services, creating virtual appliances and virtual machines in hosts, resource pools or clusters. It also provides the ability to export virtual appliances and virtual machines from hosts, resource pools or clusters as OVF packages to the content library.
The Capability service provides operations for retrieving information about the capabilities supported by the OVF service server. Note: This service is restricted for VMware internal use only.
The ExportFlag service provides operations for retrieving information about the export flags supported by the server. Export flags can be specified in a LibraryItem.CreateSpec to customize an OVF export.
The ExportSession service provides operations to export a virtual machine or virtual appliance as an OVF package. The OVF package can either be downloaded using HTTP GETs or directly transferred to a content library. The export session is represented by an ExportSession.Info resource, which includes the current state of the transfer and also provides the list of files that can be downloaded.
Note: This service is restricted for VMware internal use only.
The ImportFlag service provides operations for retrieving information about the import flags supported by the deployment platform. Import flags can be specified in a LibraryItem.ResourcePoolDeploymentSpec to customize an OVF deployment.
The ImportSession service provides operations to import an OVF package. OVF package data can be transferred by the server pulling them from a HTTP(S) source or a content library item, or the client can push them using HTTP(S) PUT requests.
An OVF import proceeds as follows:
Create import session: Create import session object by specifying the source type (ImportSession.SourceType). Wait for descriptor: Wait for the OVF descriptor and localization bundles to be available. Query options: Querying the import session for OVF instantiation parameters. Select parameters: Selecting instantiation parameters. Instantiate: Initiate instantiate. Wait for completion: Wait for completion and push files if this is a push upload.
The steps query option/select parameters can happen multiple times. For example, an OVF deployment wizard would typically query for parameters multiple times to get more specific information about possible values for instantiation parameters, as well as validating the provided values as the user progresses through the wizard.
Concurrent import of files is supported. For push import the client can push multiple files at the same time.
Note: This service is restricted for VMware internal use only.
The LibraryItem service provides operations to identify virtual machines managed by Content Library.
The ProbeImportSession service provides operations to dry-run an import of an OVF package without having selected a target. This can be used for querying instantiation parameters such as name and EULA that are not dependent on the target. Parameters that depend on the target such as networks are omitted. Once a target has been chosen, a new session must be created with ImportSession. The probe session cannot be instantiated or altered to refer to a target.
Note: This service is restricted for VMware internal use only.