Export vApp Template As OVF operation

The Export vApp Template As OVF operation enables you to downlaod a vApp template as an OVF package.

The following figure shows a sample <items> XML element for the Export vApp Template As OVF operation:

Sample <items> XML element for the Export vApp Template As OVF operation

<items>
  <item>
    <parameters>
      <vapp-template-id></vapp-template-id>
      <ovf-download-directory></ovf-download-directory>
    </parameters>
  </item>
</items>

The following table describes the elements for this adapter request:

Adapter request elements for the Export vApp Template As OVF operation

Element

Definition

Required

<operation-name>

Defines the type of operation: Export_vApp_Template_As_Ovf

Yes

<vcloud-organization>

Specifies the name of the vCloud organization

Conditional:

  • Required if not specified in the configuration
  • If used, requires <user-name> and <password>

<user-name>

Specifies the user name required for basic HTTP authentication on vCloud

Conditional:

  • Required if not specified in the configuration
  • If used, requires <vcloud-organization> and <password>

<password>

Contains the password corresponding to the specified user name

Conditional:

  • Required if not specified in the configuration
  • If used, requires <vcloud-organization> and <user-name>

<parameters>

Contains the elements for the operation

Yes

<vapp-template-id>

Specifies the ID of the corresponding vApp template that you want to download
Valid value: Any string

Yes

<ovf-download-directory>

Specifies the directory from which to download the vApp template's OVF files

Yes

The following figure shows the sample adapter request for the Export vApp Template As OVF operation:

Sample adapter request for the Export vApp Template As OVF operation

<vmware-vcloud-request>
  <operation-name>Export_Ovf_As_vApp_Template</operation-name>  
  <vcloud-organization>TestOrg</vcloud-organization>
  <user-name>TestUser</user-name>
  <password>Password</password>
  <parameters>
    <vapp-template-id>vappTemplate-145139217</vapp-template-id>
    <ovf-download-directory>/home/newuser</ovf-download-directory>
  </parameters>
</vmware-vcloud-request>

The following figure shows the response for the sample adapter request:

Sample adapter response for the Export vApp Template As OVF operation

<vmware-vcloud-response>
  <metadata>
    <status>success</status>
  </metadata>
  <status-line>
    <code>200</code>
    <reason>OK</reason>
  </status-line>
  <message-body>
    <ovf-download-directory>/home/jai</ovf-download-directory>
  </message-body>
</vmware-vcloud-response>
Was this page helpful? Yes No Submitting... Thank you

Comments