POST /vdc/{id}/action/uploadVAppTemplate

Operation:

POST /vdc/{id}/action/uploadVAppTemplate

Description:

Upload an OVF package to create a vApp template

Since:

0.9

Deprecated:

Since 5.5

Input parameters

Consume media type(s):

application/vnd.vmware.vcloud.uploadVAppTemplateParams+xml
application/vnd.vmware.vcloud.uploadVAppTemplateParams+json

Input type:

UploadVAppTemplateParamsType

Output parameters

VAppTemplateType

The response includes an upload link for the OVF descriptor

Produce media type(s):

application/vnd.vmware.vcloud.vAppTemplate+xml
application/vnd.vmware.vcloud.vAppTemplate+json

Output type:

VAppTemplateType

Examples

Request

HTTP 1.1
POST /api/vdc/afaafb99-228c-4838-ad07-5bf3aa649d42/action/uploadVAppTemplate

Headers:
Content-Length: 184
Content-Type: application/vnd.vmware.vcloud.uploadVAppTemplateParams+xml; charset=ISO-8859-1
x-vcloud-authorization: oZErT5LcKYSuwfFzYAGIhldhoR9agQL2CvOz+3HNvDI=

Body:

<?xml version="1.0" encoding="UTF-8"?><vcloud:UploadVAppTemplateParams
    xmlns:vcloud="http://www.vmware.com/vcloud/v1.5"
    name="New vApp templ name."/>

Response

HTTP/1.1 201 Created

Headers:
Content-Length: 3783
Content-Type: application/vnd.vmware.vcloud.vapptemplate+xml;version=5.5
Location: https://vcloud.example.com/api/vAppTemplate/vappTemplate-f5502ef4-c711-4ff3-b882-ce3a261f4535
Vary: Accept-Encoding

Body:

<?xml version="1.0" encoding="UTF-8"?><VAppTemplate
    xmlns="http://www.vmware.com/vcloud/v1.5"
    xmlns:ovf="http://schemas.dmtf.org/ovf/envelope/1"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    goldMaster="false"
    href="https://vcloud.example.com/api/vAppTemplate/vappTemplate-f5502ef4-c711-4ff3-b882-ce3a261f4535"
    id="urn:vcloud:vapptemplate:f5502ef4-c711-4ff3-b882-ce3a261f4535"
    name="New vApp templ name."
    ovfDescriptorUploaded="false"
    status="0"
    type="application/vnd.vmware.vcloud.vAppTemplate+xml"
    xsi:schemaLocation="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">
    <Link
        href="https://vcloud.example.com/api/vdc/afaafb99-228c-4838-ad07-5bf3aa649d42"
        rel="up"
        type="application/vnd.vmware.vcloud.vdc+xml"/>
    <Tasks>
        <Task
            cancelRequested="false"
            expiryTime="2013-05-15T13:18:48.763+03:00"
            href="https://vcloud.example.com/api/task/6d2b0d69-cd6c-446d-876a-d4aa0f722690"
            id="urn:vcloud:task:6d2b0d69-cd6c-446d-876a-d4aa0f722690"
            name="task"
            operation="Importing Virtual Application Template New vApp templ name.(f5502ef4-c711-4ff3-b882-ce3a261f4535)"
            operationName="vdcUploadOvfContents"
            serviceNamespace="com.vmware.vcloud"
            startTime="2013-02-14T13:18:48.763+02:00"
            status="running"
            type="application/vnd.vmware.vcloud.task+xml">
            <Link
                href="https://vcloud.example.com/api/task/6d2b0d69-cd6c-446d-876a-d4aa0f722690/action/cancel"
                rel="task:cancel"/>
            <Owner
                href="https://vcloud.example.com/api/vAppTemplate/vappTemplate-f5502ef4-c711-4ff3-b882-ce3a261f4535"
                name="New vApp templ name."
                type="application/vnd.vmware.vcloud.vAppTemplate+xml"/>
            <User
                href="https://vcloud.example.com/api/admin/user/51e86769-9e2d-4edc-af4e-5d3606494cbf"
                name="system"
                type="application/vnd.vmware.admin.user+xml"/>
            <Organization
                href="https://vcloud.example.com/api/org/7b832bc5-3d65-45a2-8d35-da28388ab80a"
                name="Default"
                type="application/vnd.vmware.vcloud.org+xml"/>
            <Progress>1</Progress>
            <Details/>
        </Task>
    </Tasks>
    <Files>
        <File
            bytesTransferred="0"
            name="descriptor.ovf"
            size="-1">
            <Link
                href="https://vcloud.example.com/transfer/b69da2a7-46e8-4d0a-9823-208694dda5ab/descriptor.ovf"
                rel="upload:default"/>
        </File>
    </Files>
    <Owner
        type="application/vnd.vmware.vcloud.owner+xml">
        <User
            href="https://vcloud.example.com/api/admin/user/51e86769-9e2d-4edc-af4e-5d3606494cbf"
            name="system"
            type="application/vnd.vmware.admin.user+xml"/>
    </Owner>
    <Children/>
    <LeaseSettingsSection
        href="https://vcloud.example.com/api/vAppTemplate/vappTemplate-f5502ef4-c711-4ff3-b882-ce3a261f4535/leaseSettingsSection/"
        ovf:required="false"
        type="application/vnd.vmware.vcloud.leaseSettingsSection+xml">
        <ovf:Info>Lease settings section</ovf:Info>
        <Link
            href="https://vcloud.example.com/api/vAppTemplate/vappTemplate-f5502ef4-c711-4ff3-b882-ce3a261f4535/leaseSettingsSection/"
            rel="edit"
            type="application/vnd.vmware.vcloud.leaseSettingsSection+xml"/>
        <StorageLeaseInSeconds>2592000</StorageLeaseInSeconds>
        <StorageLeaseExpiration>2013-03-16T13:18:48.673+02:00</StorageLeaseExpiration>
    </LeaseSettingsSection>
    <CustomizationSection
        goldMaster="false"
        href="https://vcloud.example.com/api/vAppTemplate/vappTemplate-f5502ef4-c711-4ff3-b882-ce3a261f4535/customizationSection/"
        ovf:required="false"
        type="application/vnd.vmware.vcloud.customizationSection+xml">
        <ovf:Info>VApp template customization section</ovf:Info>
        <CustomizeOnInstantiate>false</CustomizeOnInstantiate>
    </CustomizationSection>
    <DateCreated>2013-02-14T13:18:48.673+02:00</DateCreated>
