Task

Element:
Task
Type:
TaskType
Namespace:
http://www.vmware.com/vcloud/v1.5
Description:
Represents an asynchronous or long-running task in the vCloud environment.
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" name="xs:string" id="xs:string"
        status="xs:string" operation="xs:string" operationName="xs:string" startTime="xs:dateTime"
        endTime="xs:dateTime" expiryTime="xs:dateTime">
    <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>
</Task>

Attributes

Attribute Type Required Modifiable Since Description
href anyURI No always 0.9 Contains the URI to the entity.
type string No always 0.9 Contains the type of the entity.
name string Yes always 0.9 The name 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.
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, if it is a blocking task, administrative action.), running (The task is runnning.), 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 none 0.9 The display name of the operation that is tracked by this task.
operationName string No none 0.9 The name of the operation that is tracked by this task.
startTime dateTime No none 0.9 The date and time the system started executing the task. May not be present if the task hasn't 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.

Elements

Element Type Occurrence Modifiable Since Description
VCloudExtension VCloudExtensionType 0..* always 0.9 An optional extension element that can contain an arbitrary number of elements and attributes.
Link LinkType 0..* none 0.9 Optional link to an entity or operation associated with this object.
Description string 0..1 always 0.9 Optional description.
Tasks TasksInProgressType 0..1 none 0.9 A list of queued, running, or recently completed tasks associated with this entity.
Owner ReferenceType 0..1 none 0.9 Reference to the owner of the task.
Error ErrorType 0..1 none 0.9 Represents an error information if the task failed.
User ReferenceType 0..1 none 1.5 The user who started the task.
Organization ReferenceType 0..1 none 1.5 The organization that started the task.
Progress int 0..1 none 1.5 The progress of a long running asynchronous task. The value is between 0 - 100. Not all tasks have progress, the value is not present for task which progress is not available.
Params anyType 0..1 none 1.5 The parameters with which this task has been run.

Operations

