A system administrator can register a vCenter server and a companion vShield Manager server for use in a cloud by making a POST request to the cloud’s action/registervimserver URL and supplying a RegisterVimServerParams request body.

Verify that you are logged in to the vCloud API as a system administrator.

Verify that you know the name, IP address, and administrator password of the vCenter server and vShield Manager server.

1

Retrieve the XML representation of the vSphere platform extensions.

Use a request like this one.

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

Examine the response to locate the Link element that contains the URL for adding vCenter servers to the cloud.

This element has a rel attribute value of add and a type attribute value of application/vnd.vmware.admin.registerVimServerParams+xml, as shown here:

<Link
   type="application/vnd.vmware.admin.registerVimServerParams+xml"
   rel="add"
   href="https://vcloud.example.com/api/admin/extension/action/registervimserver"/>
3

Create a RegisterVimServerParams element that includes the information required to register the vCenter server and vShield manager.

4

POST the RegisterVimServerParams element you created in Step 3 to the URL described in Step 2.

See the request portion of Example: Register a vCenter Server and vShield Manager.

You must supply the user name and password of the vCenter administrator in the request. The response includes vCloud URLs for the newly registered vCenter and vShield Manager servers, and omits the password.

Request:

POST https://vcloud.example.com/api/admin/extension/action/registervimserver
Content-Type: application/vnd.vmware.admin.registerVimServerParams+xml
...
<?xml version="1.0" encoding="UTF-8"?>
<vmext:RegisterVimServerParams
   xmlns:vmext="http://www.vmware.com/vcloud/extension/v1.5"
   xmlns:vcloud="http://www.vmware.com/vcloud/v1.5">
   <vmext:VimServer
      name="VC-22">
      <vmext:Username>Administrator</vmext:Username>
      <vmext:Password>Pa55w0rd</vmext:Password>
      <vmext:Url>https://10.100.121.123:443</vmext:Url>
      <vmext:IsEnabled>false</vmext:IsEnabled>
   </vmext:VimServer>
   <vmext:ShieldManager
      name="VSM-VC-22">
      <vmext:Username>Administrator</vmext:Username>
      <vmext:Password>Pa55w0rd</vmext:Password>
      <vmext:Url>https://10.100.121.66</vmext:Url>
   </vmext:ShieldManager>
</vmext:RegisterVimServerParams>

Response:

200 OK
Content-Type: application/vnd.vmware.admin.registerVimServerParams+xml
...
<vmext:RegisterVimServerParams
   xmlns:vmext="http://www.vmware.com/vcloud/extension/v1.5"
   xmlns:vcloud="http://www.vmware.com/vcloud/v1.5">
   <vmext:VimServer
      type="application/vnd.vmware.admin.vmwvirtualcenter+xml"
      name="VC-22"
      href="https://vcloud.example.com/api/admin/extension/vimServer/100">
      ...
   </vmext:VimServer>
   <vmext:ShieldManager
      ...
   </vmext:ShieldManager>
</vmext:RegisterVimServerParams>