Pipeline command syntax

The pipeline executable can be found in the bin/ directory.

The syntax for the pipeline command is:

pipeline -parameter modifiers

Pipeline parameters and modifiers

You can use these parameters together or separately.

-a transport URI syntax for the application monitor

Specifies the transport to open for the application monitor.

-c pipeline configuration filename

Specifies the pipeline configuration file that you want to use with the pipeline that you are starting. If the pipeline configuration file is not located in the same directory from which you are starting the pipeline, you can specify the path by typing the full path and filename.

-d

Specifies that you want to run this pipeline in debug mode in the foreground.

You must start a pipeline using either the -s option (service/daemon mode) or the -d option (debug mode).

Note: Debug mode is not recommended for use in production scenarios, because it logs every action for this pipeline in the log files and can cause a decrease in performance. However, debug mode can be helpful in test scenarios or when you are troubleshooting a pipeline.

-e

Stops the specified pipeline running as a UNIX daemon or a Windows service (running in the background). If there are multiple pipelines running on the pipeline node, you must use the -n option to specify the name of the pipeline that you want to stop.

Note: If the pipeline that you want to stop is running in debug mode, you can also stop the pipeline by pressing Ctrl + C in the command window.

-f data file name

Loads data from the specified file into the pipeline.

If there are multiple pipelines running on the pipeline node, you must use the -n option to specify the name of the pipeline that you want to load this data into.

If you are using the transport option (-t) to load a file, you do not have to use the -f option, too, because that option specifies the filename.

-i

(Windows platforms only) Installs a pipeline as a Windows service. Once the pipeline has been installed as the Windows service, you can use the -s option to run the pipeline as a Windows service.

You only need to use the install option if the pipeline has never been installed as a Windows service or if you used the uninstall option.

-l

Lists the status of all pipelines on the pipeline node or of the status of pipeline specified by name using the -n option.

The possible statuses of the pipeline are:

Stopped

The pipeline is stopped.

Running

The pipeline is running.

-l

Lists the status of all pipelines on the pipeline node or of the status of pipeline specified by name using the -n option.

The possible statuses of the pipeline are:

Stopped

The pipeline is stopped.

Running

The pipeline is running.

-mm pipeline name

The Unique Number Matching percentage parameter can be set from 1 to 100. The higher the number, the more precisely an incoming Unique-number has to match in order to generate a Unique-Number-Match.

In the [MM] section of your pipeline.ini file(s), add the following entry (case-sensitive): UNUM_MATCH_PERCENTAGE=xx

If not specified, the default value is 75.

-s

Runs the pipeline as a daemon or a Windows service (if the pipeline has been installed as a Windows service using the -i option) in background mode. You must start a pipeline using either the -s option (service/daemon mode) or the -d option (debug mode).

If you are running multiple pipelines, it is common to use this command along with the -n command option to specify the name of the pipeline to run as a daemon or a service.

-t transport URI syntax

Specifies the Uniform Resource Identifier (URI) of the transport where the pipeline receives incoming data. You can specify more than one transport by typing multiple -t transport URIs on the same command line.

If the transport method does not already exist, the pipeline does not start.

Most of the supported transports contain command syntax options that enable you to start multiple pipeline threads to concurrently process more data.

-u

(Windows platforms only) Uninstalls the pipeline as a Windows service.

If you are running multiple pipelines, it is common to use this command with the -n option to specify the name of the pipeline to uninstall as a service.