vCloud API Programming Guide for Service Providers

• About   View
• Updated Information   View
• About the VMware vCloud API   View
• • Object Taxonomy   View
  • Objects, References, and Representations   View
  • Links and Link Relations   View
  • Client Workflow Overview   View
  • • vCloud API REST Requests   View
    • vCloud API REST Responses   View
  • Using the vCloud API with vCloud Director   View
  • • REST Client Programs   View
    • About the Schema Reference   View
  • About the vCloud API Examples   View
• Hello vCloud: A Simplified RESTful Workflow   View
• • Logging In   View
  • Find a Catalog and a VDC   View
  • Retrieve the Contents of a Catalog   View
  • Retrieve a Catalog Item   View
  • Retrieve Deployment Information From the VDC   View
  • Deploy the vApp   View
  • Get Information About a vApp   View
  • Displaying the Virtual Machine Console   View
  • Undeploy, Power Off, and Delete the vApp   View
  • Log Out   View
• Exploring a Cloud   View
• • Create a vCloud API Session   View
  • • Create a Session Using OAuth Authentication   View
    • Create a Session Using SAML Authentication   View
    • Create a Session Using Basic Authentication   View
  • Retrieve a List of Organizations Accessible to You   View
  • Retrieve an Administrative View of a Cloud   View
  • Retrieve a List of vSphere Platform Operations and Objects for a Cloud   View
• Provisioning an Organization   View
• • Upload an OVF Package to Create a vApp Template   View
  • • Initiating the OVF Upload   View
    • Retrieving the Upload URL for the OVF Descriptor   View
    • Uploading the OVF Descriptor   View
    • Retrieving Additional Upload URLs   View
    • Uploading Referenced Files   View
    • • Monitoring the Progress of an Upload   View
      • Using Ranged PUT requests to Complete a Partial Upload   View
  • Download a vApp or vApp Template as OVF or OVA   View
  • • Enable a vApp or vApp Template for Download   View
    • Download an OVF Descriptor or OVA File   View
    • Download a Referenced File   View
  • Upload a Media Image   View
  • Download a Media Image   View
  • Capturing and Importing vApps   View
  • Discovering and Adopting vApps   View
  • Managing Catalog Items   View
  • • Copy or Move a Catalog Item   View
    • Change the Name or Description of a Catalog Item   View
    • Remove an Item from a Catalog   View
    • Synchronize a Catalog or Catalog Item   View
  • Creating and Using Independent Disks   View
  • • Create an Independent Disk   View
    • Update an Independent Disk   View
    • Remove an Independent Disk   View
  • View or Change the Owner of an Object   View
  • Controlling Access to vApps and Catalogs   View
  • • Access Rights to vCloud Director Objects   View
• Deploying and Operating vApps and Virtual Machines   View
• • About Instantiation   View
  • • About vApp Networks   View
    • Network Services in vApp Networks   View
  • Create a vApp From a Template   View
  • Modify Virtual Machine Hardware and Other Properties During vApp Template Instantiation   View
  • Compose a vApp From Existing Virtual Machines   View
  • Recompose a vApp to Add, Remove, or Reconfigure Virtual Machines   View
  • Clone a vApp   View
  • Create a vApp From an OVF Package   View
  • Capture a vApp as a Template   View
  • Update vApp Access Controls   View
  • Create a VM-VM Affinity Rule   View
  • • Update or Delete a VM-VM Affinity Rule   View
  • Specifying Advanced Virtual Machine Settings with ExtraConfig Elements   View
  • Operate a vApp   View
  • • vApp Power States   View
    • Provide User Input Requested by a Virtual Machine   View
    • Creating and Using vApp Snapshots   View
    • Attach or Detach an Independent Disk   View
    • About Virtual Machine Metrics   View
    • • Retrieving All Current or Historic Metrics   View
      • Retrieving Metrics Subsets   View
      • Metric Names and Patterns   View
  • Create a Virtual Machine with Custom Resource Allocation Settings   View
