You do not need to supply a specific host name or port to address a node; you can use the node's published service name. If you need to find the nodes running on the network, you can perform discovery manually using the display services command.

Here is example output from the display services command using the servicetype filter to only return node service records.

epadmin display services --servicetype=node
Service Name = B.X
Service Type = node
Network Address = dtm-adm://Kapoho.local:43011

Service Name = A.X
Service Type = node
Network Address = dtm-adm://Kapoho.local:43005

This output indicates that there are two nodes running and that administration commands could be targeted at the node named A.X using a service name of A.X instead of using a host name of Kapoho.local and a port number of 43005.

When a service name is used to execute an administrative command, the output from the command is prefixed by the service name returning the response. For example, executing display node on all nodes in cluster X returns:

epadmin --servicename=X display node
//
//    Node B.X output
//
[B.X] Node Name = B.X
[B.X] Node Description = No description
[B.X] Node State = Stopped
[B.X] Host Name = Kapoho.local
[B.X] Administration Port = 43011
[B.X] Discovery Service = running on port 54321
[B.X] Container = tibco/sb
[B.X] Node Directory = /opt/kabira/users/djs/RUN/./B.X
[B.X] Deployment Directories = /opt/kabira/users/djs/RUN/./B.X/deploy
[B.X] Install Time = 2016-07-29 16:58:44 -0700 UTC
[B.X] Last Start Time = 
[B.X] Build Type = DEVELOPMENT
[B.X] Product Version = TIBCO StreamBase Runtime 10.0.0-SNAPSHOT (build 160729)
[B.X] Product Installation Directory = /opt/kabira/users/djs
[B.X] Web Server State = Started
[B.X] Web Server URLs = http://Kapoho.local:60780
//
//    Node A.X output
//
[A.X] Node Name = A.X
[A.X] Node Description = No description
[A.X] Node State = Stopped
[A.X] Host Name = Kapoho.local
[A.X] Administration Port = 43005
[A.X] Discovery Service = running on port 54321
[A.X] Container = tibco/sb
[A.X] Node Directory = /opt/kabira/users/djs/RUN/./A.X
[A.X] Deployment Directories = /opt/kabira/users/djs/RUN/./A.X/deploy
[A.X] Install Time = 2016-07-29 16:58:33 -0700 UTC
[A.X] Last Start Time = 
[A.X] Build Type = DEVELOPMENT
[A.X] Product Version = TIBCO StreamBase Runtime 10.0.0-SNAPSHOT (build 160729)
[A.X] Product Installation Directory = /opt/kabira/users/djs
[A.X] Web Server State = Started
[A.X] Web Server URLs = http://Kapoho.local:60747

Display adapter information.

display adapter
display adapter --engine=an-engine-name
display adapter --path=default.myModule.myAdapter

Resume a suspended adapter.

resume adapter
resume adapter --engine=an-engine-name
resume adapter --path=default.myModule.myAdapter

Start a stopped adapter.

start adapter
start adapter --engine=an-engine-name
start adapter --path=default.myModule.myAdapter

Stop a started adapter.

stop adapter
stop adapter --engine=an-engine-name
stop adapter --path=default.myModule.myAdapter

Suspend a running adapter.

suspend adapter
suspend adapter --engine=an-engine-name
suspend adapter --path=default.myModule.myAdapter

Display application information. The display command does not take any parameters.

display application

Activate a previously loaded artifact.

activate artifact --type=my-artifact-type --name=my-artifact-name --version=1.0.0
activate artifact --type=my-artifact-type --name=my-artifact-name --version=2.0.0 --latest

Deactivate a previously activated artifact.

deactivate artifact --type=my-artifact-type --name=my-artifact-name --version=1.0.0

Display artifact information.

The type, name, and version parameters are used as filters to control which artifacts are displayed. The parameters have this precedence - type, name, version. To specify a lower precedent parameter, all higher precedent parameters must be specified. For example, if name is specified, type also must be.

display artifact
display artifact --filter=required
display artifact --filter=operator
display artifact --type=my-artifact-type
display artifact --type=my-artifact-type --name=my-artifact-name
display artifact --type=my-artifact-type --name=my-artifact-name --version=1.0.0 --verbose

Export artifacts. Exported data is written to standard output.

export artifact --type=my-artifact-type --name=my-artifact-name --version=1.0.0 --file=artifact-data-file-name
export artifact --type=my-artifact-type --name=my-artifact-name --version=1.0.0 --metadata --file=artifact-metadata-file-name

