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
Managing and Monitoring a Cloud 7
The VMware vCloud API includes extensions that support operations on the vSphere platform, which provides
resources to vCloud Director. A system administrator can use these extensions to retrieve or update the
configuration of a cloud, add or remove vSphere resources, and import vApps and media from vCenter.
Only the system administrator can perform vSphere platform operations. Before you attempt these operations,
log in to the System organization with the user name and password of the system administrator account that
was created when vCloud Director was installed. See “Administrator Credentials and Privileges,” on
page 132.
This chapter includes the following topics:
n
“Summary of vSphere Platform Extension Requests,” on page 193
n
“Retrieve or Update System Settings,” on page 197
n
“Attach a vCenter Server,” on page 198
n
“Finding Available vCenter Resources,” on page 200
n
“Create a Provider vDC,” on page 209
n
“Create an External Network,” on page 219
n
“Create a Network Pool,” on page 222
n
“Import a Virtual Machine from vCenter,” on page 228
n
“Relocate a Virtual Machine to a Different Datastore,” on page 231
n
“Truststore and Keytab Maintenance,” on page 233
n
“Retrieve the vSphere URL of an Object,” on page 236
Summary of vSphere Platform Extension Requests
vSphere platform extension requests allow a system administrator to operate on vSphere platform objects
registered to vCloud Director.
n
API-URL is a URL of the form https://vcloud.example.com/api.
VMware, Inc.
193