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
Table 10‑8. Blocking Task Operations for Network Tasks (Continued)
Operation Name Description
networkUpdateNetwork Modify one or more properties of a network object.
networkUpdateNetworkPool Modify one or more properties of a VlanPoolType network pool
object.
networkUpdateVlanPool Modify one or more properties of any network pool object.
Table 10‑9. Blocking Task Operations for Edge Gateway Tasks
Operation Name Description
edgeGatewayUpdate Update an Edge Gateway.
edgeGatewayUpdateProperties Update Edge Gateway properties.
networkConfigureEdgeGatewayServices Configure services on an Edge Gateway.
networkEdgeGatewayCreate Create an Edge Gateway.
networkEdgeGatewayDelete Delete an Edge Gateway.
networkEdgeGatewayRedeploy Redeploy an Edge Gateway.
networkEdgeGatewaySynchronizeSyslog Synchronize syslog settings for an Edge Gateway.
networkEdgeGatewayUpgradeConfiguration Upgrade the configuration of an Edge Gateway
networkReapplyEdgeGatewayServices Reapply services on an Edge Gateway.
Table 10‑10. Blocking Task Operations for System Tasks
Operation Name Description
systemForceDisconnectVimserver Force disconnection of a vCenter server.
systemForceReconnectVimserver Force reconnection of a vCenter server.
systemPurgeAllStrandedItems Purge all stranded items.
systemPurgeStrandedItem Purge a specific stranded item.
systemRefreshStorageProfiles Refresh vCenter storage profiles.
systemRefreshVimserver Refresh a vCenter server.
systemRegisterLookupService Register with the vCenter lookup service.
systemRegisterVimserver Register a vCenter server.
systemUnregisterLookupService Unregister with the vCenter lookup service.
systemUnregisterVimserver Unregister a vCenter server.
systemUpdateAmqpCertificate Update the system AMQP certificate.
systemUpdateAmqpTruststore Update the system AMQP truststore.
systemUpdateLdapCertificate Update the system LDAP certificate.
systemUpdateLdapKeystore Update the system LDAP keystore.
systemUpdateLdapSspiKeytab Update the system LDAP SSPI keytab.
systemUpdateVcTruststore Update the vCenter truststore.
systemUpdateVimserver Update a vCenter server.
vCloud API Programming Guide
322 VMware, Inc.