Get vApp Template OVF Descriptor operation

The Get vApp Template OVF Descriptor operation enables you to retrieve a vApp template's Open Virtualization Format (OVF) descriptor. OVF enables efficient, flexible, and secure distribution of enterprise software, facilitating the mobility of virtual machines and giving customers vendor and platform independence. Customers can deploy an OVF-formatted virtual machine on any virtualization platform.

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

Sample <items> XML element for the Get vApp Template OVF Descriptor operation

The following table describes the elements for this adapter request:

Adapter request elements for the Get vApp Template OVF Descriptor operation

Element	Definition	Required
<operation-name>	Defines the type of operation: Get_vApp_Template_Ovf_Descriptor	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 for which you want to retrieve the OVF descriptor Valid value: Any string	Yes

The following figure shows the sample adapter request for the Get vApp Template OVF Descriptor operation:

Sample adapter request for the Get vApp Template OVF Descriptor operation

<vmware-vcloud-request>
<operation-name>Get_vApp_Template_Ovf_Descriptor</operation-name>
<vcloud-organization>TestOrg</vcloud-organization>
<user-name>TestUser</user-name>
<password>Password</password>
<parameters>
<vapp-template-id>vappTemplate-802741175</vapp-template-id>
</parameters>
</vmware-vcloud-request>

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

Sample adapter response for the Get vApp Template OVF Descriptor operation

<vmware-vcloud-response>
<metadata>
   <status>success</status>
</metadata>
<status-line>
   <code>200</code>
   <reason>OK</reason>
</status-line>
<message-body>
   <Envelope>
     <References />
     <NetworkSection>
       <Info>The list of logical networks</Info>
       <Network name="none">
         <Description>This is a special place-holder used for disconnected
network interfaces.</Description>
       </Network>
     </NetworkSection>
     <NetworkConfigSection required="false">
       <Info>The configuration parameters for logical networks</Info>
       <NetworkConfig networkName="none">
         <Description>This is a special place-holder used for disconnected
network interfaces.</Description>
         <Configuration>
           <IpScope>
             <IsInherited>false</IsInherited>
             <Gateway>196.254.254.254</Gateway>
             <Netmask>255.255.0.0</Netmask>
             <Dns1>196.254.254.254</Dns1>
           </IpScope>
           <FenceMode>isolated</FenceMode>
         </Configuration>
         <IsDeployed>false</IsDeployed>
       </NetworkConfig>
     </NetworkConfigSection>
     <LeaseSettingsSection required="false">
       <Info>Lease settings section</Info>
       <DeploymentLeaseInSeconds>0</DeploymentLeaseInSeconds>
       <StorageLeaseInSeconds>7776000</StorageLeaseInSeconds>
       <StorageLeaseExpiration>2011-04-04T17:57:07.706+05:30
</StorageLeaseExpiration>
     </LeaseSettingsSection>
     <CustomizationSection required="false">
       <Info>VApp template customization section</Info>
       <CustomizeOnInstantiate>false</CustomizeOnInstantiate>
     </CustomizationSection>
     <VirtualSystem id="TestTmpl2">
       <Info>A virtual machine:</Info>
       <Name>TestTmpl2</Name>
       <OperatingSystemSection id="79" osType="rhel6Guest">
         <Info>Specifies the operating system installed</Info>
         <Description>Red Hat Enterprise Linux 6 (32-bit)</Description>
       </OperatingSystemSection>
       <VirtualHardwareSection>
         <Info>Virtual hardware requirements</Info>
         <System>
           <ElementName>Virtual Hardware Family</ElementName>
           <InstanceID>0</InstanceID>
           <VirtualSystemIdentifier>TestTmpl2</VirtualSystemIdentifier>
           <VirtualSystemType>vmx-07</VirtualSystemType>
         </System>
         <Item>
           <Address>00:50:56:af:00:04</Address>
           <AddressOnParent>0</AddressOnParent>
           <AutomaticAllocation>false</AutomaticAllocation>
           <Connection primaryNetworkConnection="true" ipAddressingMode
