Apama 10.15.0 | Deploying and Managing Apama Applications | Deploying Apama Components with Command Central | Getting started with Command Central | Using the Command Central command line interface
 
Using the Command Central command line interface
To use the Command Central command line interface:
*Optional. Define environment variables so that you can invoke Command Central and Platform Manager commands from any location on the machine. To do so:
1. Set the CC_CLI_HOME environment variable to the following directory: Software AG_directory\CommandCentral\client.
Examples:
*Windows:  set CC_CLI_HOME=C:\SoftwareAG\CommandCentral\client
*UNIX:  export CC_CLI_HOME="/opt/SoftwareAG/CommandCentral/client"
2. Add $CC_CLI_HOME/bin to the PATH environment variable.
Examples:
*Windows:  set PATH=%PATH%;%CC_CLI_HOME%\bin
*UNIX:  export PATH="$PATH:$CC_CLI_HOME/bin"
*Define the CC_USERNAME and CC_PASSWORD environment variables to a user name and password. The default username is Administrator and password is manage.
Examples:
*Windows:  set CC_USERNAME=Administrator
*Windows: set CC_PASSWORD=manage
*UNIX:  export CC_USERNAME="Administrator"
*UNIX:  export CC_PASSWORD="manage"
*Open the command prompt. Change the directory to Software AG_directory\CommandCentral\client\bin (you do not have to change the directory if you have defined the CC_CLI_HOME environment variable). The bin folder contains all the executable files for the Command Central commands.
*Most tasks can be performed using the Command Central web interface or command line interface. For more information about using the Command Central command line interface, see Software AG Command Central Help.
The following examples illustrate how the Command Central command line interface can be used to perform some of the most common operations for Apama component instances. These examples assume that you have set the CC_PASSWORD environment variable and you are running the command line tool on the machine where Command Central is installed, and configuring the components to run on the Platform Manager node with the default node alias of local.
In the following example commands, <nodeAlias> is local.
runtimeComponentID is the ID of an instance in the format Apama-ComponentType-InstanceName, where
*ComponentType is one of the supported Apama components correlator, iaf, displayserver, or dataserver.
*myCorrelator, myIAF, myDisplayServer, and myDataServer are the InstanceName when the instance was created.
configurationTypeId is one of the supported configuration types. For more information on supported configuration types, see Configuration types that Apama components support.
For information about all the options for the sagcc command, see Software AG Command Central Help.