RemoteControlCLI command reference

Syntax

RemoteControlCLI deploy -d deployment configuration ID -v version number

RemoteControlCLI start -d deployment configuration ID -v version number

RemoteControlCLI stop -d deployment configuration ID -v version number

RemoteControlCLI startBatch -d deployment configuration ID -v deployment configuration version number -w workspace ID -fp path to feed files

[-am Off|EndOfDay|EndOfRun ] 
[-ll Off|Fatal|Error|Warn|Info|Debug|Trace]  
[-n notification file name]  
[-r] [-ri] ID of the batch run to recover
[-im Off|On]
[-id inactivity date in YYYY-MM-DD HH:MM:SS format]

RemoteControlCLI stopBatch -d deployment configuration ID -v version number

You can obtain the help for this utility by entering -h by itself or with any of the above commands.

Where to find the deployment configuration ID and version number

You can obtain the version number and ID of the deployment configuration on the Deployment tab of the workspace. Select the deployment configuration and select the History tab in the panel that opens. Look under the Version and Message columns for the version and configuration ID. When you run the command, increment the deployment configuration version by 1.

For example, if the deployment version is currently n, you would specify a deployment configuration version number of n+1.

Command and option details

RemoteControlCLI deploy -d deployment configuration ID -v deployment configuration version number

Deploy a deployment configuration to the Streams server. For a first time deployment, you must use the Deployment & Batch Run tab of the workspace. You can perform subsequent deployments using the CLI.

RemoteControlCLI start -d deployment configuration ID -v deployment configuration version number

Start a deployment configuration.

RemoteControlCLI stop -d deployment configuration ID -v version number

Stop a deployment configuration.

RemoteControlCLI startBatch -d deployment configuration ID -v deployment configuration version number -w workspace ID -fp path to feed files

Start a batch run.

The non-required options for this command allow you to set the same parameters that are available on the Deployment & Batch Run tab, as follows.

• -am Off|EndOfDay|EndOfRun

  Set the artificial transaction mode

• -ll Off|Fatal|Error|Warn|Info|Debug|Trace

  Set the logging level for all Streams components

• -n notification file name

  Set the file used to send notifications about run success or failure

• -r

  Run in recovery mode (requires -ri)

• -ri ID of batch run

  Set the ID of the batch run to recover (used with -r)

• -im Off|On

  Turn inactivity mode on or off. If you do not set this mode, the default is off.

• -id inactivity date in YYYY-MM-DD HH:MM:SS format

  Set the date for the inactivity mode (used with -im). The date that you specify is the date that the system uses to look for any Forward Looking Inactivity events that need to be triggered.

RemoteControlCLI stopBatch -d deployment configuration ID -v version number

Stop a batch run.