VMware VCLOUD API 1.0 - TECHNICAL NOTE, Programming Manual

Page: 64 / 212

vCloud API Programming Guide
64 VMware, Inc.
The response is a sparsely populated vApp body that contains a Task element The status of the vApp is initially
0 . When instantiation is complete and the vApp is powered on, the Task no longer appears in the vApp body,
and the vApp status changes to 4 , indicating that all of its children are powered on. You can check the status
of the task by issuing a GET request to the task URL or you can check the status of the vApp by issuing a GET
request to the vApp URL. These URLs are returned in the value of the object’s href attribute.
Retrieve or Modify the CustomizationSection of a vApp Template
A vApp template can include a CustomizationSection element that specifies whether or not the virtual
machines in the vApp should be customized when the vApp is instantiated. Example 5 ‐ 2 retrieves this section
from a vApp template.
Example 5-2. Retrieve vApp Template CustomizationSection
Request:
GET http://vcloud.example.com/api/v1.0/vAppTemplate/vappTemplate-3/customizationSection
Response:
200 OK
Content-type: application/vnd.vmware.vcloud.customizationxml
...
<CustomizationSection xmlns="http://www.vmware.com/vcloud/v1"
xmlns:ovf="http://schemas.dmtf.org/ovf/envelope/1"
xmlns:vcloud="http://www.vmware.com/vcloud/v1" ovf:required="false"
vcloud:href="http://vcloud.example.com/api/v1.0/vAppTemplate/vappTemplate-3/
customizationSection/"
vcloud:type="application/vnd.vmware.vcloud.customizationxml" ...>
<ovf:Info>VApp template customization section</ovf:Info>
<CustomizeOnInstantiate>true</CustomizeOnInstantiate>
<Link rel="edit" type="application/vnd.vmware.vcloud.customizationxml"
href="http://vcloud.example.com/api/v1.0/vAppTemplate/vappTemplate-3/
customizationSection/"/>
</CustomizationSection>
To change the value of CustomizeOnInstantiate , PUT a CustomizationSection body that has the changed
value to the section’s rel="edit" URL, as shown in Example 5 ‐ 3 .
Example 5-3. Modify vApp Template CustomizationSection
Request:
PUT http://vcloud.example.com/api/v1.0/vAppTemplate/vappTemplate-3/customizationSection
Content-type: application/vnd.vmware.vcloud.customizationxml
...
<CustomizationSection xmlns="http://www.vmware.com/vcloud/v1"
xmlns:ovf="http://schemas.dmtf.org/ovf/envelope/1"
xmlns:vcloud="http://www.vmware.com/vcloud/v1" ovf:required="false"
vcloud:href="http://vcloud.example.com/api/v1.0/vAppTemplate/vappTemplate-3/
customizationSection/"
vcloud:type="application/vnd.vmware.vcloud.customizationxml">
<ovf:Info>VApp template customization section</ovf:Info>
<CustomizeOnInstantiate>false</CustomizeOnInstantiate>
</CustomizationSection>
Response:
202 Accepted
Content-Type: application/vnd.vmware.vcloud.task+xml
...
<Task ...>
...
</Task>