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
<Key>Foo</Key>
...
</MetadataEntry>
</Metadata>
See “Access Control for vCloud API Object Metadata,” on page 282 for more information about the Domain
element.
The type of a Value is expressed in the xsi:type attribute of the containing TypedValue element. Values have
various restrictions, based on their type.
Table 8‑1. Metadata TypedValue Types
Type Name Restrictions on Value Size of Value
MetadataStringValue UTF-8 character set. Strings
longer than 1000 characters
cannot be searched for in a
query.
Depends on length of string.
MetadataNumberValue Must be a signed 8-byte integer. 8 bytes
MetadataDateTimeValue UTC date and time in the
format defined by
http://www.w3.org/TR/xmlsche
ma-2/#dateTime. For example,
2012-06-18T12:00:00-05:00
8 bytes
MetadataBooleanValue Must be one of: 1, 0, true, false 1 byte
The following rules apply when you update a Metadata element.
n
When the content of a Key element in the update does not match the content of an existing Key element
in the same Domain, the MetadataEntry containing that Key is added to the Metadata element.
n
When the content of Key element in the update matches the content of an existing Key element in the
same Domain, the MetadataEntry containing that Key is replaced.
Access Control for vCloud API Object Metadata
The Domain element of a MetadataEntry controls access to that entry by users and system administrators.
There are two access domains.
GENERAL
User access to metadata in the GENERAL domain is controlled by the user's
rights to the object to which the Metadata is attached. The owner of the object
can create, read, update, or delete any MetadataEntry in the GENERAL domain.
A MetadataEntry that does not include a Domain element is considered to be
in the GENERAL domain.
SYSTEM
Metadata in the SYSTEM domain can be created, updated, and deleted only by
a system administrator. User access to metadata in the SYSTEM domain is
controlled by the value of the visibility attribute of the Domain element.
Table 8‑2. Domain Visibility Attribute Values
Value Meaning
PRIVATE The metadata is visible to system
administrators only.
READONLY the metadata is visible to system
administrators and the object owner.
vCloud API Programming Guide
282 VMware, Inc.