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
5
Deploying and Operating vApps 81
Summary of vCloud API vApp and Virtual Machine Operations Requests 83
Create a vApp From a Template 85
Compose a vApp From Existing Virtual Machines 87
Recompose a vApp to Add or Remove Virtual Machines 90
Provide User Input Requested by a Virtual Machine 92
Attach or Detach an Independent Disk 93
Creating and Using vApp Snapshots 95
Operate a vApp 96
Configuring vApps and Virtual Machines 97
6
Creating and Managing Organizations 129
Summary of Administrative Requests 129
Administrator Credentials and Privileges 132
Organization Administration 132
vDC Administration 139
Network Administration 147
Catalog Administration 176
User and Group Administration 179
Working With Roles and Rights 187
Controlling Access to vApps and Catalogs 191
7
Managing and Monitoring a Cloud 193
Summary of vSphere Platform Extension Requests 193
Retrieve or Update System Settings 197
Attach a vCenter Server 198
Finding Available vCenter Resources 200
Create a Provider vDC 209
Create an External Network 219
Create a Network Pool 222
Import a Virtual Machine from vCenter 228
Relocate a Virtual Machine to a Different Datastore 231
Truststore and Keytab Maintenance 233
Retrieve the vSphere URL of an Object 236
8
Working With Object Metadata 239
Retrieve or Update a Metadata Element 241
Retrieve or Update a Metadata Value 244
9
Using the Query Service 247
Typed Queries 248
Packaged Queries 252
Query Parameters 257
Add a Metadata Filter to a Query 260
10
Configuring and Using Blocking Tasks and Notifications 263
Configure Notifications and AMQP Settings 264
Retrieve or Update Blocking Task Settings 273
vCloud API Programming Guide
4 VMware, Inc.