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
<vmext:MoRef>datastore-191</vmext:MoRef>
<vmext:VimObjectType>DATASTORE</vmext:VimObjectType>
</vmext:VimObjectRef>
</VCloudExtension>
...
<Link
rel="relocate"
type="application/vnd.vmware.vcloud.relocateVmParams+xml"
href="https://vcloud.example.com/api/vApp/vm-257/action/relocate" />
...
</Vm>
4 Construct a RelocateParams element that specifies the destination datastore for the Vm.
See “Example: Relocate a Virtual Machine,” on page 233.
5 POST the RelocateParams element to the action/relocate link described in Step 3.
You do not need to power off the virtual machine before you make the request. See “Example: Relocate a
Virtual Machine,” on page 233.
The system creates a task to manage the relocation and returns a Task element in the response. When the task
is complete, the virtual machine is relocated.
Example: Relocate a Virtual Machine
This request relocates the virtual machine retrieved in Step 2 to one of the datastores listed in Step 1. The
response is a Task.
Request:
POST https://vcloud.example.com/api/vApp/vm-257/action/relocate
Content-Type: application/vnd.vmware.vcloud.relocateVmParams+xml
...
<?xml version="1.0" encoding="UTF-8"?>
<RelocateParams
xmlns="http://www.vmware.com/vcloud/v1.5">
<Datastore
href="https://vcloud.example.com/api/admin/extension/datastore/607" />
</RelocateParams>
Truststore and Keytab Maintenance
You can use the vCloud API to upload and manage SSL certificates, keystores, and Kerberos keytabs for your
organization's LDAP service.
The OrgLdapSettings element includes links that you can use to manage the organization's LDAP truststore
and keystore by uploading new certificates and keytabs.
<Link
rel="certificate:update"
type="application/vnd.vmware.admin.certificateUpdateParams+xml"
href="https://vcloud.example.com/api/admin/org/26/settings/ldap/action/updateLdapCertificate" />
<Link
rel="certificate:reset"
href="https://vcloud.example.com/api/admin/org/26/settings/ldap/action/resetLdapCertificate" />
<Link
rel="keystore:update"
Chapter 7 Managing and Monitoring a Cloud
VMware, Inc. 233