User Guide
Page 1
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. 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
User Guide
Page 2
VMware Tools Configuration Utility User's Guide You can find the most up-to : docfeedback@vmware.com Copyright © 2009, 2010 VMware, Inc. and international copyright and intellectual property laws. 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. Palo Alto, CA 94304 www.vmware.com 2 VMware, Inc. in the United States and...
VMware Tools Configuration Utility User's Guide You can find the most up-to : docfeedback@vmware.com Copyright © 2009, 2010 VMware, Inc. and international copyright and intellectual property laws. 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. Palo Alto, CA 94304 www.vmware.com 2 VMware, Inc. in the United States and...
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
... 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. For onsite pilot programs and implementation best practices, VMware Consulting VMware, Inc. 5 Users typically include administrators and others who configures VMware Tools. Intended Audience This book is a suite of this book and other books, go to http://www.vmware.com/support/services. To access the current version of...
... 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. For onsite pilot programs and implementation best practices, VMware Consulting VMware, Inc. 5 Users typically include administrators and others who configures VMware Tools. Intended Audience This book is a suite of this book and other books, go to http://www.vmware.com/support/services. To access the current version of...
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
... space in the virtual disk and reduces the amount of a virtual machine. You can also edit default scripts or associate custom scripts with power operations. Using the VMware Tools Configuration Utility The VMware Tools configuration utility is a command-line interface you can use in the guest operating system to display complete usage information and syntax. Use its help command to modify VMware Tools settings, shrink virtual disks, and connect and disconnect virtual devices. n Use Custom VMware Tools Scripts on the guest and host still match. The VMware Tools configuration...
... space in the virtual disk and reduces the amount of a virtual machine. You can also edit default scripts or associate custom scripts with power operations. Using the VMware Tools Configuration Utility The VMware Tools configuration utility is a command-line interface you can use in the guest operating system to display complete usage information and syntax. Use its help command to modify VMware Tools settings, shrink virtual disks, and connect and disconnect virtual devices. n Use Custom VMware Tools Scripts on the guest and host still match. The VMware Tools configuration...
User Guide
Page 8
... VMware Tools periodic time synchronization, but do not become out of periodic time synchronization in the guest. 2 Change to the VMware Tools installation directory. For other periodic time synchronization mechanisms. For example, some guests might have NTP or Win32Time clock synchronization turned on by default. NOTE Mac guests use NTP and do not disable VMware Tools time synchronization completely. VMware Tools Configuration Utility User's Guide Configure Time Synchronization Between Guest and Host When you turn on periodic time synchronization, VMware Tools sets...
... VMware Tools periodic time synchronization, but do not become out of periodic time synchronization in the guest. 2 Change to the VMware Tools installation directory. For other periodic time synchronization mechanisms. For example, some guests might have NTP or Win32Time clock synchronization turned on by default. NOTE Mac guests use NTP and do not disable VMware Tools time synchronization completely. VMware Tools Configuration Utility User's Guide Configure Time Synchronization Between Guest and Host When you turn on periodic time synchronization, VMware Tools sets...
User Guide
Page 9
... virtual machine. 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. Option Windows Linux, Solaris, and FreeBSD Action Use VMwareToolboxCmd.exe. Use vmware-toolbox-cmd. 4 Enter the command to determine whether time synchronization is never synchronized with that its time never synchronizes with the host even if you do not turn...
... virtual machine. 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. Option Windows Linux, Solaris, and FreeBSD Action Use VMwareToolboxCmd.exe. Use vmware-toolbox-cmd. 4 Enter the command to determine whether time synchronization is never synchronized with that its time never synchronizes with the host even if you do not turn...
User Guide
Page 10
... the guest to the guest operating system. The service passes information between the guest and host. For example, only one virtual machine or the host can connect and disconnect removable devices such as floppy drives, DVD/CD-ROM drives, ISO images, USB devices, sound adapters, and network adapters. n Audio devices are , see "Exit Codes," on ESX/ESXi servers. VMware Tools Configuration Utility User's Guide VMware Tools Service The VMware Tools service starts when the guest operating system boots.
... the guest to the guest operating system. The service passes information between the guest and host. For example, only one virtual machine or the host can connect and disconnect removable devices such as floppy drives, DVD/CD-ROM drives, ISO images, USB devices, sound adapters, and network adapters. n Audio devices are , see "Exit Codes," on ESX/ESXi servers. VMware Tools Configuration Utility User's Guide VMware Tools Service The VMware Tools service starts when the guest operating system boots.
User Guide
Page 11
... you used the list subcommand. If you do a custom VMware Tools installation or reinstallation, you install VMware Tools, a virtual SVGA driver replaces the default VGA driver, which drivers to determine whether a device is connected or disconnected, as folder sharing available, and improve sound, graphics, and networking performance. Using the VMware Tools Configuration Utility Procedure 1 Open a command prompt or terminal on the guest operating system and the VMware product. utility-name device status device-name For device-name, use the guest-specific program name...
... you used the list subcommand. If you do a custom VMware Tools installation or reinstallation, you install VMware Tools, a virtual SVGA driver replaces the default VGA driver, which drivers to determine whether a device is connected or disconnected, as folder sharing available, and improve sound, graphics, and networking performance. Using the VMware Tools Configuration Utility Procedure 1 Open a command prompt or terminal on the guest operating system and the VMware product. utility-name device status device-name For device-name, use the guest-specific program name...
User Guide
Page 12
... space the virtual disk occupies on Linux and Solaris, is used . These modules enable backup applications to make use some virtualized applications. For example, Windows Server 2008 defaults to use the virtual machine with Workstation or Fusion and share folders between virtual machines. The host-guest file system module, called hgfs.sys on Windows guests and vmhgfs on the host. Shrinking a disk is installed. Which driver is required to LSI SAS, which guest operating systems support these drivers...
... space the virtual disk occupies on Linux and Solaris, is used . These modules enable backup applications to make use some virtualized applications. For example, Windows Server 2008 defaults to use the virtual machine with Workstation or Fusion and share folders between virtual machines. The host-guest file system module, called hgfs.sys on Windows guests and vmhgfs on the host. Shrinking a disk is installed. Which driver is required to LSI SAS, which guest operating systems support these drivers...
User Guide
Page 13
... change. Change directories to shrink the disk at a specified mount point. n Verify that require root-level permissions. Option Windows Linux, Solaris, and FreeBSD Action Use VMwareToolboxCmd.exe. utility-name disk mount-point For , use the guest-specific program name. ESX/ESXi Server can shrink the size of space the virtual disk occupies on page 19. n The virtual disk is a journaling file system, such as a user with Administrator privileges to list available mount points. Use vmware...
... change. Change directories to shrink the disk at a specified mount point. n Verify that require root-level permissions. Option Windows Linux, Solaris, and FreeBSD Action Use VMwareToolboxCmd.exe. utility-name disk mount-point For , use the guest-specific program name. ESX/ESXi Server can shrink the size of space the virtual disk occupies on page 19. n The virtual disk is a journaling file system, such as a user with Administrator privileges to list available mount points. Use vmware...
User Guide
Page 14
... state changes. n On Linux, Solaris, and FreeBSD guests, to edit a script, make sure xterm and vi are installed in as a batch file. VMware Tools Configuration Utility User's Guide Use Custom VMware Tools Scripts You can use custom scripts to display graphical applications. For example, when you plan to script the commands used in /etc/vmware-tools. 2 Write new scripts or modify default scripts and save them with power operations. Option Windows Linux and Solaris FreeBSD Action Change directories to /usr/sbin. Change directories to C:\Program Files\VMware\VMware Tools.
... state changes. n On Linux, Solaris, and FreeBSD guests, to edit a script, make sure xterm and vi are installed in as a batch file. VMware Tools Configuration Utility User's Guide Use Custom VMware Tools Scripts You can use custom scripts to display graphical applications. For example, when you plan to script the commands used in /etc/vmware-tools. 2 Write new scripts or modify default scripts and save them with power operations. Option Windows Linux and Solaris FreeBSD Action Change directories to /usr/sbin. Change directories to C:\Program Files\VMware\VMware Tools.
User Guide
Page 15
... VMware Tools Configuration Utility 5 Enter the command to use the custom script you created. utility-name script script-name enable Option utility-name (On Windows guests) utility-name (On Linux, Solaris, and FreeBSD guests) script-name Action Use VMwareToolboxCmd.exe. The default script that runs when you resume a virtual machine renews the IP address of the virtual machine. Default VMware Tools Scripts One or more default scripts for each power state are located in the /etc/vmware-tools directory. The default script...
... VMware Tools Configuration Utility 5 Enter the command to use the custom script you created. utility-name script script-name enable Option utility-name (On Windows guests) utility-name (On Linux, Solaris, and FreeBSD guests) script-name Action Use VMwareToolboxCmd.exe. The default script that runs when you resume a virtual machine renews the IP address of the virtual machine. Default VMware Tools Scripts One or more default scripts for each power state are located in the /etc/vmware-tools directory. The default script...
User Guide
Page 16
... script stops networking for suspending and resuming a virtual machine are written to suspend the guest, this script renews the IP address of the virtual machine. On Windows guests, if the virtual machine is being suspended. VMware Tools Configuration Utility User's Guide Table 1. If you configured the power-on networking for 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 reset operation to use...
... script stops networking for suspending and resuming a virtual machine are written to suspend the guest, this script renews the IP address of the virtual machine. On Windows guests, if the virtual machine is being suspended. VMware Tools Configuration Utility User's Guide Table 1. If you configured the power-on networking for 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 reset operation to use...
User Guide
Page 17
... "Exit Codes," on ESX, ESXi servers, you plan to script the commands used in the guest. 2 Change to /usr/sbin. Change directories to display. Option Windows Linux and Solaris Action Change directories to the VMware Tools installation directory. Procedure 1 Open a command prompt or terminal on page 18. Option Windows Linux and Solaris FreeBSD Action Change directories to disable the script for resuming, or if you disabled the script for the stat Command," on the guest. 2 Change to C:\Program Files\VMware\VMware Tools. What...
... "Exit Codes," on ESX, ESXi servers, you plan to script the commands used in the guest. 2 Change to /usr/sbin. Change directories to display. Option Windows Linux and Solaris Action Change directories to the VMware Tools installation directory. Procedure 1 Open a command prompt or terminal on page 18. Option Windows Linux and Solaris FreeBSD Action Change directories to disable the script for resuming, or if you disabled the script for the stat Command," on the guest. 2 Change to C:\Program Files\VMware\VMware Tools. What...
User Guide
Page 18
.../Application Support/VMware Tools'. 3 Enter the command to the virtual machine's swap file, in megabytes. sessionid (ESX/ESXi only) Displays the current session ID. 18 VMware, Inc. VMware Tools Configuration Utility User's Guide Option FreeBSD Mac Action Change directories to display information such as host time and CPU speed. 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...
.../Application Support/VMware Tools'. 3 Enter the command to the virtual machine's swap file, in megabytes. sessionid (ESX/ESXi only) Displays the current session ID. 18 VMware, Inc. VMware Tools Configuration Utility User's Guide Option FreeBSD Mac Action Change directories to display information such as host time and CPU speed. 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...
User Guide
Page 19
... a scripting tool. The command-line argument is not an ESX host (EX_TEMPFAIL). Use the list subcommand to integrate the VMware Tools configuration utility commands with the host (EX_UNAVAILABLE). Permission errors. Using the VMware Tools Configuration Utility Exit Codes You might use exits codes if you want to display valid names of devices. For the shrink command, 1 means that an error occurred. The file name does not exist. Exit Codes Code Number Applicable Command Description 0 All commands 1 All commands 64 All commands 66 script 69 device...
... a scripting tool. The command-line argument is not an ESX host (EX_TEMPFAIL). Use the list subcommand to integrate the VMware Tools configuration utility commands with the host (EX_UNAVAILABLE). Permission errors. Using the VMware Tools Configuration Utility Exit Codes You might use exits codes if you want to display valid names of devices. For the shrink command, 1 means that an error occurred. The file name does not exist. Exit Codes Code Number Applicable Command Description 0 All commands 1 All commands 64 All commands 66 script 69 device...
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.