5.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
- 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 or vApp Template as OVF
- Upload a Media Image
- Download a Media Image
- Capturing and Importing vApps
- Managing Catalog Items
- Creating and Using Independent Disks
- View or Change the Owner of an Object
- Controlling Access to vApps and Catalogs
- Deploying and Operating vApps
- Summary of vCloud API vApp and Virtual Machine Operations Requests
- Create a vApp From a Template
- Create a vApp From an OVF Package
- Compose a vApp From Existing Virtual Machines
- Recompose a vApp to Add or Remove Virtual Machines
- Clone a vApp
- Capture a vApp as a Template
- Update vApp Access Controls
- 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
- Managing and Monitoring a Cloud
- Summary of System Administration 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
A client might encounter a VCloudExtension element in any response. If the element declares
required=”true” and the client does not know how to interpret the contents of the element, the client can
ignore it, but it must include the VCloudExtension in any request to modify the element that contains it. A
server must return a failure when a request includes a VCloudExtension element that declares
required=”true” but the server does not understand the extension. For more information about
VCloudExtension, see the schema reference.
This chapter includes the following topics:
n
“XML Namespace Identifiers,” on page 359
n
“Common vCloud API Attributes,” on page 360
n
“Retrieve an Object as an Entity,” on page 362
XML Namespace Identifiers
Elements used as request or response bodies contain a set of attributes that enable XML validation. The
body of a PUT or POST request must contain all XML namespace identifiers required to validate the
elements it contains. A response body typically includes all the XML namespace identifiers that the server
used to validate it, in addition to other attributes that specify the schema locations searched during
validation.
The vCloud API uses these XML namespace identifier attributes and prefixes.
Table 12‑2. XML Namespace Identifiers in the vCloud API
Name Value Requirement
xmlns http://www.vmware.com/vcloud/v1.5 Required in all request bodies.
xmlns:vmext http://www.vmware.com/vcloud/extension/v1.5 Required in request bodies that include
elements from the vSphere platform
extensions.
xmlns:ve http://www.vmware.com/schema/ovfenv Required in request bodies that include
an ovf:Environmentelement.
xmlns:ovf http://schemas.dmtf.org/ovf/envelope/1 Required in request bodies that include
elements defined in OVF schema
http://schemas.dmtf.org/ovf/envelop
e/1/dsp8023.xsd.
xmlns:rasd http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/
CIM_ResourceAllocationSettingData
Required in request bodies that include
elements defined in OVF schema
CIM_ResourceAllocationSettingData.x
sd.
xmlns:oe http://schemas.dmtf.org/ovf/environment/1 Required in request bodies that include
elements defined in OVF schema
dsp8027_1.1.0.xsd.
xmlns:vssd http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/
CIM_VirtualSystemSettingData
Not required in request bodies.
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.
Chapter 12 XML Representations in the vCloud API
VMware, Inc. 359