="NONE">none</Connection>
           <Description>PCNet32 ethernet adapter</Description>
           <ElementName>Network adapter 0</ElementName>
           <InstanceID>1</InstanceID>
           <ResourceSubType>PCNet32</ResourceSubType>
           <ResourceType>10</ResourceType>
         </Item>
         <Item>
           <Address>0</Address>
           <Description>SCSI Controller</Description>
           <ElementName>SCSI Controller 0</ElementName>
           <InstanceID>2</InstanceID>
           <ResourceSubType>lsilogicsas</ResourceSubType>
           <ResourceType>6</ResourceType>
         </Item>
         <Item>
           <AddressOnParent>0</AddressOnParent>
           <Description>Hard disk</Description>
           <ElementName>Hard disk 1</ElementName>
           <HostResource capacity="40" busType="6" busSubType="lsilogicsas" />
           <InstanceID>2000</InstanceID>
           <Parent>2</Parent>
           <ResourceType>17</ResourceType>
         </Item>
         <Item>
           <Address>0</Address>
           <Description>IDE Controller</Description>
           <ElementName>IDE Controller 0</ElementName>
           <InstanceID>3</InstanceID>
           <ResourceType>5</ResourceType>
         </Item>
         <Item>
           <AddressOnParent>0</AddressOnParent>
           <AutomaticAllocation>false</AutomaticAllocation>
           <Description>CD/DVD Drive</Description>
           <ElementName>CD/DVD Drive 1</ElementName>
           <HostResource />
           <InstanceID>3002</InstanceID>
           <Parent>3</Parent>
           <ResourceType>15</ResourceType>
         </Item>
         <Item>
           <AddressOnParent>0</AddressOnParent>
           <AutomaticAllocation>false</AutomaticAllocation>
           <Description>Floppy Drive</Description>
           <ElementName>Floppy Drive 1</ElementName>
           <HostResource />
           <InstanceID>8000</InstanceID>
           <ResourceType>14</ResourceType>
         </Item>
         <Item>
           <AllocationUnits>hertz * 10^6</AllocationUnits>
           <Description>Number of Virtual CPUs</Description>
           <ElementName>1 virtual CPU(s)</ElementName>
           <InstanceID>4</InstanceID>
           <Reservation>0</Reservation>
           <ResourceType>3</ResourceType>
           <VirtualQuantity>1</VirtualQuantity>
           <Weight>0</Weight>
         </Item>
         <Item>
           <AllocationUnits>byte * 2^20</AllocationUnits>
           <Description>Memory Size</Description>
           <ElementName>4 MB of memory</ElementName>
           <InstanceID>5</InstanceID>
           <Reservation>0</Reservation>
           <ResourceType>4</ResourceType>
           <VirtualQuantity>4</VirtualQuantity>
           <Weight>0</Weight>
         </Item>
       </VirtualHardwareSection>
       <NetworkConnectionSection required="false">
         <Info>Specifies the available VM network connections</Info>
         <PrimaryNetworkConnectionIndex>0</PrimaryNetworkConnectionIndex>
         <NetworkConnection network="none">
           <NetworkConnectionIndex>0</NetworkConnectionIndex>
           <IsConnected>false</IsConnected>
           <MACAddress>00:50:56:af:00:04</MACAddress>
           <IpAddressAllocationMode>NONE</IpAddressAllocationMode>
         </NetworkConnection>
       </NetworkConnectionSection>
       <GuestCustomizationSection required="false">
         <Info>Specifies Guest OS Customization Settings</Info>
         <Enabled>true</Enabled>
         <ChangeSid>false</ChangeSid>
         <VirtualMachineId>1671889853</VirtualMachineId>
         <JoinDomainEnabled>false</JoinDomainEnabled>
         <UseOrgSettings>false</UseOrgSettings>
         <AdminPasswordEnabled>true</AdminPasswordEnabled>
         <AdminPasswordAuto>true</AminPasswordAuto>
         <ResetPasswordRequired>false</ResetPasswordRequired>
         <CustomizationScript />
         <ComputerName>TestTmpl2</ComputerName>
       </GuestCustomizationSection>
     </VirtualSystem>
   </Envelope>
</message-body>
</vmware-vcloud-response>

Get vApp Template OVF Descriptor operation

On this page