Uninstall AIP Console

Summary: Information about uninstalling the Console / Node services.

2.x

Front-end Console services

Deployed as Docker containers on Linux

When the front-end services are installed as Docker containers and you want to completely remove all trace of Console, perform the following actions. First move to the location where the docker-compose.yml file is stored, for example:

cd /CAST/CONSOLE

Now run the following docker commands with elevated permissions:

# Stop all containers and remove all containers, networks, volumes, and images created by the up command:
docker-compose down

# Remove all unused local volumes created by the up command, e.g. "restapi-domains" (for embedded Dashboards) and "db-data" (for the PostgreSQL instance):
docker volume prune

# Remove all unused containers, networks, images (both dangling and unreferenced), and optionally, volumes:
docker system prune -a

The commands listed above will remove all items configured in Docker, not just Console related items!

Deployed as Docker containers on Microsoft Windows

Stop all containers:

Delete the containers:

Clean up the images:

Remove the volumes "restapi-domains" (for embedded Dashboards) and "db-data" (for the PostgreSQL instance):

Deployed via Java installers (Microsoft Windows)

Dedicated uninstallers are available for all Console front-end packages which can be accessed via the Microsoft Windows Add or remove programs control panel:

Clicking Uninstall for all services will launch the Java uninstaller:

This uninstaller is configured to remove:

  • the contents of the following folders (or the equivalent custom location):
    • %PROGRAMFILES%\CAST\AIP-Gateway
    • %PROGRAMFILES%\CAST\AIP-SSO
    • %PROGRAMFILES%\CAST\AIP-Service-Registry
  • the %PROGRAMFILES%\CAST\AIP-* folders themselves if required (tick the Force the deletion of option)
  • any shortcuts on the desktop
  • any Start menu entries
  • the Windows services

This uninstaller will not remove the following items:

  • the folder and content of the following data folders (or the equivalent custom location):
    • %PROGRAMDATA%\CAST\AIP-Gateway
    • %PROGRAMDATA%\CAST\AIP-SSO
    • %PROGRAMDATA%\CAST\AIP-Service-Registry
  • the deployed cast-integrated-health-engineering-dashboard-<version>.zip file, used for access to CAST dashboards when using Java installers for Microsoft Windows
  • any CAST Storage Service/PostgreSQL items:
    • associated with the Applications you have created through Console
    • the Keycloak database
    • the aip_node and aip_config persistence schemas
  • any instances of AIP Core installed on the Nodes

Back end Node services

A dedicated uninstaller is available for the back-end Node package which can be accessed via the Microsoft Windows Add or remove programs control panel:

Clicking Uninstall will launch the Java uninstaller:

This uninstaller is configured to remove:

  • the contents of the %PROGRAMFILES%\CAST\AIP-Node installation folder (or the equivalent custom location)
  • the %PROGRAMFILES%\CAST\AIP-Node folder itself if required (tick the Force the deletion of option)
  • any shortcuts on the desktop
  • any Start menu entries
  • the Node Windows services

This uninstaller will not remove the following items:

  • the folder and content of the %PROGRAMDATA%\CAST\AIP-Node data folder (or the equivalent custom location)
  • any CAST Storage Service/PostgreSQL schemas associated with the Applications you have created through Console
  • any instances of AIP Core installed on the Node

1.x (≥ 1.20)

Microsoft Windows

A dedicated uninstaller is available for both the front-end Console and back-end Node packages which can be accessed via the Microsoft Windows Add or remove programs control panel:

Clicking Uninstall will launch the Java uninstaller:

This uninstaller is configured to remove:

  • the contents of the %PROGRAMFILES%\CAST\AipConsole installation folder (or the equivalent custom location)
  • the %PROGRAMFILES%\CAST\AipConsole folder itself if required (tick the Force the deletion of option)
  • any shortcuts on the desktop
  • any Start menu entries
  • the Console/Node Windows services

This uninstaller will not remove the following items:

  • the folder and content of the %PROGRAMDATA%\CAST\AipConsole data folder (or the equivalent custom location)
  • the deployed CAST-RESTAPI-integrated.war/zip file, used for access to CAST dashboards
  • any CAST Storage Service/PostgreSQL schemas associated with the Applications you have created through Console
  • any instances of AIP Core installed on the Nodes

Linux

A java uninstaller is made available in the following location:

$HOME\CAST\AipConsole\uninstaller\uninstaller.jar

Execute this file to start the uninstaller (you may need to explicitly change the permission on this file to allow it to be executed):

This uninstaller is configured to remove:

  • the contents of the $HOME\CAST\AipConsole installation folder (or the equivalent custom location)
  • the $HOME\CAST\AipConsole folder itself if required (tick the Force the deletion of option)

This uninstaller will not remove the following items:

  • the folder and content of the chosen data folder
  • the deployed CAST-RESTAPI-integrated.war/.zip file, used for access to CAST dashboards.
  • any CAST Storage Service/PostgreSQL schemas associated with the Applications you have created through Console

Older releases

  • Stop Console and Node(s) - close the cmd windows or stop the Windows services (if they exist)
  • Uninstall the Windows services (if they exist) by running the following batch files:
1.19.x
%PROGRAMFILES%\CAST\AipConsole\AipConsole\tools\aip-console-service-uninstall.bat
%PROGRAMFILES%\CAST\AipConsole\AipNode\tools\aip-node-service-uninstall.bat

≤ 1.18.x
<AIP_console_installation>\tools\aip-console-service-uninstall.bat
<AIP_node_installation>\tools\aip-node-service-uninstall.bat
  • Delete the following locations from disk:
    • <console_installation>
    • <node_installation>
  • Delete any shortcuts on the desktop and any Start menu entries

Note that this method will not remove:

  • the deployed CAST-RESTAPI-integrated.war/.zip file, used for access to CAST dashboards.
  • any CAST Storage Service/PostgreSQL schemas associated with the Applications you have created through Console.
  • any instances of AIP Core installed on the Node servers.

Troubleshooting

Microsoft Windows via JAR installers - cannot run the uninstaller

If you cannot run the uninstaller directly or the entry cannot be removed from the Add/remove programs feature, then proceed as follows:

  • Stop Console and Node(s) - close the cmd windows or stop the Windows services (if they exist)
  • Delete the files from their install locations on disk, typically they will be located in %PROGRAMFILES% and %PROGRAMDATA%
  • Now edit the Windows Registry to remove the items from the Add/Remove programs feature:
    • Press the Windows Logo key + R to open a Run dialog. Type regedit into the Run dialog and press Enter to launch the Registry Editor
    • In the left pane of the Registry Editor, navigate to the following directory: HKEY_LOCAL_MACHINE SOFTWARE Microsoft Windows CurrentVersion > Uninstall.
    • In the left pane of the Registry Editor, locate the sub-key pertaining to the item you need to uninstall from your computer.
    • Once you have located the sub-key belonging to the item you want to uninstall (it might not have the exact same name as the target application), right-click on it and click on Delete in the resulting context menu.
    • Click Yes in the resulting popup to confirm the action.
    • Once the sub-key belonging to the target application has been successfully deleted, close the Registry Editor and restart your computer.

Click to enlarge