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
organizations
federation of 136
to list 41, 48
OVF descriptor, to download 68
OVF environment 120
OVF package
manifest file 59, 63
to upload or download 55
uploading 57
OVF specification 81
OVF upload
initiating 59
to monitor progress of 64
using ranged PUTs 65
P
ProductSection element, to retrieve or
update 83
Provider vDC
resource pool set 213
to add or remove storage profiles 216
to create 209
to merge 193, 218
to retrieve or update 193
Q
queries
packaged 252
typed 248
query service
about 247
and metadata 260
query parameters 257
query types 248
R
requests
about 18
headers 18, 307
login 24
resource pool
adding 214
list of 193
removing 214
to enable or disable 193
to migrate virtual machines to or from 193
resource pool set, Provider vDC 213
resource pools, to retrieve list from vCenter 201
responses, about 20
right, to create 300
role, to create 187, 189
roles and rights 187
S
SAML
identity provider 46, 179
organization settings for 136
schema files
accessing 21
retrieving 43
schema reference 21
SectionType element, to retrieve or update 108
service
DHCP 166
NAT 160
service links
required and optional elements 288
to add 288
to add or remove 288
to delete 289
Session object, to delete 40
snapshot, of vApp 83
SSL certificate, to upload 233
static routing service
in Edge Gateway 161
in vApp network 112
status attribute
of vApp or vApp template 57
values 310
storage profiles
compliance check for virtual machine 83
to refresh list of 207
to retrieve list from vCenter 207
system settings, to retrieve or update 197
T
task
blocking 277
service-specific 291
to cancel 129
to retrieve 129
update progress 279
task list, to retrieve 129
task operations 274
timezone, in dateTime values 307
truststore, to upload 233
U
user
to create 129, 180
to import 182
to import from SAML 185
to retrieve 129
to update or remove 129
users, to administer 179
Index
VMware, Inc. 317