StreamBase Runtime — StreamBase Runtime command


epadmin [global-parameters] [command] [target] [target-parameters]


epadmin [global-parameters]
 targets [--format=[readable|json]]

epadmin [global-parameters]
 help [target] [--format=[readable|json]]


Use the epadmin command to install, start, manage, and communicate with StreamBase Runtime nodes and clusters. Use epadmin from a configured shell prompt as follows:

The components of an epadmin command are:

  • global-parameters are one or more parameter statements from the short list of global parameters that can apply to any epadmin command and target. Run epadmin help globals for the list.

  • command is an imperative verb such as display, install, start, stop, and help that is to be applied to the target.

  • target is one of the supported targets for the command to act on, such as node, cluster, application, engine. Run epadmin help targets for the list of supported targets.

  • target-parameters is one or more parameter statements from the list of parameters supported by the specific command and target. Use epadmin help targetname to see the target-parameters available for that target.

Parameter Syntax

The epadmin command supports two syntaxes for entering parameters:

  • Gnu-style parameter syntax with two hyphens prefixing parameter names. You can enter the fewest number of letters of each parameter's name that maintains that parameter's uniqueness among the current target's supported parameters. This syntax does not require an equals sign between a parameter and its argument, but accepts one if present. For example, the following lines each perform the same action:

    epadmin --adminport=2000 dequeue stream --verbose=true
    epadmin --ad=2000 dequeue stream --ve=true
    epadmin --ad 2000 dequeue stream --ve true
    epadmin --ad=2000 dequeue stream --ve true
  • Legacy syntax from previous releases is still supported. In this format, parameters do not use prefixed hyphens, you must type the full parameter name, and the equals signs are required. For example:

    epadmin adminport=2000 username=sbuser password=secret display node

You cannot mix Gnu and legacy syntax in the same command.

Help System

The epadmin command has extensive built-in usage help. Enter epadmin help for the help starting point. Enter epadmin help targets to see a list of available targets, then use epadmin help targetname to see target-specific help.

You can append --format=json to a request for the list of targets or for target-specific help. This provides the help usage syntax information in industry standard JSON form to make it easy to post-process it if needed. The default is --format=readable.

The epadmin help node command is especially useful to remind you of the syntax to install and start nodes.

The full syntax of the epadmin command is described in its help system, or in a separate documentation page.