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
Table 11-1. XML Namespace Identifiers in the vCloud API (Continued)
Name Value Requirement
xsi:schemaLocati
on
An installation-dependent schema location search path. See
http://www.w3.org/TR/xmlschema-0/.
Not required in request bodies.
xmlns:xsi http://www.w3.org/2001/XMLSchema-instance Not required in request bodies.
XML Namespace Prefixes in Request and Response Bodies
When a request or response includes elements from multiple XML namespaces, each element name is prefixed
with a namespace identifier. Unless all elements in a request or response originate in the same XML namespace,
these prefixes are required in request bodies, and are always included in response bodies.
The examples omit XML namespace identifiers from most responses. The following fragment shows how some
of them appear in a typical response body.
<VApp
xmlns="http://www.vmware.com/vcloud/v1.5"
...
xmlns:ovf="http://schemas.dmtf.org/ovf/envelope/1"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.vmware.com/vcloud/v1.5
https://vcloud.example.com/api/schema/v1.5/master.xsd">
...>
...
</VApp>
Common vCloud API Attributes
Most vCloud API objects have a number of common attributes. With the exception of name, none of these
attributes are required in request bodies, and are ignored if included. All of them are included in response
bodies.
Object Name
Every object requires a name attribute. The string value of this attribute is included in all object references, and
can be used as the display name for the object. The value of name must be unique within a given scope.
Table 11-2. Requirements for Unique Object Names
Object Type Name Scope
ProviderVdc Cloud
Org Cloud
Vdc Organization
Catalog Organization
CatalogItem Catalog
vAppTemplate None
vApp Organization
Vm vApp
Media None
Network Container (Organization, vApp, or cloud)
Chapter 11 XML Representations in the vCloud API
VMware, Inc. 235