Note:

• Please note:
  You can download the required file from the Citrix downloads website by visiting the following link: https://www.citrix.com/downloads/citrix-tools
• All references to VDA in this article are to the Windows version of VDA.
• Citrix recommends that you use the built-in uninstaller to remove the VDA software. Starting with Version 2003, the VDA has a built-in uninstaller.

VDA Cleanup Utility v1.11.0.32

Created Date: Apr 4, 2016

Updated Date: Apr 15, 2024

Please provide feedback to https://forms.gle/TwWrKPT6J8u7GdKA6 to help us improve the tool.

What's New in v1.11.0.32

• Added support for cleaning up the following versions of VDAs:

  • The initial release of the 2402 LTSR

Changes from Previous Versions

• Added an option to uninstall VDAs without uninstalling the Citrix Workspace Environment Management Agent.

• Updated the log folder of the tool from %temp%\Citrix\VDACleanup to %programdata%\Citrix\VDACleanup to prevent log loss.

• The most recent 2,500 application and system event logs can be saved in this log folder.

• Improved logging by capturing more data in CleanupToolLog.txt.

• Added support for cleaning up the following versions of VDAs:
  • The initial release and all CUs of the 2203 LTSR
  • The initial release and all CUs of the 1912 LTSR
  • CR 2303
  • CR 2212

• Added latest version verification for the tool.
• Fixed an issue that causes the VDA cleanup utility to mistakenly delete the Citrix HDX RealTime Connector.
• Added assistance in uninstalling browser content redirection msi (BCR_x64.msi).
• Added support for removing residual VDA registry entries and files that block upgrades from Windows 7 to Windows 10.
• Added support for VDA cleanup on Windows 2016.
• Added support for custom log paths.
• Added support for uploading experience metrics through TLS 1.2/TLS 1.1.
• Added support for removing residual registry entries that block new VDA installation on certain platforms.
• Support for unattended mode
• Improved error handling.
• Improved logging.
• Addressed an issue that prevents the tool from working properly when there is a pending restart of the operating system.
• Introduced a command line parameter “/DISABLEEXPERIENCEMETRICS” that prevents the automatic upload of analytics collected during the removal process.
• Improved driver removal.
• Reduced uninstall times for VDA versions 7.7 through 7.11 running on Windows 2012 R2 or Windows 10 operating systems.
• Changed to not clear AppInit DLL registry values during VDA uninstall
• Converted uninstall log file from plain text .log to .xml file format
• Addressed a condition that can cause VDA registration to fail after a reinstall
• Prevented running multiple instances of the tool that results in keyboard and mouse malfunctions
• Improved the tool's ability to handle corrupted MSIs and registry entries.

Description

The VDA cleanup utility assists with the following scenarios:

• When errors occur during an upgrade from an earlier version of the VDA
• When unexpected behavior or performance is experienced after an upgrade from an earlier VDA
• If a VDA upgrade is not possible due to feature incompatibility and a clean uninstall is required
• The VDA cleanup utility removes components, files, and registry values of VDA 5.6 and later
   

Important Notes

For all users:

1. When removing a 7. x VDA, the tool can take up to 20 minutes to complete and seem unresponsive during this time.  To prevent the system from becoming unstable or unusable, do not terminate or relaunch the tool.  Instead, allow the tool to complete the removal process on its own and then restart the system when prompted to do so.
2. Windows 8.1 is currently not supported by this version of the tool.

Supported Operating Systems

Supported server OS versions

• Windows 11 
• Windows 10*
• Windows 2022
• Windows 2019
• Windows 2016
• Windows 2012 R2
• Windows 2008 R2 Sp1

Supported desktop OS versions (32- and 64-bit unless noted):

• Windows 11
• Windows 10*
• Windows 7

*For Windows 10 machines, the following servicing options and editions are supported:

• Current Branch for Business (CBB): Pro, Enterprise, Education
• Long Term Service Branch (LTSB): LTSB
• Current Branch (CB): Not supported

Prerequisites

To run the tool, you must have administrator privileges on the target machine.

Required Security Permissions

Read, write, and modify permissions are required for the following:

• Local machine registry (HKLM)
• Local user registry (HKCU)
• Default user profile on computer
• %ProgramFiles%\Citrix on 32-bit systems or %ProgramFiles(x86)%\Citrix on 64-bit systems

How to Use the VDA Cleanup Utility

The VDA cleanup utility is a standalone executable file and does not require installation.

Caution: Always back up the registry.  Although the VDA cleanup utility backs up VDA registry keys before deleting them, Citrix recommends that you back up the registry first. See Microsoft article How to back up and restore the registry in Windows for information on backing up the registry.

Steps:

• Run the VDA cleanup utility with administrator privileges.
• The tool might prompt for a system restart to complete driver removal.
• After system restart, log on to the machine with the same administrator account, The tool automatically reruns.

Note:

Log Files for the VDA Cleanup Utility
Log files for the VDA cleanup utility are created in the %VCUOutput%\Citrix\VdaCleanupfolder and can be used to track all uninstall actions and results.

Note: Starting from version 2.0, %VCUOutput% refers to %programdata%, but if the tool user doesn't have access to %programdata%, %VCUOutput% still refers to %Temp%.

Data Modified by the VDA Cleanup Utility

The utility terminates all running VDA processes (if any) after using the standard metainstaller uninstall process. See the Readme file included with the tool for a list of items that are removed during the cleanup process.

How to Undo the Changes Made by the VDA Cleanup Utility

The VDA cleanup utility creates a backup of Citrix registry keys related to the VDA in the %TEMP%\Citrix\VdaCleanup\RegBackup.reg file before running any cleanup and deletion process.

To undo the changes:

• Reinstall the VDA
• Import the RegBackup.reg file to restore settings and customizations in the registry

Uninstalling the VDA Cleanup Utility

Delete the downloaded executable from the current folder and delete the log files from the %TEMP%\Citrix\VdaCleanup folder.

Known Issues

Contact Information
Questions? Concerns? Send any feedback to https://forms.gle/TwWrKPT6J8u7GdKA6.

Disclaimer

These software applications are provided to you as is with no representations, warranties or conditions of any kind.  You may use and distribute it at your own risk. CITRIX DISCLAIMS ALL WARRANTIES WHATSOEVER, EXPRESS, IMPLIED, WRITTEN, ORAL OR STATUTORY, INCLUDING WITHOUT LIMITATION WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NONINFRINGEMENT. Without limiting the generality of the foregoing, you acknowledge and agree that (a) the software application may exhibit errors, design flaws or other problems, possibly resulting in loss of data or damage to property; (b) it may not be possible to make the software application fully functional; and (c) Citrix may, without notice or liability to you, cease to make available the current version and/or any future versions of the software application.  In no event should the code be used to support of ultra-hazardous activities, including but not limited to life support or blasting activities.  NEITHER CITRIX NOR ITS AFFILIATES OR AGENTS WILL BE LIABLE, UNDER BREACH OF CONTRACT OR ANY OTHER THEORY OF LIABILITY, FOR ANY DAMAGES WHATSOEVER ARISING FROM USE OF THE SOFTWARE APPLICATION, INCLUDING WITHOUT LIMITATION DIRECT, SPECIAL, INCIDENTAL, PUNITIVE, CONSEQUENTIAL OR OTHER DAMAGES, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.  You agree to indemnify and defend Citrix against any and all claims arising from your use, modification or distribution of the code.