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