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
Table 7-1. Summary of vSphere Platform Extension Requests (Continued)
Operation Request Request Body Response
Unprepare a host. POST API-
URL/admin/extension/hos
t/id/action/unprepare
None
Task
Enable a host. POST API-
URL/admin/extension/hos
t/id/action/enable
None
Task
Disable a host. POST API-
URL/admin/extension/hos
t/id/action/disable
None
Task
Repair a host. POST API-
URL/admin/extension/hos
t/id/action/repair
None 204 No Content
Upgrade a host. POST API-
URL/admin/extension/hos
t/id/action/upgrade
None
Task
Create a Provider vDC.
[NEW]
POST API-
URL/admin/extension/pro
vidervdcsparams
VMWProviderVdcParams VMWProviderVdc
Create a Provider vDC.
[DEPRECATED]
POST API-
URL/admin/extension/pro
vidervdcs
VMWProviderVdc VMWProviderVdc
Retrieve a Provider vDC. GET API-
URL/admin/extension/pro
vidervdc/id
None
VMWProviderVdc
Update a Provider vDC. PUT API-
URL/admin/extension/pro
vidervdc/id
VMWProviderVdc VMWProviderVdc
Enable a Provider vDC. POST API-
URL/admin/extension/pro
vidervdc/id/action/enable
None 204 No Content
Disable a Provider vDC. POST API-
URL/admin/extension/pro
vidervdc/id/action/disable
None 204 No Content
Delete a Provider vDC. DELETE API-
URL/admin/extension/pro
vidervdc/id
None
Task
Create an external network. POST API-
URL/admin/extension/exte
rnalnets
VMWExternalNetwork VMWExternalNetwork
Retrieve an external network. GET API-
URL/admin/extension/exte
rnalnet/id
None
VMWExternalNetwork
Update an external network. PUT API-
URL/admin/extension/exte
rnalnet/id
VMWExternalNetwork VMWExternalNetwork
Delete an external network. DELETE API-
URL/admin/extension/exte
rnalnet/id
None
Task
Create a network pool. POST API-
URL/admin/extension/net
workPools
VMWNetworkPool VMWNetworkPool
Chapter 7 Managing and Monitoring a Cloud
VMware, Inc. 195