CRUD Operation Description Since
create POST /admin/catalog/{id}/metadata Merges the metadata for a catalog with the information provided. 1.5
create POST /admin/extension/host/{id}/action/disable Disables a host. 0.9
create POST /admin/extension/host/{id}/action/enable Enables a host. 0.9
create POST /admin/extension/host/{id}/action/prepare Prepares a host. 0.9
create POST /admin/extension/host/{id}/action/repair Repairs a host. 1.0
create POST /admin/extension/host/{id}/action/unprepare Unprepares a host. 0.9
create POST /admin/extension/host/{id}/action/upgrade Upgrades the host agent. 1.0
create POST /admin/extension/providervdc/{id}/action/updateResourcePools Update backing resource pools for provider vdc 1.5
create POST /admin/extension/vimServer/{id}/action/forcevimserverreconnect Forces a vSphere server to reconnect. 1.0
create POST /admin/extension/vimServer/{id}/action/unregister Unregisters a vSphere server. 0.9
create POST /admin/extension/vimServer/{id}/importVmIntoExistingVApp Imports a vSphere server VM into an existing vApp. 1.5
create POST /admin/network/{id}/action/reset Reset(undeploy & redeploy) networking services on a logical network. 1.5
create POST /admin/network/{id}/action/syncSyslogServerSettings Synchronize syslog server settings of a logical network with system defaults Synchronize operation can be performed on: - routed organization network - routed/fenced vApp networks 1.5
create POST /admin/network/{id}/metadata Merges the metadata for a network with the information provided. 1.5
create POST /admin/org/{id}/metadata Merges the metadata for a organization with the information provided. 1.5
create POST /admin/providervdc/{id}/metadata Merges the metadata for a provider vDC with the information provided. 1.5
create POST /admin/vdc/{id}/metadata Merges the metadata for a vDC with the information provided. 1.5
create POST /catalogItem/{id}/metadata Merges the metadata for a catalog item with the information provided. 1.5
create POST /media/{id}/metadata Merges the metadata for a media with the information provided. 1.5
create POST /vApp/{id}/action/consolidate Consolidates a vm. 1.5
create POST /vApp/{id}/action/deploy Deploys a vApp/VM. 0.9
create POST /vApp/{id}/action/discardSuspendedState Discard suspended state of a vApp/VM. 0.9
create POST /vApp/{id}/action/installVMwareTools Installs VMware tools to the virtual machine. v1.5
create POST /vApp/{id}/action/recomposeVApp Recompose a vApp by removing its own VMs and/or adding new ones from other vApps or vApp templates. 1.0
create POST /vApp/{id}/action/relocate Relocates a vm. 1.5
create POST /vApp/{id}/action/undeploy Undeploy a vApp/VM. 0.9
create POST /vApp/{id}/action/upgradeHardwareVersion Upgrade virtual hardware version of a VM to the highest supported virtual hardware version of provider vDC where the VM locates 1.5
create POST /vApp/{id}/media/action/ejectMedia Ejects a media from a VM. 0.9
create POST /vApp/{id}/media/action/insertMedia Inserts a media into a VM. 0.9
create POST /vApp/{id}/metadata Merges the metadata for a vApp/vm with the information provided. 1.5
create POST /vApp/{id}/power/action/powerOff Powers off a vApp/VM. 0.9
create POST /vApp/{id}/power/action/powerOn Powers on a vApp/VM. 0.9
create POST /vApp/{id}/power/action/reboot Reboots a vApp/VM. 0.9
create POST /vApp/{id}/power/action/reset Resets a vApp/VM. 0.9
create POST /vApp/{id}/power/action/shutdown Shutdowns a vApp/VM. 0.9
create POST /vApp/{id}/power/action/suspend Suspends a vApp/VM. 0.9
create POST /vAppTemplate/{id}/action/consolidate Consolidates a vm. 1.5
create POST /vAppTemplate/{id}/action/enableDownload Enables downloading of the ovf of a vApp template. 0.9
create POST /vAppTemplate/{id}/action/relocate Relocates a vm. 1.5
create POST /vAppTemplate/{id}/metadata Merges the metadata for a vApp Template with the information provided. 1.5
read GET /task/{id} Retrieves a task. 0.9
action POST /task/{id}/action/cancel Cancel a task. 1.5
as output PUT /admin/catalog/{id}/metadata/{key} Sets the metadata for the particular key for the catalog to the value provided. 1.5
as output DELETE /admin/catalog/{id}/metadata/{key} Deletes the metadata for the particular key for the catalog 1.5
as output DELETE /admin/extension/externalnet/{id} Deletes an external network. 1.0
as output DELETE /admin/extension/networkPool/{id} Deletes a network pool. 0.9
as output DELETE /admin/extension/providervdc/{id} Deletes a provider vDC. 0.9
as output PUT /admin/extension/vimServer/{id} Modifies a vSphere server. 0.9
as output PUT /admin/network/{id} Modifies an org network. 0.9
as output DELETE /admin/network/{id} Deletes a network. 0.9
as output PUT /admin/network/{id}/metadata/{key} Sets the metadata for the particular key for the network to the value provided. 1.5
as output DELETE /admin/network/{id}/metadata/{key} Deletes the metadata for the particular key for the network 1.5
as output PUT /admin/org/{id}/metadata/{key} Sets the metadata for the particular key for the organization to the value provided. 1.5
as output DELETE /admin/org/{id}/metadata/{key} Deletes the metadata for the particular key for the organization 1.5
as output PUT /admin/providervdc/{id}/metadata/{key} Sets the metadata for the particular key for the provider vDC to the value provided. 1.5
as output DELETE /admin/providervdc/{id}/metadata/{key} Deletes the metadata for the particular key for the provider vDC 1.5
as output PUT /admin/vdc/{id} Modifies a Virtual Data Center. 0.9
as output DELETE /admin/vdc/{id} Deletes a Virtual Data Center. 0.9
as output DELETE /admin/vdc/{id}/metadata/{key} Deletes the metadata for the particular key for the vDC 1.5
as output PUT /admin/vdc/{id}/metadata/{key} Sets the metadata for the particular key for the vDC to the value provided. 1.5
as output DELETE /catalogItem/{id}/metadata/{key} Deletes the metadata for the particular key for the catalog item 1.5
as output PUT /catalogItem/{id}/metadata/{key} Sets the metadata for the particular key for the catalog item to the value provided. 1.5
as output DELETE /media/{id} Deletes a media. 0.9
as output PUT /media/{id} Updates the name/description of a media. 0.9
as output PUT /media/{id}/metadata/{key} Sets the metadata for the particular key for the media to the value provided. 1.5
as output DELETE /media/{id}/metadata/{key} Deletes the metadata for the particular key for the media 1.5
as output PUT /vApp/{id} Modifies the name/description of a vApp/VM. 0.9
as output DELETE /vApp/{id} Deletes a vApp/VM. 0.9
as output PUT /vApp/{id}/guestCustomizationSection Modifies the guest customization options of a VM. 1.0
as output PUT /vApp/{id}/leaseSettingsSection Modifies the lease settings section of a vApp or vApp template. 0.9
as output PUT /vApp/{id}/metadata/{key} Sets the metadata for the particular key for the vApp/vm to the value provided. 1.5
as output DELETE /vApp/{id}/metadata/{key} Deletes the metadata for the particular key for the vApp/vm 1.5
as output PUT /vApp/{id}/networkConfigSection Modifies the network config section of a vApp. 0.9
as output PUT /vApp/{id}/networkConnectionSection Modifies the network connection section of a VM. 0.9
as output PUT /vApp/{id}/operatingSystemSection Modifies the operating system section of a VM. 0.9
as output PUT /vApp/{id}/productSections Modifies the product section information of a vApp/VM 1.5
as output PUT /vApp/{id}/startupSection Modifies the startup section of a vApp. 0.9
as output PUT /vApp/{id}/virtualHardwareSection Modifies the virtual hardware section of a VM. 0.9
as output PUT /vApp/{id}/virtualHardwareSection/cpu Modifies the CPU properties in virtual hardware section of a VM. 0.9
as output PUT /vApp/{id}/virtualHardwareSection/disks Modifies the disks list in virtual hardware section of a VM. 0.9
as output PUT /vApp/{id}/virtualHardwareSection/memory Modifies the memory properties in virtual hardware section of a VM 0.9
as output PUT /vApp/{id}/virtualHardwareSection/networkCards Modifies the network cards list in virtual hardware section of a VM. 0.9
as output PUT /vApp/{id}/virtualHardwareSection/serialPorts Modifies the serial ports list in virtual hardware section of a VM. 1.5
as output DELETE /vAppTemplate/{id} Deletes a vApp template. 0.9
as output PUT /vAppTemplate/{id} Modifies only the name/description of a vApp template. 0.9
as output PUT /vAppTemplate/{id}/customizationSection Modifies the vApp template customization information. 1.0
as output PUT /vAppTemplate/{id}/guestCustomizationSection Modifies the guest customization options of a VM. 1.0
as output PUT /vAppTemplate/{id}/leaseSettingsSection Modifies the lease settings section of a vApp or vApp template. 0.9
as output PUT /vAppTemplate/{id}/metadata/{key} Sets the metadata for the particular key for the vApp Template to the value provided. 1.5
as output DELETE /vAppTemplate/{id}/metadata/{key} Deletes the metadata for the particular key for the vApp Template 1.5
as output PUT /vAppTemplate/{id}/networkConfigSection Modifies the network config section of a vApp. 0.9
as output PUT /vAppTemplate/{id}/networkConnectionSection Modifies the network connection section of a VM. 0.9
as output PUT /vAppTemplate/{id}/productSections Modifies the product section information of a vApp/VM 1.5