5.1
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 Template as OVF
- Upload a Media Image
- Copying and Moving with the vCloud API
- Capturing and Importing vApps
- Cataloging vApp Templates and Media Images
- Creating and Using Independent Disks
- View or Change the Owner of an Object
- 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
- 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
- Controlling Access to vApps and Catalogs
- Managing and Monitoring a Cloud
- Summary of vSphere Platform Extension 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
n
“Operate a vApp,” on page 96
n
“Configuring vApps and Virtual Machines,” on page 97
Summary of vCloud API vApp and Virtual Machine Operations Requests
These vCloud API operations requests create, manage, operate, and delete vApps and the virtual machines
that they contain.
n
API-URL is a URL of the form https://vcloud.example.com/api.
n
id is a unique identifier in the form of a UUID, as defined by RFC 4122.
n
VApp-or-Vm-URL is a URL of the form API-URL/vApp/vapp-id (for a VApp object) or API-URL/vApp/vm-
id (for a Vm object)
n
Vm-URL is a URL of the form API-URL/vApp/vm-id
IMPORTANT Request URLs are always available in Link elements contained by the representation of the object
on which they operate. URL forms shown here are for reference purposes only. Although URLs have a well-
known syntax and a well-understood interpretation, a client should treat vCloud API request URLs as opaque
strings. The rules that govern how the server constructs these strings might change in future releases.
This summary may not cover all requests in this category. For the complete list of requests, along with detailed
information about input and output types, see the Operations lists in the schema reference.
Table 5-1. Summary of vApp and Virtual Machine Operations Requests
Operation Request Request Body Response
Instantiate a vApp template
to create a vApp
POST API-URL/vdc/id/
action/instantiateVAppTe
mplate
InstantiateVAppTemplat
eParams
VApp
Change the name or
description of a vApp.
PUT API-URL/vApp/vapp-
id
VApp Task
Compose a vApp POST API-URL/vdc/id/
action/composeVApp
ComposeVAppParams VApp
Recompose a vApp to add or
remove virtual machines
POST API-
URL/vApp/vapp-id/
action/recomposeVApp
RecomposeVAppParams Task
Deploy a vApp or Virtual
Machine
POST VApp-or-Vm-
URL/action/deploy
DeployVAppParams Task
Undeploy a vApp or Virtual
Machine
POST VApp-or-Vm-
URL/action/undeploy
UndeployVAppParams Task
Power On a vApp or Virtual
Machine
POST VApp-or-Vm-
URL/action/powerOn
None
Task
Power Off a vApp or Virtual
Machine
POST VApp-or-Vm-
URL/action/powerOff
None
Task
Reset a vApp or Virtual
Machine
POST VApp-or-Vm-
URL/action/reset
None
Task
Suspend a vApp or Virtual
Machine
POST VApp-or-Vm-
URL/action/suspend
None
Task
Discard the Suspended State
of a vApp or Virtual Machine
POST VApp-or-Vm-
URL/action/
discardSuspendedState
None
Task
Shut Down a vApp or Virtual
Machine
POST VApp-or-Vm-
URL/action/shutdown
None
Task
Chapter 5 Deploying and Operating vApps
VMware, Inc. 83