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
Table 12‑4. status Attribute Values for VAppTemplate, VApp, Vm, and Media Objects (Continued)
Num
eric
Valu
e String Value Description
vAppTem
plate vApp Vm Media
10 MIXED Children do not all have the
same status.
YES YES No No
11 DESCRIPTOR_PEN
DING
Upload initiated, OVF
descriptor pending.
YES No No No
12 COPYING_CONTE
NTS
Upload initiated, copying
contents.
YES No No No
13 DISK_CONTENTS_
PENDING
Upload initiated , disk contents
pending.
YES No No No
14 QUARANTINED Upload has been quarantined. YES No No No
15 QUARANTINE_EX
PIRED
Upload quarantine period has
expired.
YES No No No
16 REJECTED Upload has been rejected. YES No No No
17 TRANSFER_TIMEO
UT
Upload transfer session timed
out.
YES No No YES
18 VAPP_UNDEPLOY
ED
The vApp is resolved and
undeployed.
YES No No No
19 VAPP_PARTIALLY
_DEPLOYED
The vApp is resolved and
partially deployed.
YES No No No
VDC objects have their own set of status values and mappings.
Table 12‑5. status Attribute Values for VDC Objects
Numeric
Value String Value Description
-1 FAILED_CREATION The VDC could not be created.
0 NOT_READY The VDC is not ready for use
1 READY The VDC Is ready for use
2 UNKNOWN The VDC status could not be retrieved
3 UNRECOGNIZED The VDC status cannot be mapped to a known state.
Retrieve an Object as an Entity
You can use the vCloud API entity resolver with an object's id attribute value to retrieve a context-free
reference to the object.
Every first-class object that the vCloud API defines includes an id attribute whose value is 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.
You can append the value of the id attribute to the vCloud API entityResolver URL to retrieve a context-
free representation of the underlying object as an Entity element.
Prerequisites
Verify that you are logged in to the vCloud API as a system administrator or member of an organization in
the cloud.
vCloud API Programming Guide
362 VMware, Inc.