epadmin-engine

epadmin engine target — Manages StreamBase Runtime engines in a node.

SYNOPSIS

epadmin [globalparameters] command engine [commandparameters]

DESCRIPTION

Use the engine target to show information about engines in a running node, and to start, stop, and suspend an engine.

If the node of interest has a single engine, it is probably more appropriate to use epadmin node commands to manage node and engine states. The commands in the engine target are a better fit for nodes with more than one engine, to manage one engine independently of others. These commands can also be used to halt one or more engines in a node for debugging or troubleshooting purposes, and to manage non-JVM engines.

The engine target has four commands:

The designation [sn|ad] in syntax examples is a reminder that this command requires either the global parameter ‑‑servicename or the ‑‑adminport and ‑‑hostname combination to identify the node or cluster of interest.

epadmin display engine

Displays a set of information lines about the deployed engines in a node. If the name parameter is not specified, information is shown for all deployed engines. 

epadmin [sn|ad] display engine
epadmin [sn|ad] display engine --name=JVMengine1
epadmin [sn|ad] display engine --detailed

Example output: 

Name = JVMEngineA
State = Started
Build Type = PRODUCTION
Fragment Type = ep-eventflow-fragment
Fragment Identifier = Not Available
Fragment Version = Not Available
Target = com.tibco.sb.sample.bestbidsandasks.BestBidsAsks
Target Parameters = suspend=true,configuration=
  /Users/sbuser/Studio_1060E/sample_bestbidsandasks/src/main/configurations/trustworthyP51.conf
EventFlow Fragment Client URI = sb://devmachine.local:18145
LiveView Fragment Client URI = 
LiveView Fragment Secure Client URI = 
Engine Data Area = /Users/sbuser/Studio_1060E/.nodes/A.sbuser/application/engines/JVMEngineA
JMX State = Started
JMX Service Address = bwrought.local:8487
JMX Service URL = service:jmx:rmi:///jndi/rmi://devmachine.local:8487/jmxrmi
Install Timestamp = 2020-04-10 19:01:50 -0400 UTC
Start Timestamp = 2020-04-10 19:01:52 -0400 UTC
Stop Timestamp = 
Exit Status = 
Shutdown Timeout Seconds = 80
Java Home = /Library/Java/JavaVirtualMachines/jdk-11.0.6.jdk/Contents/Home
Debugger Port = Not Enabled
Suspend Type = None
Command Parameter Description Required
name Engine name. No. Default value is all engines.
detailed A boolean value controlling whether to display details about an engine. No. Default value is false.

epadmin start engine

Starts a deployed engine. If the name parameter is not specified, all deployed engines are started. Starting an already started engine reports success without impacting the running engine. The start engine command does not wait for the engine to be fully started before returning. 

epadmin [sn|ad] start engine
epadmin [sn|ad] start engine --name=JVMengine1
Command Parameter Description Required
name Engine name. No. The default value is all engines.

epadmin stop engine

Stops a running engine. If the name parameter is not specified, all deployed engines are stopped. Stopping an already stopped engine reports success. The stop engine command does not return until the engine is stopped. 

epadmin [sn|ad] stop engine
epadmin [sn|ad] stop engine --name=JVMengine1
Command Parameter Description Required
name Engine name. No. The default value is all engines.

epadmin suspend engine

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

The supported suspend types have the following behavior:

  • all—performs a jvm suspend, followed by a fragment suspend.

  • fragment—start the JVM (and engine) and performs fragment specific behavior:

    • Java fragment—same behavior as the jvm suspend type.

    • EventFlow fragment—suspends all EventFlow containers.

    • LiveView fragment—suspends all EventFlow containers.

  • jvm—suspends a JVM engine before running main and waits for a remote debugger to attach to the designated debug port before starting the engine. 

epadmin [sn|ad] suspend engine
epadmin [sn|ad] suspend engine --name=JVMengine1
epadmin [sn|ad] suspend engine --name=JVMengine1 --debugport=5404
epadmin [sn|ad] suspend engine --name=JVMengine1 --type=jvm
Command Parameter Description Required
debugport Integer value specifying the Java debugger port. A value of 0 choses a random port. No. The default value is 0.
name Engine name. No. The default value is all engines.
type Specifies the suspend type. Valid values are jvm, fragment, or all. No. The default value is jvm.

SEE ALSO

Help System for epadmin
epadmin(1)
epadmin-globals(1)