1.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
- Provisioning an Organization with vApps, Templates, and Media
- 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
- Operate a vApp
- Configuring vApps and Virtual Machines
- Retrieve the Configuration Links for a vApp
- Retrieve the Configuration Links for 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
- Creating, Provisioning, and Managing Organizations
- Summary of Administrative Requests
- Administrator Credentials and Privileges
- Organization Administration
- Network Administration
- vDC Administration
- Catalog Administration
- User and Group Administration
- Working With Roles and Rights
- Controlling Access to vApps and Catalogs
- Using vCloud API Extensions to Provision and Manage a Cloud
- Working With Object Metadata
- Using the Query Service
- Configuring and Using Blocking Tasks and Notifications
- XML Representations in the vCloud API
- Index
2 Retrieve the Metadata element.
If the object has no metadata, the element contains only a rel="edit" link that you can use when modifying
the element and a rel="up" link that references the containing object, as shown in this example.
<Metadata
xmlns="http://www.vmware.com/vcloud/v1.5"
type="application/vnd.vmware.vcloud.metadata+xml"
href="https://vcloud.example.com/api/admin/org/26/metadata"
... >
<Link
rel="add"
type="application/vnd.vmware.vcloud.metadata+xml"
href="https://vcloud.example.com/api/admin/org/26/metadata" />
<Link
rel="up"
type="application/vnd.vmware.vcloud.org+xml"
href="https://vcloud.example.com/api/admin/org/37" />
</Metadata>
3 Modify the retrieved Metadata element.
You can add new MetadataEntry elements or modify existing ones. If you modify existing ones, your
modifications are merged into the object's Metadata following the rules listed in “vCloud API Object
Metadata Contents,” on page 195.
4 POST the Metadata element to the rel="add" link described in Step 2.
See “Example: Update a Metadata Element,” on page 197.
Example: Update a Metadata Element
This example updates the empty Metadata element shown in Step 2 to create two MetadataEntry elements
specific to this organization. The response is a Task.
Request:
POST https://vcloud.example.com/api/admin/org/26/metadata
Content-Type: application/vnd.vmware.vcloud.metadata+xml
...
<?xml version="1.0" encoding="UTF-8"?>
<Metadata
type="application/vnd.vmware.vcloud.metadata+xml"
xmlns="http://www.vmware.com/vcloud/v1.5">
<MetadataEntry>
<Key>Organization Web Page</Key>
<Value>http://internal.example.com/orgs/Finance</Value>
</MetadataEntry>
<MetadataEntry>
<Key>LOS</Key>
<Value>bronze</Value>
</MetadataEntry>
</Metadata>
Response:
<Task
xmlns="http://www.vmware.com/vcloud/v1.5"
status="running"
...
Chapter 8 Working With Object Metadata
VMware, Inc. 197