User Guide
Page 1
EN-000275-01 VMware Tools Configuration Utility User's Guide VMware Fusion 3.0 vSphere 4.1 VMware Workstation 7.0 VMware Player 3.0 This document supports the version of this document, see http://www.vmware.com/support/pubs. To check for more recent editions of each product listed and supports all subsequent versions until the document is replaced by a new edition.
EN-000275-01 VMware Tools Configuration Utility User's Guide VMware Fusion 3.0 vSphere 4.1 VMware Workstation 7.0 VMware Player 3.0 This document supports the version of this document, see http://www.vmware.com/support/pubs. To check for more recent editions of each product listed and supports all subsequent versions until the document is replaced by a new edition.
User Guide
Page 2
...documentation, submit your feedback to -date technical documentation on the VMware Web site at http://www.vmware.com/go/patents. in the United States and/or other marks and names mentioned herein may be trademarks of VMware, Inc. VMware is protected by one or more patents listed at : http...://www.vmware.com/support/ The VMware Web site also provides the latest product updates. This product is a registered trademark or ...
...documentation, submit your feedback to -date technical documentation on the VMware Web site at http://www.vmware.com/go/patents. in the United States and/or other marks and names mentioned herein may be trademarks of VMware, Inc. VMware is protected by one or more patents listed at : http...://www.vmware.com/support/ The VMware Web site also provides the latest product updates. This product is a registered trademark or ...
User Guide
Page 3
Contents About This Book 5 Using the VMware Tools Configuration Utility 7 Configure Time Synchronization Between Guest and Host 8 Disable Time Synchronization Completely 9 VMware Tools Service 10 Connect or Disconnect a Virtual Device 10 VMware Tools Device Drivers 11 Shrink a Virtual Disk 12 Use Custom VMware Tools Scripts 14 Default VMware Tools Scripts 15 Disable a VMware Tools Script 16 Retrieve Status Information About the Virtual Machine 17 Subcommands for the stat Command 18 Exit Codes 19 Index 21 VMware, Inc. 3
Contents About This Book 5 Using the VMware Tools Configuration Utility 7 Configure Time Synchronization Between Guest and Host 8 Disable Time Synchronization Completely 9 VMware Tools Service 10 Connect or Disconnect a Virtual Device 10 VMware Tools Device Drivers 11 Shrink a Virtual Disk 12 Use Custom VMware Tools Scripts 14 Default VMware Tools Scripts 15 Disable a VMware Tools Script 16 Retrieve Status Information About the Virtual Machine 17 Subcommands for the stat Command 18 Exit Codes 19 Index 21 VMware, Inc. 3
User Guide
Page 5
... Resources The following technical support resources are available to you have comments, send your business needs, go to http://www.vmware.com/support/pubs. For onsite pilot programs and implementation best practices, VMware Consulting VMware, Inc. 5 To access the current version of terms as on priority 1 issues. Online and Telephone Support Support Offerings...
... Resources The following technical support resources are available to you have comments, send your business needs, go to http://www.vmware.com/support/pubs. For onsite pilot programs and implementation best practices, VMware Consulting VMware, Inc. 5 To access the current version of terms as on priority 1 issues. Online and Telephone Support Support Offerings...
User Guide
Page 6
VMware Tools Configuration Utility User's Guide Services provides offerings to http://www.vmware.com/services. 6 VMware, Inc. To access information about education classes, certification programs, and consulting services, go to help you assess, plan, build, and manage your virtual environment.
VMware Tools Configuration Utility User's Guide Services provides offerings to http://www.vmware.com/services. 6 VMware, Inc. To access information about education classes, certification programs, and consulting services, go to help you assess, plan, build, and manage your virtual environment.
User Guide
Page 7
... previously available only in the guest operating system to perform several tasks. This program is included in the following VMware products for functionality that , VMware Tools checks once every minute to determine whether the clocks on the guest and host still match. n Connect or...the clock on the guest is a command-line interface you can use this release: n VMware ESX/ESXi 4.1 and later n VMware Workstation 7.0 and later n VMware Fusion 3.0 and later n VMware Player 3.0 and later n VMware ACE 2.6 and later You can use scripts to automate guest operating system operations when you ...
... previously available only in the guest operating system to perform several tasks. This program is included in the following VMware products for functionality that , VMware Tools checks once every minute to determine whether the clocks on the guest and host still match. n Connect or...the clock on the guest is a command-line interface you can use this release: n VMware ESX/ESXi 4.1 and later n VMware Workstation 7.0 and later n VMware Fusion 3.0 and later n VMware Player 3.0 and later n VMware ACE 2.6 and later You can use scripts to automate guest operating system operations when you ...
User Guide
Page 8
... the guest operating system to be either forward or backward in time. If the clock on the guest falls behind the clock on the host, VMware Tools moves the clock on the guest forward to match the clock on by default. If the clock on the guest is no need to... know what the exit codes are using native time synchronization software, turn off VMware Tools periodic time synchronization, but do not become out of the virtual machine and set several synchronization properties to a snapshot, and after shrinking a disk. If...
... the guest operating system to be either forward or backward in time. If the clock on the guest falls behind the clock on the host, VMware Tools moves the clock on the guest forward to match the clock on by default. If the clock on the guest is no need to... know what the exit codes are using native time synchronization software, turn off VMware Tools periodic time synchronization, but do not become out of the virtual machine and set several synchronization properties to a snapshot, and after shrinking a disk. If...
User Guide
Page 9
...Option Windows Linux, Solaris, and FreeBSD Action Use VMwareToolboxCmd.exe. For information about the additional functionality this procedure, the VMware Tools service enables or disables periodic time synchronization, as you must set the properties to keep a fictitious time in ... configuration file. To configure the virtual machine so that on page 10. To completely disable time synchronization, you want to FALSE. VMware, Inc. 9 Disable Time Synchronization Completely If you must disable time synchronization completely. tools.syncTime = "FALSE" time.synchronize.continue =...
...Option Windows Linux, Solaris, and FreeBSD Action Use VMwareToolboxCmd.exe. For information about the additional functionality this procedure, the VMware Tools service enables or disables periodic time synchronization, as you must set the properties to keep a fictitious time in ... configuration file. To configure the virtual machine so that on page 10. To completely disable time synchronization, you want to FALSE. VMware, Inc. 9 Disable Time Synchronization Completely If you must disable time synchronization completely. tools.syncTime = "FALSE" time.synchronize.continue =...
User Guide
Page 10
...on whether your system administrator has enabled them. n Runs scripts that the guest operating system is called vmtoolsd.exe in Windows guests, vmware-tools-daemon in Mac guests, and vmtoolsd in the management interface. IMPORTANT Note the following tasks: n Passes messages from the host... between host and guest. n In Windows guests, allows the pointer to the guest operating system. VMware Tools Configuration Utility User's Guide VMware Tools Service The VMware Tools service starts when the guest operating system boots. This feature applies to indicate that help automate ...
...on whether your system administrator has enabled them. n Runs scripts that the guest operating system is called vmtoolsd.exe in Windows guests, vmware-tools-daemon in Mac guests, and vmtoolsd in the management interface. IMPORTANT Note the following tasks: n Passes messages from the host... between host and guest. n In Windows guests, allows the pointer to the guest operating system. VMware Tools Configuration Utility User's Guide VMware Tools Service The VMware Tools service starts when the guest operating system boots. This feature applies to indicate that help automate ...
User Guide
Page 11
...one of the names displayed when you can choose which allows for device functionality, see "VMware Tools Device Drivers," on page 11. VMware Tools Device Drivers Device drivers smooth mouse operations, make VMware features such as you used the list subcommand. 5 Enter the command to connect or...usr/sbin. utility-name device list For utility-name use one of the names displayed when you specified. Change directories to install. Use vmware-toolbox-cmd. After you complete this procedure, the device is connected. Use enable or disable. utility-name device status device-name For ...
...one of the names displayed when you can choose which allows for device functionality, see "VMware Tools Device Drivers," on page 11. VMware Tools Device Drivers Device drivers smooth mouse operations, make VMware features such as you used the list subcommand. 5 Enter the command to connect or...usr/sbin. utility-name device list For utility-name use one of the names displayed when you specified. Change directories to install. Use vmware-toolbox-cmd. After you complete this procedure, the device is connected. Use enable or disable. utility-name device status device-name For ...
User Guide
Page 12
...operating system is for PVSCSI adapters, which provides the best performance for information on the host. In the preparation step, VMware Tools reclaims all 64-bit Windows guests and 32-bit Windows Server 2003, Windows Server 2008, and Windows Vista guests if you ...a two-step process. Shrink a Virtual Disk Shrinking a virtual disk reclaims unused space in the guest operating system. 12 VMware, Inc. When you use the virtual machine with VMware Server, Workstation, or Fusion. Shrinking a disk is installed. For example, Windows Server 2008 defaults to use of the ...
...operating system is for PVSCSI adapters, which provides the best performance for information on the host. In the preparation step, VMware Tools reclaims all 64-bit Windows guests and 32-bit Windows Server 2003, Windows Server 2008, and Windows Vista guests if you ...a two-step process. Shrink a Virtual Disk Shrinking a virtual disk reclaims unused space in the guest operating system. 12 VMware, Inc. When you use the virtual machine with VMware Server, Workstation, or Fusion. Shrinking a disk is installed. For example, Windows Server 2008 defaults to use of the ...
User Guide
Page 13
... system. n The virtual machine contains a snapshot. Procedure 1 Open a command prompt or terminal in as the root user to the VMware Tools installation directory. Option Windows Linux and Solaris FreeBSD Action Change directories to the virtual disk when you created it. Prerequisites Perform the...must be logged in the guest. 2 Change to shrink virtual disks. n You preallocated all the disk space to C:\Program Files\VMware\VMware Tools. utility-name disk list For utility-name use one of the mount points displayed when you plan to script the commands used...
... system. n The virtual machine contains a snapshot. Procedure 1 Open a command prompt or terminal in as the root user to the VMware Tools installation directory. Option Windows Linux and Solaris FreeBSD Action Change directories to the virtual disk when you created it. Prerequisites Perform the...must be logged in the guest. 2 Change to shrink virtual disks. n You preallocated all the disk space to C:\Program Files\VMware\VMware Tools. utility-name disk list For utility-name use one of the mount points displayed when you plan to script the commands used...
User Guide
Page 14
... tasks, as necessary: n To familiarize yourself with the default scripts, see "Exit Codes," on page 15. Edit scripts in Program Files\VMware\VMware Tools. Because vmtoolsd is installed, you want to edit a script, make sure xterm and vi are installed in the guest and are run...Examine the contents of the logged-in any executable format, such as a batch file. Create the script in user. Change directories to the VMware Tools installation directory. IMPORTANT This utility cannot run scripts on Windows NT, Me, Windows 98, or Windows 95 guest operating systems. Scripts are...
... tasks, as necessary: n To familiarize yourself with the default scripts, see "Exit Codes," on page 15. Edit scripts in Program Files\VMware\VMware Tools. Because vmtoolsd is installed, you want to edit a script, make sure xterm and vi are installed in the guest and are run...Examine the contents of the logged-in any executable format, such as a batch file. Create the script in user. Change directories to the VMware Tools installation directory. IMPORTANT This utility cannot run scripts on Windows NT, Me, Windows 98, or Windows 95 guest operating systems. Scripts are...
User Guide
Page 15
...Solaris, and FreeBSD guests, the default script that runs when you resume a virtual machine renews the IP address of the virtual machine. VMware, Inc. 15 Using the VMware Tools Configuration Utility 5 Enter the command to use DHCP. Use power, resume, suspend, or shutdown. 6 Enter the command to ...enable the script. What the default scripts do depends in the Program Files\VMware\VMware Tools folder. IMPORTANT This utility cannot run on page 10. The default script that the custom script you complete this service performs, see...
...Solaris, and FreeBSD guests, the default script that runs when you resume a virtual machine renews the IP address of the virtual machine. VMware, Inc. 15 Using the VMware Tools Configuration Utility 5 Enter the command to use DHCP. Use power, resume, suspend, or shutdown. 6 Enter the command to ...enable the script. What the default scripts do depends in the Program Files\VMware\VMware Tools folder. IMPORTANT This utility cannot run on page 10. The default script that the custom script you complete this service performs, see...
User Guide
Page 16
... virtual machine is being powered off operation to restart the guest, this script releases the IP address of the virtual machine. Default VMware Tools Scripts Script Name poweroff-vm-default poweron-vm-default resume-vm-default suspend-vm-default Description If you configured the suspend operation ... operation to use DHCP, this script runs when the virtual machine is being powered on networking for the other action as root. 16 VMware, Inc. This script has no effect on rather than resumed. On Windows guests, if the virtual machine is configured to restart the ...
... virtual machine is being powered off operation to restart the guest, this script releases the IP address of the virtual machine. Default VMware Tools Scripts Script Name poweroff-vm-default poweron-vm-default resume-vm-default suspend-vm-default Description If you configured the suspend operation ... operation to use DHCP, this script runs when the virtual machine is being powered on networking for the other action as root. 16 VMware, Inc. This script has no effect on rather than resumed. On Windows guests, if the virtual machine is configured to restart the ...
User Guide
Page 17
...about memory and CPU reservations and limits. Change directories to /usr/local/sbin. 3 Enter the command to /usr/sbin. Use vmware-toolbox-cmd. For virtual machines hosted on page 19. Option Windows Linux and Solaris Action Change directories to /usr/sbin. Change ...directories to C:\Program Files\VMware\VMware Tools. Prerequisites n Determine what the exit codes are, see "Exit Codes," on ESX, ESXi servers, you disabled the script for...
...about memory and CPU reservations and limits. Change directories to /usr/local/sbin. 3 Enter the command to /usr/sbin. Use vmware-toolbox-cmd. For virtual machines hosted on page 19. Option Windows Linux and Solaris Action Change directories to /usr/sbin. Change ...directories to C:\Program Files\VMware\VMware Tools. Prerequisites n Determine what the exit codes are, see "Exit Codes," on ESX, ESXi servers, you disabled the script for...
User Guide
Page 18
...to the virtual machine's swap file, in MHz. memlimit (ESX/ESXi only) Displays memory limit information, in MHz. VMware Tools Configuration Utility User's Guide Option FreeBSD Mac Action Change directories to display the desired status information. Change directories to '/Library/Application... Support/VMware Tools'. 3 Enter the command to /usr/local/sbin. sessionid (ESX/ESXi only) Displays the current session ID. 18 VMware, Inc. Use hosttime or speed, or, if applicable, one of memory...
...to the virtual machine's swap file, in MHz. memlimit (ESX/ESXi only) Displays memory limit information, in MHz. VMware Tools Configuration Utility User's Guide Option FreeBSD Mac Action Change directories to display the desired status information. Change directories to '/Library/Application... Support/VMware Tools'. 3 Enter the command to /usr/local/sbin. sessionid (ESX/ESXi only) Displays the current session ID. 18 VMware, Inc. Use hosttime or speed, or, if applicable, one of memory...
User Guide
Page 19
... stat 75 stat 77 All commands The command was successful. Always indicates that although shrinking is enabled, the shrink command cannot be carried out. VMware, Inc. 19 For the shrink command, 1 means that an error occurred. The file name does not exist. The host does not support ...the stat command, 69 means the program could not communicate with a scripting tool. Permission errors. Use the list subcommand to integrate the VMware Tools configuration utility commands with the host (EX_UNAVAILABLE). For the device command, 69 means the specified device does not exist. Using the...
... stat 75 stat 77 All commands The command was successful. Always indicates that although shrinking is enabled, the shrink command cannot be carried out. VMware, Inc. 19 For the shrink command, 1 means that an error occurred. The file name does not exist. The host does not support ...the stat command, 69 means the program could not communicate with a scripting tool. Permission errors. Use the list subcommand to integrate the VMware Tools configuration utility commands with the host (EX_UNAVAILABLE). For the device command, 69 means the specified device does not exist. Using the...