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
object identifiers 12
object references, about 12
organization
retrieve or update settings 157
system 152
to create, update, or remove 149
to retrieve administrative view of 149
to administer 153
to create 153
to enable or disable 149, 160
to remove 160
organization VDC network
about 169
direct 188
isolated 194
routed 191
to administer 169
to configure static routes 182
to create 187
to create, update, or remove 149
organizations
federation of 157
to list 41, 49
OVF, to instantiate 97
OVF descriptor
to download 70
upload URL for 62
OVF environment 139
OVF package
manifest file 60, 66
to upload or download 55
uploading 58
OVF specification 89
OVF upload
initiating 60
to monitor progress of 66
using ranged PUTs 67
P
ProductSection element, to retrieve or
update 91
Provider VDC
resource pool set 255
to retrieve or update 235
to add or remove storage profiles 258
to create 251
to merge 235, 260
Q
queries
packaged 294
typed 290
query service
about 289
and metadata 303
attribute names 299
query parameters 299
query encoding rules 299
query types 290
R
requests
about 18
headers 18, 357
login 24
resource pool
adding 256
list of 235
removing 256
to enable or disable 235
to migrate virtual machines to or from 235
resource pool set, Provider VDC 255
resource pools, to retrieve list from vCenter 244
responses, about 20
right
reference format 231
to create 349
role, to create 227, 231
roles and rights 227
S
SAML
identity provider 46, 219
organization settings for 157
schema files
accessing 22
retrieving 43
schema reference 22
SectionType element, to retrieve or update 127
service
DHCP 187
NAT 181
service links
required and optional elements 336
to add 336
to add or remove 336
to delete 337
Session object, to delete 40
snapshot, of vApp 91
SSL certificate, to upload 275
static routing service
in Edge Gateway 182
in vApp network 131
status attribute
of vApp or vApp template 58
values 360
storage profiles
and storage policies 166, 258
compliance check for virtual machine 91
Index
VMware, Inc. 367