StreamBase Runtime — StreamBase Runtime command
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-parametersare one or more
parameterstatements from the short list of global parameters that can apply to any epadmin command and target. Run
epadmin help globalsfor the list.
commandis an imperative verb such as
helpthat is to be applied to the
targetis one of the supported targets for the
commandto act on, such as node, cluster, application, engine. Run
epadmin help targetsfor the list of supported targets.
target-parametersis one or more
parameterstatements from the list of parameters supported by the specific command and target. Use
epadmin helpto see the
target-parametersavailable for that target.
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 --verbse=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 old and new syntax in the same command.
The epadmin command has extensive built-in usage help. Enter
epadmin help for the help starting point. Use
epadmin help to see target-specific help.
epadmin help node command is especially useful to remind you of the syntax to install and start nodes.
In previous StreamBase releases, calling epadmin help required connecting to an installed node. Starting with StreamBase 10.3.0, epadmin help is available offline, without nodes or clusters running.
The full syntax of the epadmin command is described in its help system, or in a separate documentation page.