TaskType

Element:
Task
Type:
TaskType
Namespace:
http://www.vmware.com/vcloud/v1.5
Description:
Represents an asynchronous operation in vCloud Director.
Since:
0.9
Schema:
task.xsd
Media type(s):
application/vnd.vmware.vcloud.task+xml
Extends:
EntityType
XML Representation:
<Task xmlns="http://www.vmware.com/vcloud/v1.5" href="xs:anyURI" type="xs:string" id="xs:string" operationKey="xs:string"
        name="xs:string" status="xs:string" operation="xs:string" operationName="xs:string"
        serviceNamespace="xs:string" startTime="xs:dateTime" endTime="xs:dateTime" expiryTime="xs:dateTime"
        cancelRequested="xs:boolean">
    <Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
            rel="xs:string"/>
    <Description> xs:string </Description>
    <Tasks>
        <Task> TaskType </Task>
    </Tasks>
    <Owner href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
    <Error message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string" vendorSpecificErrorCode="xs:string"
            stackTrace="xs:string"/>
    <User href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
    <Organization href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
    <Progress> xs:int </Progress>
    <Params> ... </Params>
    <Details> xs:string </Details>
</Task>

Attributes

Attribute Type Required Modifiable Since Deprecated Description
href anyURI No always 0.9 The URI of the entity.
type string No always 0.9 The MIME type of the entity.
id string No none 0.9 The entity identifier, expressed in URN format. The value of this attribute uniquely identifies the entity, persists for the life of the entity, and is never reused.
operationKey string No create 5.1 Optional unique identifier to support idempotent semantics for create and delete operations.
name string Yes always 0.9 The name of the entity.
status string Yes none 0.9 The execution status of the task. One of:
queued (The task has been queued for execution)
preRunning (The task is awaiting preprocessing or administrative action.)
running (The task is running.)
success (The task completed with a status of success.)
error (The task encountered an error while running.)
canceled (The task was canceled by the owner or an administrator.)
aborted (The task was aborted by an administrative action.)
operation string No always 0.9 A message describing the operation that is tracked by this task.
operationName string No none 0.9 The short name of the operation that is tracked by this task.
serviceNamespace string No create 5.1 Identifier of the service that created the task. It must not start with com.vmware.vcloud and the length must be between 1 and 128 symbols.
startTime dateTime No none 0.9 The date and time the system started executing the task. May not be present if the task has not been executed yet.
endTime dateTime No none 0.9 The date and time that processing of the task was completed. May not be present if the task is still being executed.
expiryTime dateTime No none 0.9 The date and time at which the task resource will be destroyed and no longer available for retrieval. May not be present if the task has not been executed or is still being executed.
cancelRequested boolean No none 5.1 Whether user has requested this processing to be canceled.

Elements

Element Type Required Modifiable Since Deprecated Description
Description string No always 0.9 Optional description.
Details string No always 5.1 Detailed message about the task. Also contained by the Owner entity when task status is preRunning.
Error ErrorType No always 0.9 Represents error information from a failed task.
Link LinkType No none 0.9 A reference to an entity or operation associated with this object.
Organization ReferenceType No none 1.5 The organization to which the User belongs.
Owner ReferenceType No create 0.9 Reference to the owner of the task. This is typically the object that the task is creating or updating.
Params anyType No none 1.5 The parameters with which this task was started.
Progress int No none 1.5 Read-only indicator of task progress as an approximate percentage between 0 and 100. Not available for all tasks.
Tasks TasksInProgressType No none 0.9 A list of queued, running, or recently completed tasks associated with this entity.
User ReferenceType No create 1.5 The user who started the task.
VCloudExtension VCloudExtensionType No always 0.9 An optional extension element that can contain an arbitrary number of elements and attributes. Not related to extension services.

Operations

