vSphere platform extension requests allow a system administrator to operate on vSphere platform objects registered to vCloud Director.

API-URL is a URL of the form https://vcloud.example.com/api.

id is a unique identifier in the form of a UUID, as defined by RFC 4122.

Important

Request URLs are always available in Link elements contained by the representation of the object on which they operate. URL forms shown here are for reference purposes only. Although URLs have a well-known syntax and a well-understood interpretation, a client should treat vCloud API request URLs as opaque strings. The rules that govern how the server constructs these strings might change in future releases.

This summary may not cover all requests in this category. For the complete list of requests, along with detailed information about input and output types, see the Operations lists in the schema reference.

Summary of vSphere Platform Extension Requests

Operation

Request

Request Body

Response

Retrieve a list of Provider vDCs in the system.

GET API-URL/admin/extension/ providerVdcReferences

None

VMWProviderVdcReferences

Retrieve a list of external networks in the system.

GET API-URL/admin/extension/ externalNetworkReferences

None

VMWExternalNetworkReferences

Retrieve a list of network pools in the system.

GET API-URL/admin/extension/ networkPoolReferences

None

VMWNetworkPoolReferences

Retrieve a list of vCenter servers registered to vCloud Director.

GET API-URL/admin/extension/vimServerReferences

None

VMWVimServerReferences

Retrieve information about a vCenter server.

GET API-URL/admin/extension/vimServer/id

None

VimServer

Retrieve a list of available resource pools on a vCenter server.

GET API-URL/admin/extension/vimServer/id/resourcePoolList

None

ResourcePoolList

Update vCenter server settings.

PUT API-URL/admin/extension/vimServer/id

VimServer

Task

Register a vCenter server and vShield manager.

POST API-URL/admin/extension/ action/registervimserver

RegisterVimServerParams

RegisterVimServerParams

Unregister a vCenter server and vShield manager.

POST API-URL/admin/extension/ action/unregister

None

Task

Force reconnection to a vCenter server.

POST API-URL/admin/extension/ vimServer/id/ action/forcevimserverreconnect

None

Task

Retrieve a list of ESX/ESXi hosts in the system.

GET API-URL/admin/extension/hostReferences

None

VMWHostReferences

Retrieve information about a host.

GET API-URL/admin/extension/host/id

None

Host

Prepare a host.

POST API-URL/admin/extension/host/id/action/prepare

PrepareHostParams

Task

Unprepare a host.

POST API-URL/admin/extension/host/id/action/unprepare

None

Task

Enable a host.

POST API-URL/admin/extension/host/id/action/enable

None

Task

Disable a host.

POST API-URL/admin/extension/host/id/action/disable

None

Task

Repair a host.

POST API-URL/admin/extension/host/id/action/repair

None

204 No Content

Upgrade a host.

POST API-URL/admin/extension/host/id/action/upgrade

None

Task

Create a Provider vDC. [NEW]

POST API-URL/admin/extension/providervdcsparams

VMWProviderVdcParams

VMWProviderVdc

Create a Provider vDC. [DEPRECATED]

POST API-URL/admin/extension/providervdcs

VMWProviderVdc

VMWProviderVdc

Retrieve a Provider vDC.

GET API-URL/admin/extension/providervdc/id

None

VMWProviderVdc

Update a Provider vDC.

PUT API-URL/admin/extension/providervdc/id

VMWProviderVdc

VMWProviderVdc

Enable a Provider vDC.

POST API-URL/admin/extension/providervdc/id/action/enable

None

204 No Content

Disable a Provider vDC.

POST API-URL/admin/extension/providervdc/id/action/disable

None

204 No Content

Delete a Provider vDC.

DELETE API-URL/admin/extension/providervdc/id

None

Task

Create an external network.

POST API-URL/admin/extension/externalnets

VMWExternalNetwork

VMWExternalNetwork

Retrieve an external network.

GET API-URL/admin/extension/externalnet/id

None

VMWExternalNetwork

Update an external network.

PUT API-URL/admin/extension/externalnet/id

VMWExternalNetwork

VMWExternalNetwork

Delete an external network.

DELETE API-URL/admin/extension/externalnet/id

None

Task

Create a network pool.

POST API-URL/admin/extension/networkPools

VMWNetworkPool

VMWNetworkPool

Retrieve a network pool.

GET API-URL/admin/extension/networkPool/id

None

VMWNetworkPool

Update a network pool.

PUT API-URL/admin/extension/networkPool/id

VMWNetworkPool

VMWNetworkPool

Delete a network pool.

DELETE API-URL/admin/extension/networkPool/id

None

Task

Import a virtual machine from vCenter as a vApp.

POST API-URL/admin/extension/ vimServer/id/importVmAsVapp

ImportVmAsVAppParams

VApp

Import a virtual machine from vCenter as a vApp template.

POST API-URL/admin/extension/ vimServer/id/importVmAsVappTemplate

ImportVmAsVAppTemplateParams

VAppTemplate

Retrieve the representation of a datastore.

GET API-URL/admin/extension/datastore/id

None

Datastore

Enable a datastore.

POST API-URL/admin/extension/datastore/id/action/enable

None

Datastore

Disable a datastore.

POST API-URL/admin/extension/datastore/id/action/disable

None

Datastore

Update a datastore.

PUT API-URL/admin/extension/datastore/id

Datastore

Datastore

Delete a datastore.

DELETE API-URL/admin/extension/datastore/id

None

204 No Content

Import a virtual machine from vCenter into an existing vApp.

POST API-URL/admin/extension/ vimServer/id/importVmIntoExistingVApp

ImportVmIntoExistingVAppParams

Task

Import a media image from vCenter.

POST API-URL/admin/extension/vimServer/id/importMedia

ImportMediaParams

Media

Enable a resource pool.

POST API-URL/admin/extension/resourcePool/id/action/enable

None

204 No Content

Disable a resource pool.

POST API-URL/admin/extension/resourcePool/id/action/disable

None

204 No Content

Place a vApp in maintenance mode to prevent users from changing vApp metadata.

POST API-URL/vApp/id/action/enterMaintenanceMode

None

204 No Content

Remove a vApp from maintenance mode.

POST API-URL/vApp/id/action/exitMaintenanceMode

None

204 No Content

Relocate a virtual machine in a vApp template to a different datastore. [DEPRECATED]

POST API-URL/vAppTemplate/vm-id/action/relocate

RelocateParams

Task

Relocate a virtual machine to a different datastore. [DEPRECATED]

POST API-URL/vApp/vm-id/action/relocate

RelocateParams

Task

Migrate a virtual machines to a different resource pool. [NEW]

POST API-URL/admin/extension/resourcePool/id/action/migrateVms

MigrateParams

Task

Retrieve a URL that you can use to access a vSphere object with a vSphere client. [NEW]

GET API-URL/admin/extension/vimServer/id/vimObjType/vimObjMoref/vSphereWebClientUrl

None

VSphereWebClientUrl

Merge Provider vDCs. [NEW]

PUT API-URL/admin/extension/providervdc/id/action/merge

None

204 No Content

Retrieve the list of storage profiles that exist on a vCenter server. [NEW]

GET API-URL/admin/extension/vimServer/id/storageProfiles

None

VMWStorageProfiles

Refresh the list of storage profiles that exist on a vCenter server. [NEW]

POST API-URL/admin/extension/vimServer/id/action/refreshStorageProfiles

None

Task

Register vCloud Director so that it appears as an extension in the vSphere Client Soultions Manager tab. [NEW]

POST API-URL/admin/extension/vimServer/id/action/refresh

None

Task