1.0
Table Of Contents
- vCloud API Programming Guide
- Contents
- About This Book
- Introducing the VMware vCloud API
- Hello vCloud: A Structured REST Workflow Example
- Logging In and Getting an Organization List
- Browsing an Organization
- Finding a vApp Template
- Getting Information About a vDC
- Instantiating the Template in the vDC
- Deploying and Powering On the vApp
- Getting Information About the vApp
- Displaying the Console
- Deleting the vApp
- Logging Out
- Moving on to Additional Use Cases
- Browsing
- Provisioning
- Summary of Provisioning Requests
- Upload OVF to Create a vApp Template
- View the OVF Descriptor of a vApp Template
- Download a vApp Template as OVF
- Upload a Media Image
- Copying and Moving
- Changing a Name or Description
- Delete a vAppTemplate, vApp, or Media Image
- Cataloging vApp Templates and Media Images
- Controlling Access
- Datacenter Operations
- Summary of Datacenter Operations Requests
- vApp Lifecycle
- Instantiate a vApp Template
- Compose a vApp
- Recompose a vApp to Add or Remove Virtual Machines
- Capture a vApp to Create a vApp Template
- Reconfiguring vApps and Virtual Machines
- Deploying and Controlling vApps and Virtual Machines
- Deploy a vApp or Virtual Machine
- Undeploy a vApp or Virtual Machine
- Power On a vApp or Virtual Machine
- Power Off a vApp or Virtual Machine
- Reset a vApp or Virtual Machine
- Suspend a vApp or Virtual Machine
- Discard the Suspended State of a vApp or Virtual Machine
- Shut Down a vApp or Virtual Machine
- Reboot a vApp or Virtual Machine
- List Media Devices of a Virtual Machine
- Insert Media Into a Virtual Machine
- Eject Media from a Virtual Machine
- Get a Screen Thumbnail for a Virtual Machine
- Get a Screen Ticket for a Virtual Machine
- Provide User Input Requested by a Virtual Machine
- Control Access to vApps
- Retrieve a Task
- Administrative Operations
- VMware vSphere Platform Operations
- Summary of vSphere Platform Operations Requests
- List vSphere Platform Operations and Objects for a vCloud
- List Provider vDCs in a vCloud
- List External Networks in a vCloud
- List Network Pools in a vCloud
- List vCenter Servers Registered to a vCloud
- List ESX/ESXi Hosts in a vCloud
- Create a Provider vDC
- Create an External Network
- Create a Network Pool
- Import a Virtual Machine from vCenter
- XML Representations in the vCloud API
- User API Reference
- Request Parameters Reference
- Administrative API Reference
- vSphere Platform Extensions Reference
- OVF and the vCloud API
- An Introduction to REST for vCloud API Users
- Index
VMware, Inc. 209
Index
A
AccessLevel element
example of use 57
schema reference 178
AccessSetting element
example of use 56, 57
schema reference 178
AccessSettings element
example of use 56
schema reference 178
AdminVdc element
example of use 104
AllEULAsAccepted
description 172
AllEULAsAccepted element
example of use 63, 65
authentication
about 18
example request 21
AvailableNetworks element
example of use 103, 104, 129
schema reference 153
C
CaptureVAppParams element
example of use 68
schema reference 175
Catalog element
example of use 35
schema reference 160
CatalogItem element
example of use 36
schema reference 160
CatalogItems element
schema reference 160
Catalogs
about 14
controlling access to 56
CloneMediaParams element
example of use 51
schema reference 176
CloneVAppParams element
example of use 52
schema reference 176
CloneVAppTemplateParams element
example of use 51
schema reference 176
ComposeVAppParams element
example of use 65
schema reference 173
Configuration element
schema reference 155
ControlAccessParams element
example of use 56
schema reference 177
D
DeployVAppParams
example of use 26, 81
DeployVAppParams element
schema reference 175
E
Error codes 146
Error element
schema reference 146
examples
about 19
ExternalNetwork element
example of use 99
schema reference 180
F
File element
schema reference 154
Firewall rules
to create or modify 72
FirewallRule element
example of use 72
FirewallService element
example of use 72
schema reference 156
G
Group element
example of use 113
schema reference 191
GuestCustomizationSection element
cannot be passed in InstantiationParams 80
H
Host element
example of use 124