Convert Template To VM operation

The Convert Template To VM operation switches a virtual machine (VM) template to a virtual machine (VM) and re-associates the VM to a resource pool and a host.

The following table describes the elements for this request:

Adapter request elements for the Convert Template To VM operation

Element

Definition

Required

<operation-type>

Defines the type of the operation: Basic_VM

Yes

<operation-name>

Defines the name of the operation: Convert_Template_To_VM

Yes

<soap-url>

Specifies the URL for the remote SOAP service running on the VMware VirtualCenter

If the <soap-url> element is not specified, the request uses the VirtualCenter Server details specified in the adapter configuration.

Default format for HTTPS: https://<hostName>:<port>/sdk/vim

Default format for HTTP: http://<hostName>:<port>/sdk/vim

Note

If you want to use an HTTP value, you might need to change the configuration of the VMware Infrastructure application.

No

<transport>

Specifies the transport protocol for the message

If the <transport> element is not specified, the request uses the VirtualCenter Server details specified in the adapter configuration.

Valid values: https-rpc (default), http-rpc

Note

If the value of the <transport> element is https-rpc, you must install the security certificate for the VMware Virtual Center to the keystore of the peer on which the adapter is enabled.

No

<user-name>

Specifies the user name that is used for HTTP basic authentication on the VMware Virtual Center

If no user name is specified, the request is executed with the user name that is specified in the configuration.

No

<password>

Specifies the password corresponding to <user-name>

Conditional; required if <user-name> is specified

<parameters>

Contains the elements required to execute the operation

Yes

<virtual-machine-template>

Specifies the template to be converted to a VM

Valid value: Any string

Yes

<resource-pool>

Specifies the resource pool to associate with the VM

Valid value: Any string

Yes

<host-system>

Specifies the target host on which the VM is to run

For a stand-alone host or a cluster with a Distributed Resource Scheduler (DRS), if you do not specify <host-system>, a default value that is compatible with the host system is used.

Valid value: Any string

No

The [expand] macro is a standalone macro and it cannot be used inline.

Sample adapter response for the Convert Template To VM operation


<vmware-infrastructure-response>
 <metadata>
   <status>success</status>
 </metadata>
 <MarkAsVirtualMachineResponse></MarkAsVirtualMachineResponse>
</vmware-infrastructure-response>

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*