User Guide
Page 1
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. EN-000275-01
User Guide
Page 2
... patents listed at : http://www.vmware.com/support/ The VMware Web site also provides the latest product updates. If you have comments about this documentation, submit your feedback to -date technical documentation on the VMware Web site at http://www.vmware.com/go/patents. This product is a registered trademark or trademark of their respective companies. All rights reserved. All other jurisdictions. VMware Tools Configuration Utility User's Guide You...
... patents listed at : http://www.vmware.com/support/ The VMware Web site also provides the latest product updates. If you have comments about this documentation, submit your feedback to -date technical documentation on the VMware Web site at http://www.vmware.com/go/patents. This product is a registered trademark or trademark of their respective companies. All rights reserved. All other jurisdictions. VMware Tools Configuration Utility User's Guide You...
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
... of a virtual machine. VMware Education Services courses offer extensive hands-on priority 1 issues. To access the current version of VMware Tools by writing their own scripts. Users typically include administrators and others who configures VMware Tools. Document Feedback VMware welcomes your products, go to http://www.vmware.com/support/phone_support.html. Online and Telephone Support Support Offerings VMware Professional Services To use telephone support for the fastest response on labs, case study examples, and course...
... of a virtual machine. VMware Education Services courses offer extensive hands-on priority 1 issues. To access the current version of VMware Tools by writing their own scripts. Users typically include administrators and others who configures VMware Tools. Document Feedback VMware welcomes your products, go to http://www.vmware.com/support/phone_support.html. Online and Telephone Support Support Offerings VMware Professional Services To use telephone support for the fastest response on labs, case study examples, and course...
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
... you turn on page 14 You can use scripts to automate guest operating system operations when you change the power state of a virtual machine. n Use Custom VMware Tools Scripts on periodic time synchronization, VMware Tools sets the time of the host. After that was previously available only in the VMware Tools control panel. n Connect or Disconnect a Virtual Device on the guest and host still match. Using the VMware Tools Configuration Utility The VMware Tools configuration utility is a command-line interface you can also edit default scripts...
... you turn on page 14 You can use scripts to automate guest operating system operations when you change the power state of a virtual machine. n Use Custom VMware Tools Scripts on periodic time synchronization, VMware Tools sets the time of the host. After that was previously available only in the VMware Tools control panel. n Connect or Disconnect a Virtual Device on the guest and host still match. Using the VMware Tools Configuration Utility The VMware Tools configuration utility is a command-line interface you can also edit default scripts...
User Guide
Page 8
... VMware Tools time synchronization. Option Windows Linux and Solaris FreeBSD Default Path Change directories to match the clock on the host. If you must edit the configuration file (.vmx file) of the virtual machine and set several synchronization properties to FALSE. To disable time synchronization completely, you are , see "Exit Codes," on page 19. If you plan to script the commands used in the guest. 2 Change to the VMware Tools installation directory. Change directories to /usr/local/sbin. 8 VMware, Inc. Change directories...
... VMware Tools time synchronization. Option Windows Linux and Solaris FreeBSD Default Path Change directories to match the clock on the host. If you must edit the configuration file (.vmx file) of the virtual machine and set several synchronization properties to FALSE. To disable time synchronization completely, you are , see "Exit Codes," on page 19. If you plan to script the commands used in the guest. 2 Change to the VMware Tools installation directory. Change directories to /usr/local/sbin. 8 VMware, Inc. Change directories...
User Guide
Page 9
..." time.synchronize.resume.disk = "FALSE" time.synchronize.shrink = "FALSE" time.synchronize.tools.startup = "FALSE" 3 Save and close the file. Use vmware-toolbox-cmd. 4 Enter the command to keep a fictitious time in a virtual machine, so that on the host, you complete this service performs, see "Disable Time Synchronization Completely," on periodic time synchronization. After you must set the properties to determine whether time synchronization is never synchronized with a text editor. 2 Add lines...
..." time.synchronize.resume.disk = "FALSE" time.synchronize.shrink = "FALSE" time.synchronize.tools.startup = "FALSE" 3 Save and close the file. Use vmware-toolbox-cmd. 4 Enter the command to keep a fictitious time in a virtual machine, so that on the host, you complete this service performs, see "Disable Time Synchronization Completely," on periodic time synchronization. After you must set the properties to determine whether time synchronization is never synchronized with a text editor. 2 Add lines...
User Guide
Page 10
... guests. n Is one time. n Provides support for virtual machines on page 19. 10 VMware, Inc. IMPORTANT Note the following tasks: n Passes messages from the host to the screen resolution of the virtual machine changes. 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 script the commands used by certain backup applications. When the virtual machine runs under ESX/ESXi, or VMware Server, a gauge for this heartbeat...
... guests. n Is one time. n Provides support for virtual machines on page 19. 10 VMware, Inc. IMPORTANT Note the following tasks: n Passes messages from the host to the screen resolution of the virtual machine changes. 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 script the commands used by certain backup applications. When the virtual machine runs under ESX/ESXi, or VMware Server, a gauge for this heartbeat...
User Guide
Page 11
...Optional) Enter the command to list available devices. Change directories to /usr/local/sbin. Change directories to /usr/sbin. When you install VMware Tools also depends on the guest operating system and the VMware product. Use enable or disable. The following device drivers are installed when you install VMware Tools, a virtual SVGA driver replaces the default VGA driver, which drivers to connect or disconnect the device. Using the VMware Tools Configuration Utility Procedure 1 Open a command prompt or terminal on the guest. 2 Change to C:\Program Files\VMware\VMware Tools...
...Optional) Enter the command to list available devices. Change directories to /usr/local/sbin. Change directories to /usr/sbin. When you install VMware Tools also depends on the guest operating system and the VMware product. Use enable or disable. The following device drivers are installed when you install VMware Tools, a virtual SVGA driver replaces the default VGA driver, which drivers to connect or disconnect the device. Using the VMware Tools Configuration Utility Procedure 1 Open a command prompt or terminal on the guest. 2 Change to C:\Program Files\VMware\VMware Tools...
User Guide
Page 12
... Shadow Copy Services (VSS) module is a two-step process. These modules enable backup applications to LSI SAS, which enhance the performance of disk partitions (such as the SVGA driver, and it adds Windows Aero support. Shrinking a disk is installed. 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 use some virtualized applications. WDDM) driver is installed. For example, Windows Server 2008 defaults to create application...
... Shadow Copy Services (VSS) module is a two-step process. These modules enable backup applications to LSI SAS, which enhance the performance of disk partitions (such as the SVGA driver, and it adds Windows Aero support. Shrinking a disk is installed. 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 use some virtualized applications. WDDM) driver is installed. For example, Windows Server 2008 defaults to create application...
User Guide
Page 13
... codes are, see "Exit Codes," on an ESX/ESXi server. Option Windows Linux, Solaris, and FreeBSD Action Use VMwareToolboxCmd.exe. IMPORTANT Shrinking disks is not allowed under the following tasks: n On Linux, Solaris, and FreeBSD guests, run VMware Tools as a user with Administrator privileges to script the commands used the list subcommand. Change directories to shrink the disk at a specified mount point. VMware, Inc. 13 n You preallocated all the disk space to the virtual disk...
... codes are, see "Exit Codes," on an ESX/ESXi server. Option Windows Linux, Solaris, and FreeBSD Action Use VMwareToolboxCmd.exe. IMPORTANT Shrinking disks is not allowed under the following tasks: n On Linux, Solaris, and FreeBSD guests, run VMware Tools as a user with Administrator privileges to script the commands used the list subcommand. Change directories to shrink the disk at a specified mount point. VMware, Inc. 13 n You preallocated all the disk space to the virtual disk...
User Guide
Page 14
... script the commands used in Program Files\VMware\VMware Tools. Edit scripts in the guest. 4 Change to automate guest operating system operations when you can configure settings so that it cannot display graphical applications. Change directories to know what the exit codes are, see "Default VMware Tools Scripts," on Windows, the scripts are run scripts on Windows NT, Me, Windows 98, or Windows 95 guest operating systems. Scripts are in a new location. IMPORTANT This utility cannot run by making changes and saving the edited scripts...
... script the commands used in Program Files\VMware\VMware Tools. Edit scripts in the guest. 4 Change to automate guest operating system operations when you can configure settings so that it cannot display graphical applications. Change directories to know what the exit codes are, see "Default VMware Tools Scripts," on Windows, the scripts are run scripts on Windows NT, Me, Windows 98, or Windows 95 guest operating systems. Scripts are in a new location. IMPORTANT This utility cannot run by making changes and saving the edited scripts...
User Guide
Page 15
... address of the virtual machine. IMPORTANT This utility cannot run on page 10. What the default scripts do depends in the Program Files\VMware\VMware Tools folder. In Windows guests, the default scripts are located in VMware Tools. For information about the additional functionality this procedure, the VMware Tools service runs the script whenever the specified power operation occurs. Using the VMware Tools Configuration Utility 5 Enter the command to use the custom script you specified is now being used. Use...
... address of the virtual machine. IMPORTANT This utility cannot run on page 10. What the default scripts do depends in the Program Files\VMware\VMware Tools folder. In Windows guests, the default scripts are located in VMware Tools. For information about the additional functionality this procedure, the VMware Tools service runs the script whenever the specified power operation occurs. Using the VMware Tools Configuration Utility 5 Enter the command to use the custom script you specified is now being used. Use...
User Guide
Page 16
... poweroff-vm-default poweron-vm-default resume-vm-default suspend-vm-default Description If you configured the reset operation to test, edit, or disable the running of these actions, you configured the reset operation to use DHCP, this script runs when the virtual machine is being suspended. This script has no effect on networking for the virtual machine. If you configured the power-off operation to work together. VMware Tools Configuration Utility User's Guide Table 1.
... poweroff-vm-default poweron-vm-default resume-vm-default suspend-vm-default Description If you configured the reset operation to test, edit, or disable the running of these actions, you configured the reset operation to use DHCP, this script runs when the virtual machine is being suspended. This script has no effect on networking for the virtual machine. If you configured the power-off operation to work together. VMware Tools Configuration Utility User's Guide Table 1.
User Guide
Page 17
.... Change directories to /usr/sbin. Retrieve Status Information About the Virtual Machine You can display additional information about host time and CPU speed. VMware, Inc. 17 Change directories to /usr/local/sbin. 3 Enter the command to C:\Program Files\VMware\VMware Tools. For virtual machines hosted on page 19. n If you disabled the script for resuming, also disable the script for the stat Command," on the guest. 2 Change to C:\Program Files\VMware\VMware Tools. See "Subcommands for suspending. Option Windows...
.... Change directories to /usr/sbin. Retrieve Status Information About the Virtual Machine You can display additional information about host time and CPU speed. VMware, Inc. 17 Change directories to /usr/local/sbin. 3 Enter the command to C:\Program Files\VMware\VMware Tools. For virtual machines hosted on page 19. n If you disabled the script for resuming, also disable the script for the stat Command," on the guest. 2 Change to C:\Program Files\VMware\VMware Tools. See "Subcommands for suspending. Option Windows...
User Guide
Page 18
... server. Use vmware-toolbox-cmd. Table 2. sessionid (ESX/ESXi only) Displays the current session ID. 18 VMware, Inc. memres cpures (ESX/ESXi only) Displays memory reservation information, in megabytes. (ESX/ESXi only) Displays CPU reservation information, in megabytes. Subcommands for the stat Command You can use the stat command to the virtual machine's swap file, in megabytes. VMware Tools Configuration Utility User's Guide Option FreeBSD Mac Action Change directories to display the desired status...
... server. Use vmware-toolbox-cmd. Table 2. sessionid (ESX/ESXi only) Displays the current session ID. 18 VMware, Inc. memres cpures (ESX/ESXi only) Displays memory reservation information, in megabytes. (ESX/ESXi only) Displays CPU reservation information, in megabytes. Subcommands for the stat Command You can use the stat command to the virtual machine's swap file, in megabytes. VMware Tools Configuration Utility User's Guide Option FreeBSD Mac Action Change directories to display the desired status...
User Guide
Page 19
... command-line argument is not an ESX host (EX_TEMPFAIL). Permission errors. Exit Codes Code Number Applicable Command Description 0 All commands 1 All commands 64 All commands 66 script 69 device and stat 75 stat 77 All commands The command was successful. For the stat command, 69 means the program could not communicate with a scripting tool. VMware, Inc. 19 Using the VMware Tools Configuration Utility Exit Codes You might use exits codes if you want to display valid names of devices...
... command-line argument is not an ESX host (EX_TEMPFAIL). Permission errors. Exit Codes Code Number Applicable Command Description 0 All commands 1 All commands 64 All commands 66 script 69 device and stat 75 stat 77 All commands The command was successful. For the stat command, 69 means the program could not communicate with a scripting tool. VMware, Inc. 19 Using the VMware Tools Configuration Utility Exit Codes You might use exits codes if you want to display valid names of devices...
User Guide
Page 21
... 17, 18 custom scripts 14 custom VMware Tools scripts 14 D device command 10 device drivers, virtual 11 disk command 12 drivers, VMware Tools 11 DVD drives, connecting 10 E exit codes 19 F Filesystem Sync drivers 11 floppy drives, connecting 10 H hgfs.sys kernel module 11 host time 17 I ISO images, connecting 10 L LSI Logic adapters, virtual 11 M memory control drivers, virtual 11 memory statistics 17, 18 mouse drivers, virtual 11 N network adapters, connecting 10 VMware, Inc. Index A audio adapters, connecting 10 audio drivers, virtual 11 B backup applications, drivers for Linux...
... 17, 18 custom scripts 14 custom VMware Tools scripts 14 D device command 10 device drivers, virtual 11 disk command 12 drivers, VMware Tools 11 DVD drives, connecting 10 E exit codes 19 F Filesystem Sync drivers 11 floppy drives, connecting 10 H hgfs.sys kernel module 11 host time 17 I ISO images, connecting 10 L LSI Logic adapters, virtual 11 M memory control drivers, virtual 11 memory statistics 17, 18 mouse drivers, virtual 11 N network adapters, connecting 10 VMware, Inc. Index A audio adapters, connecting 10 audio drivers, virtual 11 B backup applications, drivers for Linux...
User Guide
Page 22
VMware Tools Configuration Utility User's Guide vmware-tools-cli utility for Mac guests with Fusion 7 VMwareToolboxCmd.exe utility for Windows guests 7 vmxnet networking drivers 11 Volume Shadow Copy Services drivers 11 22 VMware, Inc.
VMware Tools Configuration Utility User's Guide vmware-tools-cli utility for Mac guests with Fusion 7 VMwareToolboxCmd.exe utility for Windows guests 7 vmxnet networking drivers 11 Volume Shadow Copy Services drivers 11 22 VMware, Inc.