• Reconfiguring vApps and Virtual Machines   View
• • Retrieve the Configuration Links for a vApp   View
  • Retrieve the Configuration Links for a Virtual Machine   View
  • • vCloud API Custom Attributes   View
  • Retrieve a List of Supported Virtual Hardware Versions and Guest Operating Systems   View
  • Update Multiple Sections of a Virtual Machine   View
  • Retrieve or Update a Modifiable Section   View
  • Update a vApp Network Configuration   View
  • Update the NetworkConnectionSection of a Virtual Machine   View
  • Retrieve or Modify the CPU Configuration of a Virtual Machine   View
  • Retrieve or Modify the GuestCustomizationSection of a Virtual Machine   View
  • Retrieve or Modify ProductSection Elements   View
  • Retrieve or Modify Groups of Related Sections in a Virtual Machine   View
  • Retrieve or Modify the Hard Disk Configuration of a Virtual Machine   View
  • Retrieve or Update the VDC Compute Policy of a Virtual Machine   View
  • Update the Storage Profile for a Virtual Machine   View
  • Override the Default Storage Profile for a Hard Disk   View
  • Specify Hard Disk IOPS   View
• Managing an Organization   View
• • Administrator Credentials and Privileges   View
  • Organization Administration   View
  • • Retrieve or Update Organization Settings   View
    • Truststore and Keytab Maintenance for Organizations   View
  • VDC Administration   View
  • • Create a VDC from a Template   View
    • Change the Name or Description of an Existing VDC   View
    • Update Organization VDC Storage Profiles   View
    • Enable, Disable, or Remove a VDC   View
    • Apply Access Controls to a VDC   View
  • Network Administration   View
  • • About vCloud Director Networks   View
    • Configure Edge Gateway Services   View
    • • Firewall Service Configurations   View
      • NAT Service Configurations   View
      • Static Routing Service Configurations   View
      • Load Balancer Service Configurations   View
      • IPsec VPN Service Configurations   View
      • Gateway DHCP Service Configurations   View
    • Create an Organization VDC Network   View
    • • Create an Organization VDC Network With a Routed Connection   View
      • Create an Isolated Organization VDC Network   View
    • Synchronize Syslog Server Settings for an Edge Gateway or vApp Network   View
  • Catalog Administration   View
  • • Add a Catalog to an Organization   View
    • • Create a Catalog For External Publication   View
      • Create a Catalog With an External Subscription   View
      • Specify a Storage Profile for a Catalog   View
    • Update Catalog Access Controls   View
    • Share a Catalog with All Organizations in a Cloud   View
    • Share a Catalog With Specific Organizations in a Cloud   View
    • Publish an Existing Catalog Externally   View
    • Content Subscription Endpoint Specification   View
  • User and Group Administration   View
  • • Create a Local User   View
    • Import a User from an LDAP Service   View
    • Import a Group from an LDAP Service   View
    • Import a User or Group from an OAuth Identity Provider   View
    • Import a User or Group from a SAML Identity Provider   View
    • Take Control of a User's Objects   View
  • About Federation and Single Sign-On   View
  • • Configuring and Managing Federation with OAuth   View
    • Configuring and Managing Federation with SAML   View
    • Configuring and Managing Federation with LDAP   View
  • Managing Rights and Roles   View
  • • Predefined Roles and Their Rights   View
    • Create a Role in Your Organization   View
    • View or Modify Role Template Linkage   View
