Ovf Import Session APIs

Ovf Import Session APIs

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.

Operations
POST
Create For Resource Pool Resource Pool Internal
Creates an import session that can instantiate an OVF package to a resource pool. This operation is idempotent. Two calls with the same client token will receive the same import session object. if you do not have all of the privileges described as follows: - Operation execution requires System.Read. - The resource ResourcePool referenced by the parameter resourcePool requires System.Read. - The resource HostSystem referenced by the parameter hostSystem requires System.Read. - The resource Folder referenced by the parameter folder requires System.Read. - The resource com.vmware.content.library.Item referenced by the attribute ImportSession.CreateSpec.content-library-item requires System.Read.
DELETE
Delete Id Import Session Internal
Deletes (or cancels) an import session. A client should terminate a session to free up resources on the server. An import session will automatically be reclaimed after a period of inactivity. For example it will only remain in IMPORT_ERROR and IMPORT_COMPLETED state for a period of time. if you do not have all of the privileges described as follows: - Operation execution requires System.Read. - The resource com.vmware.vcenter.OvfImportSession referenced by the parameter id requires System.Read.
GET
Get Id Import Session Internal
Retrieves information about an import session. if you do not have all of the privileges described as follows: - Operation execution requires System.Read. - The resource com.vmware.vcenter.OvfImportSession referenced by the parameter id requires System.Read.
POST
Instantiate Id Internal
Instantiates the virtual machine or virtual appliance. This method is only valid to call with an import session in state IMPORT_SELECTING_OVF_PARAMS. During the execution of this method the session state will progress over IMPORT_FILE_TRANSFER and IMPORT_INSTANTIATING to IMPORT_COMPLETED. This method must be called to complete the session. After the call it is an error to call instantiate. if you do not have all of the privileges described as follows: - Operation execution requires System.Read. - The resource com.vmware.vcenter.OvfImportSession referenced by the parameter id requires System.Read.
POST
Preview Ovf Import Session Internal
Do a preview of an OVF descriptor. This can be used to get an overview of the required files that need to be transferred, and basic validation result during an OVF template import. The OVF descriptor can be in plain text or compressed by gzip and followed by base64 encoding. Note that the compression must be gzip and must be encoded with base64 after compression, otherwise InvalidArgument exception will be thrown. if you do not have all of the privileges described as follows: - Operation execution requires System.Read.
POST
Probe Ovf Import Session Internal
if you do not have all of the privileges described as follows: - Operation execution requires System.Read.
POST
Progress Id Internal
Used by the client to set the progress of disk upload when the source type is PUSH_SOURCE. Should be called regularly to keep the given export session alive. if you do not have all of the privileges described as follows: - Operation execution requires System.Read. - The resource com.vmware.vcenter.OvfImportSession referenced by the parameter id requires System.Read.
POST
Try Instantiate Id Internal
Returns information about the instantiation parameters that can be specified for the import session when an import session is in the IMPORT_SELECTING_OVF_PARAMS state. The instantiation parameters returned may depend on the choices specified in any instantiation parameters provided as input arguments. This method can be iteratively called with progressively more detailed instantiation parameters. The operation does not change the state of the import session. The call must supply all instantiation parameters each time. They are not remembered from one invocation to the next. This also means that the operation is naturally idempotent. if you do not have all of the privileges described as follows: - Operation execution requires System.Read. - The resource com.vmware.vcenter.OvfImportSession referenced by the parameter id requires System.Read.