1.5
Table Of Contents
- vCloud API Programming Guide
- Contents
- vCloud API Programming Guide
- About the VMware vCloud API
- Hello vCloud: A Simplified RESTful Workflow
- Exploring a Cloud
- Provisioning an Organization with vApps, Templates, and Media
- Deploying and Operating vApps
- Summary of vCloud API vApp and Virtual Machine Operations Requests
- Create a vApp From a Template
- Compose a vApp From Existing Virtual Machines
- Recompose a vApp to Add or Remove Virtual Machines
- Operate a vApp
- Configuring vApps and Virtual Machines
- Retrieve the Configuration Links for a vApp
- Retrieve the Configuration Links for 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
- Creating, Provisioning, and Managing Organizations
- Summary of Administrative Requests
- Administrator Credentials and Privileges
- Organization Administration
- Network Administration
- vDC Administration
- Catalog Administration
- User and Group Administration
- Working With Roles and Rights
- Controlling Access to vApps and Catalogs
- Using vCloud API Extensions to Provision and Manage a Cloud
- Working With Object Metadata
- Using the Query Service
- Configuring and Using Blocking Tasks and Notifications
- XML Representations in the vCloud API
- Index
Request:
PUT https://vcloud.example.com/api/admin/extension/settings/blockingTask
Content-Type: application/vnd.vmware.admin.blockingTaskSettings+xml
...
<?xml version="1.0" encoding="UTF-8"?>
<BlockingTaskSettings
xmlns:vcloud="http://www.vmware.com/vcloud/v1.5"
xmlns="http://www.vmware.com/vcloud/extension/v1.5">
<TimeoutAction>abort</TimeoutAction>
<BlockingTaskOperations>
<vcloud:Operation>vdcUploadMedia</vcloud:Operation>
</BlockingTaskOperations>
<TimeoutInMilliseconds>86400000</TimeoutInMilliseconds>
</BlockingTaskSettings>
The response echoes the request, and adds the href attributes and edit links for the BlockingTaskSettings
element and the BlockingTaskOperations element it contains.
Response:
200 OK
Content-Type: application/vnd.vmware.admin.blockingTaskSettings+xml
...
<BlockingTaskSettings
xmlns="http://www.vmware.com/vcloud/v1.5"
TimeoutInMilliseconds="86400000"
type="application/vnd.vmware.admin.blockingTaskSettings+xmll"
href="https://vcloud.example.com/api/admin/extension/settings/blockingTask"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" ... >
<Link
rel="edit"
type="application/vnd.vmware.admin.blockingTaskSettings+xml"
href="https://vcloud.example.com/api/admin/extension/settings/blockingTask" />
<Link
rel="down"
type="application/vnd.vmware.admin.taskOperationList+xml"
href="https://vcloud.example.com/api/admin/extension/settings/blockingTask/operations"/>
<TimeoutAction>abort</TimeoutAction>
<BlockingTaskOperations
type="application/vnd.vmware.admin.taskOperationList+xml"
href="https://vcloud.example.com/api/admin/extension/settings/blockingTask/operations">
<Link
rel="edit"
type="application/vnd.vmware.admin.taskOperationList+xml"
href="https://vcloud.example.com/api/admin/extension/settings/blockingTask/operations"/>
<Operation>vdcUploadMedia</Operation>
</BlockingTaskOperations>
</BlockingTaskSettings>
Task Operations
Requests that you can configure as blocking tasks are represented by task operation names.
To configure a request type as a blocking task, place the operation name in an Operation element and add that
element to the cloud's BlockingTaskOperations element. See “Retrieve or Update Blocking Task Settings,” on
page 225.
vCloud API Programming Guide
226 VMware, Inc.