VMware VCLOUD API 1.0 - TECHNICAL NOTE, Programming Manual

Page: 54 / 212

vCloud API Programming Guide
54 VMware, Inc.
Change the Name or Description of a Media Image
Example 4 ‐ 21 changes the description of a media image that was created by the copy operation in
Example 4 ‐ 17 .
Example 4-21. Change the Description of a Media Image
Request:
PUT http://vcloud.example.com/api/v1.0/media/277
Content-Type: application/vnd.vmware.vcloud.media+xml
...
<Media name="database.iso" size="242131" imageType="iso" xmlns="http://www.vmware.com/vcloud/v1">
<Description>New description</Description>
</Media>
Response:
202 Accepted
Content-Type: application/vnd.vmware.vcloud.task+xml
...
<Task ...>
...
</Task>
Delete a vAppTemplate, vApp, or Media Image
You can use an HTTP DELETE request to delete a vAppTemplate, vApp, or media image. All of these
operations conform to the prototype (DELETE href , where href is the URL of the object you want to delete)
shown in Example 2 ‐ 10 on page 30 . You cannot delete an object if it is in use. Any object that is being copied
or moved is in use. Other criteria that determine whether an object is in use depend on the object type.

A vApp template is in use if it is being instantiated. After instantiation is complete, the template is no
longer in use.

A vApp is in use if it is deployed.

A media image is in use if it is inserted in a Vm.
Cataloging vApp Templates and Media Images
Although references to vApp templates and media images can be retrieved directly from the vDC to which
they were uploaded, it is a common practice to place references to such assets in one of an organization’s
catalogs. Doing so makes the asset easier to discover, because a catalog can include assets from all vDCs in an
organization. It also provides more flexible administrative control over these assets, because access to catalogs
and the items in them can be restricted to specific users and groups. Assets such as vApp templates are not
enabled for most uses until you include them in a catalog. For example, a vApp template that is not included
in a catalog can be modified but cannot be instantiated. A media image that is not included in a catalog cannot
be used by anyone but its owner.
Add an Item to a Catalog
A catalog can contain references to vApp templates and media images that have been uploaded to any vDC
in an organization. A vApp template or media image can be listed in at most one catalog.