| Local Properties | Local Methods | |
Managed Object Types | Data Object Types | All Properties | All Methods |
Properties
Name | Type | Description |
---|---|---|
info | TaskInfo |
|
Properties inherited from ExtensibleManagedObject | ||
availableField, value |
Methods
Methods defined in this Managed Object |
---|
CancelTask, SetTaskDescription, SetTaskState, UpdateProgress |
Methods inherited from ExtensibleManagedObject |
setCustomValue |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the Task used to make the method call. |
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
InvalidState | |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the Task used to make the method call. |
description P | LocalizableMessage |
Since vSphere API 4.0 |
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the Task used to make the method call. |
state P | TaskInfoState |
Since VI API 2.5 |
result* P | xsd:anyType |
Since VI API 2.5 |
fault* P | MethodFault |
Since VI API 2.5 |
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
InvalidState | |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the Task used to make the method call. |
percentDone P | xsd:int |
Since VI API 2.5 |
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
InvalidState | |
OutOfBounds | |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Top of page | Local Properties | Local Methods | |
Managed Object Types | Data Object Types | All Properties | All Methods |