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
rel="remove"
href="https://vcloud.example.com/api/media/254" />
<Description>ISO database image</Description>
<Files>
<File
size="51242131"
bytesTransferred="0"
name="file">
<Link
rel="upload:default"
href="https://vcloud.example.com/transfer/.../file" />
</File>
</Files>
<Owner
...
</Owner>
</Media>
Copying and Moving with the vCloud API
The vCloud API provides object-specific copy operations, implemented by clone actions, for media images,
vApp templates, and vApps. With these operations, you can create a copy of the object in the same vDC or in
another vDC in the same organization.
vCloud API copy operations support an option to delete the source object after the copy is complete. Doing so
when the source and target objects are in different vDCs moves the source object to the target vDC. Doing so
when the source and target objects are in the same vDC renames the source object. The vCloud API does not
include an explicit move operation. When you move an object by copying it and deleting its source, an
intermediate object is created in the target vDC, as part of the following sequence of events:
1 The source object is copied to an intermediate object whose name is a combination of the object name and
a UUID.
2 The source object is deleted.
3 The intermediate object is renamed with the name specified for the target object in the copy request.
Copy or Move a Media Image
The cloneMedia request makes a copy of the media image referenced in the Source element of the request body.
The request specifies a new name and, optionally, a new description for the copy. The request can optionally
include an IsSourceDelete element whose value specifies whether the source media image is deleted after the
copy is complete. If IsSourceDelete is missing from the request body or present with a value of false, the
source object remains in place after the copy is complete. Setting IsSourceDelete to true effectively moves the
media image.
For more information and an example, see the cloneMedia operation in the schema reference.
Copy or Move a vApp Template
The cloneVAppTemplate request makes a copy of the vApp template referenced in the Source element of the
request body. The request specifies a new name and, optionally, a new description for the copy. The request
can optionally include an IsSourceDelete element whose value specifies whether the source vApp template
is deleted after the copy is complete. If IsSourceDelete is missing from the request body or present with a value
of false, the source object remains in place after the copy is complete. Setting IsSourceDelete to true effectively
moves the vApp template.
For more information and an example, see the cloneVAppTemplate operation in the schema reference.
Chapter 4 Provisioning an Organization
VMware, Inc. 71