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
vCloud API Programming Guide
210 VMware, Inc.
schema reference 199
HTTP headers
Content-Type 142
HTTP status codes 18
I
InstantiateVAppTemplateParams element
example of use 25, 63
schema reference 172
Instantiation Parameters
about 62
InstantiationParams element
example of use 25, 63
schema reference 172
IpRange element
example of use 72
schema reference 156
L
Link element
about 15
rel attribute 15
login
example of 21
logout
example of 30
M
Media element
example of use 50
schema reference 161
MediaInsertOrEjectParams element
example of use 85
schema reference 177
N
NAT rules
to create or modify 72
NatRule element
example of use 72
schema reference 158
network
vApp 62
NetworkConfigSection element
example of use 71
O
Org element
example of use 22
schema reference 151
Org entity
to retrieve 34
OrgList element
example of use 21
OrgNetwork element
schema definition 154
OVF
to create vApp template from 42
to download vApp template as 47
to upload 171
P
Property element
example of use 36, 161
schema reference 161
R
rel attribute
about 15
ResourceEntity element
about 38
example of use 37, 55
schema reference 154
responses
contents of 18
Role element
example of use 114
schema reference 191
S
ScreenTicket element
example of use 30, 87
Source element
example of use 63, 65, 67
T
Task element
example of use 89
schema reference 168
Tasks
about 14
TasksList element
example of use 97
technical support resources 12
U
UndeployVAppParams element
schema reference 175
UploadVAppTemplateParams element
example of use 43
schema reference 171
User element
example of use 110
schema reference 190