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
Table 9-1. Query Types (Continued)
Type Name Result Set User Admin
Syste
m Format
datastore All datastores in the system No No YES All
datastoreProviderVdcRela
tion
All datastore-to-provider-vDC relationships
in the system
No No YES records,
idrecords
dvSwitch All vCenter distributed virtual switches
available for use by the system
No No YES records,
idrecords
event All stored event records YES YES YES records,
idrecords
externalNetwork External networks in the system No No YES All
group All groups in your organization YES YES No All
host ESX/ESXi hosts registered to the system No No YES All
media All media that you can view or modify YES YES No All
networkPool All network pools in the system No No YES All
organization All organizations visible to you No YES YES All
orgNetwork Networks in your organization YES YES No All
orgVdc All vDcs in your organization. YES YES No All
orgVdcResourcePoolRelati
on
vDC-to-resource-pool relationships in your
organization
No No YES records,
idrecords
portgroup All vCenter portgroups in the system No No YES records,
idrecords
providerVdc All provider vDCs in the system No No YES records,
idrecords
providerVdcResourcePool
Relation
Provider-vDC-to-resource-pool relationships
in the system
No No YES records,
idrecords
resourcePool All resource pools in the system No No YES records,
idrecords
right All rights defined in the system No YES YES All
role All roles defined in the system No YES YES All
strandedUser All stranded users. When you delete an LDAP
group, users who were imported from that
group become stranded and cannot log in.
No YES No All
task Active and recently completed tasks in your
organization
YES YES No All
user Users in your organization YES YES No All
vApp All vApps that you can view or modify YES YES No All
vAppNetwork All vApp networks in your organization (or in
the system, if the query is run by a system
administrator)
YES YES No All
vAppOrgNetworkRelatio
n
All vApps that are connected to organization
networks in your organization (or in the
system, if the query is run by a system
administrator)
No YES YES All
vAppTemplate All vApp templates in your organization YES YES No All
Chapter 9 Using the Query Service
VMware, Inc. 203