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
Table 11‑1. Summary of vCloud API Extensibility Requests
Operation Request Request Body Response
Register an extension service
with vCloud Director
POST API-
URL/admin/extension/serv
ice
Service Service
Retrieve a list of registered
extension services.
GET API-
URL/admin/extension/serv
ice
None
ExtensionServices
Update a registered
extension service.
PUT API-
URL/admin/extension/serv
ice/id
Service Service
Delete a registered extension
service.
DELETE API-
URL/admin/extension/serv
ice/id
None 204 No Content
Register extension service
links with vCloud Director
objects.
POST API-
URL/admin/extension/serv
ice/id/links
ServiceLink ServiceLink
Create resource class
definitions for a registered
extension service.
POST API-
URL/admin/extension/serv
ice/id/resourceClasses
ResourceClass ResourceClass
Associate actions with a
resource class.
POSTAPI-
URL/admin/extension/serv
ice/resourceClass/id/resour
ceClassActions
ResourceClassAction ResourceClassAction
Create an ACL rule for a
resource class.
POSTAPI-
URL/admin/extension/serv
ice/resourceClassAction/id
/aclRules
AclRule AclRule
Associate a right with an
extension service.
POSTAPI-
URL/admin/extension/serv
ice/id/rights
Right RightRight
Update a right associated
with an extension service.
PUTAPI-
URL/admin/right/id
Right Right
Delete rights no longer
associated with a role or
ACL rule after the
associated extension service
has been deleted.
POSTAPI-
URL/admin/extension/serv
ice/action/clearUnusedRig
hts
None 204 No Content
List the access rights for a
specific combination of user
and entity
POSTAPI-
URL/admin/user/id/entity
Rights
EntityReferences UserEntityRights
Create a Task object in the
organization/id
POSTAPI-URL/tasksList/id
Task Task
Update a Task object PUTAPI-URL/task/id
Task Task
Post an extension service
event to the system.
POSTAPI-
URL/admin/org/id/events
Event
204 No Content
Initiate the upload of a
localization bundle for an
extension service.
POSTAPI-
URL/admin/extension/serv
ice/id/localizationBundles
BundleUploadParams BundleUploadSocket
Chapter 11 vCloud Director Extension Services
VMware, Inc. 331