Welcome to the Alteryx Knowledge Base
Created/Edited -
In this article, we are going to review how to perform a silent uninstallation of Alteryx Server using the command-line.
Table of Contents
Introduction
A silent installation is a method of installation of software while suppressing any message or window, thus rendering the process silent. This enables users to script the process and ensure it runs using specified parameters without the need for someone to sit and wait it through.
This same process can be applied to the uninstallation as well.
We are going to cover the standard installation of Alteryx Server on a single-node. To apply this to a multi-node environment, simply replicate the steps on all machines.
Process
The uninstallation of Alteryx Server is composed of four steps, no matter if add-ons such as Predictive Tools or Intelligence Suite are installed.
- Optional: License deactivation
- Uninstallation of Alteryx Server
- Optional: Removal of local files
- Optional: Removal of registry keys
Remarks:
- The silent uninstallation method presented here requires the original installation file to trigger the process.
- The uninstallation of Alteryx Server will remove all add-ons such as Predictive Tools and Intelligence Suite.
Note: In this example, we are going to uninstall Alteryx Server version 2021.4.2.35356. In case you are trying to install a different version, please do update the version references to match your environment.
Deactivate license
The deactivation of the license can only be performed while Alteryx Server is installed which is why it must be the very first step of the process, should you want to deregister it from the current machine.
Should you decide not to perform this step at this stage, you can always use the [Alteryx License Portal] to manage your license keys and seats.
The deactivation of the license uses the Alteryx command-line licensing utility AlteryxActivateLicenseKeyCmd.exe.
It takes one or two parameters:
- delete: The action to perform.
- Optional: The license key to deactivate. If no specific value is provided, all licenses will be removed.
Open a command prompt as administrator, navigate to the Alteryx installation path bin directory, and run the following command.
AlteryxActivateLicenseKeyCmd.exe delete
Remark: You might see a message indicating that the process has failed. In this case, simply run the command below to validate that all licenses have indeed been revoked.
AlteryxActivateLicenseKeyCmd.exe list
Note: This step is not really silent as it does produce an output message.
Upon success the following message will appear in the command prompt:
License(s) successfully removed.
Upon failure, it will list the issues encountered:
There was an issue during deletion. 3be9-49f8-3906-35c2-fda7-2f89-8c9f-bbe9: The license key is invalid. 75a3-2743-8d11-0c6c-324e-b93a-97c0-eb6b: The license key is invalid.
Uninstall Alteryx Server
The uninstallation of Alteryx Server is quite straightforward. The aim is to call the installation executable file with two parameters:
- /s: Specifies that it should run in silent mode.
- REMOVE=TRUE: Specifies that Alteryx Server should be uninstalled.
Remark: The uninstallation can only be done with the original installation files. Do not attempt to replicate with a patch installer.
Open a command prompt as administrator, navigate to the directory containing your source files, and run the command below (change the filename with the corresponding product version if required).
AlteryxServerInstallx64_2021.4.2.35356.exe /s REMOVE=TRUE
The uninstallation will take a couple of minutes depending on your environment. Wait for the process to complete.
Note: The uninstallation process will start in the background. It is visible from the task manager or the resource manager.
Remove local files
By default, some local files will remain on the machine such as the underlying MongoDB database files and the system settings.
Open a command prompt as administrator, and run the commands below to remove all remaining Alteryx files.
rmdir /s /q "%PROGRAMFILES%\Alteryx" rmdir /s /q "%PROGRAMDATA%\Alteryx" rmdir /s /q "%PROGRAMDATA%\SRC" rmdir /s /q "%LOCALAPPDATA%\Alteryx" rmdir /s /q "%APPDATA%\SRC" rmdir /s /q "%APPDATA%\Alteryx"
Remarks:
- If you have installed Alteryx in a custom directory, replace %PROGRAMFILES% with the appropriate path.
- If you have configured settings to write to custom directories, e.g., for temporary files or logs, do not forget to include them should you want to clear them also.
Remove registry keys
Upon installation, Alteryx registers some keys in Windows registry. Those are not automatically removed and will remain after an uninstallation.
reg delete HKEY_CURRENT_USER\Software\SRC /f
For a complete list of all registry keys to remove, please refer to the article Complete Uninstall of Alteryx Designer.
Conclusion
In this article, we went through all the steps required to uninstall Alteryx Server silently. To make this process more robust, I encourage you to wrap this in a script that will monitor the different processes and log each individual step so that it can be audited.
For an example of such an automation script, check out the open-source alteryx-deploy PowerShell utility.
- Alteryx Command-Line Options
- Alteryx PowerShell Module (PSAYX): A PowerShell module with wrapper functions to perform all steps of the silent installation of Alteryx and much more from PowerShell.
- alteryx-deploy: A PowerShell utility for the automation of the deployment and maintenance of Alteryx.