1.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
- Provisioning an Organization with vApps, Templates, and Media
- 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
- Operate a vApp
- Configuring vApps and Virtual Machines
- Retrieve the Configuration Links for a vApp
- Retrieve the Configuration Links for 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
- Creating, Provisioning, and Managing Organizations
- Summary of Administrative Requests
- Administrator Credentials and Privileges
- Organization Administration
- Network Administration
- vDC Administration
- Catalog Administration
- User and Group Administration
- Working With Roles and Rights
- Controlling Access to vApps and Catalogs
- Using vCloud API Extensions to Provision and Manage a Cloud
- Working With Object Metadata
- Using the Query Service
- Configuring and Using Blocking Tasks and Notifications
- XML Representations in the vCloud API
- Index
Contents
vCloud API Programming Guide 7
1
About the VMware vCloud API 9
Object Taxonomy 10
Objects, References, and Representations 11
Links and Link Relations 12
Client Workflow Overview 15
Using the vCloud API with vCloud Director 18
About the vCloud API Examples 22
2
Hello vCloud: A Simplified RESTful Workflow 23
Logging In 24
Find a Catalog and a vDC 26
Retrieve the Contents of a Catalog 27
Retrieve a Catalog Item 28
Retrieve Deployment Information From the vDC 30
Deploy the vApp 31
Get Information About a vApp 34
Displaying the Virtual Machine Console 37
Delete the vApp 38
Log Out 39
3
Exploring a Cloud 41
Summary of vCloud API Browsing Requests 41
Retrieve the Login URL and List of Supported API Versions 42
Create a Login Session 44
Retrieve a List of Organizations Accessible to You 46
Retrieve an Administrative View of a Cloud 47
Retrieve a List of vSphere Platform Operations and Objects for a Cloud 49
4
Provisioning an Organization with vApps, Templates, and Media 53
Summary of vCloud API Provisioning Requests 54
Upload an OVF Package to Create a vApp Template 55
Download a vApp Template as OVF 64
Upload a Media Image 67
Copying and Moving with the vCloud API 69
Capturing and Importing vApps 70
Cataloging vApp Templates and Media Images 70
View or Change the Owner of an Object 73
VMware, Inc.
3