Managed Object - ConverterConverterWorker

Property of: ConverterWorkerContent
See also: ConverterComputerSpec, ConverterConversionParams, ConverterConversionRuntimeEnvironmentInfo, ConverterConverterWorkerVmCreationResult, ConverterParamsStorageMapping, ConverterServerConversionP2VSourceModificationSpec
Since: Converter API 2.0

Managed Object Description

ConverterWorker provides methods for creating the target VM, converting sources into target VMs as well as "reconfiguring" VMs.

Properties

Name	Type	Description
None

Methods

Methods defined in this Managed Object
ConverterTargetVMManagerCreateVM, ConverterWorkerConvert_Task, ConverterWorkerDeleteBitmap, ConverterWorkerEstimateTimeToComplete

ConverterTargetVMManagerCreateVM

Create target VM

Required Privileges: None

Parameters

Name

Type

Description

_this

ManagedObjectReference

A reference to the ConverterConverterWorker used to make the method call.

source P

ConverterComputerSpec

The ComputerSpec of the source machine

Since Converter API 2.0

params P

ConverterConversionParams

Specifies parameters for the conversion operations. Can not be a reconfig-only conversion.

Since Converter API 2.0

PRequired privilege - see tooltip for details

Return Value

Type	Description
ConverterConverterWorkerVmCreationResult	The ComputerSpec for the target VM and the mapping between the source and target volume/disks

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

ConverterWorkerConvert_Task

Converts source into target or just reconfigures the specified VM.

Required Privileges: None

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the ConverterConverterWorker used to make the method call.
source* P	ConverterComputerSpec	Specifies source of a cloning operation for a cloning task, For a "reconfig"-only task is not specified. *Since* Converter API 2.0
target P	ConverterComputerSpec	Specifies cloning target for a cloning operation or reconfig target for a reconfig-only task. *Since* Converter API 2.0
params P	ConverterConversionParams	Specifies parameters for the conversion operations, as well what kind of conversion -- clone+reconfig or reconfig-only this operation is. *Since* Converter API 2.0
sourceModificationSpec* P	ConverterServerConversionP2VSourceModificationSpec	Specifies if the Agent should be uninstalled and the source shutdown. *Since* Converter API 2.0
storageMapping* P	ConverterParamsStorageMapping	Specifies the source to target volume and/or disk mapping. Is not passed in case of reconfig-only. *Since* Converter API 2.0
envInfo P	ConverterConversionRuntimeEnvironmentInfo	Specifies the environment in which the conversion will run. *Since* Converter API 2.0

*Need not be set PRequired privilege - see tooltip for details

Return Value

Type	Description
ManagedObjectReference to a ConverterTask

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

ConverterWorkerDeleteBitmap

Cleanup the previous bitmaps after an incremental P2V is done.

Required Privileges: None

Parameters

Name

Type

Description

_this

ManagedObjectReference

A reference to the ConverterConverterWorker used to make the method call.

source P

ConverterComputerSpec

The source of the previous cloning operation.

Since Converter API 2.0

prevBitmapIds P

xsd:string[]

The list of bitmaps to be deleted.

Since Converter API 2.0

PRequired privilege - see tooltip for details

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

ConverterWorkerEstimateTimeToComplete

Estimates the time in seconds that will be required to sucessfully complete the given task.

Required Privileges: None

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the ConverterConverterWorker used to make the method call.
source* P	ConverterComputerSpec	Specifies source of a cloning operation for a cloning task, For a "reconfig"-only task is not specified. *Since* Converter API 2.0
target P	ConverterComputerSpec	Specifies cloning target for a cloning operation or reconfig target for a reconfig-only task. *Since* Converter API 2.0
params P	ConverterConversionParams	Specifies parameters for the conversion operations. *Since* Converter API 2.0
envInfo P	ConverterConversionRuntimeEnvironmentInfo	Additional information on the environment in which the task will run. *Since* Converter API 2.0

*Need not be set PRequired privilege - see tooltip for details

Return Value

Type	Description
xsd:int	The estimated time remaining and the current percentage estimated complete.

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