Summary: This page describes the CLI (Command Line Interface) option that is available to fully delete an Application from Console.
This documentation is valid only for Console 1.x.
What does the CLI option do?
This CLI option will fully delete an Application from Console (this option is also available in the Console GUI). It is generally only necessary to use the CLI option if you have attempted to delete an Application in the GUI and this has failed. The CLI option will then attempt to fully remove all trace of the Application from Console for example:
- delete the Application specific Delivery folder
- delete the application schemas
- delete any Console embedded database entries
How does it work?
The CLI option is run via a predefined batch file using specific options. The batch must be run on the Node which is used to manage the Application you want to delete. You can find the batch file in the following location - i.e. on the Node:
<console_installation>\AipNode\admin\deleteApplication.bat
Run this batch script from a CMD window using the following arguments - see Available CLI arguments:
deleteApplication.bat -apiHost "<http://localhost:8082>" -appName "<applicationName>" -token "<Node token>" -keepData
Available CLI arguments
| Arguments | Default value | Required? | Description |
|---|---|---|---|
| -appName | - |  | Specifies the Application to be deleted. This is case-sensitive and must match the name of the Application as defined in the CAST Management Studio. |
| -apiHost |  | Specifies the server/port URL for the Node. If omitted, the default value is used. | |
| -token | - | | Specifies the access token for the Node. This can be found in the <console_installation>\AipNode\data\aip-node-app.properties file on the line spring.liquibase.parameters.baseToken |
| -keepData | NO | | Specifies whether you want to keep the data associated with the Application (Delivery folder, schemas, Console database entries). If omitted, the default value is used (data is deleted). If you intend to re-import the Application, use this option. |
Example
Remove the Application "MEUDON" from the Node "my_node", deleting all data:
<console_installation>\AipNode\admin\deleteApplication.bat -apiHost "my_node:8082" -appName "MEUDON" -token "XDD1rgGfKcXDD2gk6Vjd"
Remove the Application "MEUDON" from the AIP Node "my_aip_node", retaining all data:
<console_installation>\AipNode\admin\deleteApplication.bat -apiHost "my_node:8082" -appName "MEUDON" -token "XDD1rgGfKcXDD2gk6Vjd" -keepData
