Managed Object - ConverterTask

Property of
ConverterJobHasActiveTaskFault, ConverterServerJobJobInfo, ConverterTaskFilterSpec, ConverterTaskInfo, ConverterTaskManager
Parameter to
ConverterDestroyTask, ConverterGenerateTaskLogBundle, ConverterGetChildTask
Returned by
AbortCustomization_Task, AddDisks_Task, AddDVPortgroup_Task, AddHost_Task, AddStandaloneHost_Task, ApplyEntitiesConfig_Task, ApplyEvcModeVM_Task, ApplyHostConfig_Task, ApplyStorageDrsRecommendation_Task, ApplyStorageDrsRecommendationToPod_Task, AttachDisk_Task, AttachScsiLunEx_Task, BatchAddHostsToCluster_Task, BatchAddStandaloneHosts_Task, CertMgrRefreshCACertificatesAndCRLs_Task, CertMgrRefreshCertificates_Task, CertMgrRevokeCertificates_Task, ChangeKey_Task, CheckAddHostEvc_Task, CheckAnswerFileStatus_Task, CheckClone_Task, CheckCompatibility_Task, CheckCompliance_Task, CheckConfigureEvcMode_Task, CheckHostPatch_Task, CheckInstantClone_Task, CheckMigrate_Task, CheckPowerOn_Task, CheckProfileCompliance_Task, CheckRelocate_Task, CheckVmConfig_Task, CloneVApp_Task, CloneVM_Task, CloneVStorageObject_Task, CompositeHostProfile_Task, ConfigureDatastoreIORM_Task, ConfigureEvcMode_Task, ConfigureHCI_Task, ConfigureHostCache_Task, ConfigureStorageDrsForPod_Task, configureVcha_Task, ConfigureVFlashResourceEx_Task, ConnectNvmeControllerEx_Task, ConsolidateVMDisks_Task, ConverterAgentClone_Task, ConverterAgentConvert_Task, ConverterAgentCustomize_Task, ConverterAgentReconfig_Task, ConverterHelperConvert_Task, ConverterWorkerConvert_Task, CopyDatastoreFile_Task, CopyVirtualDisk_Task, CreateChildVM_Task, CreateDisk_Task, CreateDiskFromSnapshot_Task, CreateDVPortgroup_Task, CreateDVS_Task, CreateNvdimmNamespace_Task, CreateNvdimmPMemNamespace_Task, createPassiveNode_Task, CreateScreenshot_Task, CreateSecondaryVM_Task, CreateSecondaryVMEx_Task, CreateSnapshot_Task, CreateSnapshotEx_Task, CreateVirtualDisk_Task, CreateVM_Task, createWitnessNode_Task, CryptoUnlock_Task, CustomizeGuest_Task, CustomizeVM_Task, DatastoreExitMaintenanceMode_Task, DefragmentVirtualDisk_Task, DeleteDatastoreFile_Task, DeleteNvdimmBlockNamespaces_Task, DeleteNvdimmNamespace_Task, DeleteSnapshot_Task, DeleteVirtualDisk_Task, DeleteVStorageObject_Task, DeleteVStorageObjectEx_Task, deployVcha_Task, Destroy_Task, destroyVcha_Task, DetachDisk_Task, DetachScsiLunEx_Task, DisableEvcMode_Task, DisableSecondaryVM_Task, DisconnectHost_Task, DisconnectNvmeControllerEx_Task, DVPortgroupRollback_Task, DVSManagerExportEntity_Task, DVSManagerImportEntity_Task, DvsReconfigureVmVnicNetworkResourcePool_Task, DVSRollback_Task, EagerZeroVirtualDisk_Task, EnableSecondaryVM_Task, EnterMaintenanceMode_Task, EstimateStorageForConsolidateSnapshots_Task, EvacuateVsanNode_Task, ExitMaintenanceMode_Task, ExportAnswerFile_Task, ExtendDisk_Task, ExtendHCI_Task, ExtendVirtualDisk_Task, GenerateHostConfigTaskSpec_Task, GenerateHostProfileTaskList_Task, GenerateLogBundles_Task, HostCloneVStorageObject_Task, HostCreateDisk_Task, HostDeleteVStorageObject_Task, HostDeleteVStorageObjectEx_Task, HostExtendDisk_Task, HostInflateDisk_Task, HostReconcileDatastoreInventory_Task, HostRelocateVStorageObject_Task, HostUpdateVStorageObjectMetadata_Task, HostUpdateVStorageObjectMetadataEx_Task, HostVStorageObjectCreateDiskFromSnapshot_Task, HostVStorageObjectCreateSnapshot_Task, HostVStorageObjectDeleteSnapshot_Task, HostVStorageObjectRevert_Task, HttpNfcLeasePullFromUrls_Task, ImportCertificateForCAM_Task, InflateDisk_Task, InflateVirtualDisk_Task, InitializeDisks_Task, initiateFailover_Task, InstallHostPatch_Task, InstallHostPatchV2_Task, InstallIoFilter_Task, InstantClone_Task, JoinDomain_Task, JoinDomainWithCAM_Task, LeaveCurrentDomain_Task, MakePrimaryVM_Task, MarkAsLocal_Task, MarkAsNonLocal_Task, MarkAsNonSsd_Task, MarkAsSsd_Task, MarkPerenniallyReservedEx_Task, MergeDvs_Task, MigrateVM_Task, MountVmfsVolumeEx_Task, MoveDatastoreFile_Task, MoveDVPort_Task, MoveHostInto_Task, MoveInto_Task, MoveIntoFolder_Task, MoveVirtualDisk_Task, PerformDvsProductSpecOperation_Task, PerformVsanUpgrade_Task, PowerDownHostToStandBy_Task, PowerOffVApp_Task, PowerOffVM_Task, PowerOnMultiVM_Task, PowerOnVApp_Task, PowerOnVM_Task, PowerUpHostFromStandBy_Task, prepareVcha_Task, PromoteDisks_Task, QueryHostPatch_Task, QueryVMotionCompatibilityEx_Task, RebootHost_Task, RecommissionVsanNode_Task, ReconcileDatastoreInventory_Task, ReconfigureCluster_Task, ReconfigureComputeResource_Task, ReconfigureDatacenter_Task, ReconfigureDVPort_Task, ReconfigureDVPortgroup_Task, ReconfigureDvs_Task, ReconfigureHostForDAS_Task, ReconfigVM_Task, ReconnectHost_Task, RectifyDvsHost_Task, RectifyDvsOnHost_Task, RefreshStorageDrsRecommendationsForPod_Task, RegisterChildVM_Task, RegisterVM_Task, reloadVirtualMachineFromPath_Task, RelocateVM_Task, RelocateVStorageObject_Task, RemoveAllSnapshots_Task, RemoveDatastoreEx_Task, RemoveDisk_Task, RemoveDiskMapping_Task, RemoveSnapshot_Task, Rename_Task, ResetVM_Task, ResignatureUnresolvedVmfsVolume_Task, ResolveInstallationErrorsOnCluster_Task, ResolveInstallationErrorsOnHost_Task, ResolveMultipleUnresolvedVmfsVolumesEx_Task, RetrieveKmipServersStatus_Task, RevertToCurrentSnapshot_Task, RevertToSnapshot_Task, RevertVStorageObject_Task, ScanHostPatch_Task, ScanHostPatchV2_Task, SearchDatastore_Task, SearchDatastoreSubFolders_Task, setClusterMode_Task, ShrinkVirtualDisk_Task, ShutdownHost_Task, StageHostPatch_Task, StampAllRulesWithUuid_Task, StartGuestNetwork_Task, StartRecording_Task, StartReplaying_Task, StopRecording_Task, StopReplaying_Task, SuspendVApp_Task, SuspendVM_Task, TerminateFaultTolerantVM_Task, TurnDiskLocatorLedOff_Task, TurnDiskLocatorLedOn_Task, TurnOffFaultToleranceForVM_Task, UninstallHostPatch_Task, UninstallIoFilter_Task, UnmapVmfsVolumeEx_Task, UnmountDiskMapping_Task, UnmountVmfsVolumeEx_Task, UnregisterAndDestroy_Task, unregisterVApp_Task, UpdateAnswerFile_Task, UpdateDVSHealthCheckConfig_Task, UpdateDVSLacpGroupConfig_Task, UpdateHostCustomizations_Task, UpdateProductLockerLocation_Task, UpdateVirtualMachineFiles_Task, UpdateVsan_Task, UpdateVStorageInfrastructureObjectPolicy_Task, UpdateVStorageObjectCrypto_Task, UpdateVStorageObjectPolicy_Task, UpdateVVolVirtualMachineFiles_Task, UpgradeIoFilter_Task, UpgradeTools_Task, UpgradeVM_Task, ValidateHostProfileComposition_Task, VCenterUpdateVStorageObjectMetadataEx_Task, VStorageObjectCreateSnapshot_Task, ZeroFillVirtualDisk_Task
Extended by
ConverterTaskAgentTask
See also
ConverterEvent, ConverterTaskInfo, ConverterTaskSpec
Since
Converter API 1.0


Managed Object Description

A task is used to monitor and potentially cancel long running operations.

Properties

Name Type Description
child*ConverterTaskInfo[]

Child tasks of this task.

Since Converter API 2.0
event*ConverterEvent[]

Events associated with this task.
infoConverterTaskInfo

Detailed information about this task.
spec*ConverterTaskSpec

Detailed specification about this task.
*May not be present

Methods

Methods defined in this Managed Object
ConverterCancelTask

ConverterCancelTask

Cancels a running or queued task. A task may only be canceled if it is cancelable. Multiple cancel requests will be treated as a single cancelation request. Canceling a completed or already canceled task will have no effect on the task.

If a task is canceled, its runtime state will be set to error and its error state will be set to RequestCanceled.

A cancel operation is asynchronous. The operation may return before the task is canceled.

Required Privileges
Global.CancelTask

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the ConverterTask used to make the method call.

Return Value

Type Description
None

Faults

Type Description
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None