Export VM As OVF Template operation

The Export VM As OVF Template operation exports the specified virtual machine as an OVF template and downloads the files that are associated with the virtual machine entity.

The following table describes the elements for this request.

Adapter request elements for the Export VM As OVF Template operation

Element

Definition

Required

<operation-type>

Defines the type of the operation: Configure_VM

Yes

<operation-name>

Defines the name of the operation: Export_VM_As_OVF_Template

Yes

<soap-url>

Specifies the URL for the remote SOAP service running on the VMware VirtualCenter

If the <soap-url> element is not specified, the request uses the VirtualCenter Server details specified in the adapter configuration.

Default format for HTTPS: https://<hostName>:<port>/sdk/vim

Default format for HTTP: http://<hostName>:<port>/sdk/vim

Note

If you want to use an HTTP value, you might need to change the configuration of the VMware Infrastructure application.

Specifies the transport protocol for the message

If the <transport> element is not provided, the request uses the VirtualCenter Server details specified in the adapter configuration.

Valid values: https-rpc (default), http-rpc

Note

If the value of the <transport> element is https-rpc, you must install the security certificate for the VMware Virtual Center to the keystore of the peer on which the adapter is enabled.

<user-name>

Specifies the user name that is used for HTTP basic authentication on the VMware Virtual Center

If no user name is specified, the request is executed with the user name that is specified in the configuration.

Specifies the password corresponding to <user-name>

Conditional; required if <user-name> is specified

Contains the elements required to execute the operation

Yes

<virtual-machine>

Specifies the virtual machine that you want to export as an OVF template

Valid value: String

Yes

<ovf-download-directory>

Specifies the directory on the TrueSight Orchestration peer under which the virtual machine OVF descriptor and the other entity files are to be exported

Valid value: String

Yes

<cdp>

Contains the required parameters for generating the OVF descriptor

Sample format:

The <name> element specifies the OVF ID to use for the top-level OVF entity. If the OVF ID is not set, the entity's product name is used. If the product name is not available, the VMware Infrastructure entity name is used.

Valid value: String

The <description> element specifies the contents of the annotation section of the top-level OVF Entity. If the description is not set, any existing annotation on the entity is left unchanged.

Valid value: String

The following code sample shows a sample adapter request for the Export VM As OVF Template operation.

Sample adapter request for the Export VM As OVF Template operation

<vmware-infrastructure-request>
   <operation-type>Configure_Vm</operation-type>
   <operation-name>Export_VM_As_OVF_Template</operation-name>
   <parameters>
     <virtual-machine>TestDev3</virtual-machine>
     <ovf-download-directory>/home/Rominder</ovf-download-directory>
     <cdp>
       <name>ExportedVM_OVF</name>
       <description>TestDescription</description>
     </cdp>
   </parameters>
</vmware-infrastructure-request>

The following code sample shows the response for the sample Export VM As OVF Template operation.

Sample adapter response for the Export VM As OVF Template operation

<vmware-infrastructure-response>
<metadata>
<status>success</status>
</metadata>
<ExportVmResponse>
<ovf-download-directory>/home/test</ovf-download-directory>
</ExportVmResponse>
</vmware-infrastructure-response>

Export VM As OVF Template operation

On this page