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
Index
A
administrative tasks, about 129
administrator, system 132
AMQP
about 263
certificate and truststore 233
AMQP settings
to configure 264
to test 266
API client, to develop 21
attributes
custom 105
name 310
status 310
B
blocking task, to configure 263
blocking task requests, to monitor 276
blocking task settings, to configure 273
browsing 41
C
catalog
adding items 73
change owner 79
controlling access to 191
removing items 75
to administer 176
to change owner 129
to create 129, 176
to delete 129
to find 26
to publish 178
to retrieve 27, 41
catalog item, to retrieve 28, 41
client, REST 21
cloud, administrative view of 49
console, displaying 37
D
datastore
to delete 193
to enable or disable 193
to retrieve or update 193
DHCP 160, 166
dhcp service, in vApp network 112
DHCP service, in Edge Gateway 166
disk, independent 75
download URL 68
E
Edge Gateway
about 148
interface capacity 170
syslog server settings 175
to create 151
to create or update 129
entity, retrieve object as 12
entity resolver, about 312
event, service-specific 293
examples, conventions for 22
extensibility 282
extension framework 281
extension services
ACL rules 298
and events 291
and tasks 291
API definition 303
API filters for 302
authorization frameworks for 294
localization of 302
resource class actions 297
resource classes 295
REST APIs for 302
to register 284
URL patterns for 302
external network
to create 219
to retrieve or update 193
F
firewall service
and syslog 175
in Edge Gateway 158
in vApp network 112
G
group
to create, update, or remove 129
to import 183
to import from SAML 185
groups, to administer 179
VMware, Inc. 315