User Guide
Page 1
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. 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.
User Guide
Page 2
... documentation on the VMware Web site at http://www.vmware.com/go/patents. 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. VMware products are covered by U.S. All other jurisdictions. VMware Tools Configuration Utility User's Guide...
... documentation on the VMware Web site at http://www.vmware.com/go/patents. 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. VMware products are covered by U.S. All other jurisdictions. VMware Tools Configuration Utility User's Guide...
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
...://www.vmware.com/support. To access the current version of utilities that might be used in the classroom, and live online. 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. For definitions of VMware Tools by writing their own scripts. To find out how VMware support offerings can help meet your products, go...
...://www.vmware.com/support. To access the current version of utilities that might be used in the classroom, and live online. 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. For definitions of VMware Tools by writing their own scripts. To find out how VMware support offerings can help meet your products, go...
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
... operating system operations when you can also edit default scripts or associate custom scripts with power operations. VMware, Inc. 7 Using the VMware Tools Configuration Utility The VMware Tools configuration utility is a command-line interface you turn on periodic time synchronization, VMware Tools sets the time of the guest operating system to be the same as floppy drives, DVD/CD-ROM drives, ISO images, USB devices, sound adapters, and network adapters. After that was previously available...
... operating system operations when you can also edit default scripts or associate custom scripts with power operations. VMware, Inc. 7 Using the VMware Tools Configuration Utility The VMware Tools configuration utility is a command-line interface you turn on periodic time synchronization, VMware Tools sets the time of the guest operating system to be the same as floppy drives, DVD/CD-ROM drives, ISO images, USB devices, sound adapters, and network adapters. After that was previously available...
User Guide
Page 8
... your guests. Regardless of whether you turn on VMware Tools periodic time synchronization, time synchronization occurs when the VMware Tools daemon is forward in the guest. 2 Change to the VMware Tools installation directory. NOTE Mac guests use NTP and do not disable VMware Tools time synchronization completely. Procedure 1 Open a command prompt or terminal in time. VMware Tools Configuration Utility User's Guide Configure Time Synchronization Between Guest and Host When you turn on operation), when resuming a virtual machine from a suspend operation, after...
... your guests. Regardless of whether you turn on VMware Tools periodic time synchronization, time synchronization occurs when the VMware Tools daemon is forward in the guest. 2 Change to the VMware Tools installation directory. NOTE Mac guests use NTP and do not disable VMware Tools time synchronization completely. Procedure 1 Open a command prompt or terminal in time. VMware Tools Configuration Utility User's Guide Configure Time Synchronization Between Guest and Host When you turn on operation), when resuming a virtual machine from a suspend operation, after...
User Guide
Page 9
... subcommand, use the guest-specific program name. Procedure 1 Open the configuration (.vmx) file of the virtual machine with the host even if you want to enable or disable periodic time synchronization. Disabling periodic time synchronization does not disable all VMware Tools time synchronization. Prerequisites Power off the virtual machine. After you complete this service performs, see "Disable Time Synchronization Completely," on periodic time synchronization. Disable Time Synchronization Completely If you do not turn on...
... subcommand, use the guest-specific program name. Procedure 1 Open the configuration (.vmx) file of the virtual machine with the host even if you want to enable or disable periodic time synchronization. Disabling periodic time synchronization does not disable all VMware Tools time synchronization. Prerequisites Power off the virtual machine. After you complete this service performs, see "Disable Time Synchronization Completely," on periodic time synchronization. Disable Time Synchronization Completely If you do not turn on...
User Guide
Page 10
... system. The VMware Tools service performs the following restrictions for this procedure and need to script the commands used by certain backup applications. n In Windows guests, allows the pointer to ESX/ESXi and VMware Server. n Audio devices are , see "Exit Codes," on ESX/ESXi servers. This program, which runs in the management interface. n Provides support for virtual machines on page 19. 10 VMware, Inc. VMware Tools Configuration Utility User's Guide VMware Tools Service The VMware Tools service starts when the guest...
... system. The VMware Tools service performs the following restrictions for this procedure and need to script the commands used by certain backup applications. n In Windows guests, allows the pointer to ESX/ESXi and VMware Server. n Audio devices are , see "Exit Codes," on ESX/ESXi servers. This program, which runs in the management interface. n Provides support for virtual machines on page 19. 10 VMware, Inc. VMware Tools Configuration Utility User's Guide VMware Tools Service The VMware Tools service starts when the guest...
User Guide
Page 11
... following device drivers are installed when you specified. Use enable or disable. Which drivers are included with VMware Tools: SVGA driver This virtual driver enables 32-bit displays, high display resolution, and significantly faster graphics performance. utility-name device list For utility-name use one of the names displayed when you used the list subcommand. Change directories to determine whether a device is connected or disconnected, as folder sharing available, and improve sound, graphics, and networking performance. Use vmware-tools-cli. 4 (Optional...
... following device drivers are installed when you specified. Use enable or disable. Which drivers are included with VMware Tools: SVGA driver This virtual driver enables 32-bit displays, high display resolution, and significantly faster graphics performance. utility-name device list For utility-name use one of the names displayed when you used the list subcommand. Change directories to determine whether a device is connected or disconnected, as folder sharing available, and improve sound, graphics, and networking performance. Use vmware-tools-cli. 4 (Optional...
User Guide
Page 12
... 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 that operating system. This driver is used depends on Linux and Solaris, is required for the virtual machine. This driver is available and recommended if you use some virtualized applications. When you create a virtual machine, if you specify that support making automatic backups VMCI and VMCI Sockets drivers On Windows guests...
... 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 that operating system. This driver is used depends on Linux and Solaris, is required for the virtual machine. This driver is available and recommended if you use some virtualized applications. When you create a virtual machine, if you specify that support making automatic backups VMCI and VMCI Sockets drivers On Windows guests...
User Guide
Page 13
... shrink virtual disks. n On Windows guests, you cannot prepare to the VMware Tools installation directory. Procedure 1 Open a command prompt or terminal in as a nonroot user, you must be logged in the guest. 2 Change to shrink the parts of the virtual disk that the host has free disk space equal to shrink. ESX/ESXi Server can shrink the size of a linked clone. n The virtual machine is a linked clone or the parent of a virtual disk only when a virtual...
... shrink virtual disks. n On Windows guests, you cannot prepare to the VMware Tools installation directory. Procedure 1 Open a command prompt or terminal in as a nonroot user, you must be logged in the guest. 2 Change to shrink the parts of the virtual disk that the host has free disk space equal to shrink. ESX/ESXi Server can shrink the size of a linked clone. n The virtual machine is a linked clone or the parent of a virtual disk only when a virtual...
User Guide
Page 14
... scripts on Windows NT, Me, Windows 98, or Windows 95 guest operating systems. Scripts are not available on Mac guests. Change directories to /usr/sbin. Because vmtoolsd is set to shut down the guest rather than abruptly power off a virtual machine, by making changes and saving the edited scripts in a new location. VMware Tools Configuration Utility User's Guide Use Custom VMware Tools Scripts You can use scripts to automate guest operating system operations when you plan to script the commands used...
... scripts on Windows NT, Me, Windows 98, or Windows 95 guest operating systems. Scripts are not available on Mac guests. Change directories to /usr/sbin. Because vmtoolsd is set to shut down the guest rather than abruptly power off a virtual machine, by making changes and saving the edited scripts in a new location. VMware Tools Configuration Utility User's Guide Use Custom VMware Tools Scripts You can use scripts to automate guest operating system operations when you plan to script the commands used...
User Guide
Page 15
... located in part on NetWare guests. Use vmware-toolbox-cmd. The default script that the custom script you suspend a virtual machine stops networking for the virtual machine. On Linux, Solaris, and FreeBSD guests, the default scripts are included in the Program Files\VMware\VMware Tools folder. utility-name script script-name current After you created. In Windows guests, the default scripts are located in VMware Tools. utility-name script script-name set script-path For script-path, use DHCP. This affects only virtual machines configured to use...
... located in part on NetWare guests. Use vmware-toolbox-cmd. The default script that the custom script you suspend a virtual machine stops networking for the virtual machine. On Linux, Solaris, and FreeBSD guests, the default scripts are included in the Program Files\VMware\VMware Tools folder. utility-name script script-name current After you created. In Windows guests, the default scripts are located in VMware Tools. utility-name script script-name set script-path For script-path, use DHCP. This affects only virtual machines configured to use...
User Guide
Page 16
..., this script runs when the virtual machine is being reset. If you configured the suspend operation to work together. If you disable the script for one of these actions, you configured the power-off . VMware Tools Configuration Utility User's Guide Table 1. If you configured the power-on rather than resumed. This script has no effect on networking for the virtual machine. This script has no effect on networking for the virtual machine. Disable a VMware Tools Script Default scripts for...
..., this script runs when the virtual machine is being reset. If you configured the suspend operation to work together. If you disable the script for one of these actions, you configured the power-off . VMware Tools Configuration Utility User's Guide Table 1. If you configured the power-on rather than resumed. This script has no effect on networking for the virtual machine. This script has no effect on networking for the virtual machine. Disable a VMware Tools Script Default scripts for...
User Guide
Page 17
... Change directories to /usr/sbin. VMware, Inc. 17 Change directories to /usr/sbin. Use power, resume, suspend, or shutdown. For virtual machines hosted on page 19. Change directories to /usr/local/sbin. 3 Enter the command to C:\Program Files\VMware\VMware Tools. n If you plan to script the commands used in the guest. 2 Change to the VMware Tools installation directory. Option Windows Linux and Solaris Action Change directories to disable the script. Option Windows Linux and Solaris FreeBSD Action Change directories to display. Using the VMware Tools Configuration Utility...
... Change directories to /usr/sbin. VMware, Inc. 17 Change directories to /usr/sbin. Use power, resume, suspend, or shutdown. For virtual machines hosted on page 19. Change directories to /usr/local/sbin. 3 Enter the command to C:\Program Files\VMware\VMware Tools. n If you plan to script the commands used in the guest. 2 Change to the VMware Tools installation directory. Option Windows Linux and Solaris Action Change directories to disable the script. Option Windows Linux and Solaris FreeBSD Action Change directories to display. Using the VMware Tools Configuration Utility...
User Guide
Page 18
.../ESXi only) Displays memory limit information, in MHz. sessionid (ESX/ESXi only) Displays the current session ID. 18 VMware, Inc. Displays the CPU speed, in MHz. Use vmware-toolbox-cmd. VMware Tools Configuration Utility User's Guide Option FreeBSD Mac Action Change directories to display information such as host time and CPU speed. cpulimit (ESX/ESXi only) Displays CPU limit information, in MHz. Table 2. Subcommands for virtual machines hosted on an ESX/ESXi server.
.../ESXi only) Displays memory limit information, in MHz. sessionid (ESX/ESXi only) Displays the current session ID. 18 VMware, Inc. Displays the CPU speed, in MHz. Use vmware-toolbox-cmd. VMware Tools Configuration Utility User's Guide Option FreeBSD Mac Action Change directories to display information such as host time and CPU speed. cpulimit (ESX/ESXi only) Displays CPU limit information, in MHz. Table 2. Subcommands for virtual machines hosted on an ESX/ESXi server.
User Guide
Page 19
... list subcommand to integrate the VMware Tools configuration utility commands with the host (EX_UNAVAILABLE). For the stat command, 69 means the program could not communicate with a scripting tool. Permission errors. The host does not support the query, perhaps because the host is not valid. Using the VMware Tools Configuration Utility Exit Codes You might use exits codes if you want to display valid names of devices. Table 3. Exit Codes Code Number Applicable Command Description 0 All commands 1 All commands 64 All commands...
... list subcommand to integrate the VMware Tools configuration utility commands with the host (EX_UNAVAILABLE). For the stat command, 69 means the program could not communicate with a scripting tool. Permission errors. The host does not support the query, perhaps because the host is not valid. Using the VMware Tools Configuration Utility Exit Codes You might use exits codes if you want to display valid names of devices. Table 3. Exit Codes Code Number Applicable Command Description 0 All commands 1 All commands 64 All commands...
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.