A successful login by a system administrator returns a Session element that contains a link that you can use to retrieve a VMWExtension element.

Every VMware Cloud Director installation depends on vSphere platform resources such as vCenter serversvCenter Server instances and hosts, vShield Manager, portgroups, virtual switches, and so on. The VMWExtension element provides access to a cloud-wide namespace of vSphere platform objects that are registered for use by the system, and links that allow you to add vSphere servers and related resources to your cloud. Objects in the admin/extension XML namespace provide a system administrator with programmatic access to these resources.

Prerequisites

Use the credentials of a system administrator to create a login session. See Create a Session Using Basic Authentication.

Procedure

  1. Retrieve the XML representation of your Session object.
    Use a request like this one: 
    GET https://vcloud.example.com/api/session
  2. Examine the contents of the Session element to locate the link to the VMWExtension object.
    This link has the following form: 
    <Link
   rel="down"
   type="application/vnd.vmware.admin.vmwExtension+xml"
   href="https://vcloud.example.com/api/admin/extension"/>
  3. Retrieve the list of organizations by making a GET request to the href value of the Link described in Step 2.
    The request returns a VMWExtension element, as shown in Retrieve a List of vSphere Platform Operations and Objects for a Cloud.

Example: Retrieve a List of vSphere Platform Operations and Objects for a Cloud

Request: 
GET https://vcloud.example.com/api/admin/extension

The response is a VMWExtension element containing a number of Link elements. This example shows only a subset of VMWExtension contents.

Response: 
200 OK
Content-Type: application/vnd.vmware.admin.vmwextension+xml
...
<vmext:VMWExtension
   xmlns:vmext="http://www.vmware.com/vcloud/extension/v1.5"
   xmlns:vcloud="http://www.vmware.com/vcloud/v1.5"
   type="application/vnd.vmware.admin.vmwExtension+xml">
   <vcloud:Link
      rel="down"
      type="application/vnd.vmware.admin.vmwProviderVdcReferences+xml"
      href="https://vcloud.example.com/api/admin/extension/providerVdcReferences" />
   <vcloud:Link
      rel="down"
      type="application/vnd.vmware.admin.vmwExternalNetworkReferences+xml"
      href="https://vcloud.example.com/api/admin/extension/externalNetworkReferences" />
   <vcloud:Link
      rel="down"
      type="application/vnd.vmware.admin.vmwNetworkPoolReferences+xml"
      href="https://vcloud.example.com/api/admin/extension/networkPoolReferences" />
   <vcloud:Link
      rel="down"
      type="application/vnd.vmware.admin.vmwVimServerReferences+xml"
      href="https://vcloud.example.com/api/admin/extension/vimServerReferences" />
   <vcloud:Link
      rel="down"
      type="application/vnd.vmware.admin.vmwHostReferences+xml"
      href="https://vcloud.example.com/api/admin/extension/hostReferences" />
   <vcloud:Link ... />
   ...
  <vcloud:Link
      rel="down"
      type="application/vnd.vmware.admin.extensionServices+xml"
      href="https://vcloud.example.com/api/admin/extension/service" />
</vmext:VMWExtension>