5.1
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
- Summary of vCloud API Browsing Requests
- Retrieve the Login URL and List of Supported API Versions
- Create a Login Session Using the Integrated Identity Provider
- Retrieve a List of Organizations Accessible to You
- Retrieve an Administrative View of a Cloud
- Retrieve a List of vSphere Platform Operations and Objects for a Cloud
- Provisioning an Organization
- Summary of vCloud API Provisioning Requests
- Upload an OVF Package to Create a vApp Template
- Download a vApp Template as OVF
- Upload a Media Image
- Copying and Moving with the vCloud API
- Capturing and Importing vApps
- Cataloging vApp Templates and Media Images
- Creating and Using Independent Disks
- View or Change the Owner of an Object
- 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
- Provide User Input Requested by a Virtual Machine
- Attach or Detach an Independent Disk
- Creating and Using vApp Snapshots
- Operate a vApp
- Configuring vApps and Virtual Machines
- Retrieve the Configuration Links for a vApp
- Retrieve the Configuration Links for a Virtual Machine
- Update Multiple Sections of 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
- Update the Storage Profile for a Virtual Machine
- Creating and Managing Organizations
- Summary of Administrative Requests
- Administrator Credentials and Privileges
- Organization Administration
- vDC Administration
- Network Administration
- Catalog Administration
- User and Group Administration
- Working With Roles and Rights
- Controlling Access to vApps and Catalogs
- Managing and Monitoring a Cloud
- Summary of vSphere Platform Extension Requests
- Retrieve or Update System Settings
- Attach a vCenter Server
- Finding Available vCenter Resources
- Create a Provider vDC
- Create an External Network
- Create a Network Pool
- Import a Virtual Machine from vCenter
- Relocate a Virtual Machine to a Different Datastore
- Truststore and Keytab Maintenance
- Retrieve the vSphere URL of an Object
- Working With Object Metadata
- Using the Query Service
- Configuring and Using Blocking Tasks and Notifications
- vCloud Director Extension Services
- XML Representations in the vCloud API
- Index
Add an Item to a Catalog
A catalog can contain references to vApp templates and media images from any vDC in an organization. A
vApp template or media image can be listed in at most one catalog.
Prerequisites
Verify that you are logged in as a user with the Catalog Author role, as an organization administrator, or as a
system administrator.
Procedure
1 Retrieve the XML representation of your organization and look for links to the catalogs and vDCs it
contains.
Links to catalogs have the following form:
<Link rel="down"
type="application/vnd.vmware.vcloud.catalog+xml"
name="CatalogName"
href="https://vcloud.example.com/api/catalog/32"/>
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
Chapter 4 Provisioning an Organization
VMware, Inc. 73