• Managing and Monitoring a Cloud   View
• • Retrieve or Update System Settings   View
  • Attach a vCenter Server Instance   View
  • Register an NSX-T Manager Instance   View
  • Finding Available vCenter Resources   View
  • • Retrieve a List of Resource Pools from a vCenter Server   View
    • Retrieve a List of Available Portgroups and Switches from a vCenter Server   View
    • Retrieve a List of External Networks and Network Pools   View
    • Retrieve a List of Virtual Machines from a vCenter Server   View
    • Retrieve a List of Storage Profiles from a vCenter Server   View
  • Create an Organization   View
  • • Edit Organization Rights   View
    • Enable, Disable, or Remove an Organization   View
  • Create a Provider VDC   View
  • • Retrieve a Provider VDC Resource Pool Set   View
    • Update Provider VDC Resource Pools   View
    • Update Provider VDC Storage Profiles   View
    • Configure Storage I/O Control Support in a Provider VDC   View
    • Merge Provider VDCs   View
  • Create an External Network   View
  • Create a Network Pool   View
  • • Create a VXLAN-Backed Network Pool   View
    • Create a VLAN-Backed Network Pool   View
    • Create a Portgroup-Backed Network Pool   View
  • Add a VDC to an Organization   View
  • • Adopt Resource Pools With a VDC   View
    • Configure Storage I/O Control Support in an Organization VDC   View
    • Create an Edge Gateway   View
    • Create an Organization VDC Network With a Direct Connection   View
  • Managing VM-Host Affinity Rules and VDC Compute Policies   View
  • • Create or Update a Host Group   View
    • Create or Update a VM Group   View
    • Create or Update a VM-Host Affinity Rule   View
    • View and Modify Organization VDC Compute Policies   View
  • Creating and Managing VDC Templates   View
  • • Create a VDC Template   View
    • Create a VDC Template That Includes Routed Networking   View
    • Create a VDC Template That Includes Routed Networking and Multiple Provider VDCs   View
    • Controlling Access to VDC Templates   View
  • Import a Virtual Machine from vCenter   View
  • • Import a Virtual Machine as a vApp   View
    • Import a Virtual Machine as a vApp Template   View
  • Relocate a Virtual Machine to a Different Datastore   View
  • Migrate Tenant Storage   View
  • Configure the vCloud Director AMQP Service   View
  • • Test AMQP Settings   View
  • System Truststore and Keytab Maintenance   View
  • Retrieve the vSphere URL of an Object   View
  • • Mapping a vCloud Director Object to a vSphere Object   View
  • Configuring and Managing Multisite Deployments   View
  • • Associate Two Sites   View
    • Associate Organizations at Member Sites   View
• Working With Object Metadata   View
• • Retrieve or Update a Metadata Element   View
  • Retrieve or Update a Metadata Value   View
• Using the Query Service   View
• • Typed Queries   View
  • Packaged Queries   View
  • Query Parameters   View
  • Add a Metadata Filter to a Query   View
• Configuring and Using Blocking Tasks and Notifications   View
• • Configure Notifications   View
  • Retrieve or Update Blocking Task Settings   View
  • • Task Operations   View
  • Monitor Blocking Tasks   View
  • Take Action on a Blocking Task   View
  • Extend The Timeout Expiration of an Active Task   View
  • Notification Message Format   View
• Extending vCloud Director   View
• • vCloud Director Object Extensions   View
  • • Register an Object Extension   View
    • Retrieve or Update an Object Extension   View
    • Create a Selector Extension   View
    • Retrieve or Update a Selector Extension   View
  • vCloud Director Extension Services   View
  • • Register an Extension Service   View
    • Service-Specific Links   View
    • • Add a Service Link   View
      • Delete a Service Link   View
    • Service-Specific Tasks and Events   View
    • • Create or Update a Service-Specific Task   View
      • Create a Service-Specific Event   View
    • Authorization Framework for Extension Service Operations   View
    • • Create an Extension Service Resource Class   View
      • Define an Action for a Resource Class   View
      • Define an ACL Rule for a Resource Class Action   View
      • Create a Service-Specific Right   View
    • Localization Framework for Extension Services   View
    • • Upload or Update a Localization Bundle   View
      • Message File Content   View
    • REST APIs for Extension Services   View
    • • Create an API Filter for an Extension Service   View
      • Create or Update an Extension Service API Definition   View
    • Extension Service AMQP Message Format   View
• XML Representations in the vCloud API   View
• • XML Namespace Identifiers   View
  • Common vCloud API Attributes   View
  • Retrieve an Object as an Entity   View