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
Table 9-3. Query Filter Expressions
Operator Example Operation
==
attribute==value Matches. The example evaluates to true if attribute
has a value that matches value in a case-sensitive
comparison.
NOTE Asterisk (*) characters that appear anywhere
in value are treated as wildcards that match any
character string. When value includes wildcards, the
comparison with attribute becomes case-insensitive.
!=
attribute!=value Does not match. The example evaluates to true if
attribute has a value that does not match value in a
case-sensitive comparison. Wildcard characters are
not allowed.
;
attribute1==value1;attribute2!=value2 Logical AND. The example evaluates to true only if
attribute1 has a value that matches value1 and
attribute2 has a value that does not match value2 in a
case-sensitive comparison.
,
attribute1==value1,attribute2==value2 Logical OR. The example evaluates to true if
attribute1 has a value that matches value1 or
attribute2 has a value that matches value2 in a case-
sensitive comparison.
=gt=
attribute=gt=value Greater than. The example evaluates to true if
attribute has a value that is greater than value. Both
attribute and value must be of type int, long, or
dateTime.
=lt=
attribute=lt=value Less than. The example evaluates to true if attribute
has a value that is less than value. Both attribute and
value must be of type int, long, or dateTime.
=ge=
attribute=ge=value Greater than or equal to. The example evaluates to
true if attribute has a value that is greater than or
equal to value. Both attribute and value must be of type
int, long, or dateTime.
=le=
attribute=le=value Less than or equal to. The example evaluates to true
if attribute has a value that is less than or equal to
value. Both attribute and value must be of type int,
long, or dateTime.
Specifying Metadata in a Query or a Filter Expression
Because metadata values are dynamic and metadata names have an optional domain qualifier queries that
filter metadata must specify a qualified name, a value, and the type of the value.
n
The domain must be specified for any MetadataEntry that is in the SYSTEM domain. If no DOMAIN is
specified, the query returns the value for key name in the GENERAL domain, if it exists.
n
The type of the value must be specified, using one of the following keywords.
Table 9-4. Metadata Type Specifiers in Query Filters
Type Name as Specified in TypedValue Type Name as a Filter Expression Keyword
MetadataStringValue STRING
MetadataNumberValue NUMBER
MetadataDateTimeValue DATETIME
MetadataBooleanValue BOOLEAN
vCloud API Programming Guide
258 VMware, Inc.