- Citrix Workspace Removal
- Citrix Client Removal Tool
- Citrix Client Removal Tool Repair
- Citrix Removal Tool
- Citrix Management Tools
Citrix Virtual Apps and Desktops, formerly XenApp and XenDesktop, fits the enterprise need to bring both VDI and apps into a user-centric experience.
VDA Cleanup Utility v1.7.0.9
Created Date: Apr 4, 2016
Updated Date: Jul 8, 2020
Please provide feedback to https://podio.com/webforms/15459646/1036539 to help us improve the tool.
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:
- 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.
- Windows 8.1 is currently not supported by this version of the tool.
What's New in v1.7.0.9
- Added support for cleanup of VDA 1912.
- Added latest version verification for the tool.
- Fixed an issue that causes the VDA cleanup utility to mistakenly delete the Citrix HDX RealTime Connector.
Changes in Previous Versions
- 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 the 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.
Supported Operating Systems
Supported server OS versions
- Windows 2016
- Windows 2012 R2
- Windows 2008 R2 Sp1
Supported desktop OS versions (32- and 64-bit unless noted):
- 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
Back Up the Registry
See Microsoft article How to back up and restore the registry in Windows for instructions on backing up the registry.
How to Use the VDA Cleanup Utility
The VDA cleanup Utility is a standalone executable file and does not require installation.
Although the VDA cleanup Utility back up VDA registry keys before deleting them, Citrix recommends that you back up the registry before running this tool. See Microsoft article How to back up and restore the registry in Windows for information on backing up the registry.
Caution: Always back 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 in silent mode by using the /silent option.
C:/> VDACleanupUtility.exe /silent
In silent mode, the tool restarts the system automatically. Log on to the machine with the same administrator account. The tool automatically reruns.
- 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.
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.
Log files for the VDA cleanup Utility are created in the %TEMP%CitrixVdaCleanupfolder and can be used to track all uninstall actions and results.
How to run the VDA Cleanup Utility with SCCM Task Sequences
See How to Run VDA cleanup Utility with SCCM Task Sequence.
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
Citrix Workspace Removal
The VDA cleanup Utility creates a backup of Citrix registry keys related to the VDA in the %TEMP%CitrixVdaCleanupRegBackup.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
Citrix Client Removal Tool
Delete the downloaded executable from the current folder and delete the log files from the %TEMP%CitrixVdaCleanup folder.
| 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:ProgramDataCitrixPvsAgent 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. |
Citrix Client Removal Tool Repair
Contact Information
Questions? Concerns? Send any feedback to https://podio.com/webforms/15459646/1036539.
Citrix Removal Tool
Disclaimer
Citrix Management Tools
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.