</VAppTemplate>

Upload ovf.

Request

HTTP 1.1
PUT /transfer/b69da2a7-46e8-4d0a-9823-208694dda5ab/descriptor.ovf

Headers:
Content-Length: 4941
Content-Type: application/*+xml
x-vcloud-authorization: oZErT5LcKYSuwfFzYAGIhldhoR9agQL2CvOz+3HNvDI=

Body:

<?xml version="1.0" encoding="UTF-8"?><Envelope
    xmlns="http://schemas.dmtf.org/ovf/envelope/1"
    xmlns:cim="http://schemas.dmtf.org/wbem/wscim/1/common"
    xmlns:ovf="http://schemas.dmtf.org/ovf/envelope/1"
    xmlns:rasd="http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_ResourceAllocationSettingData"
    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">
  <References>
    <File
        ovf:href="UnOS2.vmdk"
        ovf:id="file1"
        ovf:size="828928"/>
  </References>
  <DiskSection>
    <Info>Virtual disk information</Info>
    <Disk
        ovf:capacity="2"
        ovf:capacityAllocationUnits="byte * 2^20"
        ovf:diskId="vmdisk1"
        ovf:fileRef="file1"
        ovf:format="http://www.vmware.com/interfaces/specifications/vmdk.html#streamOptimized"/>
  </DiskSection>
  <NetworkSection>
    <Info>The list of logical networks</Info>
    <Network
        ovf:name="AutomationNetwork">
      <Description>This network provides connectivity to this virtual machine.</Description>
    </Network>
  </NetworkSection>
  <VirtualSystem
      ovf:id="UnOS2">
    <Info>A virtual machine</Info>
    <Name>UnOS2</Name>
    <OperatingSystemSection
        ovf:id="93"
        vmw:osType="ubuntuGuest">
      <Info>The kind of installed guest operating system</Info>
    </OperatingSystemSection>
    <VirtualHardwareSection>
      <Info>Virtual hardware requirements</Info>
      <System>
        <vssd:ElementName>Virtual Hardware Family</vssd:ElementName>
        <vssd:InstanceID>0</vssd:InstanceID>
        <vssd:VirtualSystemIdentifier>UnOS2</vssd:VirtualSystemIdentifier>
        <vssd:VirtualSystemType>vmx-04</vssd:VirtualSystemType>
      </System>
      <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>1</rasd:InstanceID>
        <rasd:ResourceType>3</rasd:ResourceType>
        <rasd:VirtualQuantity>1</rasd:VirtualQuantity>
      </Item>
      <Item>
        <rasd:AllocationUnits>byte * 2^20</rasd:AllocationUnits>
        <rasd:Description>Memory Size</rasd:Description>
        <rasd:ElementName>32MB of memory</rasd:ElementName>
        <rasd:InstanceID>2</rasd:InstanceID>
        <rasd:ResourceType>4</rasd:ResourceType>
        <rasd:VirtualQuantity>32</rasd:VirtualQuantity>
      </Item>
      <Item>
        <rasd:Address>0</rasd:Address>
        <rasd:Description>SCSI Controller</rasd:Description>
        <rasd:ElementName>scsi0</rasd:ElementName>
        <rasd:InstanceID>3</rasd:InstanceID>
        <rasd:ResourceSubType>lsilogic</rasd:ResourceSubType>
        <rasd:ResourceType>6</rasd:ResourceType>
      </Item>
      <Item>
        <rasd:Address>0</rasd:Address>
        <rasd:Description>IDE Controller</rasd:Description>
        <rasd:ElementName>unknown device</rasd:ElementName>
        <rasd:InstanceID>4</rasd:InstanceID>
        <rasd:ResourceType>5</rasd:ResourceType>
      </Item>
      <Item
          ovf:required="false">
        <rasd:AddressOnParent>0</rasd:AddressOnParent>
        <rasd:AutomaticAllocation>false</rasd:AutomaticAllocation>
        <rasd:Description>Floppy Drive</rasd:Description>
        <rasd:ElementName>floppy0</rasd:ElementName>
        <rasd:InstanceID>5</rasd:InstanceID>
        <rasd:ResourceType>14</rasd:ResourceType>
      </Item>
      <Item>
        <rasd:AutomaticAllocation>true</rasd:AutomaticAllocation>
        <rasd:Connection>AutomationNetwork</rasd:Connection>
        <rasd:Description>PCNet32 ethernet adapter on "VM Network"</rasd:Description>
        <rasd:ElementName>unknown device</rasd:ElementName>
        <rasd:InstanceID>6</rasd:InstanceID>
        <rasd:ResourceSubType>PCNet32</rasd:ResourceSubType>
        <rasd:ResourceType>10</rasd:ResourceType>
      </Item>
      <Item
          ovf:required="false">
        <rasd:AddressOnParent>0</rasd:AddressOnParent>
        <rasd:AutomaticAllocation>true</rasd:AutomaticAllocation>
        <rasd:ElementName>ide0:0</rasd:ElementName>
        <rasd:InstanceID>7</rasd:InstanceID>
        <rasd:Parent>4</rasd:Parent>
        <rasd:ResourceType>15</rasd:ResourceType>
      </Item>
      <Item>
        <rasd:AddressOnParent>0</rasd:AddressOnParent>
        <rasd:ElementName>scsi0:1</rasd:ElementName>
        <rasd:HostResource>ovf:/disk/vmdisk1</rasd:HostResource>
        <rasd:InstanceID>8</rasd:InstanceID>
        <rasd:Parent>3</rasd:Parent>
        <rasd:ResourceType>17</rasd:ResourceType>
      </Item>
    </VirtualHardwareSection>
    <AnnotationSection
        ovf:required="false">
      <Info>A human-readable annotation</Info>
      <Annotation>VM annotation</Annotation>
    </AnnotationSection>
    <ProductSection>
      <Info>Information about the installed software</Info>
      <Product>UnOS</Product>
    </ProductSection>
  </VirtualSystem>
</Envelope>

Response

HTTP/1.1 200 OK

Headers:
Content-Length: 0

Body:

Upload disk(s).

Request

HTTP 1.1
PUT /transfer/b69da2a7-46e8-4d0a-9823-208694dda5ab/UnOS2.vmdk

Headers:
Content-Length: 828928
Content-Type: application/*+xml
x-vcloud-authorization: oZErT5LcKYSuwfFzYAGIhldhoR9agQL2CvOz+3HNvDI=

Body:

The disk data.

Response

HTTP/1.1 200 OK

Headers:
Content-Length: 0

Body: