VMware Host - Clone
Declaration
<AMVMWAREVM ACTIVITY="clone_vm" SESSION="text" HOSTTYPE="text (options)" SERVER="text" USERNAME="text" PASSWORD="text (encrypted)" CONNECTIONTIMEOUT="number" VMPATH="text" TIMEOUT="number" OPENVMTIMEOUT="number" DESTVMPATH="text" LINKED="YES/NO" />
Description
Creates a clone (copy) of an existing virtual machine. When the cloning operation is complete, the clone is a separate virtual machine — though it may share virtual disks with the parent virtual machine. Changes made to a clone do not affect the parent virtual machine. This activity provides the option to create a full clone, which is an independent copy of a virtual machine, and a linked clone, which is a copy of a virtual machine that shares virtual disks with the parent virtual machine in an ongoing manner.
Practical usage
With clones, you can make many copies of a virtual machine from a single installation and configuration process. Clones are useful when you must deploy many identical virtual machines to a group. For example, a teacher can clone a virtual machine for each student, with all the lessons and labs required for the term. With clones, you can conveniently make complete copies of a virtual machine, without browsing a host file system or worrying if you have located all the configuration files.
Parameters
Connection
| Property | Type | Required | Default | Markup | Description |
|---|---|---|---|---|---|
| Connection | --- | --- | --- | --- | Indicates where
this activity's connection properties should originate from. Different
parameters become active depending on the option selected. This
is a visual parameter used only during design-time, therefore,
contains no properties or markups. The available options are:
|
| Session | Text | Yes, if Connection is set to Session | VMOpsSession1 | SESSION="VMO101" | The name of a session (created in a previous VWmware Host - Connect step) in which to link this activity. This parameter is active only if the Connection parameter is set to Session. |
| Host type | Text (options) | Yes, if Connection is set to Host | VIServer |
|
The type of VM
host to establish a connection with. This parameter is active
only if the Connection
parameter is set to Host.
The available options are:
|
| Host name | Text | Yes | (Empty) | SERVER="host.server.com" | The hostname or IP address of the computer where the virtual machine is located. This parameter is active only if the Host type parameter is set to VMware Server (1.0x) or VMware VI Server (ESX/ESXi, vCenter, VMware Server 2.0). |
| Username | Text | No | (Empty) | USERNAME="MsPacman" | The username identifying a valid user account on the machine. This parameter is active only if the Host type parameter is set to VMware Server (1.0x) or VMware VI Server (ESX/ESXi, vCenter, VMware Server 2.0). |
| Password | Text | No | (Empty) | PASSWORD="encrypted" | The password identifying a valid user account on the machine. This parameter is active only if the Host type parameter is set to VMware Server (1.0x) or VMware VI Server (ESX/ESXi, vCenter, VMware Server 2.0). |
| Connection timeout | Number | No | 60 | CONNECTIONTIMEOUT="50" | The maximum time period in seconds during which a connection must be established between the guest and host, otherwise, the step times out. The default value is 60 seconds. |
Virtual Machine
| Property | Type | Required | Default | Markup | Description |
|---|---|---|---|---|---|
|
Virtual machine path |
Text | Yes | (Empty) | VMPATH="C:\VMFolder\VMfile.vmx" | The absolute path of the virtual machine configuration (.vmx) file in which to clone. This parameter varies by product platform. With ESX/ESXi hosts and VMware Server 2.0, use a URL of the form "https://<hostName>:<port>/sdk" where <hostName> is either the DNS name or IP address, and <port> might be optional; credentials are required even for connections made locally. With VMware Workstation, use undef to connect to the local host. With VMware Server 1.0.x, use a DNS name or IP address for remote connections, or the same as Workstation for local connections. |
| Destination path | Text | Yes | (Empty) | DESTVMPATH="C:\VM\VM_file.vmx" | The absolute path (full path and file name) of the virtual machine configuration file that will be created for the virtual machine clone produced by this activity. This should be a full absolute path name, with directory names delineated according to host system convention (that is, \ for Windows and / for Linux). |
| Linked | Yes/No | No | No | LINKED="yes" | If selected, creates a linked clone, which is a copy of a virtual machine that shares virtual disks with the parent virtual machine in an ongoing manner. This conserves disk space as long as the parent and clone do not change too much from their original state. If disabled (default), creates a full, independent clone of the virtual machine. |
| Timeout (seconds) | Number | No | 60 | TIMEOUT="5" | The time out value in seconds that this activity waits for a response from the host. |
| Open VM timeout (seconds) | Number | No | 60 | OPENVMTIMEOUT="5" | The maximum time period in seconds during which this activity must successfully connect to the specified VMware product or the task times out. |
Example
- Copy and paste the sample AML code below directly into the Task Builder Steps Panel.
- To successfully run the sample code, update parameters containing user credentials, files, file paths, or other information specific to the task to match your environment.
Description
This sample task clones a virtual machine and stores its new location.
<AMVMWAREVM ACTIVITY="clone_vm" VMPATH="C:\Virtual Machines\Windows 10 x64 (FULL)\Windows 10 x64.vmx" DESTVMPATH="C:\Temp\VMClone.vmx" LINKED="yes" />