| Local Methods | ||
Managed Object Types | Data Object Types | All Properties | All Methods |
Properties
Name | Type | Description |
---|---|---|
None |
Methods
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the ConverterQueryManager used to make the method call. |
targets P | ConverterTargetVmSpecManagedVmLocation[] |
Specifies the array of managed target locations.
Since Converter API 1.0 |
Return Value
Type | Description |
---|---|
ConverterConfigOptionsInfo[] | The set of ConfigOptionsInfo for each of the target locations. |
Faults
Type | Description |
---|---|
InvalidLogin | Thrown if authentication with the host fails. |
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 ConverterQueryManager used to make the method call. |
Return Value
Type | Description |
---|---|
ConverterSupportedSources | Data structure holding the supported source types. |
Faults
Type | Description |
---|---|
InvalidLogin | Thrown if authentication with the host fails. |
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 ConverterQueryManager used to make the method call. |
Return Value
Type | Description |
---|---|
ConverterSupportedSources | Data structure holding the supported source types. |
Faults
Type | Description |
---|---|
InvalidLogin | Thrown if authentication with the host fails. |
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 ConverterQueryManager used to make the method call. |
source P | ConverterComputerSpec |
Specifies the source of the conversion operation
Since Converter API 1.0 |
Return Value
Type | Description |
---|---|
ConverterSupportedTargets | Data structure holding the supported target types |
Faults
Type | Description |
---|---|
InvalidLogin | Thrown if authentication with the host fails |
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 ConverterQueryManager used to make the method call. |
source P | ConverterComputerSpec |
Specifies the VM to reconfigure/customize.
Since Converter API 1.0 |
Return Value
Type | Description |
---|---|
ConverterDefaultVMReconfigurationParamsResult | The default parameters for configuring and customizing a VM with property info/warnings. |
Faults
Type | Description |
---|---|
InvalidLogin | Thrown if authentication with the host fails. |
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 ConverterQueryManager used to make the method call. |
source P | ConverterComputerSpec |
Specifies computer to query.
Since Converter API 2.0 |
Return Value
Type | Description |
---|---|
ConverterComputerInfo | Hardware and OS info the specified computer. |
Faults
Type | Description |
---|---|
InvalidLogin | Thrown if authentication with the host fails. |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
VimFault |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the ConverterQueryManager used to make the method call. |
target P | ConverterComputerSpec |
The ComputerSpec of the target VM
Since Converter API 2.0 |
Return Value
Type | Description |
---|---|
ConverterSnapshotInfo[] | The array of valid bootable snapshots |
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 ConverterQueryManager used to make the method call. |
source P | ConverterComputerSpec |
Specifies computer to query.
Since Converter API 1.0 |
Return Value
Type | Description |
---|---|
ConverterComputerHardwareInfo | Hardware and boot loader config information for the specified computer. |
Faults
Type | Description |
---|---|
ConverterConverterFault | Thrown if unable to contact the agent to perform this operation. Typically, a more specific subclass, such as NoRemoteAgent is thrown. |
ConverterNoHostConnection | Thrown if an error occurred when connecting to the host. |
InvalidLogin | Thrown if authentication with the host fails. |
MethodFault | |
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 ConverterQueryManager used to make the method call. |
source P | ConverterComputerSpec |
Specifies the HyperV server to query
Since Converter API 1.0 |
Return Value
Type | Description |
---|---|
ConverterHyperVInventoryInfo | The list of available VMs and basic configuration details is returned from this query interface |
Faults
Type | Description |
---|---|
HostConnectFault | Thrown if an error occurred when remote host cannot be reached. Typically, a more specific subclass, such as NoHost is thrown. |
InvalidLogin | Thrown if authentication with the host fails. |
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 |
If bootLoaderEntry is not not specified, the OS information is retrieved for the "default" OS instance discovered by the backend.
For an offline multi-boot computer, locating the default OS instance may be ambiguous. bootLoaderEntry can be used to explicitly specify a particular boot loader configuration entry to reference a particular OS instance. ConverterQueryComputerInfo can be used to discover the boot loader(s) information.
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the ConverterQueryManager used to make the method call. |
source P | ConverterComputerSpec |
Specifies computer to query.
Since Converter API 1.0 |
bootLoaderEntry* P | ConverterBootConfigInfoBootLoaderEntrySpec |
Optionally specifies a boot loader entry to use when locating
the OS in offline computer. If a boot loader entry is not specified, the default
OS is used by default. The default OS is determined by guessing the default boot
loader entry in a default boot loader. For a live source this argument should
not be specified because only the currently active OS can be queried.
Since Converter API 1.0 |
Return Value
Type | Description |
---|---|
ConverterComputerOsInfo | Hardware and software information for the specified computer. |
Faults
Type | Description |
---|---|
ConverterConverterFault | Thrown if unable to contact the agent to perform this operation. Typically, a more specific subclass, such as NoRemoteAgent is thrown. |
ConverterNoHostConnection | Thrown if an error occurred when connecting to the host. |
InvalidLogin | Thrown if authentication with the host fails. |
MethodFault | |
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 ConverterQueryManager used to make the method call. |
source P | ConverterComputerSpec |
Specifies computer which is about to queried for its information.
Since Converter API 1.0 |
Return Value
Type | Description |
---|---|
ConverterQueryManagerAgentAvailabilityResult | if system needs a reboot or not, if agent is available. If agent is not available throws an exception. |
Faults
Type | Description |
---|---|
InvalidLogin | Thrown if authentication with the host fails. |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
VimFault |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the ConverterQueryManager used to make the method call. |
source P | ConverterComputerSpec |
Specifies the source of the conversion operation.
Since Converter API 1.0 |
conversionParams P | ConverterConversionParams |
Conversion job parameters to validate.
Since Converter API 1.0 |
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
ConverterPropertyInfoFault | throws a fault containing property info array describing some failed validation. |
InvalidLogin | Thrown if authentication with the host fails. |
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 ConverterQueryManager used to make the method call. |
source P | ConverterComputerSpec |
Specifies the source of conversion operation.
Since Converter API 3.0 |
target P | ConverterTargetVmSpec |
Specifies target VM destination.
Since Converter API 3.0 |
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
ConverterConverterFault | Thrown if unable to contact the agent to perform this operation. Typically, a more specific subclass, such as NoRemoteAgent is thrown. |
ConverterNoHostConnection | Thrown if an error occurred when connecting to the host. |
InvalidLogin | Thrown if authentication with the host fails. |
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 ConverterQueryManager used to make the method call. |
source P | ConverterComputerSpec |
Specifies the source of the conversion operation.
Since Converter API 1.0 |
target P | ConverterTargetVmSpec |
Specifies target VM destination.
Since Converter API 1.0 |
Return Value
Type | Description |
---|---|
ConverterDefaultConversionParamsResult | The default parameters for the conversion with property info/warnings. |
Faults
Type | Description |
---|---|
InvalidLogin | Thrown if authentication with the host fails. |
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 ConverterQueryManager used to make the method call. |
source P | ConverterComputerSpec |
Specifies the source of conversion operation.
Since Converter API 1.0 |
sourceHardwareInfo P | ConverterComputerHardwareInfo |
the hardware information about the source. This call
demands that this be supplied by client, so that no additional source
queries are done by the server.
Since Converter API 1.0 |
conversionParams P | ConverterConversionParams |
Conversion job parameters
Since Converter API 1.0 |
Return Value
Type | Description |
---|---|
ConverterValidationResult |
Faults
Type | Description |
---|---|
ConverterPropertyInfoFault | |
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 Methods | ||
Managed Object Types | Data Object Types | All Properties | All Methods |