Load artifacts. Loading an already loaded artifact (same type, name, and version) follows these rules:

load artifact --type=my-artifact-type --name=my-artifact-name --version=1.0.0 --source="xxx" --metadata="yyy"
load artifact --type=my-artifact-type --name=my-artifact-name --version=1.0.0 --source="xxx" --encoding="ascii"
load artifact --type=my-artifact-type --name=my-artifact-name --version=1.0.0 --sourcefile=my-artifact.file --metadatafile=my-artifact-metadata.file
load artifact --type=my-artifact-type --name=my-artifact-name --version=1.0.0 --source="zzz" --force

Send a message notification to registered operators.

notify artifact --type=my-artifact-type --name=my-artifact-name --severity=INFO --message=hello
notify artifact --type=my-artifact-type --name=my-artifact-name --version=1.0.0 --severity=ERROR --source=an-administrator --messagecode="ERROR-10" message="something very bad"

Update or create an operator's artifact registration.

register artifact --operator=default.myModule.myOperator --type=my-artifact-type --name=my-artifact-name
register artifact --operator=default.myModule.myOperator --type=my-artifact-type --name=my-artifact-name --version=1.0.0
register artifact --engine=my-engine --operator=default.myModule.myOperator --type=my-artifact-type
register artifact --operator=default.myModule.myOperator --type=my-artifact-type --action=restore
register artifact --engine=my-engine --operator=default.myModule.myOperator --type=my-artifact-type --action=restore

Remove a loaded artifact. The artifact must have been deactivated.

remove artifact --type=my-artifact-type --name=my-artifact-name --version=1.0.0

Reset node authentication to the initial authentication state after node installation which is:

The reset command can be executed remotely or locally. If executed remotely by specifying the servicename or adminport/hostname global parameters, the installpath parameter does not need to be specified.

reset authentication
reset authentication --installpath=A.X
reset authentication --installpath=A.X --password=supersecret

Display availability zone information.

display availabilityzone
display availabilityzone --name=cluster-wide-availability-zone

Rebalance availability zone data.

rebalance availabilityzone
rebalance availabilityzone --wait
rebalance availabilityzone --name=cluster-wide-availability-zone
rebalance availabilityzone --threads=4 --chunksize=500

Restore an availability zone following a multi-master event.

restore availabilityzone
restore availabilityzone --name=cluster-wide-availability-zone
restore availabilityzone --threads=4 --chunksize=500
restore availabilityzone --action=replace --from=B.X

Browse for breakpoints. The browse command does not exit - it continues to look for newly hit breakpoints until it is explicitly terminated with an interrupt. As breakpoints are hit they are displayed.

browse breakpoint

The browse command does not take any parameters.

Display the transaction and thread call stacks for transactions at breakpoints.

callstack breakpoint
callstack breakpoint --identifier=8:110
callstack breakpoint --name=MyTransaction

The identifier and name parameters are mutually exclusive.

Clear transaction breakpoints.

clear breakpoint
clear breakpoint --type=deadlock
clear breakpoint --type=begin --name=MyTransaction

Continue transactions from breakpoints.

continue breakpoint
continue breakpoint --identifier=8:110
continue breakpoint --name=MyTransaction

The identifier and name parameters are mutually exclusive.

Display information about transactions at breakpoints.

display breakpoint
display breakpoint --identifier=8:110
display breakpoint --name=MyTransaction
display breakpoint --name=MyTransaction --locklimit=400
display breakpoint --name=MyTransaction --locklimit=0

The identifier and name parameters are mutually exclusive.

List the currently set breakpoints.

list breakpoint

The list command does not take any parameters.

Display the locks held by transactions at breakpoints.

locks breakpoint
locks breakpoint --identifier=8:110
locks breakpoint --name=MyTransaction
locks breakpoint --name=MyTransaction --locklimit=400
locks breakpoint --name=MyTransaction --locklimit=0

Set a transaction breakpoint.

set breakpoint --type=deadlock
set breakpoint --type=begin --name=MyTransaction

Add a new type to an existing named cache.

add cache --name=MyCache --type=managed.Type

Create a named cache. Cache names are unique on a node. If the cache being created already exists, this command quietly does nothing. Newly created caches have an unlimited cache size.

create cache --name=MyCache

Display information about named caches on a node. If name is not specified, information about all caches is displayed.

display cache
display cache --name=MyCache

