1.5
Table Of Contents
- vCloud API Programming Guide
- Contents
- vCloud API Programming Guide
- About the VMware vCloud API
- Hello vCloud: A Simplified RESTful Workflow
- Exploring a Cloud
- Provisioning an Organization with vApps, Templates, and Media
- Deploying and Operating vApps
- Summary of vCloud API vApp and Virtual Machine Operations Requests
- Create a vApp From a Template
- Compose a vApp From Existing Virtual Machines
- Recompose a vApp to Add or Remove Virtual Machines
- Operate a vApp
- Configuring vApps and Virtual Machines
- Retrieve the Configuration Links for a vApp
- Retrieve the Configuration Links for a Virtual Machine
- Retrieve or Update a Modifiable Section
- Update a vApp Network Configuration
- Update the NetworkConnectionSection of a Virtual Machine
- Retrieve or Modify the CPU Configuration of a Virtual Machine
- Retrieve or Modify the GuestCustomizationSection of a Virtual Machine
- Retrieve or Modify ProductSection Elements
- Retrieve or Modify Groups of Related Sections in a Virtual Machine
- Retrieve or Modify the Hard Disk Configuration of a Virtual Machine
- Creating, Provisioning, and Managing Organizations
- Summary of Administrative Requests
- Administrator Credentials and Privileges
- Organization Administration
- Network Administration
- vDC Administration
- Catalog Administration
- User and Group Administration
- Working With Roles and Rights
- Controlling Access to vApps and Catalogs
- Using vCloud API Extensions to Provision and Manage a Cloud
- Working With Object Metadata
- Using the Query Service
- Configuring and Using Blocking Tasks and Notifications
- XML Representations in the vCloud API
- Index
Links to vDCs have the following form:
<Link rel="down"
type="application/vnd.vmware.vcloud.vdc+xml"
name="vDCName"
href="https://vcloud.example.com/api/vdc/5"/>
2 Browse the vDCs in your organization to find the ResourceEntity element that represents the item to add
to the catalog.
Resource entities are contained in the ResourceEntities element of a Vdc .
<Vdc
xmlns="http://www.vmware.com/vcloud/v1.5"
name="ExampleVdc01"
type="application/vnd.vmware.vcloud.vdc+xml"
href="https://vcloud.example.com/api/vdc/5">
...
<ResourceEntities>
<ResourceEntity
href="https://vcloud.example.com/api/vAppTemplate/vappTemplate-111"
type="application/vnd.vmware.vcloud.vAppTemplate+xml"
name="Ubuntu Template with vsftpd"/>
<ResourceEntity
type="application/vnd.vmware.vcloud.vAppTemplate+xml"
name="NewVAppTemplate"
href="https://vcloud.example.com/api/vAppTemplate/vappTemplate-559" />
...
</ResourceEntities>
...
</Vdc>
3 Retrieve the XML representation of the catalog to which to add the item.
Use a request like this one:
GET https://vcloud.example.com/api/catalog/32
4 Examine the response to locate the Link element that contains the URL for adding items to the catalog.
This element has a rel attribute value of add and a type attribute value of
application/vnd.vmware.admin.catalogItem+xml, as this example shows:
<Link
rel="add"
type="application/vnd.vmware.admin.catalogItem+xml"
href="https://vcloud.example.com/api/catalog/32/catalogItems"/>
5 Create a CatalogItem element that contains a reference to the ResourceEntity
See “Example: ResourceEntity and Corresponding CatalogItem,” on page 72 for an example.
6 POST the CatalogItem body to the catalog's rel="add" URL.
Step 4 explains how to find this URL.
Chapter 4 Provisioning an Organization with vApps, Templates, and Media
VMware, Inc. 71