epadmin
StreamBase Runtime — StreamBase Runtime command
DESCRIPTION
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:
-
On Windows, you must use a StreamBase Command Prompt.
-
On macOS and Linux, use a StreamBase-configured command shell.
The components of an epadmin command are:
-
global-parameters
are one or moreparameter
statements from the short list of global parameters that can apply to any epadmin command and target. Runepadmin help globals
for the list. -
command
is an imperative verb such asdisplay
,install
,start
,stop
, andhelp
that is to be applied to thetarget
. -
target
is one of the supported targets for thecommand
to act on, such as node, cluster, application, engine. Runepadmin help targets
for the list of supported targets. -
target-parameters
is one or moreparameter
statements from the list of parameters supported by the specific command and target. Useepadmin help
to see thetargetname
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. For example, the following two lines perform the same action:
epadmin --adminport=2000 --username=sbuser --password=secret display node epadmin --ad=2000 --us=sbuser --pa=secret display node
-
Legacy syntax from previous releases is still supported. In this format, parameters do not use prefixed hyphens, and you must type the full parameter name. For example:
epadmin adminport=2000 username=sbuser password=secret display node
You cannot mix old and new syntax in the same command.
Help System
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.
targetname
The 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.