Remove a named cache. All objects in the cache are restored to their default caching behavior.

remove cache --name=MyCache

Set or change cache size. When changing a cache size, any required object flushing will occur asynchronously.

Cache sizes can be set as a percentage of total shared memory in the node, or as an absolute size. When setting size using an absolute size these suffixes are supported:

Percentage values are specified using a % suffix.

set cache --name=MyCache --size=0%    // Disables caching
set cache --name=MyCache --size=100%  // Unlimited cache size
set cache --name=MyCache --size=50%   // Size cache to 50% of node shared memory
set cache --name=MyCache --size=0     // Disables caching
set cache --name=MyCache --size=25000 // Set cache size to 25000 bytes
set cache --name=MyCache --size=25K   // Set cache size to 25 kilobytes
set cache --name=MyCache --size=2M    // Set cache size to 2 megabytes
set cache --name=MyCache --size=1G    // Set cache size to 1 gigabyte

Display cluster information.

The type controls the information displayed. Valid values are:

display cluster
display cluster --type=configuration
display cluster --type=local
display cluster --type=remote
display cluster --type=classmismatches

Remove a discovered node.

This command allows a node to removed from a cluster if it is never going to be part of the cluster again, for example if it was permanently removed from service.

remove cluster --remotenode=A

Wait for remote nodes to be discovered.

This waits for all nodes to be discovered that are in the nodes parameter. Success is reported if the nodes are discovered, otherwise a failure is returned.

wait cluster --nodes="A,B"

Activate configuration.

If there is already an active configuration with the same type and name, it is deactivated as part of activating the current configuration.

activate configuration --type=MyConfigurationType --name=myConfiguration --version="1.0"

Clear configuration state change history.

Configuration change history that meets the specified filter criteria defined using the parameters to this command is cleared. The filter parameters have this precedence - type, name, version, date. To specify a lower precedent filter value, all higher precedent values must be specified. For example, if name is specified, type also must be.

The date parameter is used to remove configuration history older than the specified date.

clearhistory configuration
clearhistory configuration --type=MyConfigurationType
clearhistory configuration --type=MyConfigurationType --name=myConfiguration
clearhistory configuration --type=MyConfigurationType --name=myConfiguration --version="1.0"
clearhistory configuration --type=MyConfigurationType --name=myConfiguration --version="1.0" --date="2005-07-31-23:59:59"

Deactivate configuration.

This command will leave the node with no active configuration. It is generally recommended to use the activate command to atomically deactivate and activate new configuration.

deactivate configuration --type=MyConfigurationType --name=myConfiguration --version="1.0"

Display configuration.

The type, name, and version parameters are used as filters to control which configuration is displayed. The parameters have this precedence - type, name, version. To specify a lower precedent parameter, all higher precedent parameters must be specified. For example, if name is specified, type also must be.

display configuration
display configuration --type=MyConfigurationType
display configuration --type=MyConfigurationType --name=myConfiguration
display configuration --type=MyConfigurationType --name=myConfiguration version="1.0"
display configuration --history

Export configuration data to a file.

The exported configuration is in format that can be reloaded after making any required changes.

export configuration --type=MyConfigurationType --name=myConfiguration --version="1.0" --file=./myConfiguration.conf

Generate a sample configuration.

generate configuration --rootobject=OIDCAuthenticationRealm --file=example.conf
generate configuration --rootobject=OIDCAuthenticationRealm --file=example.conf --requiredonly
generate configuration --type=com.tibco.ep.dtm.configuration.security --rootobject=OIDCAuthenticationRealm --file=example.conf

List available configuration types and root objects.

list configuration
list configuration --type "^com.tibco.ep.dtm.configuration.*"
list configuration --rootobject "^Secure.*"
list configuration --type "^com.tibco.ep.dtm.configuration.*" --rootobject "^OIDC.*"

Load configuration data.

The configuration file has been loaded into shared memory after this command completes - but it is not active. It needs to be activated using the activate command to take affect.

load configuration --source=myConfiguration.conf
load configuration --source=myConfiguration.conf --ignorethrottle
load configuration --source=myConfiguration.conf --substitutions="foo=bar,bar=foo"
load configuration --source=myConfiguration.conf --substitutionfile=mysubstitutions.prop

Here are the example contents of a substitution file.

#
#  Substitution properties for myConfiguration.conf
#
foo=bar

bar=foo

Remove configuration data from shared memory.

The configuration being removed cannot be active. Configuration that is removed from shared memory must be reloaded using the load command.

