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
Extends
The base type from which this element is derived.
XML Representation
The XML representation of the element or type. Names of contained elements
are links to the reference pages for those elements.
Attributes
A table listing the following properties of each attribute of the element or type:
Attribute
The name of the attribute.
Type
The primitive XML type of the attribute.
Required
Yes for attributes that are required. No for attributes
that are optional.
Modifiable
A value of always means that a client request can
modify the value of this attribute. A value of create
means that this attribute can be set or modified only
as part of object creation. A value of none means that
this attribute is read-only.
Since
The vCloud API version in which this attribute first
appeared.
Description
A description of the purpose and contents of the
attribute.
Elements
A table listing the following properties of each element defined in the type:
Element
The name of the element.
Type
A link to the definition of the complex type that the
element is based on.
Occurrence
The occurrence constraint for the element. The
constraint can be one of the following expressions:
0..*
Optional. Can occur zero or more
times.
0..1
Optional. Can occur at most once.
1
Required. Must occur exactly once.
Modifiable
A value of always means that a client request can
modify the contents of this element. A value of
create means that element contents can be set or
modified only as part of object creation. A value of
none means that this element is read-only.
Since
The vCloud API version in which this element first
appeared.
Description
A description of the purpose and contents of the
element.
Operations
A summary of the operations permitted on the element. Operations are
categorized by request type; one of create, retrieve, update, and delete. This
sequence of verbs is often abbreviated with the acronym CRUD.
Chapter 1 About the VMware vCloud API
VMware, Inc. 21