CRUD Operation Description Since Deprecated
create POST /admin/catalog/{id}/metadata Merge the metadata provided in the request with existing metadata. 1.5
create POST /admin/edgeGateway/{id}/action/configureServices Update edgeGateway configuration. 5.1
create POST /admin/edgeGateway/{id}/action/reapplyServices Reapply services on an edgeGateway. 5.1
create POST /admin/edgeGateway/{id}/action/redeploy Redeploy edgeGateway. 5.1
create POST /admin/edgeGateway/{id}/action/syncSyslogServerSettings Synchronize syslog server settings on an edgeGateway. 5.1
create POST /admin/edgeGateway/{id}/action/upgradeConfig Upgrade edgeGateway configuration from compact to full. 5.1
create POST /admin/extension/host/{id}/action/disable Disable a host. 0.9
create POST /admin/extension/host/{id}/action/enable Enable a host. 0.9
create POST /admin/extension/host/{id}/action/prepare Prepare a host. 0.9
create POST /admin/extension/host/{id}/action/repair Repair a host. 1.0
create POST /admin/extension/host/{id}/action/unprepare Unprepare a host. 0.9
create POST /admin/extension/host/{id}/action/upgrade Upgrade the vCloud Director host agent on a host after you have upgraded vCloud Director software. 1.0
create POST /admin/extension/providervdc/{id}/action/merge Merge provider vDCs. 5.1
create POST /admin/extension/providervdc/{id}/action/updateResourcePools Add or remove provider vDC resource pools. 1.5
create POST /admin/extension/providervdc/{id}/storageProfiles Update storage classes of a provider vDC. 5.1
create POST /admin/extension/resourcePool/{id}/action/migrateVms Migrate one or more virtual machines to a different resource pool. 5.1
create POST /admin/extension/strandedItem/{id}/action/forceDelete Removes stranded item and its children 5.1
create POST /admin/extension/vimServer/{id}/action/forcevimserverreconnect Force vCloud Director to reconnect to a registered vCenter server. 1.0
create POST /admin/extension/vimServer/{id}/action/refresh Refresh vCenter server. 5.1
create POST /admin/extension/vimServer/{id}/action/refreshStorageProfiles Refresh Storage Classes data from a registered vCenter server. 5.1
create POST /admin/extension/vimServer/{id}/action/unregister Unregister a vCenter server. 0.9
create POST /admin/extension/vimServer/{id}/importVmIntoExistingVApp Import a virtual machine from vCenter into an existing vCloud Director vApp. 1.5
create POST /admin/network/{id}/action/reset Reset networking services on a network. 1.5
create POST /admin/network/{id}/action/syncSyslogServerSettings Synchronize syslog server settings for a network. 1.5
create POST /admin/network/{id}/metadata Merge the metadata provided in the request with existing metadata. 1.5
create POST /admin/org/{id}/metadata Merge the metadata provided in the request with existing metadata. 1.5
create POST /admin/providervdc/{id}/metadata Merge the metadata provided in the request with existing metadata. 1.5
create POST /admin/pvdcStorageProfile/{id}/metadata Merge the metadata provided in the request with existing metadata.
create POST /admin/vdc/{id}/action/registerVApp Create a vApp based on a set of .vmx files and resource mappings 5.5
create POST /admin/vdc/{id}/metadata Merge the metadata provided in the request with existing metadata. 1.5
create POST /admin/vdc/{id}/vdcStorageProfiles Add or remove virtual datacenter storage classes.
create POST /admin/vdcStorageProfile/{id}/metadata Merge the metadata provided in the request with existing metadata.
create POST /catalog/{id}/action/captureVApp Create a vApp template in this catalog from a vApp. 5.5
create POST /catalog/{id}/action/copy Copy a catalog item from one catalog to another. 5.5
create POST /catalog/{id}/action/move Move a catalog item from one catalog to another. 5.5
create POST /catalog/{id}/action/sync Force sync the catalog to the remote subscribed catalog. 5.5
create POST /catalogItem/{id}/action/sync
create POST /catalogItem/{id}/metadata Merge the metadata provided in the request with existing catalog item metadata. 1.5
create POST /disk/{id}/metadata Merge the metadata provided in the request with existing metadata. 5.1
create POST /media/{id}/action/enableDownload Enable download for the media 5.5
create POST /media/{id}/metadata Merge the metadata provided in the request with existing metadata. 1.5
create POST /tasksList/{id} Post an external task to this organization.
create POST /vApp/vm-{id}/action/reconfigureVm Updates Vm name, Description, and any or all of the following sections.
  • VirtualHardwareSection
  • OperatingSystemSection
  • NetworkConnectionSection
  • GuestCustomizationSection