remove configuration --type=MyConfigurationType --name=myConfiguration --version="1.0"

Close connections.

close connection
close connection --engine=an-engine-name
close connection --type=jdbc
close connection --type=jdbc --name="my-data-source"

Display connection information.

display connection
display connection --engine=an-engine-name
display connection --type=jdbc
display connection --type=jdbc --name="my-data-source"

Add a container to a running engine.

add container --module=mymodule.sbapp --name=myContainer --connections="myContainer.anotherModule.inputStream=default.myModule.outputStream"
add container --engine=an-engine --module=mymodule.sbapp --name=myContainer --dequeue=disabled --enqueue=droptuples --suspend
add container --module=mymodule.sbapp --name=myContainer --moduleparameters="a=b,c=d" --modulesearchpaths="module-directory" --resourcesearchpaths="resources-directory"
add container --module=mymodule.sbapp --name=myContainer --trace --tracebuffered=false --tracecompress --tracefilebase="trace_" --traceoverwrite --tracestreampattern="value=Yo!"

Establish cross-container connections. Cross-container connections must be between containers in the same engine.

connect container --connections="myContainer.anotherModule.inputStream=default.myModule.outputStream" --where="value=5"
connect container --engine=an-engine-name --connections="myContainer.anotherModule.inputStream=default.myModule.outputStream"

Disconnect cross-container connections.

disconnect container --connections="myContainer.anotherModule.inputStream=default.myModule.outputStream"
disconnect container --engine=an-engine-name --connections="myContainer.anotherModule.inputStream=default.myModule.outputStream"

Display container information.

display container
display container --detailed
display container --engine=an-engine-name
display container --name=myContainer

Modify a container.

modify container --engine=an-engine --name=myContainer --dequeue=disabled --enqueue=droptuples
modify container --name=myContainer --trace --tracebuffered=false --tracecompress --tracefilebase=trace-directory --traceoverwrite --tracestreampattern="value=Yo!"

Remove a container.

remove container
remove container --engine=an-engine-name
remove container --name=myContainer

Restart a container.

restart container
restart container --engine=an-engine-name
restart container --name=myContainer

Resume a suspended container.

resume container
resume container --engine=an-engine-name
resume container --name=myContainer

Suspend a running container.

suspend container
suspend container --engine=an-engine-name
suspend container --name=myContainer

Get current dynamic variable values.

get dynvar
get dynvar --engine=myEngine
get dynvar --path=myModule.myDynamicVariable
get dynvar --engine=myEngine --path=myModule.myDynamicVariable

Set a dynamic variable value.

set dynvar --path=myModule.myDynamicVariable --value="new-value"
set dynvar --engine=myEngine --path=myModule.myDynamicVariable --value="new-value"

Display the status of deployed engines. If name parameter is not specified information is displayed for all deployed engines.

display engine
display engine --name=myEngine
display engine --detailed

Start a deployed engine. If name parameter is not specified all deployed engines are started. Starting an already started engine reports success without impacting the running engine.

start engine
start engine --name=myEngine

Stop a running engine. If name parameter is not specified all deployed engines are stopped. Stopping an already stopped engine reports success.

stop engine
stop engine --name=myEngine

Start a stopped engine in a suspended state for debugging. A debugger listener is started on the suspended engine. If name parameter is not specified all stopped engines are started in a suspended state. Suspending an already suspended engine reports an error.

The supported suspend types have this behavior:

suspend engine
suspend engine --name=myEngine
suspend engine --name=myEngine --debugport=5404
suspend engine --name=myEngine --type=jvm

Abort a local transaction initiated by a global transaction. The abort command cannot be run on the node initiating the global transaction. It can only be run on remote nodes involved in the global transaction.

abort globaltransaction --identifier="serializable:98752449084876475:221:33:360614189986813"

Commit a local transaction initiated by a global transaction. The commit command cannot be run on the node initiating the global transaction. It can only be run on remote nodes involved in the global transaction.

commit globaltransaction --identifier="serializable:98752449084876475:221:33:360614189986813"

Display global transactions running on this node.

display globaltransaction
display globaltransaction --verbose

Display performance metrics.

display history
display history --seconds=5

Stream performance metrics.

stream history
stream history --seconds=5

Display current logging levels.

display logging
display logging --enginename=an-engine-name
display logging --loggername=my-logger
display logging --enginename=an-engine-name --loggername=my-logger

