Stop Script


The stop script shuts down the Appian engines and associated other services, like Service Manager and the Internal Messaging Service.


<APPIAN_HOME>/services/bin/ (.bat)


Short Name Long Name Required Meaning
-h --help No Show usage information
-p --password Yes Password for Admin REST API
-s --services Yes A comma-separated list of services to stop. See below for values.
-c --cluster No Stop the entire Service Manager cluster
-nk --no-kafka No Skip stopping Internal Messaging Service
-par --parallel No Stop all engines at once (deprecated; this will have no effect)
-q --quick No Skip checkpointing when stopping an engine or engines

Available values for the --services parameter: all, analytics00analytics31, channels, content, download-stats, execution00execution31, forums, groups, notifications, notifications-email, portal, process-design, manager.

When using the --cluster option, you must run the stop script on all servers that are configured to run engines at the same time as the script will pause and wait for other servers to indicate that they have shut down their services before exiting.

By default, and unless you use the --quick option, the stop script will checkpoint the engines as they shut down. This results in .kdb files that contain up-to-date data (i.e. no data is persisted solely in the Internal Messaging Service - Kafka) which are suitable for performing an upgrade. Using the --quick option will result in .kdb files that do not contain all of the engine's data and the remaining transactions will need to be replayed as part of the subsequent startup. Kdb files like this are not suitable for performing an upgrade.


./ -p <password> -s all
Open in Github Built: Fri, Mar 11, 2022 (04:59:07 PM)

On This Page