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 6-1. Summary of Administrative Requests (Continued)
Operation Request Request Body Response
List the organization vDCs
supported by a provider
vDC.
GET API-
URL/admin/providervdc/
id/vdcReferences
None
VdcReferences
Create an organization vDC. POST API-
URL/admin/org/id/vdcs
AdminVdc AdminVdc
Enable an organization vDC. POST API-
URL/admin/vdc/
id/action/enable
None 204 No Content
Disable an organization vDC. POST API-
URL/admin/vdc/
id/action/disable
None 204 No Content
Delete an organization vDC. DELETE API-
URL/admin/vdc/id
None
Task
Create a catalog. POST API-
URL/admin/org/id/catalogs
AdminCatalog AdminCatalog
Publish a catalog. POST API-
URL/admin/catalog/
id/action/publish
PublishCatalogParams
204 No Content
Update catalog properties. PUT API-
URL/admin/catalog/id
AdminCatalog AdminCatalog
Delete a catalog. DELETE API-
URL/admin/catalog/id
None 204 No Content
Update the owner of a
catalog.
PUT API-
URL/admin/catalog/
id/owner
Owner
204 No Content
Create or import a user. POST API-
URL/admin/org/id/users
User User
Update user properties. PUT API-
URL/admin/user/id
User User
Delete a user. DELETE API-
URL/admin/user/id
None 204 No Content
Import a group. POST API-
URL/admin/org/id/groups
Group Group
Delete a group. DELETE API-
URL/admin/group/id
None 204 No Content
Update group properties. PUT API-
URL/admin/group/id
Group Group
Create a role. POST API-
URL/admin/org/id/roles
Role Role
Update role properties. PUT API-
URL/admin/role/id
Role Role
Delete a role. DELETE API-
URL/admin/role/id
None 204 No Content
Retrieve a list of tasks owned
by organization id.
GET API-URL/tasksList/id None
TasksList
Retrieve a task. GET API-URL/task/id None
Task
Cancel a task. POST API-
URL/task/id/action/cancel
None 204 No Content
Chapter 6 Creating and Managing Organizations
VMware, Inc. 131