Export any logging configuration changes to a file. This command only exports configuration if the default product logging configuration was changed.

export logging --enginename=an-engine-name --file=logging.xml

Reset logging levels to initial values. This command resets any values changed by the set command (see the section called “set command”).

reset logging
reset logging --enginename=an-engine-name
reset logging --loggername=my-logger
reset logging --enginename=an-engine-name --loggername=my-logger

Change current logging levels.

	These changes are not persistent - they are reset to default levels on engine or node restart.

set logging --configuration=my-logging-config.xml
set logging --enginename=an-engine-name --configuration=my-logging-config.groovy --format=groovy
set logging --loggername=my-logger --level=TRACE
set logging --enginename=an-engine-name --loggername=my-logger --level=TRACE

Read all new messages in an engine's log stream. This command blocks until it is interrupted, or count messages are read. This command can be executed against engines that are not in the started state. When the engine is started any new log messages will be displayed.

tail logging
tail logging --enginename=an-engine-name
tail logging --enginename=an-engine-name --count=100
tail logging --count=100

Display node information.

display node

Get the administrative port for a node.

The only valid global parameter for this command is hostname. The hostname global parameter can be used to execute this command on a remote machine. SSH access is required to the machine specified in the hostname parameter. See the section called “Secure shell (SSH)” for details.

getadminport node
getadminport node --installpath=/opt/tibco/RUN/A
--hostname=acme.com getadminport node --installpath=/opt/tibco/RUN/A

Install a node and optionally deploy an application.

The only valid global parameters for this command are hostname and username. The hostname global parameter can be used to execute this command on a remote machine. SSH access is required to the machine specified in the hostname parameter. See the section called “Secure shell (SSH)” for details. The username global parameter can be used to change the user name of the node administration user.

The javahome parameter can be used to configure the JRE or JDK used by the node. If the javahome parameter is not specified, it defaults to JAVA_HOME set in the environment.

The javalibrarypath, javabinarypath, and javaenvironment parameters can be used to update the node's environment, as required, for the JRE/JDK configured with the javahome parameter.

Any install node parameters that are also present in the node deployment configuration file, e.g. adminhost, override the values in the node deploy configuration.

install node --nodename=A.X
install node --application=myapplication.zip --substitutions="foo=bar,bar=foo" \
        --nodedeploy=mynodeploy.conf --nodename=A.X
install node --application=myapplication.zip --nodedeploy=mydeploy.conf \
        --substitutionfile=mysubstitutions.prop
install node --adminport=1234 --nodename="MyNode"
install node --webenabled --webport=5873 \
        --discoveryhosts="host1:host2" --discoveryport=9737
install node --buildtype=DEVELOPMENT --memorytype=sysvshm --memorysize=2048 \
        --memoryallocators=4
install node --nodedirectory=/opt/tibco/A --deploydirectories=/opt/tibco/deploy
install node --javahome=$JAVA_HOME --javabinarypath=/opt/jre/bin 
        --javalibrarypath=/opt/jre/lib --javaenvironment="foo=bar,bar=foo"
--hostname=acme.com install node --nodedirectory=/opt/tibco/RUN --nodename=A \
        --producthome=/opt/tibco
install node --nodename=A.X --keystore=secret.ks --keystorepassword=supersecret

Here are the example contents of a substitution file.

#
#  Substitution properties for myConfiguration.conf
#
foo=bar

bar=foo

Kill a running node.

Nodes are killed asynchronously. The kill command may return before the node has been killed.

When a node is killed it must be reinstalled after removing the node directory using remove node installpath=<node-directory>. The primary use of the kill command is testing.

kill node

Remove a stopped node.

A node must be stopped before it can be removed, unless the installpath parameter is specified. If installpath is specified, and a node is running, any running fragment engines are killed.

When a node is removed, the node coordinator is stopped if it is still running, and the node directory is deleted.

Use the hostname and adminport or servicename global parameters to identify the node to be removed.

If the remove command fails because it cannot connect to the node, then use the installpath parameter to identify the node directory. To remove a failed node on a remote machine use the hostname global parameter and the producthome parameter to specify the location of the product installation on the remote machine. SSH access is required to the machine specified in the hostname parameter. See the section called “Secure shell (SSH)” for details.

remove node
remove node --installpath=/opt/tibco/RUN/A
--hostname=acme.com remove node --installpath=/opt/tibco/RUN/A --producthome=/opt/tibco

Restore a node that was previously upgraded using the upgrade command.

