vCloud REST API Extension Operations

Extension Operations


Extension Operations (93)

Operation Description Since
GET /admin/extension Get various links to access extension API. 1.0
POST /admin/extension/action/registervimserver Register a vSphere server and shield manager. 0.9
GET /admin/extension/blockingTask/{id} Gets the representation of a task extension request. 1.5
POST /admin/extension/blockingTask/{id}/action/abort This operation:
  • Aborts request (sets it to {@link TaskExtensionRequestStatusType#ABORTED}
  • Cancels/stops task execution (unlocking any busy object)
  • Cleans/deletes any newly created objects
  • Sets underlying task status to {@link TaskStatus#ABORTED}
This operation is considered successful, if requests exists and:
  • Request is in status {@link TaskExtensionRequestStatusType#ACTIVE}, OR
  • Request is in status {@link TaskExtensionRequestStatusType#ABORTED}.
1.5
POST /admin/extension/blockingTask/{id}/action/fail This operation:
  • Fails request (sets it to {@link TaskExtensionRequestStatusType#FAILED}
  • Cancels/stops task execution (unlocking any busy object)
  • Sets any newly created objects to error state
  • Sets underlying task status to error
This operation is considered successful, if requests exists and:
  • Request is in status {@link TaskExtensionRequestStatusType#ACTIVE}, OR
  • Request is in status {@link TaskExtensionRequestStatusType#FAILED}.
1.5
POST /admin/extension/blockingTask/{id}/action/resume Resumes request and continues with executing underlying operation. 1.5
POST /admin/extension/blockingTask/{id}/action/updateProgress This operation updates:
  • the message appended to task log
  • the timeout date - the new value is calculated as the current time plus the new timeout period passed to this method
The new timeout date value is calculated as the current time plus the new timeout period passed to this method.
1.5
GET /admin/extension/blockingTasks Returns task extension requests that have already been processed or are currently active. 1.5
GET /admin/extension/datastore/{id} Gets the representation of a datastore. 1.5
PUT /admin/extension/datastore/{id} Updates the datastore. 1.5
DELETE /admin/extension/datastore/{id} Removes the datastore. 1.5
POST /admin/extension/datastore/{id}/action/disable Disables the datastore. 1.5
POST /admin/extension/datastore/{id}/action/enable Enables the datastore. 1.5
GET /admin/extension/datastores Get a list of all datastores. 1.5
GET /admin/extension/datastores/query Get a list of all datastores by using RETS API General QueryHandler. 1.5
GET /admin/extension/externalNetworkReferences Get list of external network references. 1.0
GET /admin/extension/externalNetworkReferences/query Get list of external networks by using REST API general QueryHandler. 1.5
GET /admin/extension/externalnet/{id} Gets an extension view of external network. 1.0
PUT /admin/extension/externalnet/{id} Modifies an external network. 1.0
DELETE /admin/extension/externalnet/{id} Deletes an external network. 1.0
POST /admin/extension/externalnets Creates an external network. 1.0
GET /admin/extension/host/{id} Gets a host. 1.0
POST /admin/extension/host/{id}/action/disable Disables a host. 0.9
POST /admin/extension/host/{id}/action/enable Enables a host. 0.9
POST /admin/extension/host/{id}/action/prepare Prepares a host. 0.9
POST /admin/extension/host/{id}/action/repair Repairs a host. 1.0
POST /admin/extension/host/{id}/action/unprepare Unprepares a host. 0.9
POST /admin/extension/host/{id}/action/upgrade Upgrades the host agent. 1.0
GET /admin/extension/hostReferences Get list of host references. 1.0
GET /admin/extension/hostReferences/query Get list of hosts by using REST API general QueryHAndler; This is read only list of host references and is not bound to specific states. 1.5
GET /admin/extension/licensing/report/{id} Gets a licensing report. 1.0
GET /admin/extension/licensing/reports Lists the licensing reports. 1.0
GET /admin/extension/networkPool/{id} Gets a network pool. 0.9
PUT /admin/extension/networkPool/{id} Modifies a network pool. 0.9
DELETE /admin/extension/networkPool/{id} Deletes a network pool. 0.9
GET /admin/extension/networkPoolReferences Get list of network pool references. 1.0
GET /admin/extension/networkPoolReferences/query Get list of network pools by using REST API general QueryHandler. 1.5
POST /admin/extension/networkPools Creates a network pool. 0.9
GET /admin/extension/orgNetworks/query Get list of Organization Networks for the system by using REST API general QueryHandler. 1.5
GET /admin/extension/orgVdcs/query Get list of all Organization Vdcs in the system by using REST API general QueryHandler. 1.5
GET /admin/extension/providerVdcReferences Get list of provider vDC references. 1.0
GET /admin/extension/providerVdcReferences/query Get list of provider vDCs by using REST API general QueryHandler. 1.5
GET /admin/extension/providervdc/{id} Gets an extension representation of provider vDC. 0.9
PUT /admin/extension/providervdc/{id} Modifies a provider vDC. 0.9
DELETE /admin/extension/providervdc/{id} Deletes a provider vDC. 0.9
POST /admin/extension/providervdc/{id}/action/disable Disables a provider vDC. 0.9
POST /admin/extension/providervdc/{id}/action/enable Enables a provider vDC. 0.9
POST /admin/extension/providervdc/{id}/action/updateResourcePools Update backing resource pools for provider vdc 1.5
GET /admin/extension/providervdc/{id}/resourcePools Retrieve provider vdc resource pools 1.5
POST /admin/extension/providervdcs Creates a provider vDC. 0.9
POST /admin/extension/resourcePool/{id}/action/disable Disable Provider VDC resource pool 1.5
POST /admin/extension/resourcePool/{id}/action/enable Enable Provider VDC resource pool 1.5
GET /admin/extension/settings Retrieves the {@link SystemSettings}. 1.5
PUT /admin/extension/settings Updates the {@link SystemSettings}. 1.5
GET /admin/extension/settings/amqp Retrieves the {@link AmqpSettings}. 1.5
PUT /admin/extension/settings/amqp Updates the {@link AmqpSettings}. 1.5
POST /admin/extension/settings/amqp/action/test Test AMQP settings. 1.5
GET /admin/extension/settings/blockingTask Returns global task extensions settings. 1.5
PUT /admin/extension/settings/blockingTask Updates global task extensions settings. 1.5
GET /admin/extension/settings/blockingTask/operations Gets task operations which are enabled for extension. 1.5
PUT /admin/extension/settings/blockingTask/operations Updates the task operations which are enabled for extension. 1.5
GET /admin/extension/settings/branding Retrieves the {@link BrandingSettings}. 1.5
PUT /admin/extension/settings/branding Updates the {@link BrandingSettings}. 1.5
GET /admin/extension/settings/email Retrieves the {@link EmailSettings}. 1.5
PUT /admin/extension/settings/email Updates the {@link EmailSettings}. 1.5
GET /admin/extension/settings/general Retrieves the {@link GeneralSettings}. 1.5
PUT /admin/extension/settings/general Updates the {@link GeneralSettings}. 1.5
GET /admin/extension/settings/ldapSettings Retrieves the {@link LdapSpec}. 1.5
PUT /admin/extension/settings/ldapSettings Updates the {@link LdapSpec}. 1.5
GET /admin/extension/settings/license Retrieves the {@link LicenseSpec}. 1.5
PUT /admin/extension/settings/license Updates the {@link LicenseSpec}. 1.5
GET /admin/extension/settings/notifications Retrieves the Notifications settings. 1.5
PUT /admin/extension/settings/notifications Updates the Notifications settings. 1.5
GET /admin/extension/settings/passwordPolicy Retrieves the {@link SystemPasswordPolicySettings}. 1.5
PUT /admin/extension/settings/passwordPolicy Updates the {@link SystemPasswordPolicySettings}. 1.5
GET /admin/extension/uberAdminSettings Retrieves the {@link UberAdminSettings}. 1.5
PUT /admin/extension/uberAdminSettings Updates the {@link UberAdminSettings}. 1.5
GET /admin/extension/vapps/query Get list of all vApps in the system by using REST API general QueryHandler. 1.5
GET /admin/extension/vdc/{id}/resourcePools Retrieves resource pools associated with an organization VDC 1.5
GET /admin/extension/vimServer/{id} Gets a vSphere server. 0.9
PUT /admin/extension/vimServer/{id} Modifies a vSphere server. 0.9
POST /admin/extension/vimServer/{id}/action/forcevimserverreconnect Forces a vSphere server to reconnect. 1.0
POST /admin/extension/vimServer/{id}/action/unregister Unregisters a vSphere server. 0.9
GET /admin/extension/vimServer/{id}/hostReferences Gets all the hosts attached to VC with @param id 1.5
POST /admin/extension/vimServer/{id}/importMedia Import media from vSphere Supported media types are ISO and FLOPPY The returned media entity will contain a task of importing process. 1.5
POST /admin/extension/vimServer/{id}/importVmAsVApp Imports a vSphere server VM as vApp. 1.0
POST /admin/extension/vimServer/{id}/importVmAsVAppTemplate Imports a vSphere server VM as vApp template. 1.0
POST /admin/extension/vimServer/{id}/importVmIntoExistingVApp Imports a vSphere server VM into an existing vApp. 1.5
GET /admin/extension/vimServer/{id}/networks Gets all the networks available to VC with @param id 1.5
GET /admin/extension/vimServer/{id}/resourcePoolList Lists free resource pools in a vSphere server. 1.0
GET /admin/extension/vimServer/{id}/vmsList Lists available VMs for import from a vSphere server. 1.0
GET /admin/extension/vimServerReferences Get list of vSphere server references. 1.0
GET /admin/extension/vimServerReferences/query Get list of vSphere servers by using REST API general QueryHandler; This is read only list of vim servers and is not bound to specific states. 1.5