VMware Cloud Director API - PUT-VAppTemplate

VMware Cloud Director API - PUT-VAppTemplate

PUT /vAppTemplate/{id}

Operation:
PUT /vAppTemplate/{id}
Description:
Update the name, description and gold master of a vApp template. Also updates the compute policies of a template's VMs if given.
Since:
0.9
Input parameters
Consume media type(s):
application/vnd.vmware.vcloud.vAppTemplate+xml
application/vnd.vmware.vcloud.vAppTemplate+json
Input type:
VAppTemplateType
Output parameters
TaskType

This operation is asynchronous and returns a task that you can monitor to track the progress of the request.

Produce media type(s):
application/vnd.vmware.vcloud.task+xml
application/vnd.vmware.vcloud.task+json
Output type:
TaskType
Examples
Request
HTTP 1.1
PUT /api/vAppTemplate/vappTemplate-a43ab159-1b59-412d-86d7-22fcb6fb5bac

Headers:
x-vcloud-authorization: FJiMs+Zs/UyBIUgiaBXuzAOWAOL6ORo3h0HMbVqnLQU=

Body:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns6:VAppTemplate
    xmlns="http://www.vmware.com/vcloud/versions" xmlns:ns2="http://schemas.dmtf.org/ovf/envelope/1" xmlns:ns3="http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_VirtualSystemSettingData" xmlns:ns4="http://schemas.dmtf.org/wbem/wscim/1/common" xmlns:ns5="http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_ResourceAllocationSettingData" xmlns:ns6="http://www.vmware.com/vcloud/v1.5" xmlns:ns7="http://www.vmware.com/schema/ovf" xmlns:ns8="http://schemas.dmtf.org/ovf/environment/1" xmlns:ns9="http://www.vmware.com/vcloud/extension/v1.5"
    ovfDescriptorUploaded="true"
    goldMaster="false"
    status="8"
    name="DamnSmallLinux"
    id="urn:vcloud:vapptemplate:a43ab159-1b59-412d-86d7-22fcb6fb5bac"
    type="application/vnd.vmware.vcloud.vAppTemplate+xml"
    href="https://vcloud.example.com/api/vAppTemplate/vappTemplate-a43ab159-1b59-412d-86d7-22fcb6fb5bac">
    <ns6:Link
        rel="up"
        type="application/vnd.vmware.vcloud.vdc+xml"
        href="https://vcloud.example.com/api/vdc/7d56a28d-7677-47f0-b874-7dd979f5dcb6"/>
    <ns6:Link
        rel="catalogItem"
        type="application/vnd.vmware.vcloud.catalogItem+xml"
        href="https://vcloud.example.com/api/catalogItem/ebbbf969-65d3-4dfd-861f-8bf94bae32ec"/>
    <ns6:Link
        rel="remove"
        href="https://vcloud.example.com/api/vAppTemplate/vappTemplate-a43ab159-1b59-412d-86d7-22fcb6fb5bac"/>
    <ns6:Link
        rel="edit"
        type="application/vnd.vmware.vcloud.vAppTemplate+xml"
        href="https://vcloud.example.com/api/vAppTemplate/vappTemplate-a43ab159-1b59-412d-86d7-22fcb6fb5bac"/>
    <ns6:Link
        rel="enable"
        href="https://vcloud.example.com/api/vAppTemplate/vappTemplate-a43ab159-1b59-412d-86d7-22fcb6fb5bac/action/enableDownload"/>
    <ns6:Link
        rel="disable"
        href="https://vcloud.example.com/api/vAppTemplate/vappTemplate-a43ab159-1b59-412d-86d7-22fcb6fb5bac/action/disableDownload"/>
    <ns6:Link
        rel="ovf"
        type="text/xml"
        href="https://vcloud.example.com/api/vAppTemplate/vappTemplate-a43ab159-1b59-412d-86d7-22fcb6fb5bac/ovf"/>
    <ns6:Link
        rel="storageProfile"
        type="application/vnd.vmware.vcloud.vdcStorageProfile+xml"
        name="*"
        href="https://vcloud.example.com/api/vdcStorageProfile/b967a518-1ac9-4b46-8c71-3379c72718e1"/>
    <ns6:Link
        rel="down"
        type="application/vnd.vmware.vcloud.owner+xml"
        href="https://vcloud.example.com/api/vAppTemplate/vappTemplate-a43ab159-1b59-412d-86d7-22fcb6fb5bac/owner"/>
    <ns6:Link
        rel="down"
        type="application/vnd.vmware.vcloud.metadata+xml"
        href="https://vcloud.example.com/api/vAppTemplate/vappTemplate-a43ab159-1b59-412d-86d7-22fcb6fb5bac/metadata"/>
    <ns6:Link
        rel="down"
        type="application/vnd.vmware.vcloud.productSections+xml"
        href="https://vcloud.example.com/api/vAppTemplate/vappTemplate-a43ab159-1b59-412d-86d7-22fcb6fb5bac/productSections/"/>
    <ns6:Description></ns6:Description>
    <ns6:Owner
        type="application/vnd.vmware.vcloud.owner+xml">
        <ns6:User
            type="application/vnd.vmware.admin.user+xml"
            name="system"
            href="https://vcloud.example.com/api/admin/user/d9827f2d-715c-4f1a-b494-77f6b58611c1"/>
    </ns6:Owner>
    <ns6:Children>
        <ns6:Vm
            goldMaster="false"
            status="8"
            name="DamnSmallLinux"
            id="urn:vcloud:vm:a2d8cb0e-b9d9-4692-a34b-d390e60fbec9"
            type="application/vnd.vmware.vcloud.vm+xml"
            href="https://vcloud.example.com/api/vAppTemplate/vm-a2d8cb0e-b9d9-4692-a34b-d390e60fbec9">
            <ns6:VCloudExtension
                required="false">
                <ns9:VmVimInfo>
                    <ns9:VmVimObjectRef>
                        <ns9:VimServerRef
                            type="application/vnd.vmware.admin.vmwvirtualcenter+xml"
                            name="Private vCenter"
                            href="https://vcloud.example.com/api/admin/extension/vimServer/d5841e90-feea-4b3e-8c52-5e670a1d760d"/>
                        <ns9:MoRef>vm-164</ns9:MoRef>
                        <ns9:VimObjectType>VIRTUAL_MACHINE</ns9:VimObjectType>
                    </ns9:VmVimObjectRef>
                    <ns9:DatastoreVimObjectRef>
                        <ns9:VimServerRef
                            type="application/vnd.vmware.admin.vmwvirtualcenter+xml"
                            name="Private vCenter"
                            href="https://vcloud.example.com/api/admin/extension/vimServer/d5841e90-feea-4b3e-8c52-5e670a1d760d"/>
                        <ns9:MoRef>datastore-102</ns9:MoRef>
                        <ns9:VimObjectType>DATASTORE</ns9:VimObjectType>
                    </ns9:DatastoreVimObjectRef>
                    <ns9:HostVimObjectRef>
                        <ns9:VimServerRef
                            type="application/vnd.vmware.admin.vmwvirtualcenter+xml"
                            name="Private vCenter"
                            href="https://vcloud.example.com/api/admin/extension/vimServer/d5841e90-feea-4b3e-8c52-5e670a1d760d"/>
                        <ns9:MoRef>host-101</ns9:MoRef>
                        <ns9:VimObjectType>HOST</ns9:VimObjectType>
                    </ns9:HostVimObjectRef>
                    <ns9:VirtualDisksMaxChainLength>2</ns9:VirtualDisksMaxChainLength>
                </ns9:VmVimInfo>
            </ns6:VCloudExtension>
            <ns6:Link
                rel="up"
                type="application/vnd.vmware.vcloud.vAppTemplate+xml"
                href="https://vcloud.example.com/api/vAppTemplate/vappTemplate-a43ab159-1b59-412d-86d7-22fcb6fb5bac"/>
            <ns6:Link
                rel="storageProfile"
                type="application/vnd.vmware.vcloud.vdcStorageProfile+xml"
                href="https://vcloud.example.com/api/vdcStorageProfile/b967a518-1ac9-4b46-8c71-3379c72718e1"/>
            <ns6:Link
                rel="relocate"
                type="application/vnd.vmware.vcloud.relocateVmParams+xml"
                href="https://vcloud.example.com/api/vAppTemplate/vm-a2d8cb0e-b9d9-4692-a34b-d390e60fbec9/action/relocate"/>
            <ns6:Link
                rel="consolidate"
                href="https://vcloud.example.com/api/vAppTemplate/vm-a2d8cb0e-b9d9-4692-a34b-d390e60fbec9/action/consolidate"/>
            <ns6:Link
                rel="shadowVms"
                type="application/vnd.vmware.vcloud.shadowVms+xml"
                href="https://vcloud.example.com/api/vAppTemplate/vm-a2d8cb0e-b9d9-4692-a34b-d390e60fbec9/shadowVms"/>
            <ns6:Link
                rel="down"
                type="application/vnd.vmware.vcloud.metadata+xml"
                href="https://vcloud.example.com/api/vAppTemplate/vm-a2d8cb0e-b9d9-4692-a34b-d390e60fbec9/metadata"/>
            <ns6:Link
                rel="down"
                type="application/vnd.vmware.vcloud.productSections+xml"
                href="https://vcloud.example.com/api/vAppTemplate/vm-a2d8cb0e-b9d9-4692-a34b-d390e60fbec9/productSections/"/>
            <ns6:Description>VMware engineering hostd intgration test vm w/2.4.26 linux with vmware tools</ns6:Description>
            <ns6:NetworkConnectionSection
                type="application/vnd.vmware.vcloud.networkConnectionSection+xml"
                href="https://vcloud.example.com/api/vAppTemplate/vm-a2d8cb0e-b9d9-4692-a34b-d390e60fbec9/networkConnectionSection/" ns2:required="false">
                <ns2:Info>Specifies the available VM network connections</ns2:Info>
            </ns6:NetworkConnectionSection>
            <ns6:GuestCustomizationSection
                type="application/vnd.vmware.vcloud.guestCustomizationSection+xml"
                href="https://vcloud.example.com/api/vAppTemplate/vm-a2d8cb0e-b9d9-4692-a34b-d390e60fbec9/guestCustomizationSection/" ns2:required="false">
                <ns2:Info>Specifies Guest OS Customization Settings</ns2:Info>
                <ns6:Enabled>false</ns6:Enabled>
                <ns6:ChangeSid>false</ns6:ChangeSid>
                <ns6:VirtualMachineId>a2d8cb0e-b9d9-4692-a34b-d390e60fbec9</ns6:VirtualMachineId>
                <ns6:JoinDomainEnabled>false</ns6:JoinDomainEnabled>
                <ns6:UseOrgSettings>false</ns6:UseOrgSettings>
                <ns6:AdminPasswordEnabled>true</ns6:AdminPasswordEnabled>
                <ns6:AdminPasswordAuto>true</ns6:AdminPasswordAuto>
                <ns6:AdminAutoLogonEnabled>false</ns6:AdminAutoLogonEnabled>
                <ns6:AdminAutoLogonCount>0</ns6:AdminAutoLogonCount>
                <ns6:ResetPasswordRequired>false</ns6:ResetPasswordRequired>
                <ns6:ComputerName>DamnSmallLi-001</ns6:ComputerName>
                <ns6:Link
                    rel="edit"
                    type="application/vnd.vmware.vcloud.guestCustomizationSection+xml"
                    href="https://vcloud.example.com/api/vAppTemplate/vm-a2d8cb0e-b9d9-4692-a34b-d390e60fbec9/guestCustomizationSection/"/>
            </ns6:GuestCustomizationSection>
            <ns2:ProductSection ns2:instance="" ns2:class="" ns2:required="true">
                <ns2:Info>Information about the installed software</ns2:Info>
                <ns2:Category>vCloud</ns2:Category>
                <ns2:Property ns2:value="" ns2:userConfigurable="true" ns2:type="string" ns2:password="false" ns2:key="vCloud_reconfigToken">
                    <ns2:Label>vCloud_reconfigToken</ns2:Label>
                </ns2:Property>
                <ns2:Property ns2:value="" ns2:userConfigurable="true" ns2:type="string" ns2:password="false" ns2:key="vCloud_UseSysPrep">
                    <ns2:Label>vCloud_UseSysPrep</ns2:Label>
                </ns2:Property>
                <ns2:Property ns2:value="" ns2:userConfigurable="true" ns2:type="string" ns2:password="false" ns2:key="vCloud_bitMask">
                    <ns2:Label>vCloud_bitMask</ns2:Label>
                </ns2:Property>
                <ns2:Property ns2:value="" ns2:userConfigurable="true" ns2:type="string" ns2:password="false" ns2:key="vCloud_markerid">
                    <ns2:Label>vCloud_markerid</ns2:Label>
                </ns2:Property>
                <ns2:Property ns2:value="" ns2:userConfigurable="true" ns2:type="string" ns2:password="false" ns2:key="vCloud_computerName">
                    <ns2:Label>vCloud_computerName</ns2:Label>
                </ns2:Property>
                <ns2:Property ns2:value="" ns2:userConfigurable="true" ns2:type="string" ns2:password="false" ns2:key="vCloud_numnics">
                    <ns2:Label>vCloud_numnics</ns2:Label>
                </ns2:Property>
                <ns2:Property ns2:value="" ns2:userConfigurable="true" ns2:type="string" ns2:password="false" ns2:key="vCloud_primaryNic">
                    <ns2:Label>vCloud_primaryNic</ns2:Label>
                </ns2:Property>
                <ns2:Property ns2:value="" ns2:userConfigurable="true" ns2:type="string" ns2:password="false" ns2:key="vCloud_adminPassword">
                    <ns2:Label>vCloud_adminPassword</ns2:Label>
                </ns2:Property>
                <ns2:Property ns2:value="" ns2:userConfigurable="true" ns2:type="string" ns2:password="false" ns2:key="vCloud_resetPassword">
                    <ns2:Label>vCloud_resetPassword</ns2:Label>
                </ns2:Property>
            </ns2:ProductSection>
            <ns6:VAppScopedLocalId>DamnSmallLinux</ns6:VAppScopedLocalId>
            <ns6:DateCreated>2013-03-29T09:28:06.327+02:00</ns6:DateCreated>
        </ns6:Vm>
    </ns6:Children>
    <ns2:NetworkSection ns6:href="https://vcloud.example.com/api/vAppTemplate/vappTemplate-a43ab159-1b59-412d-86d7-22fcb6fb5bac/networkSection/" ns6:type="application/vnd.vmware.vcloud.networkSection+xml">
        <ns2:Info>The list of logical networks</ns2:Info>
    </ns2:NetworkSection>
    <ns6:NetworkConfigSection
        type="application/vnd.vmware.vcloud.networkConfigSection+xml"
        href="https://vcloud.example.com/api/vAppTemplate/vappTemplate-a43ab159-1b59-412d-86d7-22fcb6fb5bac/networkConfigSection/" ns2:required="false">
        <ns2:Info>The configuration parameters for logical networks</ns2:Info>
    </ns6:NetworkConfigSection>
    <ns6:LeaseSettingsSection
        type="application/vnd.vmware.vcloud.leaseSettingsSection+xml"
        href="https://vcloud.example.com/api/vAppTemplate/vappTemplate-a43ab159-1b59-412d-86d7-22fcb6fb5bac/leaseSettingsSection/" ns2:required="false">
        <ns2:Info>Lease settings section</ns2:Info>
        <ns6:Link
            rel="edit"
            type="application/vnd.vmware.vcloud.leaseSettingsSection+xml"
            href="https://vcloud.example.com/api/vAppTemplate/vappTemplate-a43ab159-1b59-412d-86d7-22fcb6fb5bac/leaseSettingsSection/"/>
        <ns6:StorageLeaseInSeconds>7776000</ns6:StorageLeaseInSeconds>
       &