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
2 Examine the response to locate the Link element that contains the URL for adding catalogs to the
organization.
This element has a rel attribute value of add and a type attribute value of
application/vnd.vmware.admin.catalog+xml, as shown here:
<Link
href="https://vcloud.example.com/api/admin/org/5/catalogs"
rel="add"
type="application/vnd.vmware.admin.catalog+xml"/>
3 Create an AdminCatalog element.
See the request portion of “Example: Create a Catalog,” on page 177.
4 POST the AdminCatalog element to the organization's add URL for catalogs.
See the request portion of “Example: Create a Catalog,” on page 177.
The server creates an empty catalog. See the response portion of “Example: Create a Catalog,” on page 177.
Example: Create a Catalog
This example adds a catalog to the organization created in “Example: Create an Organization,” on page 133.
Request:
POST https://vcloud.example.com/api/admin/org/26/catalogs
Content-Type: application/vnd.vmware.admin.catalog+xml
...
<?xml version="1.0" encoding="UTF-8"?>
<AdminCatalog
xmlns="http://www.vmware.com/vcloud/v1.5"
name="Example Catalog">
<Description>New Catalog for Example Org</Description>
</AdminCatalog>
The response contains information extracted from the request, and includes these additions that the server
creates:
n
A URL, in the value of the href attribute of the response body, that references the new catalog.
n
Links that you can use to add an item to the catalog, edit catalog properties, or remove the catalog.
n
A link to an alternate view of this catalog. All users can access the catalog at this URL.
n
An empty CatalogItems element.
n
A Task that tracks the creation of the catalog.
n
An IsPublished element whose content is the string false, indicating that the catalog is not published.
Response:
201 Created
Content-Type: application/vnd.vmware.admin.catalog+xml
...
<AdminCatalog
xmlns:vcloud="http://www.vmware.com/vcloud/v1.5"
name="Example Catalog"
id="urn:vcloud:catalog:32"
type="application/vnd.vmware.admin.catalog+xml"
href="https://vcloud.example.com/api/admin/catalog/32">
<Link
Chapter 6 Creating and Managing Organizations
VMware, Inc. 177