VMware Host - Install tools
Declaration
<AMVMWAREVM ACTIVITY="installtools" SESSION="text" HOSTTYPE="text (options)" SERVER="text" USERNAME="text" PASSWORD="text (encrypted)" CONNECTIONTIMEOUT="number" VMPATH="text" TIMEOUT="number" OPENVMTIMEOUT="number" POWERONTIMEOUT="number" />
Description
Installs VMWare Tools, a suite of utilities that enhances virtual machine operations and improves virtual machine management.
Practical usage
Used to install VMWare Tools. The VMware Tools package provides support required for shared folders, synchronization of time in the guest operating system with time on the host, copying and pasting between guest and host and other performance improvements.
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:\Temp\Snapshot.vmx" | The absolute path of the virtual machine configuration (.vmx) file in which to install VMWare Tools on. 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. |
Power-on timeout (seconds) | Number | No | (Empty) | POWERONTIMEOUT="65" | The maximum time out value in seconds that this activity should wait for the specified Virtual Machine to power on. |
Timeout (seconds) | Number | No | 60 | TIMEOUT="50" | The maximum time out value in seconds that this activity should wait for a response from the host. |
Open VM timeout (seconds) | Number | No | 60 | OPENVMTIMEOUT="40" | The maximum time period in seconds during which this activity must successfully connect to the specified VMware product or the task times out. |
Example
NOTE:
- 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 installs VMware tool on a virtual machine.
Copy
<AMVMWAREVM ACTIVITY="installtools" HOSTTYPE="Player" VMPATH="F:\Virtual Machines\Windows 10 x86\Windows 10.vmx" POWERONTIMEOUT="" />