The application being restored is specified in the application parameter.

The restore command performs the following steps if the node is running:

The restore command performs the following steps if the node is not running:

Upon successful completion a restore report is generated containing information on what was restored.

restore node --restorefile=version2.txt
restore node --restorefile=version2.txt --execute
restore node --restorefile=version2.txt --execute --deploydirectories=/opt/tibco/deployV2

Start a node or restart the node coordinator.

The start command can be used to start a node, or restart the node coordinator after a terminate command. The installpath parameter controls whether the start command is being used to start the node, or to restart the node coordinator. If the installpath parameter is specified, the node coordinator is restarted. If the installpath parameter is not specified, the node is restarted. It is an error to specify the installpath parameter if the node coordinator is already running. Executing start node on a node that is already started succeeds without performing any action.

The start command can restart a node coordinator on remote nodes using the hostname parameter. The producthome parameter can be used to specify the location of the product installation on the remote node.

start node
start node --autostart=false
start node --maxretries=50
start node --installpath=/opt/tibco/A
// restart node coordinator on remote host named remotehost
--hostname=remotehost start node --installpath=/opt/tibco/A --producthome=/opt/tibco

Stop a running node.

When a node is stopped, the node coordinator is left running, and will not be stopped unless the node is removed. Executing the start command will restart all application processes.

stop node

Terminate the node coordinator.

The start command can be used to restart the node coordinator.

terminate node

Upgrade a node.

This command upgrades the classes specified in the upgradefile parameter. This command must be used to upgrade nodes in a cluster. It can be run against a newly installed node, or a running node.

The new JAR files for the upgrade must be copied into a deployment directory for the node before performing the upgrade command.

The upgrade command performs the following steps if the node is running:

The upgrade command performs the following steps if the node is not running:

Upon successful completion an upgrade report is generated containing information on what was upgrade.

upgrade node --upgradefile=version2.txt
upgrade node --upgradefile=version2.txt --execute
upgrade node --upgradefile=version2.txt --execute --deploydirectories=/opt/tibco/deployV2
upgrade node --upgradefile=version2.txt --jvmnames=myApplication --allownonpartitioned

Display operator information.

display operator
display operator --type=map
display operator --engine=an-engine-name
display operator --path=default.myModule.myOperator
display operator --engine=an-engine-name --path=default.myModule.myOperator

Get properties for custom operators.

get operator
get operator --engine=an-engine-name
get operator --path=default.myModule.myOperator
get operator --property=myProperty

Resume a previously suspended custom operator. Builtin operators cannot be resumed.

resume operator
resume operator --engine=an-engine-name
resume operator --path=default.myModule.myOperator
resume operator --engine=an-engine-name --path=default.myModule.myOperator

Set properties for custom operators.

set operator --property=myProperty --value=hello
set operator --engine=an-engine-name --property=myProperty --value=hello
set operator --path=default.myModule.myOperator --property=myProperty --value=hello

Start a previously stopped custom operator. Builtin operators cannot be started.

start operator
start operator --engine=an-engine-name
start operator --path=default.myModule.myOperator
start operator --engine=an-engine-name --path=default.myModule.myOperator

Stop a previously started custom operator. Builtin operators cannot be stopped.

stop operator
stop operator --engine=an-engine-name
stop operator --path=default.myModule.myOperator
stop operator --engine=an-engine-name --path=default.myModule.myOperator

Suspend a previously started custom operator. Builtin operators cannot be suspended.

suspend operator
suspend operator --engine=an-engine-name
suspend operator --path=default.myModule.myOperator
suspend operator --engine=an-engine-name --path=default.myModule.myOperator

Display partition information.

display partition
display partition --name=my-partition
display partition --zone=cluster-wide-availability-zone

Change password.

change password --username=fred --password=supersecret
change password --username=fred --password=supersecret --realm=my-local-auth-realm

Display playback command status.

display playback
display playback --identifier=1

Pause an active playback command.

pause playback
pause playback --identifier=1

Resume a paused playback command.

resume playback
resume playback --identifier=1

Set the number of tuples per second to generate for an active playback.

set playback --ratepersecond=5.3
set playback --asfastaspossible
set playback --identifier=1 --ratepersecond=1000
set playback --identifier=1 --asfastaspossible

Start an asynchronous playback command.

