Managed Object - ConverterConverterAgent

Property of
ConverterAgentContent
See also
ConverterComputerInfo, ConverterComputerSpec, ConverterConversionRuntimeEnvironmentInfo, ConverterParamsAgentCloningParams, ConverterParamsAgentCustomizationParams, ConverterReconfigParams, ConverterTargetVmSpec
Since
Converter API 2.0


Managed Object Description

Interface for conversion functionality which has to be executed "close" to the source of the conversion.

I.e. for live P2V ConverterAgent is running on the physical machine.

Properties

Name Type Description
None

Methods

Methods defined in this Managed Object
ConverterAgentClone_Task, ConverterAgentCustomize_Task, ConverterAgentDeleteBitmap, ConverterAgentQuery, ConverterAgentReconfig_Task, ConverterAgentValidateTarget

ConverterAgentClone_Task

Perform cloning.
Required Privileges
None

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the ConverterConverterAgent used to make the method call.
target PConverterComputerSpec

Specifies target VM to clone to.

Since Converter API 2.0
params PConverterParamsAgentCloningParams

Parameters for the cloning operation.

Since Converter API 2.0
envInfo PConverterConversionRuntimeEnvironmentInfo

Specifies the environment in which the task will run.

Since Converter API 2.0
PRequired privilege - see tooltip for details

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

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



ConverterAgentCustomize_Task

Perform customization of the target VM.
Required Privileges
None

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the ConverterConverterAgent used to make the method call.
target PConverterComputerSpec

Target VM to reconfig.

Since Converter API 2.0
customizationParams PConverterParamsAgentCustomizationParams

Customization parameters.

Since Converter API 2.0
cloningParams* PConverterParamsAgentCloningParams

Optional cloning parameters are used for mapping

Since Converter API 2.0
envInfo PConverterConversionRuntimeEnvironmentInfo

Specifies 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
ManagedObjectReference
to a ConverterTask

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



ConverterAgentDeleteBitmap

Cleanup the previous bitmaps after an incremental P2V is done.
Required Privileges
None

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the ConverterConverterAgent used to make the method call.
prevBitmapIds Pxsd:string[]

The list of bitmaps to be deleted.

Since Converter API 2.0
P Required privilege: prevBitmapIds

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



ConverterAgentQuery

Query and return information on the specified source.
Required Privileges
None

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the ConverterConverterAgent used to make the method call.
source PConverterComputerSpec

Specifies source to query

Since Converter API 2.0
P Required privilege: source

Return Value

Type Description
ConverterComputerInfoSource info.

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



ConverterAgentReconfig_Task

Perform reconfiguration of the target VM.
Required Privileges
None

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the ConverterConverterAgent used to make the method call.
target PConverterComputerSpec

Target VM to reconfig.

Since Converter API 2.0
reconfigParams PConverterReconfigParams

Reconfiguration parameters.

Since Converter API 2.0
cloningParams* PConverterParamsAgentCloningParams

Optional cloning parameters are used for mapping source volumes to target volumes for certain types of reconfig functionality.

Since Converter API 2.0
envInfo PConverterConversionRuntimeEnvironmentInfo

Specifies 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
ManagedObjectReference
to a ConverterTask

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



ConverterAgentValidateTarget

Perform validation on target.
Required Privileges
None

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the ConverterConverterAgent used to make the method call.
source PConverterComputerSpec

Specifies the source of the conversion operation.

Since Converter API 2.0
target PConverterTargetVmSpec

Specifies target VM destination.

Since Converter API 2.0
PRequired privilege - see tooltip for details

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