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 7‑1. Summary of vSphere Platform Extension Requests (Continued)
Operation Request Request Body Response
Create a network pool. POST API-
URL/admin/extension/net
workPools
VMWNetworkPool VMWNetworkPool
Retrieve a network pool. GET API-
URL/admin/extension/net
workPool/id
None
VMWNetworkPool
Update a network pool. PUT API-
URL/admin/extension/net
workPool/id
VMWNetworkPool VMWNetworkPool
Delete a network pool. DELETE API-
URL/admin/extension/net
workPool/id
None
Task
Import a virtual machine
from vCenter as a vApp.
POST API-
URL/admin/extension/vim
Server/id/importVmAsVap
p
ImportVmAsVAppParams VApp
Import a virtual machine
from vCenter as a vApp
template.
POST API-
URL/admin/extension/vim
Server/id/importVmAsVap
pTemplate
ImportVmAsVAppTemplate
Params
VAppTemplate
Retrieve the representation
of a datastore.
GET API-
URL/admin/extension/data
store/id
None
Datastore
Enable a datastore. POST API-
URL/admin/extension/data
store/id/action/enable
None
Datastore
Disable a datastore. POST API-
URL/admin/extension/data
store/id/action/disable
None
Datastore
Update a datastore. PUT API-
URL/admin/extension/data
store/id
Datastore Datastore
Delete a datastore. DELETE API-
URL/admin/extension/data
store/id
None 204 No Content
Import a virtual machine
from vCenter into an
existing vApp.
POST API-
URL/admin/extension/vim
Server/id/importVmIntoEx
istingVApp
ImportVmIntoExistingVA
ppParams
Task
Import a media image from
vCenter.
POST API-
URL/admin/extension/vim
Server/id/importMedia
ImportMediaParams Media
Enable a resource pool. POST API-
URL/admin/extension/reso
urcePool/id/action/enable
None 204 No Content
Disable a resource pool. POST API-
URL/admin/extension/reso
urcePool/id/action/disable
None 204 No Content
Place a vApp in
maintenance mode to
prevent users from changing
vApp metadata.
POST API-
URL/vApp/id/action/enter
MaintenanceMode
None 204 No Content
vCloud API Programming Guide
238 VMware, Inc.