VMware Cloud Director API - GET-VAppTemplateOvfDescriptor

VMware Cloud Director API - GET-VAppTemplateOvfDescriptor

GET /vAppTemplate/{id}/ovf

Operation:
GET /vAppTemplate/{id}/ovf
Description:
Retrieve the OVF descriptor of a vApp template.
Since:
0.9
Input parameters
Consume media type(s):
None
Input type:
None
Output parameters
ovf:EnvelopType

Produce media type(s):
text/xml
application/*+xml
application/xml
Output type:
EnvelopType
Examples
Request
HTTP 1.1
GET /api/vAppTemplate/vappTemplate-fa813d19-3936-4099-bff9-e0ad8d1e34bb/ovf

Headers:
x-vcloud-authorization: 4Ezv8QOCNMOaWCVI6gEHOXEG299HZAsmcB0qrgPRp1I=

Body:
Response
HTTP/1.1 200 OK

Headers:
Content-Length: 10347
Content-Type: application/*+xml;version=5.5
Vary: Accept-Encoding

Body:
<?xml version="1.0" encoding="UTF-8"?><ovf:Envelope
    xmlns:ovf="http://schemas.dmtf.org/ovf/envelope/1"
    xmlns:rasd="http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_ResourceAllocationSettingData"
    xmlns:vcloud="http://www.vmware.com/vcloud/v1.5"
    xmlns:vmw="http://www.vmware.com/schema/ovf"
    xmlns:vssd="http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_VirtualSystemSettingData"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_VirtualSystemSettingData http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2.22.0/CIM_VirtualSystemSettingData.xsd http://www.vmware.com/schema/ovf http://www.vmware.com/schema/ovf http://schemas.dmtf.org/ovf/envelope/1 http://schemas.dmtf.org/ovf/envelope/1/dsp8023_1.1.0.xsd http://www.vmware.com/vcloud/v1.5 http://https://vcloud.example.com/api/v1.5/schema/master.xsd http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_ResourceAllocationSettingData http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2.22.0/CIM_ResourceAllocationSettingData.xsd">
    <ovf:References/>
    <ovf:NetworkSection>
        <ovf:Info>The list of logical networks</ovf:Info>
        <ovf:Network
            ovf:name="VM Network">
            <ovf:Description>VM Network</ovf:Description>
        </ovf:Network>
    </ovf:NetworkSection>
    <vcloud:CustomizationSection
        goldMaster="false"
        ovf:required="false">
        <ovf:Info>VApp template customization section</ovf:Info>
        <vcloud:CustomizeOnInstantiate>false</vcloud:CustomizeOnInstantiate>
    </vcloud:CustomizationSection>
    <vcloud:NetworkConfigSection
        ovf:required="false">
        <ovf:Info>The configuration parameters for logical networks</ovf:Info>
        <vcloud:NetworkConfig
            networkName="VM Network">
            <vcloud:Description>VM Network</vcloud:Description>
            <vcloud:Configuration>
                <vcloud:IpScopes>
                    <vcloud:IpScope>
                        <vcloud:IsInherited>false</vcloud:IsInherited>
                        <vcloud:Gateway>192.168.254.1</vcloud:Gateway>
                        <vcloud:Netmask>255.255.255.0</vcloud:Netmask>
                        <vcloud:IsEnabled>true</vcloud:IsEnabled>
                        <vcloud:IpRanges>
                            <vcloud:IpRange>
                                <vcloud:StartAddress>192.168.254.100</vcloud:StartAddress>
                                <vcloud:EndAddress>192.168.254.199</vcloud:EndAddress>
                            </vcloud:IpRange>
                        </vcloud:IpRanges>
                    </vcloud:IpScope>
                </vcloud:IpScopes>
                <vcloud:FenceMode>isolated</vcloud:FenceMode>
                <vcloud:RetainNetInfoAcrossDeployments>false</vcloud:RetainNetInfoAcrossDeployments>
            </vcloud:Configuration>
            <vcloud:IsDeployed>false</vcloud:IsDeployed>
        </vcloud:NetworkConfig>
    </vcloud:NetworkConfigSection>
    <vcloud:LeaseSettingsSection
        ovf:required="false">
        <ovf:Info>Lease settings section</ovf:Info>
        <vcloud:StorageLeaseInSeconds>2592000</vcloud:StorageLeaseInSeconds>
        <vcloud:StorageLeaseExpiration>2013-03-16T13:08:54.587+02:00</vcloud:StorageLeaseExpiration>
    </vcloud:LeaseSettingsSection>
    <ovf:VirtualSystem
        ovf:id="imported">
        <ovf:Info>A virtual machine</ovf:Info>
        <ovf:Name>imported</ovf:Name>
        <ovf:OperatingSystemSection
            ovf:id="102"
            vmw:osType="windows7Server64Guest">
            <ovf:Info>Specifies the operating system installed</ovf:Info>
            <ovf:Description>Microsoft Windows Server 2008 R2 (64-bit)</ovf:Description>
        </ovf:OperatingSystemSection>
        <ovf:VirtualHardwareSection
            ovf:transport="">
            <ovf:Info>Virtual hardware requirements</ovf:Info>
            <ovf:System>
                <vssd:ElementName>Virtual Hardware Family</vssd:ElementName>
                <vssd:InstanceID>0</vssd:InstanceID>
                <vssd:VirtualSystemIdentifier>imported</vssd:VirtualSystemIdentifier>
                <vssd:VirtualSystemType>vmx-08</vssd:VirtualSystemType>
            </ovf:System>
            <ovf:Item>
                <rasd:Address>00:50:56:8d:7f:21</rasd:Address>
                <rasd:AddressOnParent>0</rasd:AddressOnParent>
                <rasd:AutomaticAllocation>false</rasd:AutomaticAllocation>
                <rasd:Connection
                    vcloud:ipAddressingMode="DHCP"
                    vcloud:primaryNetworkConnection="true">VM Network</rasd:Connection>
                <rasd:Description>E1000 ethernet adapter on "VM Network"</rasd:Description>
                <rasd:ElementName>Network adapter 0</rasd:ElementName>
                <rasd:InstanceID>1</rasd:InstanceID>
                <rasd:ResourceSubType>E1000</rasd:ResourceSubType>
                <rasd:ResourceType>10</rasd:ResourceType>
            </ovf:Item>
            <ovf:Item>
                <rasd:Address>0</rasd:Address>
                <rasd:Description>SCSI Controller</rasd:Description>
                <rasd:ElementName>SCSI Controller 0</rasd:ElementName>
                <rasd:InstanceID>2</rasd:InstanceID>
                <rasd:ResourceSubType>lsilogicsas</rasd:ResourceSubType>
                <rasd:ResourceType>6</rasd:ResourceType>
            </ovf:Item>
            <ovf:Item>
                <rasd:AddressOnParent>0</rasd:AddressOnParent>
                <rasd:Description>Hard disk</rasd:Description>
                <rasd:ElementName>Hard disk 1</rasd:ElementName>
                <rasd:HostResource
                    vcloud:busSubType="lsilogicsas"
                    vcloud:busType="6"
                    vcloud:capacity="40"/>
                <rasd:InstanceID>2000</rasd:InstanceID>
                <rasd:Parent>2</rasd:Parent>
                <rasd:ResourceType>17</rasd:ResourceType>
            </ovf:Item>
            <ovf:Item>
                <rasd:Address>0</rasd:Address>
                <rasd:Description>IDE Controller</rasd:Description>
                <rasd:ElementName>IDE Controller 0</rasd:ElementName>
                <rasd:InstanceID>3</rasd:InstanceID>
                <rasd:ResourceType>5</rasd:ResourceType>
            </ovf:Item>
            <ovf:Item>
                <rasd:AddressOnParent>0</rasd:AddressOnParent>
                <rasd:AutomaticAllocation>false</rasd:AutomaticAllocation>
                <rasd:Description>Floppy Drive</rasd:Description>
                <rasd:ElementName>Floppy Drive 1</rasd:ElementName>
                <rasd:HostResource/>
                <rasd:InstanceID>8000</rasd:InstanceID>
                <rasd:ResourceType>14</rasd:ResourceType>
            </ovf:Item>
            <ovf:Item>
                <rasd:AllocationUnits>hertz * 10^6</rasd:AllocationUnits>
                <rasd:Description>Number of Virtual CPUs</rasd:Description>
                <rasd:ElementName>1 virtual CPU(s)</rasd:ElementName>
                <rasd:InstanceID>4</rasd:InstanceID>
                <rasd:Reservation>0</rasd:Reservation>
                <rasd:ResourceType>3</rasd:ResourceType>
                <rasd:VirtualQuantity>1</rasd:VirtualQuantity>
                <rasd:Weight>0</rasd:Weight>
                <vmw:CoresPerSocket
                    ovf:required="false">1</vmw:CoresPerSocket>
            </ovf:Item>
            <ovf:Item>
                <rasd:AllocationUnits>byte * 2^20</rasd:AllocationUnits>
                <rasd:Description>Memory Size</rasd:Description>
                <rasd:ElementName>4096 MB of memory</rasd:ElementName>
                <rasd:InstanceID>5</rasd:InstanceID>
                <rasd:Reservation>0</rasd:Reservation>
                <rasd:ResourceType>4</rasd:ResourceType>
                <rasd:VirtualQuantity>4096</rasd:VirtualQuantity>
                <rasd:Weight>0</rasd:Weight>
            </ovf:Item>
            <ovf:Item>
                <rasd:Address>1</rasd:Address>
                <rasd:Description>IDE Controller</rasd:Description>
                <rasd:ElementName>IDE 1</rasd:ElementName>
                <rasd:InstanceID>100</rasd:InstanceID>
                <rasd:ResourceType>5</rasd:ResourceType>
            </ovf:Item>
            <ovf:Item>
                <rasd:AddressOnParent>0</rasd:AddressOnParent>
                <rasd:AutomaticAllocation>false</rasd:AutomaticAllocation>
                <rasd:Description>CD/DVD Drive</rasd:Description>
                <rasd:ElementName>CD/DVD Drive 1</rasd:ElementName>
                <rasd:HostResource/>
                <rasd:InstanceID>3002</rasd:InstanceID>
                <rasd:Parent>100</rasd:Parent>
                <rasd:ResourceType>15</rasd:ResourceType>
            </ovf:Item>
        </ovf:VirtualHardwareSection>
        <vcloud:GuestCustomizationSection
            ovf:required="false">
            <ovf:Info>Specifies Guest OS Customization Settings</ovf:Info>
            <vcloud:Enabled>false</vcloud:Enabled>
            <vcloud:ChangeSid>false</vcloud:ChangeSid>
            <vcloud:VirtualMachineId>078a00a2-e103-4237-97e5-c40a698aa8fa</vcloud:VirtualMachineId>
            <vcloud:JoinDomainEnabled>false</vcloud:JoinDomainEnabled>
            <vcloud:UseOrgSettings>false</vcloud:UseOrgSettings>
            <vcloud:AdminPasswordEnabled>false</vcloud:AdminPasswordEnabled>
            <vcloud:AdminPasswordAuto>true</vcloud:AdminPasswordAuto>
            <vcloud:AdminAutoLogonEnabled>false</vcloud:AdminAutoLogonEnabled>
            <vcloud:AdminAutoLogonCount>0</vcloud:AdminAutoLogonCount>
            <vcloud:ResetPasswordRequired>false</vcloud:ResetPasswordRequired>
            <vcloud:ComputerName>imported-001</vcloud:ComputerName>
        </vcloud:GuestCustomizationSection>
        <vcloud:NetworkConnectionSection
            ovf:required="false">
            <ovf:Info>Specifies the available VM network connections</ovf:Info>
            <vcloud:PrimaryNetworkConnectionIndex>0</vcloud:PrimaryNetworkConnectionIndex>
            <vcloud:NetworkConnection
                needsCustomization="true"
                network="VM Network">
                <vcloud:NetworkConnectionIndex>0</vcloud:NetworkConnectionIndex>
                <vcloud:IsConnected>false</vcloud:IsConnected>
                <vcloud:MACAddress>00:50:56:8d:7f:21</vcloud:MACAddress>
                <vcloud:IpAddressAllocationMode>DHCP</vcloud:IpAddressAllocationMode>
            </vcloud:NetworkConnection>
        </vcloud:NetworkConnectionSection>
    </ovf:VirtualSystem>
</ovf:Envelope>