Citrix VDA Cleanup Utility Tool

book

Article ID: CTX209255

calendar_today

Updated On:

Description

Please note:

  • You can download Citrix VDA Cleanup Utility Tool 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.13.0.45
 

Citrix Virtual Apps and Desktops, formerly XenApp and XenDesktop, fit the enterprise's need to bring both VDI and apps into a user-centric experience.

Created Date: Apr 4, 2016

Updated Date: May 22, 2026

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

What's New in v1.13.0.45 

  • Added support for cleaning up the following versions of VDAs:
    • The initial release of the 2607 LTSR 

Changes from Previous Versions 

  • Updated the utility to skip uninstalling uberAgent not managed by CVAD 
  • Added support for cleaning up the following versions of VDAs: 
    • The initial release and all CUs of the 2507 LTSR 
    • The initial release and all CUs of the 2402 LTSR 
  • 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
CU is short for Cumulative Update, LTSR is short for Long Term Service Release, and CR is short for Current Release.
    • 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

Context and Support Evolution  

Historically, older versions of the VDA encountered limitations regarding in-place upgrades and left residual components behind during uninstallation. As a result, many customers incorporated the VCU into their standard automation workflows to ensure a clean environment for new installations. 

Citrix has endeavored to improve the reliability of VDA upgrades as we address root causes of these special-case failures. While Citrix continues to fully support the VDA Cleanup Utility, the recommendation remains that the VDA Installer should be used as the first option for in-place upgrades or uninstallation of the VDA. The VCU should only be used in the case of unrecoverable failure of upgrades and uninstallation. 

Recommended Usage Workflow  

To ensure product stability and a positive user experience, Citrix recommends the following priority of tools when managing VDA installations: 

  • Primary Recommendation: VDA Installer  

For all standard upgrades or uninstallations, the VDA Installer must always be the first choice. 

  • Last Resort: VDA Cleanup Utility (VCU)  

If a VDA upgrade or uninstallation fails, administrator should first check the error messages in the installation logs to find the root cause and then take appropriate action. Only as a last resort should the VCU be utilized. 

Note: Citrix recognizes that customers managing large-scale VDA deployments — sometimes dozens or hundreds of machines — often automate their upgrade sequences. If VCU has been incorporated into a standard automated workflow, Citrix encourages revisiting that workflow considering the improvements made to the VDA Installer. 

Operational Risks and System Impact  

The VCU utilizes a direct and aggressive method to clean up the software environment. This approach is effective in resolving deeply stuck or corrupted VDA installations or related files, but it carries inherent risks that users must be aware of: 

  • "Brute Force" Methodology: The tool forcibly removes VDA components, registry entries, files, and related artifacts in a comprehensive sweep. This method intentionally bypasses normal uninstaller logic in order to recover from states where standard procedures have failed. 
  • System Stability: In certain specialized or complex OS configurations, this level of aggressive cleanup may inadvertently affect the underlying Operating System. This can potentially lead to system instability or, in rare cases, OS failure. 
  • Pre-Cleanup Requirement: Citrix strongly recommends performing a full system backup or creating a snapshot of the Virtual Machine before executing the VCU. 

Release Cycle and Maintenance Policy  

Unlike the VDA itself, the VCU does not follow a regular or periodic release schedule (such as LTSR or CR cycles). To manage operational expectations, please note that a new version of the VCU is generally only released under the following conditions: 

  • Architectural Changes: When significant changes are made to the VDA Installer (e.g., the introduction of new modules or core service shifts). 
  • Critical Quality Issues: Upon the discovery of major quality defects or critical security vulnerabilities within the utility itself. 

Note: If you find that your workflow consistently requires the VCU to achieve successful upgrades, please contact Citrix Technical Support to investigate the root cause of the VDA upgrade failures, as the VCU should not be a requirement for standard operations. 

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: You can run the VDA cleanup utility by using different options:
 