start playback --simulationfile=my.sbfs
start playback --simulationfile=my.sbfs --path=mycontainer
start playback --simulationfile=my.sbfs --csvfile=mydata.csv --engine=my-engine --connecttime=60
start playback --simulationfile=my.sbfs --asfastaspossible
start playback --simulationfile=my.sbfs --maxtime=10 --maxtuples=1000 --multiplier=2.3
start playback --simulationfile=my.sbfs --prefilltuplebuffer --tuplebuffersize=10000

Please see the TIBCO StreamBase documentation for the syntax of the playback simulation files (.sbfs).

Stop a playback command.

stop playback
stop playback --identifier=1

Wait for a playback command to complete.

wait playback
wait playback --identifier=1

Display query table information.

display querytable
display querytable --engine=an-engine-name
display querytable --path=default.myModule.myQueryTable
display querytable --engine=an-engine-name --path=default.myModule.myQueryTable

Read query table rows.

read querytable
read querytable --engine=an-engine-name --verbose
read querytable --path=default.myModule.myQueryTable --format=json
read querytable --path=default.myModule.myQueryTable --format=csv nullstring=empty quotechar"'"
read querytable --path=default.myModule.myQueryTable --limit=0
read querytable --queryscope=node --where="value=10"

Comma separated value (CSV) formatted rows have a syntax of <value-1>,<value-2>,..., for example Steve,30.

JSON formatted rows have a syntax of {<field-name-1>:<value-1>,<field-name-2>:<value-2>,...}, for example {name:Steve,age:30}.

Backup a local authentication realm.

backup realm --file=default-realm.backup
backup realm --name=my-local-auth-realm --file=my-local-auth-realm.backup

Display realm information.

display realm
display realm --name=my-local-auth-realm

Return authentication realm being used for node administration.

getadmin realm

Restore local authentication realm from a backup file.

restore realm --file=/opt/backups/realm.backup
restore realm --file=/opt/backups/realm.backup --name=my-local-auth-realm

Set authentication realm to use for node administration.

The user specified with the --newrealusername parameter must have administrator privileges (see the section called “Privileges”) in the authentication realm being set for node administration, otherwise the command fails. This ensures that there is at least one user in the new realm that has node administration privileges.

setadmin realm
setadmin realm --newrealmusername=administrator --newrealmpassword=supersecret
setadmin realm --newrealmusername=administrator // password prompt displayed
setadmin realm --name=my-local-auth-realm

Display record command status.

display record
display record --identifier=1

Start an asynchronous record command.

start record --name=my-recording
start record --name=my-recording --engine=my-engine --connecttime=60
start record --name=my-recording --directory=my-recording-data

Stop a record command.

stop record
stop record --identifier=1

Display router information.

display router
display router --name=my-router

Generate a master secret and store it in a key store file. No node is required to execute this command.

create secret --keystore=mastersecret.ks
create secret --keystore=mastersecret.ks --keystorepassword=supersecret

Encrypt data using the master secret. The encrypted data is displayed on the console. No node is required to execute this command.

encrypt secret --keystore=mastersecret.ks
encrypt secret --keystore=mastersecret.ks --keystorepassword=supersecret
encrypt secret --keystore=mastersecret.ks --keystorepassword=supersecret --data=precious

Load a master secret to a node. The load fails if the node already has a master secret installed.

load secret --keystore=mastersecret.ks
load secret --keystore=mastersecret.ks --keystorepassword=supersecret

Browse for services. The browse command does not exit - it continues to look for new services on the network until it is explicitly terminated with an interrupt. As new services are discovered they are displayed.

browse services --servicetype=node
browse services --servicename=X
browse services --interval=1 --iterations=10
browse services --showproperty=NodeState
browse services --detailed
browse services --properties="property1=value1,property2=value2"

Display services.

display services
display services --servicename=X
display services --detailed
display services --showproperty=NodeState
display services --properties="property1=value1,property2=value2"

Verify that service discovery is working correctly.

verify services
verify services --mode=verification-type

	The --debug global option adds discovery service debug tracing to the output of this command.

Create a snapshot archive. The created archive is named <node name>.<timestamp>.zip.

create snapshot
create snapshot --description="issue 4567"
create snapshot --destination=/tmp
create snapshot --includeclasspaths
create snapshot --installpath=/opt/tibco/nodes/A

Clear current statistic values. Clearing a statistic that does not support clear has no effect. See Table 8.111, “Supported statistics” for a list of statistics that support clearing.

clear statistics --statistics="transaction,mutex"

Disable collection of statistics. Disabling a statistic that does not support disable has no effect. See Table 8.111, “Supported statistics” for a list of statistics that support disable.

