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. EN-000275-01 To check for more recent editions of each product listed and supports all subsequent versions until the document is replaced by a new edition.
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. EN-000275-01 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
... companies. VMware products are covered by U.S. Palo Alto, CA 94304 www.vmware.com 2 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. 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...
... companies. VMware products are covered by U.S. Palo Alto, CA 94304 www.vmware.com 2 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. 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...
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
... is a suite of VMware Tools by writing their own scripts. For definitions of this book and other books, go to http://www.vmware.com/support/pubs. Go to configure VMware Tools. To access the current version of terms as on-the-job reference tools. Document Feedback VMware welcomes your products, go to you . About This Book The VMware Tools Configuration Utility User's Guide provides an introduction to using the VMware® Tools command-line utility...
... is a suite of VMware Tools by writing their own scripts. For definitions of this book and other books, go to http://www.vmware.com/support/pubs. Go to configure VMware Tools. To access the current version of terms as on-the-job reference tools. Document Feedback VMware welcomes your products, go to you . About This Book The VMware Tools Configuration Utility User's Guide provides an introduction to using the VMware® Tools command-line utility...
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
... host. VMware, Inc. 7 This program is called VMwareToolboxCmd.exe in Windows guests, vmware-tools-cli in Mac guests, and vmware-toolbox-cmd in the virtual disk and reduces the amount of space the virtual disk occupies on page 10 You can connect and disconnect removable devices such as the time of a virtual machine. Using the VMware Tools Configuration Utility The VMware Tools configuration utility is a command-line interface you can use in the VMware Tools control panel. The VMware Tools configuration utility provides a command-line...
... host. VMware, Inc. 7 This program is called VMwareToolboxCmd.exe in Windows guests, vmware-tools-cli in Mac guests, and vmware-toolbox-cmd in the virtual disk and reduces the amount of space the virtual disk occupies on page 10 You can connect and disconnect removable devices such as the time of a virtual machine. Using the VMware Tools Configuration Utility The VMware Tools configuration utility is a command-line interface you can use in the VMware Tools control panel. The VMware Tools configuration utility provides a command-line...
User Guide
Page 8
... script the commands used in time. When the operating system starts or reboots, and when you must edit the configuration file (.vmx file) of that , VMware Tools checks once every minute to a snapshot, and after shrinking a disk. For other periodic time synchronization mechanisms. For example, some guests might have NTP or Win32Time clock synchronization turned on VMware Tools periodic time synchronization, time synchronization occurs when the VMware Tools daemon is started (such as Network Time...
... script the commands used in time. When the operating system starts or reboots, and when you must edit the configuration file (.vmx file) of that , VMware Tools checks once every minute to a snapshot, and after shrinking a disk. For other periodic time synchronization mechanisms. For example, some guests might have NTP or Win32Time clock synchronization turned on VMware Tools periodic time synchronization, time synchronization occurs when the VMware Tools daemon is started (such as Network Time...
User Guide
Page 9
... not turn on the host, you want to keep a fictitious time in a virtual machine, so that on periodic time synchronization. Use vmware-toolbox-cmd. 4 Enter the command to enable or disable periodic time synchronization. Disable Time Synchronization Completely If you must set the properties to FALSE. Option Windows Linux, Solaris, and FreeBSD Action Use VMwareToolboxCmd.exe. Disabling periodic time synchronization does not disable all VMware Tools time synchronization. Using the VMware Tools Configuration Utility 3 Enter the command to...
... not turn on the host, you want to keep a fictitious time in a virtual machine, so that on periodic time synchronization. Use vmware-toolbox-cmd. 4 Enter the command to enable or disable periodic time synchronization. Disable Time Synchronization Completely If you must set the properties to FALSE. Option Windows Linux, Solaris, and FreeBSD Action Use VMwareToolboxCmd.exe. Disabling periodic time synchronization does not disable all VMware Tools time synchronization. Using the VMware Tools Configuration Utility 3 Enter the command to...
User Guide
Page 10
... between the host and guest or between host and guest. n In Windows guests, allows the pointer to ESX/ESXi and VMware Server. The service passes information between two guests. The scripts run when the power state of the processes that sends a heartbeat to the VMware product to script the commands used by certain backup applications. n Synchronizes the time in the management interface. VMware Tools Configuration Utility User's Guide VMware Tools Service The VMware Tools service starts when the...
... between the host and guest or between host and guest. n In Windows guests, allows the pointer to ESX/ESXi and VMware Server. The service passes information between two guests. The scripts run when the power state of the processes that sends a heartbeat to the VMware product to script the commands used by certain backup applications. n Synchronizes the time in the management interface. VMware Tools Configuration Utility User's Guide VMware Tools Service The VMware Tools service starts when the...
User Guide
Page 11
... as folder sharing available, and improve sound, graphics, and networking performance. If you do a custom VMware Tools installation or reinstallation, you install VMware Tools also depends on the guest operating system and the VMware product. For more information about the VMware Tools drivers used the list subcommand. VMware, Inc. 11 Using the VMware Tools Configuration Utility Procedure 1 Open a command prompt or terminal on page 11. Use vmware-tools-cli. 4 (Optional) Enter the command to the VMware Tools installation directory. utility-name device device-name...
... as folder sharing available, and improve sound, graphics, and networking performance. If you do a custom VMware Tools installation or reinstallation, you install VMware Tools also depends on the guest operating system and the VMware product. For more information about the VMware Tools drivers used the list subcommand. VMware, Inc. 11 Using the VMware Tools Configuration Utility Procedure 1 Open a command prompt or terminal on page 11. Use vmware-tools-cli. 4 (Optional) Enter the command to the VMware Tools installation directory. utility-name device device-name...
User Guide
Page 12
... for sharing folders Memory control driver Modules and drivers that support making automatic backups VMCI and VMCI Sockets drivers On Windows guests whose operating system is used . The vmxnet and vmxnet3 networking drivers improve network performance. These modules enable backup applications to use VMware ESX/ESXi. The Virtual Machine Communication Interface driver allows fast and efficient communication between hosts and guests. VMware Tools Configuration Utility User's Guide SCSI driver Paravirtual SCSI driver VMXNet NIC drivers Mouse driver Audio driver Kernel module...
... for sharing folders Memory control driver Modules and drivers that support making automatic backups VMCI and VMCI Sockets drivers On Windows guests whose operating system is used . The vmxnet and vmxnet3 networking drivers improve network performance. These modules enable backup applications to use VMware ESX/ESXi. The Virtual Machine Communication Interface driver allows fast and efficient communication between hosts and guests. VMware Tools Configuration Utility User's Guide SCSI driver Paravirtual SCSI driver VMXNet NIC drivers Mouse driver Audio driver Kernel module...
User Guide
Page 13
...: n The virtual machine is exported. If you shrink the virtual disk as a user with Administrator privileges to the VMware Tools installation directory. Option Windows Linux and Solaris FreeBSD Action Change directories to list available mount points. Change directories to /usr/local/sbin. 3 Enter the command to C:\Program Files\VMware\VMware Tools. utility-name disk mount-point For , use the guest-specific program name. n Verify that require root-level permissions. Change directories to shrink. VMware, Inc. 13 n The virtual machine is a linked clone...
...: n The virtual machine is exported. If you shrink the virtual disk as a user with Administrator privileges to the VMware Tools installation directory. Option Windows Linux and Solaris FreeBSD Action Change directories to list available mount points. Change directories to /usr/local/sbin. 3 Enter the command to C:\Program Files\VMware\VMware Tools. utility-name disk mount-point For , use the guest-specific program name. n Verify that require root-level permissions. Change directories to shrink. VMware, Inc. 13 n The virtual machine is a linked clone...
User Guide
Page 14
... the power state changes. Do not attempt to use custom scripts to automate guest operating system operations when you write a new script, create the script as System on Linux, Solaris, and FreeBSD and as a batch file. n On Linux, Solaris, and FreeBSD guests, to use by default the poweroff-vm-default script runs if the virtual machine is set to the VMware Tools installation directory. VMware Tools Configuration Utility User's Guide Use Custom VMware Tools Scripts You can use scripts to display graphical applications.
... the power state changes. Do not attempt to use custom scripts to automate guest operating system operations when you write a new script, create the script as System on Linux, Solaris, and FreeBSD and as a batch file. n On Linux, Solaris, and FreeBSD guests, to use by default the poweroff-vm-default script runs if the virtual machine is set to the VMware Tools installation directory. VMware Tools Configuration Utility User's Guide Use Custom VMware Tools Scripts You can use scripts to display graphical applications.
User Guide
Page 15
... Windows guests, the default script that the custom script you specified is now being used. Default VMware Tools Scripts One or more default scripts for the virtual machine. The default script that runs when you resume a virtual machine starts networking for each power state are located in the /etc/vmware-tools directory. Using the VMware Tools Configuration Utility 5 Enter the command to use the custom script you created. Use vmware-toolbox-cmd. On Linux, Solaris, and FreeBSD guests, the default scripts are located in the Program Files\VMware\VMware Tools folder...
... Windows guests, the default script that the custom script you specified is now being used. Default VMware Tools Scripts One or more default scripts for the virtual machine. The default script that runs when you resume a virtual machine starts networking for each power state are located in the /etc/vmware-tools directory. Using the VMware Tools Configuration Utility 5 Enter the command to use the custom script you created. Use vmware-toolbox-cmd. On Linux, Solaris, and FreeBSD guests, the default scripts are located in the Program Files\VMware\VMware Tools folder...
User Guide
Page 16
... , this script starts networking for the virtual machine. If you disable the script for one of the virtual machine. VMware Tools Configuration Utility User's Guide Table 1. If you must disable the script for the virtual machine. If you configured the suspend operation to restart the guest, this script runs when the virtual machine is being reset. If you configured the reset operation to start the guest or configured the reset operation to test, edit, or disable the...
... , this script starts networking for the virtual machine. If you disable the script for one of the virtual machine. VMware Tools Configuration Utility User's Guide Table 1. If you must disable the script for the virtual machine. If you configured the suspend operation to restart the guest, this script runs when the virtual machine is being reset. If you configured the reset operation to start the guest or configured the reset operation to test, edit, or disable the...
User Guide
Page 17
... about host time and CPU speed. Prerequisites n Determine what the exit codes are, see "Exit Codes," on page 18. Change directories to display. Use power, resume, suspend, or shutdown. Procedure 1 Open a command prompt or terminal on ESX, ESXi servers, you plan to script the commands used in the guest. 2 Change to disable the script. For virtual machines hosted on the guest. 2 Change to C:\Program Files\VMware\VMware Tools. Option Windows Linux and Solaris Action Change directories to the VMware Tools installation directory...
... about host time and CPU speed. Prerequisites n Determine what the exit codes are, see "Exit Codes," on page 18. Change directories to display. Use power, resume, suspend, or shutdown. Procedure 1 Open a command prompt or terminal on ESX, ESXi servers, you plan to script the commands used in the guest. 2 Change to disable the script. For virtual machines hosted on the guest. 2 Change to C:\Program Files\VMware\VMware Tools. Option Windows Linux and Solaris Action Change directories to the VMware Tools installation directory...
User Guide
Page 18
... for virtual machines hosted on an ESX/ESXi server. balloon (ESX/ESXi only) Displays the amount of the subcommands available for virtual machines hosted on the host. Use hosttime or speed, or, if applicable, one of memory that is currently reclaimed from the virtual machine through ballooning, in megabytes. VMware Tools Configuration Utility User's Guide Option FreeBSD Mac Action Change directories to the virtual machine's swap file, in megabytes. Use vmware-toolbox-cmd. Table...
... for virtual machines hosted on an ESX/ESXi server. balloon (ESX/ESXi only) Displays the amount of the subcommands available for virtual machines hosted on the host. Use hosttime or speed, or, if applicable, one of memory that is currently reclaimed from the virtual machine through ballooning, in megabytes. VMware Tools Configuration Utility User's Guide Option FreeBSD Mac Action Change directories to the virtual machine's swap file, in megabytes. Use vmware-toolbox-cmd. Table...
User Guide
Page 19
.... Table 3. Always indicates that although shrinking is enabled, the shrink command cannot be carried out. For the stat command, 69 means the program could not communicate with a scripting tool. Use the list subcommand to integrate the VMware Tools configuration utility commands with the host (EX_UNAVAILABLE). 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. The file...
.... Table 3. Always indicates that although shrinking is enabled, the shrink command cannot be carried out. For the stat command, 69 means the program could not communicate with a scripting tool. Use the list subcommand to integrate the VMware Tools configuration utility commands with the host (EX_UNAVAILABLE). 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. The file...
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, Solaris...
... 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, Solaris...
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.