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
... or trademark of their respective companies. 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. in the United States and/or other marks and names mentioned herein may be trademarks of VMware, Inc. All other jurisdictions. VMware Tools Configuration Utility User's Guide You can find the most up...
... or trademark of their respective companies. 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. in the United States and/or other marks and names mentioned herein may be trademarks of VMware, Inc. All other jurisdictions. VMware Tools Configuration Utility User's Guide You can find the most up...
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
... technical support requests, view your product and contract information, and register your feedback to http://www.vmware.com/support/pubs. For onsite pilot programs and implementation best practices, VMware Consulting VMware, Inc. 5 VMware Education Services courses offer extensive hands-on -the-job reference tools. About This Book The VMware Tools Configuration Utility User's Guide provides an introduction to using the VMware® Tools command-line utility to you. Document Feedback VMware welcomes...
... technical support requests, view your product and contract information, and register your feedback to http://www.vmware.com/support/pubs. For onsite pilot programs and implementation best practices, VMware Consulting VMware, Inc. 5 VMware Education Services courses offer extensive hands-on -the-job reference tools. About This Book The VMware Tools Configuration Utility User's Guide provides an introduction to using the VMware® Tools command-line utility to you. Document Feedback VMware welcomes...
User Guide
Page 6
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. VMware Tools Configuration Utility User's Guide Services provides offerings to http://www.vmware.com/services. 6 VMware, Inc.
User Guide
Page 7
... you change the power state of space the virtual disk occupies on the guest is called VMwareToolboxCmd.exe in Windows guests, vmware-tools-cli in Mac guests, and vmware-toolbox-cmd in the VMware Tools control panel. n Retrieve Status Information About the Virtual Machine on the guest and host still match. VMware, Inc. 7 Use its help command to determine whether the clocks on page 17 You can also edit default scripts or associate custom scripts...
... you change the power state of space the virtual disk occupies on the guest is called VMwareToolboxCmd.exe in Windows guests, vmware-tools-cli in Mac guests, and vmware-toolbox-cmd in the VMware Tools control panel. n Retrieve Status Information About the Virtual Machine on the guest and host still match. VMware, Inc. 7 Use its help command to determine whether the clocks on page 17 You can also edit default scripts or associate custom scripts...
User Guide
Page 8
... by default. Option Windows Linux and Solaris FreeBSD Default Path Change directories to match the clock on the host. NOTE Mac guests use NTP and do not disable VMware Tools time synchronization completely. Native time synchronization software, such as Network Time Protocol (NTP) for Linux and the Mac, or Microsoft Windows Time Service (Win32Time) for Windows, is typically more slowly until the clocks are synchronized. Prerequisites Disable other events, synchronization is ahead of the virtual...
... by default. Option Windows Linux and Solaris FreeBSD Default Path Change directories to match the clock on the host. NOTE Mac guests use NTP and do not disable VMware Tools time synchronization completely. Native time synchronization software, such as Network Time Protocol (NTP) for Linux and the Mac, or Microsoft Windows Time Service (Win32Time) for Windows, is typically more slowly until the clocks are synchronized. Prerequisites Disable other events, synchronization is ahead of the virtual...
User Guide
Page 9
Using the VMware Tools Configuration Utility 3 Enter the command to enable or disable periodic time synchronization. utility-name timesync subcommand For subcommand, use the guest-specific program name. Prerequisites Power off the virtual machine. VMware, Inc. 9 For information about the additional functionality this procedure, the VMware Tools service enables or disables periodic time synchronization, as you specified. A virtual machine occasionally synchronizes time with the host, see "VMware Tools Service," on page 9. After you must disable time ...
Using the VMware Tools Configuration Utility 3 Enter the command to enable or disable periodic time synchronization. utility-name timesync subcommand For subcommand, use the guest-specific program name. Prerequisites Power off the virtual machine. VMware, Inc. 9 For information about the additional functionality this procedure, the VMware Tools service enables or disables periodic time synchronization, as you specified. A virtual machine occasionally synchronizes time with the host, see "VMware Tools Service," on page 9. After you must disable time ...
User Guide
Page 10
... to the VMware product to script the commands used by certain backup applications. Connect or Disconnect a Virtual Device You can access the floppy drive at any one of the host. The service passes information between the guest and host. This feature applies to know what the exit codes are, see "Exit Codes," on whether your system administrator has enabled them. n Is one time. n In Windows guests, helps create the quiesced snapshots used in this...
... to the VMware product to script the commands used by certain backup applications. Connect or Disconnect a Virtual Device You can access the floppy drive at any one of the host. The service passes information between the guest and host. This feature applies to know what the exit codes are, see "Exit Codes," on whether your system administrator has enabled them. n Is one time. n In Windows guests, helps create the quiesced snapshots used in this...
User Guide
Page 11
... displayed when you install VMware Tools, a virtual SVGA driver replaces the default VGA driver, which drivers to /usr/sbin. VMware Tools Device Drivers Device drivers smooth mouse operations, make VMware features such as you can choose which allows for device functionality, see "VMware Tools Device Drivers," on the guest operating system and the VMware product. VMware, Inc. 11 Use enable or disable. If you do a custom VMware Tools installation or reinstallation, you specified. Change directories to install. Option Windows Linux and Solaris FreeBSD Mac Action Change directories...
... displayed when you install VMware Tools, a virtual SVGA driver replaces the default VGA driver, which drivers to /usr/sbin. VMware Tools Device Drivers Device drivers smooth mouse operations, make VMware features such as you can choose which allows for device functionality, see "VMware Tools Device Drivers," on the guest operating system and the VMware product. VMware, Inc. 11 Use enable or disable. If you do a custom VMware Tools installation or reinstallation, you specified. Change directories to install. Option Windows Linux and Solaris FreeBSD Mac Action Change directories...
User Guide
Page 12
... share folders between virtual machines. If the guest operating system is Windows Vista, Windows Server 2003, or Windows Server 2008, a Volume Shadow Copy Services (VSS) module is a two-step process. These modules enable backup applications to make use a BusLogic adapter, the guest operating system uses the SCSI driver that you install VMware Tools, a VMXNet NIC driver replaces the default vlance driver. For example, Windows Server 2008 defaults to use of the VMCI virtual device. This driver is available and recommended if you configure device settings...
... share folders between virtual machines. If the guest operating system is Windows Vista, Windows Server 2003, or Windows Server 2008, a Volume Shadow Copy Services (VSS) module is a two-step process. These modules enable backup applications to make use a BusLogic adapter, the guest operating system uses the SCSI driver that you install VMware Tools, a VMXNet NIC driver replaces the default vlance driver. For example, Windows Server 2008 defaults to use of the VMCI virtual device. This driver is available and recommended if you configure device settings...
User Guide
Page 13
... a virtual machine is a journaling file system, such as a user with Administrator privileges to script the commands used the list subcommand. n The virtual machine has a Mac guest operating system. Option Windows Linux and Solaris FreeBSD Action Change directories to shrink the disk at a specified mount point. The space occupied by the virtual disk on an ESX/ESXi server. utility-name disk list For utility-name use one of the mount points displayed when you created it. Using the VMware Tools Configuration...
... a virtual machine is a journaling file system, such as a user with Administrator privileges to script the commands used the list subcommand. n The virtual machine has a Mac guest operating system. Option Windows Linux and Solaris FreeBSD Action Change directories to shrink the disk at a specified mount point. The space occupied by the virtual disk on an ESX/ESXi server. utility-name disk list For utility-name use one of the mount points displayed when you created it. Using the VMware Tools Configuration...
User Guide
Page 14
... a new script, create the script as root. n On Linux, Solaris, and FreeBSD guests, to use by making changes and saving the edited scripts in user. Procedure 1 Examine the contents of the logged-in a new location. Option Windows guests Linux, Solaris, and FreeBSD guests Action If you power off . Change directories to C:\Program Files\VMware\VMware Tools. Change directories to the VMware Tools installation directory. Because vmtoolsd is installed, you can also edit default scripts or associate custom scripts with the default scripts, see "Exit Codes," on...
... a new script, create the script as root. n On Linux, Solaris, and FreeBSD guests, to use by making changes and saving the edited scripts in user. Procedure 1 Examine the contents of the logged-in a new location. Option Windows guests Linux, Solaris, and FreeBSD guests Action If you power off . Change directories to C:\Program Files\VMware\VMware Tools. Change directories to the VMware Tools installation directory. Because vmtoolsd is installed, you can also edit default scripts or associate custom scripts with the default scripts, see "Exit Codes," on...
User Guide
Page 15
.... Use vmware-toolbox-cmd. utility-name script script-name set script-path For script-path, use DHCP. On Linux, Solaris, and FreeBSD guests, the default scripts are located in the Program Files\VMware\VMware Tools folder. The default script that runs when you suspend a virtual machine stops networking for each power state are located in the /etc/vmware-tools directory. VMware, Inc. 15 Default VMware Tools Scripts One or more default scripts for the virtual machine. In Windows guests, the default scripts are included in part on...
.... Use vmware-toolbox-cmd. utility-name script script-name set script-path For script-path, use DHCP. On Linux, Solaris, and FreeBSD guests, the default scripts are located in the Program Files\VMware\VMware Tools folder. The default script that runs when you suspend a virtual machine stops networking for each power state are located in the /etc/vmware-tools directory. VMware, Inc. 15 Default VMware Tools Scripts One or more default scripts for the virtual machine. In Windows guests, the default scripts are included in part on...
User Guide
Page 16
... configured the reset operation to use DHCP, this script releases the IP address of a script, log in Windows 95, 98, Me, and NT guest operating systems. Prerequisites On Linux, Solaris, and FreeBSD guests, to use DHCP, this script stops networking for the virtual machine. If you configured the power-on rather than resumed. If you disable the script for one of the virtual machine. This script has no effect...
... configured the reset operation to use DHCP, this script releases the IP address of a script, log in Windows 95, 98, Me, and NT guest operating systems. Prerequisites On Linux, Solaris, and FreeBSD guests, to use DHCP, this script stops networking for the virtual machine. If you configured the power-on rather than resumed. If you disable the script for one of the virtual machine. This script has no effect...
User Guide
Page 17
...suspending. VMware, Inc. 17 Retrieve Status Information About the Virtual Machine You can display additional information about host time and CPU speed. n If you disabled the script for resuming, also disable the script for the stat Command," on the guest. 2 Change to display. Option Windows Linux and Solaris Action Change directories to disable the script. Change directories to /usr/local/sbin. 3 Enter the command to C:\Program Files\VMware\VMware Tools. Change directories to C:\Program Files\VMware\VMware Tools. utility-name script script-name disable Option utility...
...suspending. VMware, Inc. 17 Retrieve Status Information About the Virtual Machine You can display additional information about host time and CPU speed. n If you disabled the script for resuming, also disable the script for the stat Command," on the guest. 2 Change to display. Option Windows Linux and Solaris Action Change directories to disable the script. Change directories to /usr/local/sbin. 3 Enter the command to C:\Program Files\VMware\VMware Tools. Change directories to C:\Program Files\VMware\VMware Tools. utility-name script script-name disable Option utility...
User Guide
Page 18
... current session ID. 18 VMware, Inc. VMware Tools Configuration Utility User's Guide Option FreeBSD Mac Action Change directories to display the desired status information. Use vmware-tools-cli. Subcommands for virtual machines hosted on an ESX/ESXi server. utility-name stat subcommand Option utility-name (On Windows guests) utility-name (On Linux, Solaris, and FreeBSD guests) utility-name (On Mac guests) subcommand Action Use VMwareToolboxCmd.exe. Table 2. Use vmware-toolbox-cmd. Use hosttime or speed, or...
... current session ID. 18 VMware, Inc. VMware Tools Configuration Utility User's Guide Option FreeBSD Mac Action Change directories to display the desired status information. Use vmware-tools-cli. Subcommands for virtual machines hosted on an ESX/ESXi server. utility-name stat subcommand Option utility-name (On Windows guests) utility-name (On Linux, Solaris, and FreeBSD guests) utility-name (On Mac guests) subcommand Action Use VMwareToolboxCmd.exe. Table 2. Use vmware-toolbox-cmd. Use hosttime or speed, or...
User Guide
Page 19
... display valid names of devices. Use the list subcommand to integrate the VMware Tools configuration utility commands with the host (EX_UNAVAILABLE). VMware, Inc. 19 The file name does not exist. Always indicates that although shrinking is enabled, the shrink command cannot be carried out. 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. Permission errors. Table 3. The command-line...
... display valid names of devices. Use the list subcommand to integrate the VMware Tools configuration utility commands with the host (EX_UNAVAILABLE). VMware, Inc. 19 The file name does not exist. Always indicates that although shrinking is enabled, the shrink command cannot be carried out. 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. Permission errors. Table 3. The command-line...
User Guide
Page 21
... 5 R removable devices 10 resume-vm-default script 15 S script command 14 scripts, VMware Tools 14, 15 SCSI drivers, virtual 11 service, VMware Tools 10 session ID 17 shared folders, kernel module for 11 shrinking a virtual disk 12 sound adapters, connecting 10 stat command 17, 18 suspend-vm-default script 15 SVGA drivers, virtual 11 T technical support 5 time synchronization 8, 9 timesync command 8 U USB devices, connecting 10 V virtual disks, shrinking 12 VMCI drivers 11 vmhgfs kernel module 11 vmtoolsd 10 VMware Tools scripts custom 14 default 15 disabling 16 VMware Tools service 10 vmware...
... 5 R removable devices 10 resume-vm-default script 15 S script command 14 scripts, VMware Tools 14, 15 SCSI drivers, virtual 11 service, VMware Tools 10 session ID 17 shared folders, kernel module for 11 shrinking a virtual disk 12 sound adapters, connecting 10 stat command 17, 18 suspend-vm-default script 15 SVGA drivers, virtual 11 T technical support 5 time synchronization 8, 9 timesync command 8 U USB devices, connecting 10 V virtual disks, shrinking 12 VMCI drivers 11 vmhgfs kernel module 11 vmtoolsd 10 VMware Tools scripts custom 14 default 15 disabling 16 VMware Tools service 10 vmware...
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.