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 5‑1. Summary of vApp and Virtual Machine Operations Requests (Continued)
Operation Request Request Body Response
Get a Screen Thumbnail for
a Virtual Machine
GET Vm-URL/screen None Returns a screen thumbnail
(Content-type: image/png) if
one is available. Otherwise
returns null (Content-
Length: 0).
Get a Screen Ticket for a
Virtual Machine
POST Vm-
URL/screen/action/acquire
Ticket
None
ScreenTicket
Attach an independent disk
to a virtual machine.
POST Vm-
URL/disk/action/attach
DiskAttachOrDetachPara
ms
Task
Detach an independent disk
from a virtual machine.
POST Vm-
URL/disk/action/detach
DiskAttachOrDetachPara
ms
Task
Create snapshots of all
virtual machines in a vApp.
POST API-
URL/vApp/vapp-id/
action/createSnapshot
CreateSnapshotParams Task
Remove snapshots of all
virtual machines in a vApp.
POST API-
URL/vApp/vapp-id/
action/removeAllSnapshots
None
Task
Revert all virtual machines
in a vApp to their current
snapshots.
POST API-
URL/vApp/vapp-id/
action/revertToCurrentSna
pshot
None
Task
Retrieve information about
vApp snapshots.
GET API-URL/vApp/vapp-
id/snapshotSection
None
SnapshotSection
Validate the storage profile
compliance of a virtual
machine.
POST API-URL/vApp/vm-
id/action/checkCompliance
None
Task
Retrieve a virtual machine
storage profile validation
report.
GET API-URL/vApp/vm-
id/complianceResult
None
ComplianceResult
Create a vApp From a Template
An instantiateVAppTemplate request creates a vApp from a vApp template.
To create a vApp from a vApp template, you must bind the template's abstract resource requirements, such
as network connections, storage resources, memory, and CPU capacity, to appropriate resources in the
target VDC. This binding operation is called instantiation.
For an example of a simple instantiation request, see “Deploy the vApp,” on page 31. You can also specify
additional parameters as part of instantiation.
Template contents that might influence composition of the request body include the following sections:
n
A NetworkConnectionSection that specifies network connection details for a virtual machine. Unless
you want to create a vApp in which none of the virtual machines are connected to a network, your
instantiation parameters must include at least one NetworkConfigSection that defines a vApp network,
and that section must include a NetworkConfig element whose networkName attribute value matches the
value of the network attribute of the NetworkConnection of each Vm in the template. If this attribute has
the value none or is missing, the Vm can connect to any network. If the template contains Vm elements that
specify different names for their network connections, you must create a vApp network for each.
Chapter 5 Deploying and Operating vApps
VMware, Inc. 93