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
n
To disable a vDC, POST a request to its action/disable link.
n
To remove a vDC:
a POST a request to its action/disable link to disable the vDC.
After the vDC is disabled, its representation includes a rel="remove" link.
b Make a DELETE request to the vDC's rel="remove" link.
The server takes the requested action and returns an HTTP status of 204 No Content.
Catalog Administration
A newly created organization has no catalogs in it. After an organization administrator or catalog author creates
a catalog, members of the organization can add items to it or remove items from it if they have the necessary
rights.
Catalogs can contain references to vApp templates and media images. A system administrator or a privileged
member of the organization that owns the catalog can create and remove these references. A catalog can be
shared to make it visible to other members of an organization, and can be published to make it visible to
administrators in other organizations. A system administrator specifies which organizations can publish
catalogs, and an organization administrator controls access to catalogs by organization members.
Access to Catalogs
By default, a catalog is accessible only to its creator. An organization administrator or catalog author can grant
catalog access to other members of the organization, individually, or collectively. See “Controlling Access to
vApps and Catalogs,” on page 157. An organization administrator or catalog author can also publish a catalog
to make it available to administrators in other organizations. An organization administrator or system
administrator can change the owner of a catalog. See “View or Change the Owner of an Object,” on page 73.
Add a Catalog to an Organization
Every organization has an add URL for catalogs. An organization administrator or catalog author can create
a catalog by POSTing an AdminCatalog element to this URL
A newly-created Catalog object is an empty container for references to vApp templates and media images.
Prerequisites
Verify that you are logged in as a system administrator, an organization administrator, or a user with the
Catalog Author role.
Procedure
1 Retrieve the XML representation of the organization to which you want to add the catalog.
Use a request like this one:
GET https://vcloud.example.com/api/admin/org/26
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"/>
Chapter 6 Creating, Provisioning, and Managing Organizations
VMware, Inc. 145