Sections not included in the request body will not be updated.
5.1
create POST /vApp/{id}/action/checkCompliance Perform storage profile compliance check on a VM. 5.1
create POST /vApp/{id}/action/consolidate Consolidate VM snapshots. 1.5
create POST /vApp/{id}/action/createSnapshot Creates new snapshot of a virtual machine or of all the virtual machines in a vApp. 5.1
create POST /vApp/{id}/action/deploy Deploy a vApp or VM. 0.9
create POST /vApp/{id}/action/disableNestedHypervisor Hide hardware-assisted CPU virtualization from guest OS. 5.1
create POST /vApp/{id}/action/discardSuspendedState Discard suspended state of a vApp or VM. 0.9
create POST /vApp/{id}/action/enableDownload Enable a vApp for download. 5.5
create POST /vApp/{id}/action/enableNestedHypervisor Expose hardware-assisted CPU virtualization to guest OS. 5.1
create POST /vApp/{id}/action/installVMwareTools Install VMware Tools on a running VM. 1.5
create POST /vApp/{id}/action/recomposeVApp Recompose a vApp to add or remove VMs. 1.0
create POST /vApp/{id}/action/reloadFromVc Reloads VM state from VC. 5.6
create POST /vApp/{id}/action/relocate Relocate a VM to a different datastore. 1.5 Since version 5.1 modifyVm should be used to relocate vm to a different storage profile. Storage profile can be specified by using VmType and making modifyVm request.
create POST /vApp/{id}/action/removeAllSnapshots Removes all user created snapshots for a vApp or virtual machine. 5.1
create POST /vApp/{id}/action/revertToCurrentSnapshot Reverts a vApp or virtual machine to the current snapshot, if any. 5.1
create POST /vApp/{id}/action/undeploy Undeploy a vApp/VM. 0.9
create POST /vApp/{id}/action/upgradeHardwareVersion Upgrade the virtual hardware version of a VM to the highest supported virtual hardware version of the vDC that contains it. 1.5
create POST /vApp/{id}/disk/action/attach Attach a disk to a VM. 5.1
create POST /vApp/{id}/disk/action/detach Detach a disk from a VM. 5.1
create POST /vApp/{id}/media/action/ejectMedia Eject virtual media. 0.9
create POST /vApp/{id}/media/action/insertMedia Insert virtual media. 0.9
create POST /vApp/{id}/metadata Merge the metadata provided in the request with existing metadata. 1.5
create POST /vApp/{id}/power/action/powerOff Power off a vApp or VM. 0.9
create POST /vApp/{id}/power/action/powerOn Power on a vApp or VM. 0.9
create POST /vApp/{id}/power/action/reboot Reboot a vApp or VM. 0.9
create POST /vApp/{id}/power/action/reset Reset a vApp or VM. 0.9
create POST /vApp/{id}/power/action/shutdown Shut down a vApp or VM. 0.9
create POST /vApp/{id}/power/action/suspend Suspend a vApp or VM. 0.9
create POST /vAppTemplate/{id}/action/consolidate Consolidate VM snapshots. 1.5
create POST /vAppTemplate/{id}/action/enableDownload Enable a vApp template for download 0.9
create POST /vAppTemplate/{id}/action/relocate Relocate a VM to a different datastore. 1.5 Since version 5.1
create POST /vAppTemplate/{id}/metadata Merge the metadata provided in the request with existing metadata. 1.5
read GET /task/{id} Retrieve a task. 0.9
update PUT /task/{id} Update a task. 5.1
action POST /task/{id}/action/cancel Cancel a task. 1.5
as output DELETE /admin/catalog/{id}/metadata/{domain}/{key} Delete the specified key in the specified domain and its value from catalog metadata. 5.1
as output PUT /admin/catalog/{id}/metadata/{domain}/{key} Set the value for the specified metadata key in the specified domain to the value provided, overwriting any existing value. 5.1
as output DELETE /admin/catalog/{id}/metadata/{key} Delete the specified key and its value from catalog metadata. 1.5
as output PUT /admin/catalog/{id}/metadata/{key} Set the value for the specified metadata key to the value provided, overwriting any existing value. 1.5
as output DELETE /admin/edgeGateway/{id} Delete an edge gateway. 5.1
as output PUT /admin/edgeGateway/{id} Update an edge gateway 5.1
as output DELETE /admin/extension/externalnet/{id} Delete an external network. 1.0
as output DELETE /admin/extension/networkPool/{id} Delete a network pool. 0.9
as output DELETE /admin/extension/providervdc/{id} Delete a provider vDC. 0.9
as output PUT /admin/extension/settings/lookupService Register / unregister Lookup Service to / from vCD. 5.1
as output DELETE /admin/extension/strandedItem/{id} Removes stranded item. 5.1
as output DELETE /admin/extension/strandedItems Removes all stranded items. 5.1
as output PUT /admin/extension/vimServer/{id} Update the representation of a registered vCenter server. 0.9
as output PUT /admin/extension/vsm/{id} Update vShield Manager configuration details, including administrator credentials. 5.1
as output DELETE /admin/network/{id} Delete a network. 0.9
as output PUT /admin/network/{id} Update an organization network. 5.1
as output DELETE /admin/network/{id}/metadata/{domain}/{key} Delete the specified key in the specified domain and its value from network metadata. 5.1
as output PUT /admin/network/{id}/metadata/{domain}/{key} Set the value for the specified metadata key in the specified domain to the value provided, overwriting any existing value. 5.1
as output DELETE /admin/network/{id}/metadata/{key} Delete the specified key and its value from network metadata. 1.5
as output PUT /admin/network/{id}/metadata/{key} Set the value for the specified metadata key to the value provided, overwriting any existing value. 1.5
as output DELETE /admin/org/{id}/metadata/{domain}/{key} Delete the specified key in the specified domain and its value from organization metadata. 5.1
as output PUT /admin/org/{id}/metadata/{domain}/{key} Set the value for the specified metadata key in the specified domain to the value provided, overwriting any existing value. 5.1
as output DELETE /admin/org/{id}/metadata/{key} Delete the specified key and its value from organization metadata. 1.5
as output PUT /admin/org/{id}/metadata/{key} Set the value for the specified metadata key to the value provided, overwriting any existing value. 1.5
as output DELETE /admin/providervdc/{id}/metadata/{domain}/{key} Delete the specified key in the specified domain and its value from provider vDC metadata. 5.1
as output PUT /admin/providervdc/{id}/metadata/{domain}/{key} Set the value for the specified metadata key in the specified domain to the value provided, overwriting any existing value. 5.1
as output DELETE /admin/providervdc/{id}/metadata/{key} Delete the specified key and its value from provider vDC metadata. 1.5
as output PUT /admin/providervdc/{id}/metadata/{key} Set the value for the specified metadata key to the value provided, overwriting any existing value. 1.5
as output DELETE /admin/pvdcStorageProfile/{id}/metadata/{domain}/{key} Delete the specified key and its value from Provider VDC Storage Profile metadata.
as output PUT /admin/pvdcStorageProfile/{id}/metadata/{domain}/{key} Set the value for the specified metadata key to the value provided, overwriting any existing value.
as output DELETE /admin/pvdcStorageProfile/{id}/metadata/{key} Delete the specified key and its value from Provider VDC Storage Profile metadata.
as output PUT /admin/pvdcStorageProfile/{id}/metadata/{key} Set the value for the specified metadata key to the value provided, overwriting any existing value.
as output DELETE /admin/vdc/{id} Delete an organization vDC. 0.9
as output PUT /admin/vdc/{id} Modify an organization vDC. 0.9
as output DELETE /admin/vdc/{id}/metadata/{domain}/{key} Delete the specified key in the specified domain and its value from virtual datacenter metadata. 5.1
as output PUT /admin/vdc/{id}/metadata/{domain}/{key} Set the value for the specified metadata key in the specified domain to the value provided, overwriting any existing value. 5.1
as output DELETE /admin/vdc/{id}/metadata/{key} Delete the specified key and its value from virtual datacenter metadata. 1.5
as output PUT /admin/vdc/{id}/metadata/{key} Set the value for the specified metadata key to the value provided, overwriting any existing value. 1.5
as output DELETE /admin/vdcStorageProfile/{id}/metadata/{domain}/{key} Delete the specified key and its value from vDC storage profile metadata.
as output PUT /admin/vdcStorageProfile/{id}/metadata/{domain}/{key} Set the value for the specified metadata key to the value provided, overwriting any existing value.
as output DELETE /admin/vdcStorageProfile/{id}/metadata/{key} Delete the specified key and its value from vDC storage profile metadata.
as output PUT /admin/vdcStorageProfile/{id}/metadata/{key} Set the value for the specified metadata key to the value provided, overwriting any existing value.
as output DELETE /catalogItem/{id}/metadata/{domain}/{key} Delete the specified key in the specified domain and its value from catalog item metadata. 5.1
as output PUT /catalogItem/{id}/metadata/{domain}/{key} Set the metadata value for the specified key in the specified domain to the value provided, overwriting any existing value. 5.1
as output DELETE /catalogItem/{id}/metadata/{key} Delete the specified key and its value from catalog item metadata. 1.5
as output PUT /catalogItem/{id}/metadata/{key} Set the metadata value for the specified key to the value provided, overwriting any existing value. 1.5
as output DELETE /disk/{id} Delete a disk. 5.1
as output PUT /disk/{id} Update the name, description, and storage class of a disk. 5.1
as output DELETE /disk/{id}/metadata/{domain}/{key} Delete the specified key and its value from disk metadata. 5.1
as output PUT /disk/{id}/metadata/{domain}/{key} Set the value for the specified metadata key to the value provided, overwriting any existing value. 5.1
as output DELETE /disk/{id}/metadata/{key} Delete the specified key and its value from disk metadata. 5.1
as output PUT /disk/{id}/metadata/{key} Set the value for the specified metadata key to the value provided, overwriting any existing value. 5.1
as output DELETE /media/{id} Delete a media object. 0.9
as output PUT /media/{id} Update the name and description of a media object. 0.9
as output DELETE /media/{id}/metadata/{domain}/{key} Delete the specified key in the specified domain and its value from media object metadata. 5.1
as output PUT /media/{id}/metadata/{domain}/{key} Set the value for the specified metadata key in the specified domain to the value provided, overwriting any existing value. 5.1
as output DELETE /media/{id}/metadata/{key} Delete the specified key and its value from media object metadata. 1.5
as output PUT /media/{id}/metadata/{key} Set the value for the specified metadata key to the value provided, overwriting any existing value. 1.5
as output DELETE /shadowVm/{id} Deletes shadow VM. 1.5 Since version 5.1 this operation may be removed in a future release.
as output PUT /vApp/vm-{id} Modify the name or description of a VM. 0.9
as output DELETE /vApp/{id} Delete a vApp or VM. 0.9
as output PUT /vApp/{id} Modify the name or description of a vApp. 0.9
as output PUT /vApp/{id}/guestCustomizationSection Updates the guest customization section of a VM. 1.0
as output PUT /vApp/{id}/leaseSettingsSection Updates the lease settings section of a vApp or vApp template. 0.9
as output DELETE /vApp/{id}/metadata/{domain}/{key} Delete the specified key and its value from vApp or VM metadata. 5.1
as output PUT /vApp/{id}/metadata/{domain}/{key} Set the value for the specified metadata key to the value provided, overwriting any existing value. 5.1
as output DELETE /vApp/{id}/metadata/{key} Delete the specified key and its value from vApp or VM metadata. 1.5
as output PUT /vApp/{id}/metadata/{key} Set the value for the specified metadata key to the value provided, overwriting any existing value. 1.5
as output PUT /vApp/{id}/networkConfigSection Update the network config section of a vApp. 0.9
as output PUT /vApp/{id}/networkConnectionSection Update the network connection section of a VM. 0.9
as output PUT /vApp/{id}/operatingSystemSection Update the operating system section of a VM. 0.9
as output PUT /vApp/{id}/productSections Update all ProductSection elements in a vApp template, vApp, or VM. 1.5
as output PUT /vApp/{id}/startupSection Update the startup section of a vApp. 0.9
as output PUT /vApp/{id}/virtualHardwareSection Update the virtual hardware section of a VM. 0.9
as output PUT /vApp/{id}/virtualHardwareSection/cpu Update the RASD item that specifies CPU properties of a VM. 0.9
as output PUT /vApp/{id}/virtualHardwareSection/disks Update all RASD items that specify hard disk and hard disk controller properties of a VM. 0.9
as output PUT /vApp/{id}/virtualHardwareSection/memory Update the RASD item that specifies memory properties of a VM. 0.9
as output PUT /vApp/{id}/virtualHardwareSection/networkCards Update all RASD items that specify network card properties of a VM. 0.9
as output PUT /vApp/{id}/virtualHardwareSection/serialPorts Modifies all RASD items that specify serial port properties of a VM. 1.5
as output PUT /vApp/{id}/vmCapabilities Updates VM's {@link VmCapabilities}
as output DELETE /vAppTemplate/{id} Delete a vApp template. 0.9
as output PUT /vAppTemplate/{id} Update the name, description and gold master of a vApp template. 0.9
as output PUT /vAppTemplate/{id}/guestCustomizationSection Updates the guest customization section of a VM. 1.0
as output PUT /vAppTemplate/{id}/leaseSettingsSection Updates the lease settings section of a vApp or vApp template. 0.9
as output DELETE /vAppTemplate/{id}/metadata/{domain}/{key} Delete the specified key in the specified domain and its value from vApp template or VM metadata. 5.1
as output PUT /vAppTemplate/{id}/metadata/{domain}/{key} Set the value for the specified metadata key in the specified domain to the value provided, overwriting any existing value. 5.1
as output DELETE /vAppTemplate/{id}/metadata/{key} Delete the specified key and its value from vApp template or VM metadata. 1.5
as output PUT /vAppTemplate/{id}/metadata/{key} Set the value for the specified metadata key to the value provided, overwriting any existing value. 1.5
as output PUT /vAppTemplate/{id}/networkConfigSection Update the network config section of a vApp. 0.9
as output PUT /vAppTemplate/{id}/networkConnectionSection Update the network connection section of a VM. 0.9
as output PUT /vAppTemplate/{id}/virtualHardwareSection Update the virtual hardware section of a VM. 0.9
as output PUT /vAppTemplate/{id}/virtualHardwareSection/cpu Update the RASD item that specifies CPU properties of a VM. 0.9
as output PUT /vAppTemplate/{id}/virtualHardwareSection/disks Update all RASD items that specify hard disk and hard disk controller properties of a VM. 0.9
as output PUT /vAppTemplate/{id}/virtualHardwareSection/memory Update the RASD item that specifies memory properties of a VM. 0.9
as output PUT /vAppTemplate/{id}/virtualHardwareSection/networkCards Update all RASD items that specify network card properties of a VM. 0.9
as output PUT /vAppTemplate/{id}/virtualHardwareSection/serialPorts Modifies all RASD items that specify serial port properties of a VM. 1.5