How to – enable VMware Tools debug logging

VMware Tools only generate logfiles in case of an error or a crash.
If you want to increase verbosity, you will have to enable the debug logging by hand.
This how-to will provide you a step-by-step manual:

Step 1: locate the configuration file

Locate the VMware Tools configuration file “tools.conf”. The default location depends on the guest operating system:

Windows Server 2008, Server 2012, Windows 7, Windows Vista
-> C:\ProgramData\VMware\VMware Tools\tools.conf

Windows Server 2000, Server 2003, Windows XP
-> C:\Documents and Settings\All Users\Application Data\VMware\VMware Tools\tools.conf

Linux, FreeBSD and Solaris
-> /etc/vmware-tools/tools.conf

Mac OS X
-> /Library/Application Support/VMware Tools/tools.conf

Step 2: edit the tools.conf file to enable debug logging:

Use a text editor to add the lines below to the tools.conf file. If the file does not exist, create a new one:

If the VM is running on an ESXi 5.x host:

————————————–
[logging]

log = true
vmtoolsd.level = debug
vmtoolsd.handler = file
vmtoolsd.data = c:/tmp/vmtoolsd.log
————————————–

Take care when you edit the file:
– use forward slashes (/) for path delimiters on both Windows and Linux guests!
– use the parameters explained below (Debug logging parameters for ESXi 5.x hosts) to adjust the parameters as required!

Save the file and restart the VMware Tools service.

If the VM is running on an ESXi 3.5/4.x host:

————————————–
log = “TRUE”
log.file = “c:\tmp\vmtools.log”
————————————–

Take care when you edit the file:
– use back slashes (\) for path delimiters on Windows guests (see example above) and forward slashes (/) on Linux guests!

Save the file, a restart of the VMware Tools is not necessary.

Debug logging parameters for ESXi 5.x hosts:

vmtoolsd.level =
available log levels are: none, critical, error, warning, message, info and debug (most detailed level)

vmtoolsd.handler =
– use “file” to write the output into a file inside the guest
– use “vmx” to write the output into the vmware.log file on the ESXi host
– use “std” on a Linux guest to output to the standard console

vmtoolsd.data =
this parameter is required when using a handler of type “file” to define the log file path.

Step 3: disable debug logging:

…for ESXi 5.x hosts:

open the tools.conf file in a text editor and remove the following lines:

————————————–
log = true
vmtoolsd.data = c:/tmp/vmtoolsd.log
————————————–

Close the file and restart the VMware Tools service.

Take care:
if you only change “log = true” to “log = false” logging is NOT disabled!!!

…for ESXi 3.5 and 4.x hosts:

open the tools.conf file in a text editor and remove the following lines:

————————————–
log = “TRUE”
log.file = “c:\tmp\vmtools.log”
————————————–

Close the file, it is not necessary to restart the VMware Tools service.

Take care:
if you only change “log = true” to “log = false” logging is NOT disabled!!!

Leave a Comment

Your email address will not be published. Required fields are marked *