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
Object Identifier, Type, and Reference
These attributes are common to all object representations.
id
The object identifier, expressed in URN format. The value of the id attribute
uniquely identifies the object, persists for the life of the object, and is never
reused. The id attribute value is intended to provide a context-free identifier
that can be used with the vCloud API entityResolver (see “Retrieve an Object
as an Entity,” on page 237), and is also suitable for use by clients that need to
access the object using a different API.
type
The object type, specified as a MIME content type.
href
An object reference, expressed in URL format. Because this URL includes the
object identifier portion of the id attribute value, it uniquely identifies the
object, persists for the life of the object, and is never reused. The value of the
href attribute is a reference to a view of the object, and can be used to access a
representation of the object that is valid in a particular context. Although URLs
have a well-known syntax and a well-understood interpretation, a client
should treat each href as an opaque string. The rules that govern how the server
constructs href strings might change in future releases.
Object Creation Status
Objects such as VAppTemplate, VApp, and Vm, that extend the ResourceEntity type have a status attribute whose
value indicates the state of the object. In this table, YES indicates that a status value is allowed for the object
listed in the column header. The status value for a VAppTemplate or VApp, which contain Vm objects that each
have a status attribute of their own, is computed from the status of the contained objects.
Table 11-3. status Attribute
Value Description vAppTemplate vApp Vm
-1 The object could not be created. YES YES YES
0 The object is unresolved. YES YES YES
1 The object is resolved. YES YES YES
2 The object is deployed. No No No
3 The object is suspended. No YES YES
4 The object is powered on. No YES YES
5 The object is waiting for user input. No YES YES
6 The object is in an unknown state. YES YES YES
7 The object is in an unrecognized state. YES YES YES
8 The object is powered off. YES YES YES
9 The object is in an inconsistent state. No YES YES
10 Children do not all have the same status. YES YES No
11 Upload initiated, OVF descriptor pending. YES No No
12 Upload initiated, copying contents. YES No No
13 Upload initiated , disk contents pending. YES No No
14 Upload has been quarantined. YES No No
15 Upload quarantine period has expired. YES No No
vCloud API Programming Guide
236 VMware, Inc.