The /silent option C:/>VDACleanupUtility.exe/silent You can run the VDA cleanup utility in silent mode by using the /silent option. In silent mode, the tool restarts the system automatically. Log on to the machine with the same administrator account. The tool 
automatically reruns.
The /NoReboot option C:/>VDACleanupUtility.exe
/NoReboot
You can suppress an automatic system restart by using the /NoReboot option. However, Citrix recommends that you restart the machine before attempting to re-install the VDA.
The /unattended option C:/>VDACleanupUtility.exe
/unattended
You can run the VDA cleanup utility in unattended mode by using the /unattended option. In unattended mode, the utility uninstalls the VDA without any prompt and suppresses the system restart. Depending on the exit code (1 or 0), you might or might not have to restart the system manually:
Exit code 1: Restart the system manually and execute the command again. Exit code 0: The VDA cleanup is complete.
The /skipwem
option
C:/>VDACleanupUtility.exe
/skipwem
With the /skipwem option, the VDA cleanup utility uninstalls the VDA without uninstalling the Citrix Workspace Environment
Management Agent.
 

 

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
 

How to Uninstall 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

Failure Type Description Possible Corrective Action
Uninstall If the VDA is not installed at the default location, the VDA cleanup utility might not work properly. This is a known issue with the current version of the tool and will be addressed in a future release.
Install Downgrading to an earlier version of the VDA can result in a reinstallation error. The cause is that the VDA cleanup utility does not remove the Microsoft Visual C++ runtime required by the VDA. Microsoft Visual C++ runtime can differ depending on the VDA version being installed. Manually uninstall the later versions of Microsoft Visual C++ runtime before reinstalling an earlier version of the VDA. See VDA prerequisites to determine the required version of Microsoft Visual C++ runtime.
Install Downgrading to an earlier version of the VDA can result in a reinstallation error.  The cause is that the VDA cleanup utility does not remove the Microsoft .Net Framework required by the VDA. Microsoft .Net Framework can differ depending on the VDA version being installed. Manually uninstall the later version of Microsoft .Net Framework before reinstalling an earlier version of the VDA. See VDA prerequisites to determine the required version of Microsoft .Net Framework.
Registration The C:\ProgramData\Citrix\PvsAgent folder is not removed when manually removing the VDA using Program and Features or the VDA cleanup utility. As a result, the VDA might fail to register if moved to another Site (from Site 1 to Site 2). Follow the steps listed in the Citrix Product Documentation page.
Uninstall Attempts to log on as a different user to a Desktop VDA with AutoAdminLogon enabled, after the utility initiates a restart, can cause the VDA not to be removed properly. Allow the removal process to complete before attempting to log on as a different user.
Uninstall Allowing multiple session logons to a Server VDA with AutoAdminLogon enabled, after the utility initiates a restart, can cause the VDA not to be removed properly.  Allow the removal process to complete before allowing multiple session logon.
Uninstall

Not restarting the operating system when prompted by the tool might result in the VDA not being properly removed.  Additionally, future attempts to reinstall the same or a later version of the VDA without restarting, might result in an installation error.

When prompted to, restart the VDA as recommended by the utility.
Uninstall
 
When you install a Windows VDA on a machine where you have a Delivery Controller installed, running the VDA cleanup utility removes the following registry keys. As a result, Citrix Studio shows only the automatic site upgrade option instead of the regular console. After you click the upgrade button, the following error message appears:
You do not have the permissions required to complete this request
  • HKEY_LOCAL_MACHINE\SOFTWARE\Citrix\Citrix Desktop Delivery Controller
  • HKEY_LOCAL_MACHINE\SOFTWARE\Citrix\Configuration
  • HKEY_LOCAL_MACHINE\SOFTWARE\Citrix\DesktopServer
Back up the registry keys and restore them manually after uninstalling the VDA by using the VDA cleanup utility.
 

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

Environment

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.

Issue/Introduction

Citrix VDA Cleanup Utility Tool is a specialized utility for Windows that performs a deep, clean removal of older Citrix Virtual Delivery Agent (VDA) components, files, and registry settings

Additional Information

You can download Citrix VDA Cleanup Utility Tool by visiting the following link:  https://www.citrix.com/downloads/citrix-tools