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
5
Deploying and Operating vApps 75
Summary of vCloud API vApp and Virtual Machine Operations Requests 77
Create a vApp From a Template 78
Compose a vApp From Existing Virtual Machines 80
Recompose a vApp to Add or Remove Virtual Machines 83
Operate a vApp 85
Configuring vApps and Virtual Machines 86
6
Creating, Provisioning, and Managing Organizations 109
Summary of Administrative Requests 109
Administrator Credentials and Privileges 111
Organization Administration 112
Network Administration 118
vDC Administration 139
Catalog Administration 145
User and Group Administration 148
Working With Roles and Rights 153
Controlling Access to vApps and Catalogs 157
7
Using vCloud API Extensions to Provision and Manage a Cloud 161
Summary of vSphere Platform Extension Requests 161
Retrieve or Update System Settings 165
Attach a vCenter Server 166
Finding Available vCenter Resources 167
Create a Provider vDC 173
Create an External Network 180
Create a Network Pool 183
Import a Virtual Machine from vCenter 189
Relocate a Virtual Machine to a Different Datastore 192
8
Working With Object Metadata 195
Retrieve or Update a Metadata Element 196
Retrieve or Update a Metadata Value 199
9
Using the Query Service 201
Typed Queries 201
Packaged Queries 207
Query Parameters 211
10
Configuring and Using Blocking Tasks and Notifications 215
Configure Notifications and AMQP Settings 216
Retrieve or Update Blocking Task Settings 225
Monitor Blocking Tasks 228
Take Action on a Blocking Task 229
Extend The Timeout Expiration of an Active Task 232
11
XML Representations in the vCloud API 233
XML Namespace Identifiers 234
vCloud API Programming Guide
4 VMware, Inc.