5.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
- 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 or vApp Template as OVF
- Upload a Media Image
- Download a Media Image
- Capturing and Importing vApps
- Managing Catalog Items
- Creating and Using Independent Disks
- View or Change the Owner of an Object
- Controlling Access to vApps and Catalogs
- Deploying and Operating vApps
- Summary of vCloud API vApp and Virtual Machine Operations Requests
- Create a vApp From a Template
- Create a vApp From an OVF Package
- Compose a vApp From Existing Virtual Machines
- Recompose a vApp to Add or Remove Virtual Machines
- Clone a vApp
- Capture a vApp as a Template
- Update vApp Access Controls
- 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
- Managing and Monitoring a Cloud
- Summary of System Administration 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 7‑1. Summary of vSphere Platform Extension Requests (Continued)
Operation Request Request Body Response
Remove a vApp from
maintenance mode.
POST API-
URL/vApp/id/action/exitM
aintenanceMode
None 204 No Content
Relocate a virtual machine
in a vApp template to a
different datastore.
[DEPRECATED]
POST API-
URL/vAppTemplate/vm-
id/action/relocate
RelocateParams Task
Relocate a virtual machine
to a different datastore.
[DEPRECATED]
POST API-URL/vApp/vm-
id/action/relocate
RelocateParams Task
Migrate a virtual machines
to a different resource pool.
POST API-
URL/admin/extension/reso
urcePool/id/action/migrate
Vms
MigrateParams Task
Retrieve a URL that you can
use to access a vSphere
object with a vSphere client.
GET API-
URL/admin/extension/vim
Server/id/vimObjType/vimO
bjMoref/vSphereWebClient
Url
None
VSphereWebClientUrl
Merge Provider VDCs. PUT API-
URL/admin/extension/pro
vidervdc/id/action/merge
None 204 No Content
Retrieve the list of storage
profiles that exist on a
vCenter server.
GET API-
URL/admin/extension/vim
Server/id/storageProfiles
None
VMWStorageProfiles
Refresh the list of storage
profiles that exist on a
vCenter server.
POST API-
URL/admin/extension/vim
Server/id/action/refreshSto
rageProfiles
None
Task
Register vCloud Director so
that it appears as an
extension in the vSphere
Client Soultions Manager
tab.
POST API-
URL/admin/extension/vim
Server/id/action/refresh
None
Task
Retrieve or Update System Settings
A system administrator can retrieve or update a cloud-wide set of system properties. These properties
specify default values and behaviors for the cloud and all of the organizations in it.
The SystemSettings element includes all system settings for this cloud. The element also includes links that
allow you to retrieve these subsidiary elements, which define specific categories of settings.
GeneralSettings
Control the configuration and behavior of the entire cloud.
NotificationsSettings
Control the vCloud Director AMQP notifications service.
LdapSettings
Specify details of the system LDAP directory service.
AmqpSettings
Specify credentials and connection information for the AMQP broker that
handles notifications and blocking task messages.
EmailSettings
Define configuration and connection parameters for the system default email
service, and specifies properties of email alerts that the system sends.
Chapter 7 Managing and Monitoring a Cloud
VMware, Inc. 239