Knowledge Base

The VMware Knowledge Base provides support solutions, error messages and troubleshooting guides
 
Search the VMware Knowledge Base (KB)   View by Article ID
 

Running custom quiescing scripts inside Windows virtual machine with ESX 3.5 Update 2 and later (1006671)

Details

This article provides answers to frequently asked questions on running custom quiescing scripts (pre-freeze and post-thaw) inside a Windows virtual machine with ESX 3.5 Update 2 and later.
 
In ESX/ESXi 3.5 Update 2 and later, the location of custom quiescing scripts has changed as a part of Volume Shadow Copy Service (VSS) support. 
 
Custom quiescing scripts are often used by third-party backup modules that integrate with VMware APIs for Data Protection (VADP) and VMware Consolidated Backup (VCB).

Note: VMware Tools must be installed in the guest OS for this feature to work correctly.

Solution

What is the default directory location for custom scripts during quiescing of the Windows virtual machine?

The following table provides the default directory location where the scripts should be located inside the virtual machine depending on the version of ESX (will also apply to the ESXi version too).

Version of ESX Custom quiescing script directory
ESX/ESXi 3.5 Update 1 or earlier
C:\Windows\<pre-freeze-script.bat>
C:\Windows\<post-thaw-script.bat>
ESX/ESXi 3.5 Update 2 or later
C:\Program Files\VMware\VMware Tools\backupScripts.d\
ESX/ESXi 4.x C:\Windows\backupScripts.d\
ESXi 5.0
C:\Windows\
C:\Program Files\VMware\VMware Tools\backupScripts.d\  
ESXi 5.1 and ESXi 5.5
C:\Windows\<pre-freeze-script.bat>
C:\Windows\<post-thaw-script.bat>

Notes:
  • The drive letter and name of the system directory may vary depending on the version of Windows and how Windows was installed. For example, Windows 2000 is installed by default in the winnt folder. To resolve this issue, create a folder named C:\WINDOWS and move pre-freeze-script.bat and post-thaw-script.bat files to this folder from c:\winnt.
  • Windows XP SP2 virtual machines running on ESX 3.5 Update 2 and later still use the old C:\Windows\<pre-freeze-script.bat> <post-thaw-script.bat> location for the pre-freeze and post-thaw quiescing scripts.

Does VMware Tools automatically create C:\Program Files\VMware\VMware Tools\backupScripts.d directory in the virtual machine?

The backupScripts.d directory is not created by default when VMware Tools is installed. Users need to manually create the backupScripts.d directory.

In what order do the scripts inside C:\Program Files\VMware\VMware Tools\backupScripts.d\ run?

On a Windows virtual machine with VMware Tools (ESX 3.5 Update 2 and later and ESX 4.x):

Pre-freeze
All the scripts at C:\Program Files\VMware\VMware Tools\backupScripts.d are invoked in alphabetical order with freeze as the first argument.

Post-thaw
All the scripts at C:\Program Files\VMware\VMware Tools\backupScripts.d are invoked in descending alphabetical order with thaw or freezeFail as the first argument.

How do I invoke my old quiescing scripts (in C:\Windows\) with ESX 3.5 Update 2 and later?

You can create a wrapper script under C:\Program Files\VMware\VMware Tools\backupScripts.d\
 
To create a sample wrapper script,  you can create a text file and name it vcb.bat.
echo off
if "%1" == "freeze" goto doFreeze
goto doThaw
:doFreeze
call c:\windows\pre-freeze-script.bat
goto EOF
:doThaw
call c:\windows\post-thaw-script.bat
:EOF
 
For more information about the workflow of the custom quiescing scripts, see the Virtual Machine Backup Guide for the appropriate VMware product version.
 
Caution: This folder should only contain executable scripts. Storing any other type of file within this folder may cause VMware Tools to become unstable.


Update History

01/12/2012 - Updated the Products section 01/22/2013 - Updated the table with the full path to relevant directories that VMware Tools will check for scripts

Request a Product Feature

To request a new product feature or to provide feedback on a VMware product, please visit the Request a Product Feature page.

Feedback

  • 31 Ratings

Did this article help you?
This article resolved my issue.
This article did not resolve my issue.
This article helped but additional information was required to resolve my issue.
What can we do to improve this information? (4000 or fewer characters)
  • 31 Ratings
Actions
KB: