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
... U.S. 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. Palo Alto, CA 94304 www.vmware.com 2 VMware, Inc. VMware Tools Configuration Utility User's Guide You can find the most up-to : docfeedback@vmware.com Copyright © 2009, 2010 VMware, Inc. This product is a registered trademark or trademark of...
... U.S. 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. Palo Alto, CA 94304 www.vmware.com 2 VMware, Inc. VMware Tools Configuration Utility User's Guide You can find the most up-to : docfeedback@vmware.com Copyright © 2009, 2010 VMware, Inc. This product is a registered trademark or trademark of...
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
.../support/pubs. About This Book The VMware Tools Configuration Utility User's Guide provides an introduction to using the VMware® Tools command-line utility to http://www.vmware.com/support/phone_support.html. Document Feedback VMware welcomes your products, go to you have comments, send your business needs, go to http://www.vmware.com/support. Online and Telephone Support Support Offerings VMware Professional Services To use telephone support for improving our documentation. Go to configure VMware Tools. Courses are used...
.../support/pubs. About This Book The VMware Tools Configuration Utility User's Guide provides an introduction to using the VMware® Tools command-line utility to http://www.vmware.com/support/phone_support.html. Document Feedback VMware welcomes your products, go to you have comments, send your business needs, go to http://www.vmware.com/support. Online and Telephone Support Support Offerings VMware Professional Services To use telephone support for improving our documentation. Go to configure VMware Tools. Courses are used...
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 can use scripts to automate guest operating system operations when you turn on periodic time synchronization, VMware Tools sets the time of space the virtual disk occupies on page 14 You can display additional information about host time and CPU speed. Use its help command to be the same as floppy drives, DVD/CD-ROM drives, ISO images, USB devices, sound adapters, and network adapters. The VMware Tools configuration utility provides a command-line interface for...
... You can use scripts to automate guest operating system operations when you turn on periodic time synchronization, VMware Tools sets the time of space the virtual disk occupies on page 14 You can display additional information about host time and CPU speed. Use its help command to be the same as floppy drives, DVD/CD-ROM drives, ISO images, USB devices, sound adapters, and network adapters. The VMware Tools configuration utility provides a command-line interface for...
User Guide
Page 8
... do not disable VMware Tools time synchronization completely. Prerequisites Disable other events, synchronization is typically more slowly until the clocks are using native time synchronization software, turn off VMware Tools periodic time synchronization, but do not become out of that , VMware Tools checks once every minute to be either forward or backward in time. Procedure 1 Open a command prompt or terminal in the guest. 2 Change to /usr/sbin. VMware Tools Configuration Utility User's Guide Configure Time Synchronization...
... do not disable VMware Tools time synchronization completely. Prerequisites Disable other events, synchronization is typically more slowly until the clocks are using native time synchronization software, turn off VMware Tools periodic time synchronization, but do not become out of that , VMware Tools checks once every minute to be either forward or backward in time. Procedure 1 Open a command prompt or terminal in the guest. 2 Change to /usr/sbin. VMware Tools Configuration Utility User's Guide Configure Time Synchronization...
User Guide
Page 9
...-specific program name. Disabling periodic time synchronization does not disable all VMware Tools time synchronization. Procedure 1 Open the configuration (.vmx) file of the virtual machine with a text editor. 2 Add lines for the time synchronization properties and set some properties in the guest is enabled. For information about the additional functionality this procedure, the VMware Tools service enables or disables periodic time synchronization, as you specified. To completely disable time synchronization, you must disable time synchronization completely. Disable Time...
...-specific program name. Disabling periodic time synchronization does not disable all VMware Tools time synchronization. Procedure 1 Open the configuration (.vmx) file of the virtual machine with a text editor. 2 Add lines for the time synchronization properties and set some properties in the guest is enabled. For information about the additional functionality this procedure, the VMware Tools service enables or disables periodic time synchronization, as you specified. To completely disable time synchronization, you must disable time synchronization completely. Disable Time...
User Guide
Page 10
... connecting devices: n Some devices cannot be available, depending on ESX/ESXi servers. This feature applies to the guest operating system. n The controls for virtual machines on whether your system administrator has enabled them. n In Windows guests, fits the screen resolution of the guest to move freely between host and guest. n In Linux, Solaris, and FreeBSD guests, executes commands in the management interface. VMware Tools Configuration Utility User's Guide VMware Tools Service...
... connecting devices: n Some devices cannot be available, depending on ESX/ESXi servers. This feature applies to the guest operating system. n The controls for virtual machines on whether your system administrator has enabled them. n In Windows guests, fits the screen resolution of the guest to move freely between host and guest. n In Linux, Solaris, and FreeBSD guests, executes commands in the management interface. VMware Tools Configuration Utility User's Guide VMware Tools Service...
User Guide
Page 11
... the VMware product. utility-name device status device-name For device-name, use the guest-specific program name. If you do a custom VMware Tools installation or reinstallation, you used the list subcommand. Option Windows Linux, Solaris, and FreeBSD Mac Action Use VMwareToolboxCmd.exe. Use vmware-toolbox-cmd. Change directories to the VMware Tools installation directory. Use enable or disable. When you specified. VMware Tools Device Drivers Device drivers smooth mouse operations, make VMware features such as you install VMware Tools, a virtual SVGA driver replaces...
... the VMware product. utility-name device status device-name For device-name, use the guest-specific program name. If you do a custom VMware Tools installation or reinstallation, you used the list subcommand. Option Windows Linux, Solaris, and FreeBSD Mac Action Use VMwareToolboxCmd.exe. Use vmware-toolbox-cmd. Change directories to the VMware Tools installation directory. Use enable or disable. When you specified. VMware Tools Device Drivers Device drivers smooth mouse operations, make VMware features such as you install VMware Tools, a virtual SVGA driver replaces...
User Guide
Page 12
... case, the LSI Logic SAS driver provided by the operating system is available and recommended if you configure device settings for the virtual machine. 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 operating system. These modules enable backup applications to make use the virtual machine with VMware Server, Workstation, or Fusion. Developers can write client-server applications to the VMCI...
... case, the LSI Logic SAS driver provided by the operating system is available and recommended if you configure device settings for the virtual machine. 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 operating system. These modules enable backup applications to make use the virtual machine with VMware Server, Workstation, or Fusion. Developers can write client-server applications to the VMCI...
User Guide
Page 13
... be logged in this process reduces the amount of the virtual disk that the host has free disk space equal to script the commands used the list subcommand. Procedure 1 Open a command prompt or terminal in nonpersistent mode. Use vmware-toolbox-cmd. 4 Enter the command to C:\Program Files\VMware\VMware Tools. IMPORTANT Shrinking disks is an independent disk in the guest. 2 Change to shrink virtual disks. Option Windows Linux and Solaris FreeBSD Action Change directories to shrink the disk at a specified mount point. Option Windows Linux...
... be logged in this process reduces the amount of the virtual disk that the host has free disk space equal to script the commands used the list subcommand. Procedure 1 Open a command prompt or terminal in nonpersistent mode. Use vmware-toolbox-cmd. 4 Enter the command to C:\Program Files\VMware\VMware Tools. IMPORTANT Shrinking disks is an independent disk in the guest. 2 Change to shrink virtual disks. Option Windows Linux and Solaris FreeBSD Action Change directories to shrink the disk at a specified mount point. Option Windows Linux...
User Guide
Page 14
... a new location. Option Windows Linux and Solaris FreeBSD Action Change directories to use custom scripts to shut down the guest rather than abruptly power off a virtual machine, by default the poweroff-vm-default script runs if the virtual machine is set to display graphical applications. Because vmtoolsd is installed, you want to /usr/local/sbin. 14 VMware, Inc. Procedure 1 Examine the contents of desktop sessions, which editor to C:\Program Files\VMware\VMware Tools. Change directories to create a custom script by making changes...
... a new location. Option Windows Linux and Solaris FreeBSD Action Change directories to use custom scripts to shut down the guest rather than abruptly power off a virtual machine, by default the poweroff-vm-default script runs if the virtual machine is set to display graphical applications. Because vmtoolsd is installed, you want to /usr/local/sbin. 14 VMware, Inc. Procedure 1 Examine the contents of desktop sessions, which editor to C:\Program Files\VMware\VMware Tools. Change directories to create a custom script by making changes...
User Guide
Page 15
... a virtual machine stops networking for each power state are included in the /etc/vmware-tools directory. The default script that runs when you specified is now being used. Default VMware Tools Scripts One or more default scripts for the virtual machine. Scripts cannot be run scripts on NetWare guests. On Linux, Solaris, and FreeBSD guests, the default scripts are located in part on page 10. What the default scripts do depends in the Program Files\VMware\VMware Tools folder. VMware...
... a virtual machine stops networking for each power state are included in the /etc/vmware-tools directory. The default script that runs when you specified is now being used. Default VMware Tools Scripts One or more default scripts for the virtual machine. Scripts cannot be run scripts on NetWare guests. On Linux, Solaris, and FreeBSD guests, the default scripts are located in part on page 10. What the default scripts do depends in the Program Files\VMware\VMware Tools folder. VMware...
User Guide
Page 16
... operation to use DHCP, this script stops networking for the other action as root. 16 VMware, Inc. On Linux, Solaris, and FreeBSD guests, this script releases the IP address of the virtual machine. IMPORTANT This utility cannot run scripts in as well. If you configured the power-on networking for the virtual machine. VMware Tools Configuration Utility User's Guide Table 1. On Windows guests, if the virtual machine is being reset. Default VMware Tools Scripts Script Name poweroff...
... operation to use DHCP, this script stops networking for the other action as root. 16 VMware, Inc. On Linux, Solaris, and FreeBSD guests, this script releases the IP address of the virtual machine. IMPORTANT This utility cannot run scripts in as well. If you configured the power-on networking for the virtual machine. VMware Tools Configuration Utility User's Guide Table 1. On Windows guests, if the virtual machine is being reset. Default VMware Tools Scripts Script Name poweroff...
User Guide
Page 17
... host time and CPU speed. Option Windows Linux and Solaris Action Change directories to C:\Program Files\VMware\VMware Tools. VMware, Inc. 17 Option Windows Linux and Solaris FreeBSD Action Change directories to C:\Program Files\VMware\VMware Tools. utility-name script script-name disable Option utility-name (On Windows guests) utility-name (On Linux, Solaris, and FreeBSD guests) script-name Action Use VMwareToolboxCmd.exe. What to do next If you disabled the script for resuming, also disable the script for suspending a virtual...
... host time and CPU speed. Option Windows Linux and Solaris Action Change directories to C:\Program Files\VMware\VMware Tools. VMware, Inc. 17 Option Windows Linux and Solaris FreeBSD Action Change directories to C:\Program Files\VMware\VMware Tools. utility-name script script-name disable Option utility-name (On Windows guests) utility-name (On Linux, Solaris, and FreeBSD guests) script-name Action Use VMwareToolboxCmd.exe. What to do next If you disabled the script for resuming, also disable the script for suspending a virtual...
User Guide
Page 18
... command to display the desired status information. memlimit (ESX/ESXi only) Displays memory limit information, in megabytes. Subcommands for the stat Command Subcommand Name Description hosttime speed Displays the date and time on an ESX/ESXi server. Use hosttime or speed, or, if applicable, one of memory swapped out to /usr/local/sbin. VMware Tools Configuration Utility User's Guide Option FreeBSD Mac Action Change directories to the virtual machine's swap file...
... command to display the desired status information. memlimit (ESX/ESXi only) Displays memory limit information, in megabytes. Subcommands for the stat Command Subcommand Name Description hosttime speed Displays the date and time on an ESX/ESXi server. Use hosttime or speed, or, if applicable, one of memory swapped out to /usr/local/sbin. VMware Tools Configuration Utility User's Guide Option FreeBSD Mac Action Change directories to the virtual machine's swap file...
User Guide
Page 19
... because the host is not valid. VMware, Inc. 19 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 command-line argument is not an ESX host (EX_TEMPFAIL). For the device command, 69 means the specified device does not exist. Use the list subcommand to integrate the VMware Tools configuration utility commands with the host (EX_UNAVAILABLE). Table 3. Always...
... because the host is not valid. VMware, Inc. 19 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 command-line argument is not an ESX host (EX_TEMPFAIL). For the device command, 69 means the specified device does not exist. Use the list subcommand to integrate the VMware Tools configuration utility commands with the host (EX_UNAVAILABLE). Table 3. Always...
User Guide
Page 21
... 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-toolbox-cmd utility for 11 BusLogic SCSI adapters 11 C CD-ROM drives, connecting 10 clock, synchronization between host and guest 8, 9 CPU statistics 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...
... 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-toolbox-cmd utility for 11 BusLogic SCSI adapters 11 C CD-ROM drives, connecting 10 clock, synchronization between host and guest 8, 9 CPU statistics 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...
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.