disable statistics --statistics="transaction,mutex"

Display statistic values.

Displaying a statistic that has no data available will generate empty output.

display statistics --statistics="transaction,mutex"
display statistics --statistics="transaction,mutex" --detailed
display statistics --statistics="object,transaction" --filter=none
display statistics --statistics="transaction,mutex" --label="Transaction & Mutex Report"

Enable collection of statistics. Enabling a statistic that does not support enable has no effect. See Table 8.111, “Supported statistics” for a list of statistics that support enabling.

enable statistics --statistics="transaction,mutex"

Display a timed snapshot of statistic values.

Internally the snapshot command performs these steps in order - warm up sleep, disable, clear, enable, time sleep, disable, display. The warm up sleep duration is controlled by the warmupseconds parameter. The time sleep duration is controlled by the time parameter.

snapshot statistics --statistics="transaction,mutex" --seconds=10
snapshot statistics --statistics="transaction,mutex" --seconds=10 --warmupseconds=10 --detailed
snapshot statistics --statistics="object,transaction" --seconds=10 --filter=none
snapshot statistics --statistics="transaction,mutex" --seconds=10 --warmupseconds=10 --serialize

Display current collection status of statistics that can be enabled and disabled.

status statistics

Display supported statistics.

supported statistics

Dequeue tuples from a stream.

dequeue stream
dequeue stream --engine=an-engine-name --verbose --where="value=10"
dequeue stream --path=default.myModule.myOutputStream --format=json
dequeue stream --format=csv --nullstring=empty --quotechar="'"
dequeue stream --timestamp --timestampformat="HH:mm:ss"

Display stream information.

display stream
display stream --engine=an-engine-name
display stream --path=default.myModule.myOutputStream
display stream --path=default.myModule.myOutputStream --detailed
display stream --type=input

Enqueue tuples to a stream.

enqueue stream
enqueue stream --engine=an-engine-name
enqueue stream --path=default.myModule.myInputStream --format=json
enqueue stream --path=default.myModule.myInputStream --format=csv --nullstring=empty --quotechar="'"
enqueue stream --path=default.myModule.myInputStream --input=myinput.json

Comma separated value (CSV) formatted tuples have a syntax of <value-1>,<value-2>,..., list values are enclosed in square brackets. For example Steve,30,[Bob,Mary,Joe].

JSON formatted tuples have a syntax of {<field-name-1>:<value-1>,<field-name-2>:<value-2>,...}, list values are enclosed in square brackets. For example {name:Steve,age:30,children:[Bob,Mary,Joe]}.

Tuples are enqueued following a new line for both standard input or an input file.

Install an application as a system service.

install systemservice --name="my-service" --nodedirectory=my-nodes --nodename=A.X
install systemservice --name="my-service" --nodedirectory=my-nodes --nodename=A.X \
    --application=my-app.zip --displayname=my-app --startup=automatic \
    --nodedeploy=node.conf  --substitutionfile=my-app.properties
install systemservice --name="my-service" --nodedirectory=my-nodes --nodename=A.X \
    --username=.\my-service-user --password=super-secret

Remove an installed system service.

remove systemservice --name="my-service"

Display trusted host information.

display trusted

Get current tunable variable values.

get tunable
get tunable --category=engine
get tunable --name=engine.timerParallelism

Set a tunable variable.

set tunable --name=engine.timerParallelism --value="4"
set tunable --name=engine.timerParallelism --value="4" --scope=System::administration

Reset a tunable value to its initial value.

reset tunable --name=engine.timerParallism
reset tunable --name=engine.timerParallelism scope=System::administration

Add a user.

add user --username=auser --roles=monitor
add user --username=auser --password=supersecret --roles=monitor,administrator --locked
add user --username=auser --roles=monitor --passwordexpirationdays=10
add user --username=auser --roles=monitor --realm=my-local-authentication-realm

Display local authentication realm users.

display user
display user --realm=my-local-auth-realm

Remove a user.

remove user --username=auser
remove user --username=auser --realm=my-local-auth-realm

Update an existing user's account values.

	This command cannot be used to change a user's password. Use the section called “change command” command to change a user's password.

update user --username=auser --roles="monitor,administrator"
update user --username=auser --roles=monitor --passwordexpirationdays=20
update user --username=auser --roles=monitor --realm=my-local-auth-realm --locked

Display product version information.

display version
display version --detailed