Command line interface

This section describes the command-line interface (CLI) used to manage nodes. This CLI is invoked using the epadmin command.

The epadmin command line interface uses a combination of a command and a target, possibly including parameters, to specify an action. A command is generally a verb, and the target is generally a noun.

There are two types of parameters - global and command specific. Global parameters are valid for all commands, with a few exceptions. Different mandatory and optional command specific parameters are implied by the action. Global parameters are always specified to the left of the command. Command specific parameters are always specified to the right of the target.

This is the general epadmin syntax:

epadmin global-parameters command target action-specific-parameters

Global and command specific parameters use this syntax:

For example, for the display partition command, --z could be used for the zone name parameter and --n could be used for the partition name parameter.

 display partition
    [ --name=<String> ]
        Partition name.

    [ --zone=<String> ]
        Zone name

The epadmin CLI uses the return code to indicate success or failure. The return code values have these meanings:

The epadmin executable is located in the TIBCO StreamBase® Runtime installation at:

<product-installation-location>/distrib/tibco/bin/epadmin

It is convenient to include this path in the PATH variable to save typing it every time.

Getting product version

The product version is displayed using epadmin --version. --version is an alias for the display version command which would display the same value.

epadmin --version
TIBCO StreamBase Runtime 10.3.0-SNAPSHOT (build 1804101348)

epadmin display version
TIBCO StreamBase Runtime 10.3.0-SNAPSHOT (build 1804101348)

Getting help

epadmin has extensive built-in help. Help is accessed using epadmin help, or its alias epadmin --help.

[Warning]

Help information on application specific administration targets is only available when help commands are executed against a running node. It is not available when running help commands without a node.

 epadmin --help

  epadmin [<--global-parameter>=<value>,...]
          <command> <target> [<--parameter>=<value>,...]
          Execute a command.

  epadmin [global-parameters...] help targets
          Display all available administration targets.
          If no --servicename or --adminport global parameter is
          provided show the targets known to the offline help.

  epadmin [global-parameters...] help <target>
          Help for a specific administration target.
          If no --servicename or --adminport global parameter is
          provided show the target from the offline help.

  epadmin --help [global-parameters...] <command> <target>
          Help for a specific administration target command.
          If no --servicename or --adminport global parameter is
          provided show the target command from the offline help.

  epadmin help globals
          Help for the global parameters.

  When specifying global or command parameters the '=' is optional.
  --parameter=value is equivalent to --parameter value

These help options are available

  • List of all available targets using help targets. See Example 8.1, “Target list help”.

    Example 8.1. Target list help

    epadmin help targets
      adapter           Manage adapters.
      application       Display application information.
      artifact          Artifact Distribution Service management.
      authentication    Node authentication administration commands.
      availabilityzone  Manage availability zones.
      breakpoint        Manage transaction breakpoints.
      cache             Manage named caches.
      cluster           Manage the high-availability cluster.
      configuration     Manage configuration.
      connection        Manage connections.
      container         Manage containers.
      dynvar            Manage dynamic variables.
      engine            Manage application engines.
      globaltransaction Manage global transactions for a node.
      history           Performance metrics history.
      logging           Manage engine Logback logging configurations.
      node              Manage nodes.
      object            Load and export objects in csv, xml, or json file formats.
      operator          Manage operators.
      partition         Manage object partitions.
      password          Change user passwords in a local authentication realm.
      playback          Manage playback of application data.
      querytable        Manage query tables.
      realm             Authentication realm management commands.
      record            Manage recording of data from application.
      router            Manage router.
      secret            Master secret commands.
      services          Services commands.
      snapshot          Create diagnostic snapshot.
      statistics        Control and display statistics.
      stream            Manage streams.
      systemservice     Windows system service commands.
      trusted           Trusted host management.
      tunable           Manage runtime tunable parameters.
      user              Manage users in a local authentication realm.
      version           Product version.

  • Help for a specific target using help <target>. See Example 8.2, “Specific target help”.

    Example 8.2. Specific target help

    epadmin help password
    Change user passwords in a local authentication realm. 
    
      change password [--realm=<String>] --username=<String> --password=<String> 
    
          Change a user password in a local authentication realm. 
    
          [--realm=<String>] local authentication realm name. Default: 
              default-realm 
          --username=<String> user name. 
          --password=<String> password. 

  • Help for a specific command using --help <command> <target>. See Example 8.3, “Command specific help”.

    Example 8.3. Command specific help

    epadmin --help display engine
    
      display engine [--name=<String>] [--detailed=<Boolean>] 
    
          Display one or all engines 
    
          [--name=<String>] Engine name. Default: none
          [--detailed=<Boolean>] Detailed output. Default: none


  • Global parameter help using help globals. See Example 8.4, “Global parameters help”.

    Example 8.4. Global parameters help

    epadmin help globals
      --adminport:        Administration port (no default).
      --debug:            Enable low level debug tracing for the command.
                          Valid values are true or false (default is false).
      --delimiter:        Enable delimited tabular output using parameter value
                          as delimiter.  Default is formatted text output.
      --discoveryport:    Service discovery port (default is 54321).
      --discoveryhosts:   A comma separated list of DNS host names and or
                          IP addresses, which specify which network interfaces
                          to use for sending the discovery request
                          (default is the system's host name).
      --discoverytimeout: Seconds to wait for a service discovery
                          request to complete. Sub-second precision is
                          is supported, for example 1.25
                          (default is 1).
      --help:             Display help for the current command.
                          Valid values are true or false (default is false).
      --hostname:         DNS host name or IP address (default localhost).
      --password:         User password (no default).
      --schema:           Enable schema row in delimited tabular output.
                          Valid values are true or false (default is false).
      --servicename:      Service name.  Partially qualified service names
                          may resolve to multiple nodes (no default).
      --serviceprefix:    Enable or disable service name prefix of
                          command output. Valid values are true or false
                          (default is true).
      --username:         User name (default login name).

The target list, target specific, and command specific help options can be run with and without a node. For built-in administrative targets, these two options are equivalent. Application specific administrative targets are only available when the help command is targeted at a node.

Accessing a node

Accessing a node to perform an administrative action requires:

  • Valid credentials, i.e. a user name and password

  • Network addressing information

Credentials and network address information are specified using global parameters. See the section called “Global parameters” for details.

If a username is specified but a password is not, then epadmin prompts for a password. If username is not specified, the user name in the shell environment in which epadmin is executed is used as the user name. See Chapter 5, Security to learn how to configure access control.

Node address information is required for most commands (those that apply to a node). You can specify an explicit hostname and port number, or alternatively you can use a service name to access a node. See the section called “Service discovery” for details on using a service name.

Administration actions can also be addressed to multiple nodes simultaneously. This is supported by specifying a partially-qualified service name when executing a command that should be targeted at all nodes in a cluster, a subset of the nodes, or a specific node.

Service discovery

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

Path notation

Some administration commands use EventFlow path notation to filter which entity is displayed. The EventFlow path notation has the following syntax, with a period separator between each element:

[containerName.][moduleRefName[[.moduleRef2Name].[..]]entityName

where:

  • containerName - the name of the container hosting the top-level module. Container names are either system, default, or a name you assign when creating a container. If containerName is omitted, it defaults to the container name default.

  • moduleRefName - child (aka a module reference) module name. Child modules can be nested.

  • entityName - the name of an individual stream, operator, or adapter.

The container name is an alias for the top-level module name. Top-level module names are never included in a path.

Other than the top-level container name, all path elements must be specified from the most significant element to the least significant element. It is illegal to omit more significant elements. For example:

//
//  Fully scoped operator path
//
default.childModule.grandChildModule.myOperator

//
//  Illegal path specifier for myOperator
//
grandChildModule.myOperator

//
//  Legal path specifier for myOperator
//
childModule.grandChildModule.myOperator

Here are some additional examples of valid paths:

//
//   Fully scoped path to myOperator
//
default.childModule.grandChildModule.myOperator

//
//   Resolves to default.childModule.grandChildModule.myOperator
//
childModule.grandChildModule.myOperator

//
//   Resolves to all entities and modules contained in default.childModule
//
childModule

//
//   Resolves to all entities and modules contained in default.childModule.grandChildModule
//
childModule.grandChildModule

Global parameters

Table 8.2, “Global parameters” summarizes the supported global parameters.

Table 8.2. Global parameters

NameExampleDescription
adminport--adminport=2001Administration port on target node. Required if servicename not specified. No default.
debug--debug=true|falseEnable low level debug tracing for the command. Valid values are true or false. The default value is false.
delimiter--delimiter=|Format output as a table with the first row containing column names, and all other rows containing the columnar data. The delimiter character is used to separate all columns in all rows. Default is to output formatted plain text.
discoveryport--discoveryport=54321Port to use for service discovery. Default value is 54321.
discoveryhosts--discoveryhosts=myhostA comma separated list of simple host names, fully qualified DNS names, or IP addresses, which specify which network interfaces to use for sending the discovery request. Default is the system's host name.
discoverytimeout--discoverytimeout=1.25The number of seconds to wait for a service discovery request to complete. Sub-second precision is supported, for example 1.25. Default is 1 second.
help--help=true|falseDisplay help for the current command. Valid values are true or false. Default value is false.
hostname--hostname=venusTarget node's host name. This can be a simple host name, a fully qualified DNS name, or an IPv4 or IPv6 address. If a simple host name or fully qualified DNS name is specified, an IPv6 address is used if available. Default value is localhost.
password--password=guestUser password to access target node. Cannot be specified when using trusted host authentication mechanism. It is strongly recommended that passwords never be specified on the command line. See the section called “Accessing a node” for details on specifying a password. No default.
schema--schema=trueEnable the addition of a schema row after the header row to delimited tabular output. Valid values are true or false. A value of true can only be specified if the delimiter global parameter is also set. The default value is false.
servicename--servicename=A.XThe service name of the target node. See the section called “Service discovery” for details on using service discovery. If servicename is specified, hostname and adminport are not required. No default.
serviceprefix--serviceprefix=falseEnable or disable service name prefixing of command output. Valid values are true or false. Default value is true.
username--username=guestUser name to access target node. Required if not using the trusted host authentication mechanism. Default value is the login name of the user executing epadmin. The default value requires that the host on which the command is being executed is a trusted host to the target host on which the node is running.

Supported targets

epadmin supports both built-in targets and application specific targets. Application targets may be added during development of an application. See the TIBCO StreamBase® Runtime Transactional Memory Developers Guide for details. Application specific targets are not discussed further here.

The supported built-in targets are show in Table 8.3, “Built-in administration targets”.

Table 8.3. Built-in administration targets

TargetDescription
adapterAdapter management. See the section called “adapter target”.
applicationApplication details. See the section called “application target”.
artifactArtifact Distribution Service (ADS) management. See the section called “artifact target”.
authenticationReset node authentication. See the section called “authentication target”.
availabilityzoneAvailability zone management. See the section called “availabilityzone target”.
breakpointTransaction breakpoint support. See the section called “breakpoint target”.
cacheNamed cache management. See the section called “cache target”.
clusterCluster management. See the section called “cluster target”.
configurationConfiguration management. See the section called “configuration target”.
connectionManage client and JDBC connections. See the section called “connection target”.
containerEventFlow container management. See the section called “container target”.
dynvarDynamic variable management. See the section called “dynvar target”.
engineManage application engines. See the section called “engine target”.
globaltransactionManage global transactions for a node. See the section called “globaltransaction target”.
historyPerformance metrics history. See the section called “history target”.
loggingLogging configuration management. See the section called “logging target”.
nodeNode management. See the section called “node target”.
operatorEventFlow operator management. See the section called “operator target”.
partitionPartition management. See the section called “partition target”.
passwordManage user passwords in a local authentication realm. See the section called “password target”.
playbackManage playback of recorded application data. See the section called “playback target”.
querytableDisplay and read query tables. See the section called “querytable target”.
realmAuthentication realm management. See the section called “realm target”.
recordMange recording of application data. See the section called “record target”.
routerRouter management. See the section called “router target”.
secretMaster secret management and data encryption. See the section called “secret target”.
servicesDiscover nodes using service discovery. See the section called “services target”.
snapshotCreate a diagnostic snapshot of a node. See the section called “snapshot target”.
statisticsCapture and display runtime statistics. See the section called “statistics target”.
streamInteract with EventFlow streams. See the section called “stream target”.
systemserviceWindows system service management. See the section called “systemservice target”.
trustedTrusted host management. See the section called “trusted target”.
tunableManage runtime tunable parameters. See the section called “tunable target”.
userManage users in a local authentication realm. See the section called “user target”.
versionDisplay product version. See the section called “version target”.

Details on each of these targets can be found in the following sections. These sections provide a brief description of the supported commands and targets, along with any parameters. Examples are provided to help clarify a command's usage.

[Note]

Global parameters are not shown in the examples unless they are required to clarify command usage.

adapter target

Manage adapters

display command

Display adapter information.

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

Table 8.4. display command parameters

NameDescriptionRequired
engineEngine name filter.No. Default display all adapters on all engines.
pathPath filter. See the section called “Path notation”.No. Default display all adapters at all paths.

resume command

Resume a suspended adapter.

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

Table 8.5. resume command parameters

NameDescriptionRequired
engineEngine name filter.No. Default resume all adapters on all engines.
pathPath filter. See the section called “Path notation”.No. Default resume all adapters at all paths.

start command

Start a stopped adapter.

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

Table 8.6. start command parameters

NameDescriptionRequired
engineEngine name filter.No. Default start all adapters on all engines.
pathPath filter. See the section called “Path notation”.No. Default start all adapters at all paths.

stop command

Stop a started adapter.

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

Table 8.7. stop command parameters

NameDescriptionRequired
engineEngine name filter.No. Default stop all adapters on all engines.
pathPath filter. See the section called “Path notation”.No. Default stop all adapters at all paths.

suspend command

Suspend a running adapter.

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

Table 8.8. suspend command parameters

NameDescriptionRequired
engineEngine name filter.No. Default suspend all adapters on all engines.
pathPath filter. See the section called “Path notation”.No. Default suspend all adapters at all paths.

application target

Display details on deployed applications.

display command

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

display application

artifact target

Manage artifacts in the Artifact Distribution Service (ADS). artifact commands always ensure that the cluster-wide state of the artifacts being managed is consistent, no matter if the command is sent to a single node, multiple nodes, or all nodes in a cluster.

activate command

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

Table 8.9. activate command parameters

NameDescriptionRequired
latestA boolean value indicating whether this artifact should be marked as the latest version, possibly replacing another artifact marked latest. true tags the artifact version as latest, false does not tag the artifact as latest.No. Default is false.
nameArtifact name.Yes.
typeArtifact type.Yes.
versionArtifact version.Yes.

deactivate command

Deactivate a previously activated artifact.

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

Table 8.10. deactivate command parameters

NameDescriptionRequired
nameArtifact name.Yes.
typeArtifact type.Yes.
versionArtifact version.Yes.

display command

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

Table 8.11. display command parameters

NameDescriptionRequired
filterAn enumeration value controlling the type of information to display. Valid values are loaded, required, and operator.No. Default value is loaded.
nameArtifact name. Cannot be specified if filter value is operator.No. Default display all artifact names.
typeArtifact type.No. Default display all artifact types.
verboseBoolean controlling detailed output. true enables detailed output, false disables detailed output.No. Default value is false.
versionArtifact version. Can only be specified if filter value is loaded.No. Default display all artifact versions.

export command

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

Table 8.12. export command parameters

NameDescriptionRequired
fileExport file name. If file exists it is overwritten.Yes.
metadataBoolean controlling whether to export artifact data or metadata. true exports metadata, false exports artifact data.No. Default value is false.
nameArtifact name.Yes.
typeArtifact type.Yes.
versionArtifact version.Yes.

load command

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

  1. if the artifact data, metadata, and encoding are the same, no action is taken.

  2. if the artifact data, metadata, or encoding is different, and force=false, the load fails.

  3. if the artifact data, metadata, or encoding is different, and force=true, the artifact is reloaded.

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

Table 8.13. load command parameters

NameDescriptionRequired
encodingArtifact encoding specifier.No. No default.
forceBoolean controlling whether a load should succeed if an artifact with the same type, name, and version is already loaded with different data, metadata, or encoding. true reloads the artifact if the data, metadata, or encoding is different, false causes the load to fail if the data, metadata, or encoding is different.No. Default is false.
metadataArtifact metadata. Only one of the metadata or metadatafile parameters can be specified.No. No default.
metadatafileArtifact metadata file. Only one of the metadata or metadatafile parameters can be specified.No. No default.
nameArtifact name.Yes.
sourceArtifact data. One of the source or sourcefile parameters must be specified.No. No default.
sourcefileArtifact data file. One of the source or sourcefile parameters must be specified.No. No default.
typeArtifact type.Yes.
versionArtifact version.Yes.

notify command

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"

Table 8.14. notify command parameters

NameDescriptionRequired
messageMessage text.Yes.
messagecodeMessage code.No. No default.
nameArtifact name.Yes.
severityAn enumeration value indicating the severity of the notification. Valid values are ERROR, WARN, INFO, DEBUG, and TRACE.Yes.
sourceNotification source.No. No default.
typeArtifact type.Yes.
versionArtifact version.No. Default is latest version.

register command

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

Table 8.15. register command parameters

NameDescriptionRequired
actionEnumeration controlling registration action. Valid values are register and restore. The register action updates or creates a registration for the operator. The restore action resets the operator's registration to any initial value (may be no registration).No. Default is register.
engineEngine containing the target operator.No. All engines containing the target operator.
nameArtifact name. Required if action is register. Cannot be specified if action is restore.No. No default.
operatorFully-qualified path to the target operator.Yes.
typeArtifact type.Yes.
versionArtifact version. Cannot be specified if action is restore.No. Default is latest version.

remove command

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

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

Table 8.16. remove command parameters

NameDescriptionRequired
nameArtifact name.Yes.
typeArtifact type.Yes.
versionArtifact version.Yes.

authentication target

Reset node authentication.

reset command

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

  • Use default local realm for authentication.

  • Define the operating system user executing the reset command as a node user.

  • Password is set to the value specified when executing the reset command. This password never expires.

  • New node user is assigned the administrator role which has administration privileges.

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

Table 8.17. reset command parameters

NameDescriptionRequired
installpathNode installation path. If specified, user executing command must have operating system write privileges to the node installation path.No. Required if command is executed locally.
passwordNew administrator password.No. If not specified a password prompt is displayed.

availabilityzone target

Manage availability zones.

display command

Display availability zone information.

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

Table 8.18. display command parameters

NameDescriptionRequired
nameThe name of an availability zone to display.No. Default is display all availability zones.

rebalance command

Rebalance availability zone data.

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

Table 8.19. rebalance command parameters

NameDescriptionRequired
chunksizeThe number of objects to lock per transaction when sending data to remote nodes.No. Default value is set in data distribution policy.
nameThe name of an availability zone to rebalanceNo. Default is rebalance all availability zones.
threadsThe number of threads to use when sending data to remote nodes.No. Default value is set in data distribution policy.

restore command

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

Table 8.20. restore command parameters

NameDescriptionRequired
actionOne of combine, replace, or merge. combine copies all data from a remote node to the local node, any data conflicts causes the restore to fail. replace removes all data on the local node and replaces it with data from the remote node. merge compares the data on the local and remote nodes and resolves any conflicts.No. Default is merge.
chunksizeThe number of objects to lock per transaction when sending data to remote nodes.No. Default value is set in data distribution policy.
fromRestore data from this node.No. Default is determined using a cluster wide broadcast to locate an active node to restore from.
nameThe name of the availability zone being restored.No. Default is restore all availability zones.
threadsThe number of threads to use when sending data to remote nodes.No. Default value is set in data distribution policy.

breakpoint target

Transaction breakpoint support.

Support for pausing and examining transactions is provided by the breakpoint target, which is available in both production and development mode nodes.

Supported breakpoints are defined in Table 8.21, “Supported transaction breakpoints”. The columns in the table have these meanings:

  • Type - Breakpoint type

  • Description - Brief description.

Table 8.21. Supported transaction breakpoints

TypeDescription
beginTransaction begin.
deadlockAfter a deadlock has occurred but before the transaction has rolled back.
destroyedAfter a lock on an object has failed because the object was destroyed in another transaction while waiting for it.
promotionA write lock was promoted to a write lock.
contentionContention occurred which caused blocking waiting to acquire the lock.
distributionA cluster scope query or remote method invocation was done.

A breakpoint my be set for all transactions or for transactions with a specified name.

browse command

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.

callstack command

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

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

Table 8.22. callstack command parameters

NameDescriptionRequired
identifierThe transaction identifier of a transaction at a breakpoint to display.No. Default is all transactions at breakpoints.
nameThe name of a transaction at a breakpoint to display.No. Default is all transactions at breakpoints.

The identifier and name parameters are mutually exclusive.

clear command

Clear transaction breakpoints.

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

Table 8.23. clear command parameters

NameDescriptionRequired
typeThe type of transaction breakpoint to clear. See Table 8.21, “Supported transaction breakpoints” for a list of supported breakpoint types.No. Default is all breakpoint types.
nameThe name of the transaction breakpoint to clear.No. Default is all breakpoints.

continue command

Continue transactions from breakpoints.

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

Table 8.24. continue command parameters

NameDescriptionRequired
identifierThe transaction identifier of a transaction at a breakpoint to continue.No. Default is all transactions at breakpoints.
nameThe name of a transaction at a breakpoint to continue.No. Default is all transactions at breakpoints.

The identifier and name parameters are mutually exclusive.

display command

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

Table 8.25. display command parameters

NameDescriptionRequired
identifierThe transaction identifier of a transaction at a breakpoint to display.No. Default is all transactions at breakpoints.
nameThe name of a transaction at a breakpoint to display.No. Default is all transactions at breakpoints.
locklimitThe maximum number of object locks to show. A value of 0 indicates no limit.No. Default is 100.

The identifier and name parameters are mutually exclusive.

list command

List the currently set breakpoints.

list breakpoint

The list command does not take any parameters.

locks command

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

Table 8.26. locks command parameters

NameDescriptionRequired
identifierThe transaction identifier of a transaction at a breakpoint to display.No. Default is all transactions at breakpoints.
nameThe name of a transaction at a breakpoint to display.No. Default is all transactions at breakpoints.
locklimitThe maximum number of object locks to show. A value of 0 indicates no limit.No. Default is 100.

set command

Set a transaction breakpoint.

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

Table 8.27. set command parameters

NameDescriptionRequired
typeThe type of transaction breakpoint to set. See Table 8.21, “Supported transaction breakpoints” for a list of supported breakpoint types.Yes.
nameThe name of the transaction to set the breakpoint for.No, except for begin. Default is all transactions.

cache target

Manage named caches.

add command

Add a new type to an existing named cache.

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

Table 8.28. add command parameters

NameDescriptionRequired
nameCache name.Yes.
typeFully scoped type name.Yes.

create command

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

Table 8.29. create command parameters

NameDescriptionRequired
nameCache name.Yes.

display command

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

Table 8.30. display command parameters

NameDescriptionRequired
nameCache name.No. No default value.

remove command

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

remove cache --name=MyCache

Table 8.31. remove command parameters

NameDescriptionRequired
nameCache name.Yes.

set command

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:

  • None - size in bytes.

  • K - size in kilobytes.

  • M - size in megabytes.

  • G - size in gigabytes.

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

Table 8.32. set command parameters

NameDescriptionRequired
nameCache name.Yes.
sizeCache size - percentage of shared memory or an absolute value.Yes.

cluster target

Manage a cluster.

display command

Display cluster information.

The type controls the information displayed. Valid values are:

  • classmismatches - Display class mismatch information between the local and discovered remote nodes.

  • configuration - Display local node configuration information.

  • local - Display local node status information.

  • remote - Display information about discovered remote nodes.

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

Table 8.33. display command parameters

NameDescriptionRequired
typeOptional information type to display. Valid values are one of classmismatches, configuration, local, or remote.No. Default value is remote.

remove command

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

Table 8.34. remove command parameters

NameDescriptionRequired
remotenodeRemote node name.Yes.

wait command

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"

Table 8.35. wait command parameters

NameDescriptionRequired
nodesComma separated list of nodes.Yes.

configuration target

Manage configuration.

activate command

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"

Table 8.36. activate command parameters

NameDescriptionRequired
typeConfiguration type.Yes.
nameConfiguration name.Yes.
versionConfiguration version.Yes.

clearhistory command

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"

Table 8.37. clearhistory command parameters

NameDescriptionRequired
typeConfiguration type.No. No default value.
nameConfiguration name.No. No default value.
versionConfiguration version.No. No default value.
dateOlder than date. Format is %Y-%m-%d-%H:%M:%S where month (%m) is specified as a number (1-12), hour (%H) is between 0 and 23 inclusive, and a dash separates the date and time. For example, 2005-07-31-23:59:59. Time value must be specified in the local timezone of the node.No. No default value.

deactivate command

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"

Table 8.38. deactivate command parameters

NameDescriptionRequired
typeConfiguration type.Yes.
nameConfiguration name.Yes.
versionConfiguration version.Yes.

display command

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

Table 8.39. display command parameters

NameDescriptionRequired
typeConfiguration type.No. No default value.
nameConfiguration name.No. No default value.
versionConfiguration version.No. No default value.
historyBoolean to control display of configuration state change history. A value of true will display the history.No. Default value is false.

export command

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

Table 8.40. export command parameters

NameDescriptionRequired
typeConfiguration type.Yes.
nameConfiguration name.Yes.
versionConfiguration version.Yes.
fileClient-side output file.Yes.

generate command

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

Table 8.41. generate command parameters

NameDescriptionRequired
fileClient-side output file.Yes.
requiredonlyBoolean to control which properties the generated sample contains. A value of true will generate a sample with only required properties, a value of false will generate a sample with all properties.No. Default value is false.
rootobjectConfiguration root object name.Yes.
typeConfiguration type.No. No default value.

list command

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.*"

Table 8.42. list command parameters

NameDescriptionRequired
rootobjectConfiguration root object name regular expression. Java Pattern regular expression syntax is supported.No. No default value.
typeConfiguration type regular expression. Java Pattern regular expression syntax is supported.No. No default value.

load command

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

Table 8.43. load command parameters

NameDescriptionRequired
sourceConfiguration file.Yes.
substitutionsComma separated list of <name>=<value> pairs used to replace substitution variables in the configuration file. A value specified in substitutions takes precedence over a value specified in substitutionfile if they both specify a value for the same name.No. No default value.
substitutionfileA file containing new-line terminated <name>=<value> pairs used to replace substitution variables in the configuration file. Blank lines, and lines beginning with a #, are ignored. A value specified in substitutions takes precedence over a value specified in substitutionfile if they both specify a value for the same name.No. No default value.
ignorethrottleBy default configuration files cannot be loaded if a node's shared memory utilization exceeds the configured throttle threshold. Setting this parameter to true will load the configuration file even if shared memory utilization exceeds the configured throttle value. Set this value to true with caution since it can cause memory exhaustion on a running system.No. Default is false.

remove command

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"

Table 8.44. remove command parameters

NameDescriptionRequired
typeConfiguration type.Yes.
nameConfiguration name.Yes.
versionConfiguration version.Yes.

connection target

Manage connections

close command

Close connections.

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

Table 8.45. close command parameters

NameDescriptionRequired
engineEngine name filter.No. Default close all connections on all engines.
nameConnection or datasource name filter.No. Default value is all connections.
typeConnection type filter. An enumeration with these valid values - client, jdbc.No. Default value is client.

display command

Display connection information.

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

Table 8.46. display command parameters

NameDescriptionRequired
engineEngine name filter.No. Default display all connections on all engines.
nameConnection or datasource name filter.No. Default value is all connections.
typeConnection type filter. An enumeration with these valid values - client, jdbc.No. Default value is client.

container target

EventFlow container management.

add command

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!"

Table 8.47. add command parameters

NameDescriptionRequired
connectionsComma separated list of cross-container connections to establish. Cross-container connections are specified as <target-input-stream-path>=<source-output-stream-path>.No. No default.
dequeueDequeue status for the container. An enumeration with these valid values - enabled, disabled, droptuples.No. Default value is enabled.
engineEngine name filter.No. Default is all engines.
enqueueEnqueue status for the container. An enumeration with these valid values - enabled, disabled, droptuples.No. Default value is enabled.
moduleFile containing module to execute in the container.Yes.
moduleparametersComma separated list of module parameters. The module parameters are specified as <name>=<value> pairs.No. No default.
modulesearchpathsComma separated list of module search paths. The module search paths are evaluated on the node machine.No. No default.
nameContainer name.Yes.
resourcesearchpathsComma separated list of resource search paths. The resource search paths are evaluated on the node machine.No. No default.
suspendBoolean value to control whether container is suspended or not. A value of true will suspend the container.No. Default value is false.
traceBoolean value to enable runtime tracing. A value of true will enable runtime tracing.No. Default value is false.
tracebufferedBoolean value controlling whether trace output is buffered. A value of true buffers the trace output for improved performance with the trade-off that trace output lags module execution and may be lost on a hard failure.No. Default value is true.
tracecompressBoolean value controlling trace file compression. A value of true causes the trace files to be compressed.No. Default value is false.
tracefilebaseString value that is the base name for trace files. Setting this parameter to a value causes trace output to be redirected to files. There is one trace file generated per module, including one trace file for each parallel region in a module. Trace file names are generated as <tracefilebase+containername>.sbtrace. For modules running with parallel execution enabled, the module's path becomes part of the trace file name, i.e. <tracefilebase+containername.modulepath>.sbtrace. Tracing also creates a file with extension .sbtrace.meta. This file contains a metadata description of the traced modules that is used by the Trace Debugger Studio perspective when processing .sbtrace files.No. Default is trace output is written to standard out.
traceoverwriteBoolean value controlling whether trace files are overwritten on engine restart. A value of true causes the trace files to be overwritten.No. Default value is false.
tracestreampatternEnable stream tracing using the specified pattern as a filter. The pattern value uses the java.util.regex.Pattern syntax. Stream tracing requires that the module was compiled with the streambase.codegen.trace-tuples system property set to true.No. No default.

connect command

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"

Table 8.48. connect command parameters

NameDescriptionRequired
connectionsComma separated list of cross-container connections to establish. Cross-container connections are specified as <target-input-stream-path>=<source-output-stream-path>.Yes.
engineEngine name filter.No. Default all containers on all engines.
wherePredicate expression that filters the tuples sent over the connections. The predicate expression must resolve to true or false, and should match against one or more fields in the schema of the connection's stream. Tuples are only sent over the connection if they match the predicate with a value of true.No. No default.

disconnect command

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"

Table 8.49. disconnect command parameters

NameDescriptionRequired
connectionsComma separated list of cross-container connections to disconnect. Cross-container connections are specified as <target-input-stream-path>=<source-output-stream-path>.Yes.
engineEngine name filter.No. Default all containers on all engines.

display command

Display container information.

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

Table 8.50. display command parameters

NameDescriptionRequired
detailedA boolean value controlling whether to display details about a container.No. Default is false.
engineEngine name filter.No. Default display all containers on all engines.
nameContainer name filter.No. Default display all containers.

modify command

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!"

Table 8.51. modify command parameters

NameDescriptionRequired
dequeueDequeue status for the container. An enumeration with these valid values - enabled, disabled, droptuples.No. Default value is enabled.
engineEngine name filter.No. Default is all engines.
enqueueEnqueue status for the container. An enumeration with these valid values - enabled, disabled, droptuples.No. Default value is enabled.
nameContainer name filter.No. Default is all containers.
traceBoolean value to enable runtime tracing. A value of true will enable runtime tracing.No. Default value is false.
tracebufferedBoolean value controlling whether trace output is buffered. A value of true buffers the trace output for improved performance with the trade-off that trace output may be lost on a hard failure.No. Default value is true.
tracecompressBoolean value controlling trace file compression. A value of true causes the trace files to be compressed.No. Default value is false.
tracefilebaseString value that is the base name for trace files. Setting this parameter to a value causes trace output to be redirected to files. There is one trace file generated per module, including one trace file for each parallel region in a module. Trace file names are generated as <tracefilebase+containername>.sbtrace. For modules running with parallel execution enabled, the module's path becomes part of the trace file name, i.e. <tracefilebase+containername.modulepath>.sbtrace. Tracing also creates a file with extension .sbtrace.meta. This file contains a metadata description of the traced modules that is used by the Trace Debugger Studio perspective when processing .sbtrace files.No. Default is trace output is written to standard out.
traceoverwriteBoolean value controlling whether trace files are overwritten on engine restart. A value of true causes the trace files to be overwritten.No. Default value is false.
tracestreampatternEnable stream tracing using the specified pattern as a filter. The pattern value uses the java.util.regex.Pattern syntax. Stream tracing requires that the module was compiled with the streambase.codegen.trace-tuples system property set to true.No. No default.

remove command

Remove a container.

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

Table 8.52. remove command parameters

NameDescriptionRequired
engineEngine name filter.No. Default remove all containers on all engines.
nameContainer name filter.No. Default remove all containers.

restart command

Restart a container.

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

Table 8.53. restart command parameters

NameDescriptionRequired
engineEngine name filter.No. Default restart all containers on all engines.
nameContainer name filter.No. Default restart all containers.

resume command

Resume a suspended container.

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

Table 8.54. resume command parameters

NameDescriptionRequired
engineEngine name filter.No. Default resume all containers on all engines.
nameContainer name filter.No. Default resume all containers.

suspend command

Suspend a running container.

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

Table 8.55. suspend command parameters

NameDescriptionRequired
engineEngine name filter.No. Default suspend all containers on all engines.
nameContainer name filter.No. Default suspend all containers.

dynvar target

Get and set dynamic variables.

get command

Get current dynamic variable values.

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

Table 8.56. get command parameters

NameDescriptionRequired
engineEngine name filter.No. Default is all engines.
pathPath filter. See the section called “Path notation”.No. Default get all dynamic variables at all paths.

set command

Set a dynamic variable value.

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

Table 8.57. set command parameters

NameDescriptionRequired
engineEngine name filter.No. Default is all engines.
pathDynamic variable path. See the section called “Path notation”.Yes.
valueSet dynamic variable to this value.Yes.

engine target

Manage the life-cycle of node engines.

display command

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

Table 8.58. display command parameters

NameDescriptionRequired
nameEngine name.No. Default value is all engines.
detailedA boolean value controlling whether to display details about an engine.No. Default value is false.

start command

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

Table 8.59. start command parameters

NameDescriptionRequired
nameEngine name.No. Default value is all engines.

stop command

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

Table 8.60. stop command parameters

NameDescriptionRequired
nameEngine name.No. Default value is all engines.

suspend command

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:

  • all - perform a jvm suspend followed by a fragment suspend.

  • fragment - start the JVM (and engine) and perform fragment specific behavior:

    • Java fragment - same behavior as jvm suspend type.

    • EventFlow fragment - suspend all EventFlow containers.

    • LiveView fragment - suspend all EventFlow containers.

  • jvm - suspend a JVM before executing main and wait for a remote debugger to attach to the debug port before starting the engine.

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

Table 8.61. stop command parameters

NameDescriptionRequired
debugportInteger value specifying the java debugger port. A value of 0 will chose a random port.No. Default value is 0.
nameEngine name.No. Default value is all engines.
typeEnumeration value specifying the suspend type. Valid values are jvm, fragment, or all.No. Default value is jvm.

globaltransaction target

Manage global transactions for a node.

abort command

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"

Table 8.62. abort command parameters

NameDescriptionRequired
identifierGlobal transaction identifier.Yes.

commit command

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"

Table 8.63. commit command parameters

NameDescriptionRequired
identifierGlobal transaction identifier.Yes.

display command

Display global transactions running on this node.

display globaltransaction
display globaltransaction --verbose

Table 8.64. display command parameters

NameDescriptionRequired
verboseBoolean value controlling whether to include additional global transaction details. The verbose option only displays additional details if debug tracing is enabled for distribution.No. Default value is false.

history target

Performance metrics history.

display command

Display performance metrics.

display history
display history --seconds=5

Table 8.65. display command parameters

NameDescriptionRequired
secondsInteger value for display interval.No. Default is one second.

stream command

Stream performance metrics.

stream history
stream history --seconds=5

Table 8.66. stream command parameters

NameDescriptionRequired
secondsInteger value for streaming interval.No. Default is one second.

logging target

Manage logging configuration.

display command

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

Table 8.67. display command parameters

NameDescriptionRequired
enginenameEngine name.No. Default display loggers on all engines.
loggernameLogger name.No. Default display all loggers.

export command

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

Table 8.68. export command parameters

NameDescriptionRequired
enginenameEngine name.Yes.
fileClient-side output file.Yes.

reset command

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

Table 8.69. reset command parameters

NameDescriptionRequired
enginenameEngine name.No. Default reset loggers on all engines.
loggernameLogger name.No. Default reset all loggers.

set command

Change current logging levels.

[Warning]

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

Table 8.70. set command parameters

NameDescriptionRequired
configurationNew Logback logging configuration. Cannot be specified with loggername parameter.No. No default.
enginenameEngine name.No. Default set configuration on all engines.
formatLogging configuration file format. An enumeration with valid values of xml and groovy. Can only be specified with the configuration parameter.No. Default value is xml.
levelNew logging level. An enumeration with valid values of ERROR, WARN, INFO, DEBUG, and TRACE. Cannot be specified with configuration parameter.Required if loggername specified. No default.
loggernameLogger name. Cannot be specified with configuration parameter.No. Default set configuration all loggers.

tail command

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

Table 8.71. tail command parameters

NameDescriptionRequired
countTotal number of log messages to read. The command terminates after this number of log messages is read. If not provided, the command continues to read until interrupted.No. No default value.
enginenameEngine name.No. Default tail log streams on all engines.

node target

Manage node life-cycle.

display command

Display node information.

display node

getadminport command

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

Table 8.72. getadminport command parameters

NameDescriptionRequired
installpathInstallation path.No. Default is <current working directory>/<local host name>

install command

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

Table 8.73. install command parameters

NameDescriptionRequired
adminhostSet the host address used to receive administrative commands. The host can be specified as a simple host name, a fully qualified DNS name, or an IP address.No. Default is all network interfaces.
adminportSet the port used to receive administrative commands. Note that the adminport parameter follows install node, and is not the adminport global parameter. Use of the adminport global parameter is illegal for the install command, since the node is not running when the command is executed.No. Default is a random port.
applicationOptional application archive to install on node.No. Default is to install node without an application.
buildtypeBuild type of node to be installed. Valid values are DEVELOPMENT and PRODUCTION.No . Default is PRODUCTION.
deploydirectoriesOne or more directories where application JAR files or resources can be installed. The directory names can be absolute or relative, and are separated with a :, except for Windows which uses a ;. All non-absolute paths are relative to the node nodedirectory directory. The directories must exist. All of the JAR files contained in these directories are automatically added to the class path for all engines started in the node. The directories are added in the order they are specified in the deploydirectories parameter. All file names within each directory are added using an ASCII sort order on the file names.No. Default is <node-installation-path>/deploy. JAR files placed in the default deploydirectories path are removed when the node is removed.
discoveryhostsA comma separated list of host names which specifies which network interfaces the node uses to send discovery requests. The host names can be specified as a simple host name, a fully qualified DNS name, or an IP address.No. Default value is the interface associated with the system's host name.
discoveryportDiscovery port number.No. Default value is 54321.
javabinarypathA list of JRE/JDK directories to add to the node's binary search path. Relative paths are relative to the directory specified in the javahome parameter. Use the : character to separate directories in the list, except for Windows which uses a ;. If this parameter is specified then the javahome parameter must also be specified. This parameter is not allowed if the application parameter is specified.No. Default is built-in value.
javaenvironmentA comma-separated list of name/value pairs specifying the environment variables to add to the node's environment for the JRE/JDK specified by the javahome parameter. This parameter is not allowed if the application parameter is specified.No. Default is an empty list.
javahomeLocation of the JRE or JDK to be used by the node. This parameter is not allowed if the application parameter is specified.No. Default is value of JAVA_HOME environment variable or a built-in platform default.
javalibrarypathA list of JRE/JDK directories to add to the node's library search path. Relative paths are relative to the directory specified in the javahome parameter. Use the : character to separate directories in the list, except for Windows which uses a ;. If this parameter is specified then the javahome parameter must also be specified. This parameter is not allowed if the application parameter is specified.No. Default is built-in value.
keystorePath to the keystore file containing the master secret the node should use when decrypting data. The keystore file must have been generated by the create secret command (see the section called “secret target”).No. No default value.
keystorepasswordThe password for the keystore file.Required if keystore parameter specified. If not specified, a password prompt is displayed.
memoryallocatorsNumber of concurrent shared memory allocators.No. Default value is based on number of cores in the machine.
memorysizeSize of shared memory in megabytes.No. Default value is 512.
memorytypeType of memory to use for system shared memory. The value file indicates a memory mapped file. The value sysvshm is System V Shared memory.No. Default value is file.
nodedeployOptional node deploy configuration file. This parameter can only be specified if the application parameter is specified.No. Default values are built-in.
nodedirectoryThe parent directory for the node's installation directory. The full path to the node's installation directory is <nodedirectory>/<nodename>.No. Default value is current working directory.
nodenameNode name. A fully-qualified service name that uniquely identifies the node.No. Default value is <local host name>.cluster
producthomeLocation of the product installation on the host specified by the global hostname parameter.No. Default value is based on the location of the epadmin executable on the local host.
substitutionsComma separated list of <name>=<value> pairs used to replace substitution variables in application definition and node deploy configuration files. A value specified in substitutions takes precedence over a value specified in substitutionfile if they both specify a value for the same name.No. No default value.
substitutionfileA file containing new-line terminated <name>=<value> pairs used to replace substitution variables in application definition and node deploy configuration files. Blank lines, and lines beginning with a #, are ignored. A value specified in substitutions takes precedence over a value specified in substitutionfile if they both specify a value for the same name.No. No default value.
webenabledBoolean value that controls whether the node's administration Web Server is started.No. Default value is true.
webportNode administration web server port.No. Default value is a random port.

kill command

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 command

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

Table 8.74. remove command parameters

NameDescriptionRequired
installpathInstallation path.No. No default value.
producthomeLocation of the product installation on the host specified by the global hostname parameter. This parameter can only be specified when the installpath parameter is also specified.No. Default value is based on the location of the epadmin executable on the local host.

restore command

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:

  1. Leave the cluster. All partitions with this node as the active node will migrate to a replica.

  2. Stop the node.

  3. Update the deployment directories for the node if deploydirectories is set on the command line.

  4. Remove all managed objects for classes being restored.

  5. Restart the node.

  6. Add this node as a replica to all partitions that were active on this node and join the cluster.

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

  1. Update the deployment directories for the node if deploydirectories is set on the command line.

  2. Remove all managed objects for classes being restored.

  3. Start the node.

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

Table 8.75. restore command parameters

NameDescriptionRequired
restorefileFile containing the list of classes to restore. This is the upgradefile that was passed to the upgrade command. All non-absolute paths are relative to the node installpath directory.Yes.
allownonpartitionedA boolean value indicating whether a restore should be allowed if there are instances of non-partitioned objects in shared memory. Setting this value to true allows restores to continue, but all non-partitioned objects are deleted as part of the restore process.No. Default value is false.
applicationOptional application archive to restore on node.No. Default is to restore from JAR files in deployment directories.
executeA boolean value indicating whether the command should be executed. A value of false only generates the restore report. A value of true generates the report and also executes the command.No. Default value is false.
deploydirectoriesUpdated deployment directories for the node. See Table 8.73, “install command parameters” for more details on this parameter.No. Default is value set when node was installed.
nodedeployOptional node deploy configuration file. This parameter can only be specified if the application parameter is specified.No. Default values are built-in.
substitutionsComma separated list of <name>=<value> pairs used to replace substitution variables in application definition and node deploy configuration files. A value specified in substitutions takes precedence over a value specified in substitutionfile if they both specify a value for the same name.No. No default value.
substitutionfileA file containing new-line terminated <name>=<value> pairs used to replace substitution variables in application definition and node deploy configuration files. Blank lines, and lines beginning with a #, are ignored. A value specified in substitutions takes precedence over a value specified in substitutionfile if they both specify a value for the same name.No. No default value.

start command

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

Table 8.76. start command parameters

NameDescriptionRequired
autostartA boolean value controlling whether any engines are auto-started when the node is started. A value of true will automatically start any engines. A value of false will leave the engines stopped.No. Default value is true.
installpathNode installation directory. May be absolute or relative to the current directory. This parameter must be specified to restart the node coordinator if it was previously stopped using the terminate command.No. Default is <current working directory>/<node name>.
maxretriesAmount of time in seconds to wait for node to start.No. Default value is 300 seconds.
producthomeLocation of the product installation on the host specified by the hostname parameter. This parameter can only be specified when the installpath parameter is also specified.No. Default value is based on the location of the epadmin executable on the local host.

stop command

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 command

Terminate the node coordinator.

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

terminate node

upgrade command

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:

  1. Validate that all classes being upgraded have a partition mapper installed, unless the allownonpartitioned parameter is set to true.

  2. Leave the cluster. All partitions with this node as the active node will migrate to a replica.

  3. Stop the node.

  4. Update the deployment directories for the node if deploydirectories is set on the command line.

  5. Remove all managed objects for classes being upgraded.

  6. Restart the node.

  7. Add this node as a replica to all partitions that were active on this node and join the cluster.

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

  1. Update the deployment directories for the node if deploydirectories is set on the command line.

  2. Remove all managed objects for classes being restored.

  3. Start the node.

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

Table 8.77. upgrade command parameters

NameDescriptionRequired
upgradefileFile containing the list of classes to upgrade. This file is generated by the upgrade tool. All non-absolute paths are relative to the node installpath directory.Yes.
allownonpartitionedA boolean value indicating whether an upgrade should be allowed if there are instances of non-partitioned objects in shared memory. Setting this value to true allows upgrades to continue, but all non-partitioned objects are deleted as part of the upgrade process.No. Default value is false.
applicationOptional application archive to upgrade on node.No. Default is to upgrade from JAR files in deployment directories.
deploydirectoriesUpdated deployment directories for the node. See Table 8.73, “install command parameters” for more details on this parameter.No. Default is value set when node was installed.
executeA boolean value indicating whether the command should be executed. A value of false only generates the upgrade report. A value of true generates the report and also executes the command.No. Default value is false.
jvmnamesA comma-separated list of JVM names to be used when searching for JVM specific deploy directories, when updating into a freshly installed node.No. Default value is an empty list.
nodedeployOptional node deploy configuration file. This parameter can only be specified if the application parameter is specified.No. Default values are built-in.
substitutionsComma separated list of <name>=<value> pairs used to replace substitution variables in application definition and node deploy configuration files. A value specified in substitutions takes precedence over a value specified in substitutionfile if they both specify a value for the same name.No. No default value.
substitutionfileA file containing new-line terminated <name>=<value> pairs used to replace substitution variables in application definition and node deploy configuration files. Blank lines, and lines beginning with a #, are ignored. A value specified in substitutions takes precedence over a value specified in substitutionfile if they both specify a value for the same name.No. No default value.

operator target

Manage operators.

display command

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

Table 8.78. display command parameters

NameDescriptionRequired
engineEngine name filter.No. Default display all operators on all engines.
pathPath filter. See the section called “Path notation”.No. Default display all operators at all paths.
typeOperator type filter.No. Default display all operator types.

get command

Get properties for custom operators.

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

Table 8.79. get command parameters

NameDescriptionRequired
engineEngine name filter.No. Default get all properties for all engines.
pathPath filter. See the section called “Path notation”.No. Default get all properties at all paths.
propertyProperty name filter.No. Default get all properties.

resume command

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

Table 8.80. resume command parameters

NameDescriptionRequired
engineEngine name filter.No. Default resume all custom operators on all engines.
pathPath filter. See the section called “Path notation”.No. Default resume all custom operators at all paths.

set command

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

Table 8.81. set command parameters

NameDescriptionRequired
engineEngine name filter.No. Default set property for all engines.
pathPath filter. See the section called “Path notation”.No. Default set property at all paths.
propertyProperty name.Yes.
valueProperty value.Yes.

start command

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

Table 8.82. start command parameters

NameDescriptionRequired
engineEngine name filter.No. Default start all custom operators on all engines.
pathPath filter. See the section called “Path notation”.No. Default start all custom operators at all paths.

stop command

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

Table 8.83. stop command parameters

NameDescriptionRequired
engineEngine name filter.No. Default stop all custom operators on all engines.
pathPath filter. See the section called “Path notation”.No. Default stop all custom operators at all paths.

suspend command

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

Table 8.84. suspend command parameters

NameDescriptionRequired
engineEngine name filter.No. Default suspend all custom operators on all engines.
pathPath filter. See the section called “Path notation”.No. Default suspend all custom operators at all paths.

partition target

Display partition information.

display command

Display partition information.

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

Table 8.85. display command parameters

NameDescriptionRequired
namePartition name.No. Default display all partitions.
zoneOnly display partitions in this availability zone.No. Default display partitions in all availability zones.

password target

Change user passwords in a local authentication realm.

change command

Change password.

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

Table 8.86. change command parameters

NameDescriptionRequired
passwordNew password. If not specified, a prompt will be displayed.Yes.
realmLocal authentication realm in which user is defined.No. Default is default-realm.
usernameUser name.Yes.

playback target

Manage playback of recorded application data.

display command

Display playback command status.

display playback
display playback --identifier=1

Table 8.87. display command parameters

NameDescriptionRequired
identifierPlayback identifier.No. Default display all active playback commands.

pause command

Pause an active playback command.

pause playback
pause playback --identifier=1

Table 8.88. pause command parameters

NameDescriptionRequired
identifierPlayback identifier.No. Default pause all active playback commands.

resume command

Resume a paused playback command.

resume playback
resume playback --identifier=1

Table 8.89. resume command parameters

NameDescriptionRequired
identifierPlayback identifier.No. Default resume all paused playback commands.

set command

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

Table 8.90. set command parameters

NameDescriptionRequired
asfastaspossibleBoolean to enable running simulation as fast as possible. A value of true will attempt the simulation as fast as possible.One of asfastaspossible or ratepersecond must be specified. No default.
identifierPlayback identifier.No. Default all active playback commands.
ratepersecondThe tuple playback rate per second expressed as a double value.One of asfastaspossible or ratepersecond must be specified. No default.

start command

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).

Table 8.91. start command parameters

NameDescriptionRequired
asfastaspossibleBoolean to enable running simulation as fast as possible. A value of true will attempt the simulation as fast as possible.No. Default is false.
connecttimeMaximum time in seconds to wait for the fragment to become availableNo. Default is ten seconds.
csvfilePath to data file to copy to node machine for use by the simulation.No. No default.
engineEngine name filter.No. Default start playback on all engines.
maxtimeMaximum time in seconds to run simulation.No. Default is no maximum value.
maxtuplesMaximum number of tuples to generate.No. Default is no maximum value.
multiplierSpeed up multiplier for all streams in the simulation as a double value.No. Default is no multipler.
pathContainer name. Playback is started for this container.No. Default is default container.
prefilltuplebufferBoolean controlling whether the tuple buffer should be filled before sending the first tuple when using data files or JDBC data sources. A value of true will prefill the tuple buffer.No. Default is false.
simulationfilePath to simulation file. Simulation file is copied to the node machine, however, any referenced files in the simulation file are not automatically copied to the node machine. The csvfile parameter can be used to copy these files to the node machine.Yes.
tuplebuffersizeMaximum number of tuples to buffer on each stream. A value of 0 disables all buffering.No. Default is 100.

stop command

Stop a playback command.

stop playback
stop playback --identifier=1

Table 8.92. stop command parameters

NameDescriptionRequired
identifierPlayback identifier.No. Default stop all active playback commands.

wait command

Wait for a playback command to complete.

wait playback
wait playback --identifier=1

Table 8.93. wait command parameters

NameDescriptionRequired
identifierPlayback identifier.No. Default wait for all active playback commands.

querytable target

Display and read query tables.

display command

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

Table 8.94. display command parameters

NameDescriptionRequired
engineEngine name filter.No. Default display all query tables on all engines.
pathPath filter. See the section called “Path notation”.No. Default display all query tables at all paths.

read command

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}.

Table 8.95. read command parameters

NameDescriptionRequired
engineEngine name filter.No. Default read all query tables on all engines.
formatAn enumeration value to control the output format of rows. Valid values are csv and json.No. Default is csv.
limitAn integer value limiting the number of rows to return. A value of 0 is no limit.No. Default value is 10.
nullstringNull string indicator in csv formatted output.No. Default is null.
pathPath filter. See the section called “Path notation”.No. Default read all query tables at all paths.
queryscopeAn enumeration value to control the scope of the read query. Valid values are cluster and node.No. Default is cluster.
quotecharQuote character value in csv formatted output.No. Default is ".
verboseBoolean value to control whether row output contains engine and path information. A value of true will include engine and path information in the row output.No. Default is false.
whereAn EventFlow predicate condition. The predicate must evaluate to true to include the row in the output.No. Default is true (include all rows).

realm target

Authentication realm management.

backup command

Backup a local authentication realm.

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

Table 8.96. backup command parameters

NameDescriptionRequired
nameRealm name.No. Default value is default-realm.
fileClient-side file name.Yes.

display command

Display realm information.

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

Table 8.97. display command parameters

NameDescriptionRequired
nameRealm name.No. Default is display all realms.

getadmin command

Return authentication realm being used for node administration.

getadmin realm

restore command

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

Table 8.98. restore command parameters

NameDescriptionRequired
fileRestore from this backup file.Yes.
nameRealm name.No. Default value is default-realm.

setadmin command

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

Table 8.99. setadmin command parameters

NameDescriptionRequired
nameNew realm name.No. Default value is default-realm.
newrealmpasswordAdministration user password in the new authentication realm.No. Default value is an empty password. If not specified, and newrealmusername is specified, a password prompt is displayed.
newrealmusernameAdministration user in the new authentication realm.No. Default value is operating system user executing command.

record target

Manage recording of application data.

display command

Display record command status.

display record
display record --identifier=1

Table 8.100. display command parameters

NameDescriptionRequired
identifierRecord identifier.No. Default display all active record commands.

start command

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

Table 8.101. start command parameters

NameDescriptionRequired
connecttimeMaximum time in seconds to wait for the fragment to become available.No. Default is ten seconds.
engineEngine name filter.No. Default start playback on all engines.
nameRecord name.Yes.
directoryOutput directory for recorded data. This directory must exist on the node machine and be writeable.No. Default is node directory.

stop command

Stop a record command.

stop record
stop record --identifier=1

Table 8.102. stop command parameters

NameDescriptionRequired
identifierRecord identifier.No. Default stop all active record commands.

router target

Display router information.

display command

Display router information.

display router
display router --name=my-router

Table 8.103. display command parameters

NameDescriptionRequired
nameRouter name.No. Default display all routers.

secret target

Master secret management and data encryption.

create command

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

Table 8.104. create command parameters

NameDescriptionRequired
keystoreKey store file name. This file is created. It cannot exist.Yes.
keystorepasswordKey store file password.No. If not specified, a password prompt is displayed.

encrypt command

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

Table 8.105. encrypt command parameters

NameDescriptionRequired
keystoreKey store file.Yes.
keystorepasswordKey store file password.No. If not specified, a prompt is displayed for the password.
dataData to be encrypted.No. If not specified a prompt is displayed for the data.

load command

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

Table 8.106. load command parameters

NameDescriptionRequired
keystoreKey store file to load to node.Yes.
keystorepasswordKey store file password.No. If not specified, a prompt is displayed for the password.

services target

Use service discovery to discover nodes on the local network.

browse command

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"

Table 8.107. browse command parameters

NameDescriptionRequired
servicetypeBrowse for this service type.No. Default is show all service types.
servicenameBrowse for this service name.No. Default is show all discovered services.
intervalThe number of seconds to wait between service discovery broadcasts while browsing.No. Default is ten seconds.
iterationsThe number of browse operations to perform before exiting.No. Default is browse until interrupted.
detailedBoolean value controlling detailed output. Cannot be used with showproperty parameter.No. Default is false.
showpropertyDisplay a specific property for a service if property set. Cannot be used with detailed parameter.No. No default value.
propertiesComma separated list of <name>=<value> pairs used to filter returned services.No. Default value is an empty list.

display command

Display services.

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

Table 8.108. display command parameters

NameDescriptionRequired
servicetypeService type to discover.No. Default is show all service types.
servicenameService name to discover.No. Default is show all discovered services.
detailedBoolean value controlling detailed output. Cannot be used with showproperty parameter.No. Default is false.
showpropertyDisplay a specific property for a service if property set. Cannot be used with detailed parameter.No. No default value.
propertiesComma separated list of <name>=<value> pairs used to filter returned services.No. Default value is an empty list.

verify command

Verify that service discovery is working correctly.

verify services
verify services --mode=verification-type

Table 8.109. verify command parameters

NameDescriptionRequired
modeDiscovery verification mode. May be one of server (starts a discovery server), client (sends a discovery request), or clientserver (does both).No. Default value is clientserver.

[Note]

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

snapshot target

Create and manage snapshot archive files.

Diagnostic information is captured by the snapshot target. The snapshot target creates an archive containing log files and other information required to help troubleshoot problems. A snapshot archive can be captured for an active or a failed node.

Snapshots are taken against active nodes using the adminport and hostname or servicename global parameters.

Snapshots are taken against failed nodes using the installpath parameter.

create 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

Table 8.110. create command parameters

NameDescriptionRequired
descriptionOptional description to include in archive. If specified a file named description.txt is included in the snapshot archive with the specified description.No. No default value.
destinationOptional destination directory for archive.No. Default directory is <node directory>/../snapshots/<node name>.
includeclasspathsOptional boolean value on whether or not to include the contents of a node's classpath directories.No. Default value is false.
installpathOptional node installation path. This parameter can be used to specify the node directory to create a snapshot archive if the node is not operational.Yes, if node not operational, otherwise optional. No default value.

statistics target

Access and control runtime statistics collection.

Details on the statistics data gathered, and their meaning, can be found in the TIBCO StreamBase® Runtime Performance Tuning Guide.

Supported statistics are defined in Table 8.111, “Supported statistics”. The columns in the table have these meanings:

  • Statistic - Statistic name

  • Description - Brief description.

  • Enable / Disable - Yes indicates that the statistic must be explicitly enabled to start collection and disabled to stop collection.

  • Clear - Yes indicates that the statistic value can be cleared.

  • Detailed - Yes indicates that detailed output is available for the statistic.

  • Filter - Indicates whether filtering is support for the statistic. For statistics that support filtering, the valid filter values are java or none. A value of java indicates that statistics are only reported for Java managed objects. A value of none reports statistics for all managed objects.

Table 8.111. Supported statistics

StatisticDescriptionEnable / DisableClearDetailedFilter
activetransactionsActive TransactionsNoNoNoNo
allocationsummaryAllocator Allocation SummaryNoNoNoNo
allocatorbucketsAllocator BucketsNoNoYesNo
allocatorsummaryAllocator SummaryNoNoNoNo
blockedtransactionsBlocked TransactionsNoNoNoNo
classtransformClass TransformationNoYesYesNo
cpuCPU UtilizationYesNoNoNo
deadlockDeadlockNoYesYesNo
diskDiskYesNoNoNo
distributionchannelDistribution NetworkYesYesYesNo
distributionnodeDistributionNoYesNoNo
engineNode ProcessesNoNoNoNo
eventbusShared Memory IPCNoYesYesNo
eventlogShared Memory IPC DetailedYesYesNoNo
filesFilesNoNoNoNo
hashShared Memory HashingNoNoYesNo
hostKernel InformationNoNoNoNo
javacacheJNI CacheNoYesNoNo
javastackJava StackNoNoNoNo
javatransactionTransactionYesYesYesNo
jniRuntime JNI CallsYesYesNoNo
localmutexLocal MutexYesYesYesNo
memoryusageMemory UsageNoYes*NoNo
mutexShared Memory MutexYesYesYesNo
namedcacheNamed CachesNoYesNoNo
nativeNative Runtime CallsNoYesNoNo
navigationQueryNoYesNojava or none. Default is java.
networkNetworkYesNoNoNo
objectObjectsNoYesNojava or none. Default is java.
partitionPartitionNoYesNoNo
sarSystem Activity ReporterYesNoNoNo
systeminfoSystem InformationNoNoNoNo
threadsSystem ThreadsNoNoNoNo
timerTimersNoNoNoNo
transactionTransaction LockingYesYesYesjava or none. Default is java.
transactioncontentionTransaction ContentionYesYesNojava or none. Default is java.
transactionpromotionTransaction PromotionYesYesNojava or none. Default is java.
vmstatVirtual MemoryYesNoNoNo

* - clearing memoryusage only clears the memory throttle statistics.

clear command

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"

Table 8.112. clear command parameters

NameDescriptionRequired
statisticsComma separated list of statistics. See Table 8.111, “Supported statistics” for a complete list of valid statistics.Yes.

disable command

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"

Table 8.113. disable command parameters

NameDescriptionRequired
statisticsComma separated list of statistics. See Table 8.111, “Supported statistics” for a complete list of valid statistics.Yes.

display command

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"

Table 8.114. display command parameters

NameDescriptionRequired
statisticsComma separated list of statistics. See Table 8.111, “Supported statistics” for a complete list of valid statistics.Yes.
detailedBoolean indicating whether detailed values should be displayed. See Table 8.111, “Supported statistics” for statistics that support detailed output.No. Default value is false.
filterFilter statistics output. See Table 8.111, “Supported statistics” for statistics that support filtering and valid filter values. Only a single filter value may be specified for a list of statistics.No. Default value is statistics specific.
labelA value to add to the header in non-delimited output.No. No default.

enable command

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"

Table 8.115. enable command parameters

NameDescriptionRequired
statisticsComma separated list of statistics. See Table 8.111, “Supported statistics” for a complete list of valid statistics.Yes.

snapshot command

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

Table 8.116. snapshot command parameters

NameDescriptionRequired
statisticsComma separated list of statistics. See Table 8.111, “Supported statistics” for a complete list of valid statistics.Yes.
secondsThe number of seconds to collect data.Yes.
warmupsecondsThe number of seconds to wait before starting the snapshot collection cycle.No . Default value is 0.
detailedValue passed to the display command in the snapshot collection cycle.No. No default value.
filterValue passed to the display command in the snapshot collection cycle.No. No default value.
serializeSerialize collection of statistics if true. A separate collection cycle is executed for each statistic being collected, starting with the warm up sleep.No. Default value is false.

status command

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

status statistics

supported command

Display supported statistics.

supported statistics

stream target

Interact with EventFlow streams.

dequeue command

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"

Table 8.117. dequeue command parameters

NameDescriptionRequired
engineEngine name filter.No. Default dequeue all streams on all engines.
formatAn enumeration value to control the output format of dequeued tuples. Valid values are csv and json.No. Default is csv.
nullstringNull string indicator in csv formatted output.No. Default is null.
pathPath filter. See the section called “Path notation”.No. Default dequeue all streams at all paths.
quotecharQuote character value in csv formatted output.No. Default is ".
timestampBoolean value to control whether tuple output contains a timestamp. A value of true will include a timestamp in the tuple output.No. Default is false.
timestampformatA string value specifying the timestamp format to use. The timestamp format is defined by the Java SimpleDataFormat class.No. Default is yyyy-MM-dd HH:mm:ss.SSSZ.
verboseBoolean value to control whether tuple output contains engine and path information. A value of true will include engine and path information in the tuple output.No. Default is false.
whereAn EventFlow predicate condition. The predicate must evaluate to true to include the tuple in the output.No. Default is true (include all tuples).

display command

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

Table 8.118. display command parameters

NameDescriptionRequired
detailedBoolean value to control whether detailed stream information, e.g. schema, total tuples, etc. should be included in the output. A value of true will include detailed output.No. Default is false.
engineEngine name filter.No. Default display all streams on all engines.
pathPath filter. See the section called “Path notation”.No. Default display all streams at all paths.
typeAn enumeration value to filter the type of streams to display. Valid values are input, output, and all.No. Default is all.

enqueue command

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.

Table 8.119. enqueue command parameters

NameDescriptionRequired
engineEngine name filter.No. Default enqueue to all streams on all engines.
formatAn enumeration value to control the input format of enqueued tuples. Valid values are csv and json.No. Default is csv.
inputRead input from this file or standard input. A value of - will read from standard input.No. Default is -.
nullstringNull string indicator in csv formatted input.No. Default is null.
pathPath filter. See the section called “Path notation”.No. Default enqueue to all streams at all paths.
quotecharQuote character value in csv formatted input.No. Default is ".

systemservice target

Windows system service management.

[Warning]

This command is only supported on the Windows platform.

install command

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

Table 8.120. install command parameters

NameDescriptionRequired
applicationPath to application archive.No. No default value. If not specified node is started without an application.
displaynameService display name.No. Default value is name parameter value.
nameService name.Yes.
nodedeployPath to node deploy configuration file. Can only be specified if application parameter is also specified.No. No default value.
nodedirectoryPath of the parent directory that will contain the node installation directory. The node installation directory is <nodedirectory>\<nodename>.Yes.
nodenameFully qualified node service name.Yes.
passwordUser account password. If not specified with a non-builtin Windows account (LocalService, NetworkService, or LocalSystem) username a password prompt is displayed.No. No default value.
startupAn enumeration specifying the service startup behavior. Valid values are automatic, delayed, and manual.No. Default value is manual.
substitutionfilePath to substitution file (see the section called “Substitution variables”). Can only be specified if application parameter is also specified.No. No default value.
usernameUser account to use for service. This parameter must be specified as <domain-name>\<user-name>. The local domain must be specified using a period (.). The NT AUTHORITY domain name must be used for the builtin LocalService and NetworkService accounts.No. Default value is the LocalSystem account.

remove command

Remove an installed system service.

remove systemservice --name="my-service"

Table 8.121. remove command parameters

NameDescriptionRequired
nameService name.Yes.

trusted target

Display trusted host information.

display command

Display trusted host information.

display trusted

tunable target

Manage runtime tunable variables.

Tuning runtime variables is done using the tunable target. Runtime variables set using the tunable target are only valid until a node or engine is stopped.

Supported tunable variables are defined in Table 8.122, “Supported tunable variables”.

  • Category - Variable category.

  • Variable Identifier - Variable identifier.

  • Scope - Variable scope. A variable is scoped either to a node, or a specific engine running on a node. Node scope is specified with a literal value of Node, while engine scope is specified using the engine name.

  • Description - Variable description.

The full name of a tunable variable is <category-name>.<variable-name>, for example flusher.flushIntervalSeconds, where flusher is the category name and flushIntervalSeconds is the variable identifier.

Table 8.122. Supported tunable variables

CategoryVariable IdentifierScopeDescription
datatransportkeepAliveSendIntervalSecondsNodeKeep-alive send interval in seconds.
datatransportnonResponseTimeoutSecondsNodeNon-response timeout in seconds.
datatransportdeferredWritesEnabledNodeControl deferred distributed writes.
enginetimerParallelismEngine nameTimer execution parallelism.
enginetimerResolutionMillisecondsEngine nameTimer resolution in milliseconds.
engineminimumDispatchThreadsEngine nameMinimum number of dispatch threads.
enginemaximumDispatchThreadsEngine nameMaximum number of dispatch threads.
engineshutdownTimerSecondsEngine nameThe engine shutdown timer in seconds.
eventbusnoDestinationTimeoutSecondsNodeThe time in seconds to wait for an engine to start when dispatching work.
flusherflushIntervalSecondsNodeThe shared memory flusher wakeup interval in seconds.
flushermaximumObjectsPerTypeNodeThe maximum number of objects to flush per flush interval.
memorythrottlethresholdPercentageNodeThe percentage of shared memory utilization at which to throttle.
memorythrottlechecksPerSecondNodeThe number of checks per second that the memory throttle threshold should be checked.
transactiontimeoutSecondsNodeDistributed deadlock timeout value in seconds.
transactionnumberCompletedTransactionsNodeNumber of completed transactions to maintain in the transaction history.
transactionmaximumBackoffMillisecondsNodeMaximum amount of time, in milliseconds, the deadlock back-off algorithm will wait before retrying a transaction.

get command

Get current tunable variable values.

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

Table 8.123. get command parameters

NameDescriptionRequired
categoryCategory name filter.No. Default value is all categories.
nameVariable name filter, specified as <category-name>.<variable-name>No. Default value is all variables.

set command

Set a tunable variable.

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

Table 8.124. set command parameters

NameDescriptionRequired
nameVariable name filter, specified as <category-name>.<variable-name>Yes.
valueVariable value. Simple value or an array. Arrays are specified as comma separated values. An array element that contains a comma must be enclosed in single-quotes.Yes.
scopeVariable scope, either Node or a valid engine name.No. Default value is Node.

reset command

Reset a tunable value to its initial value.

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

Table 8.125. reset command parameters

NameDescriptionRequired
nameVariable name filter, specified as <category-name>.<variable-name>Yes.
scopeVariable scope, either Node or a valid engine name.No. Default value is Node.

user target

Manage users in a local authentication realm.

add command

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

Table 8.126. add command parameters

NameDescriptionRequired
lockedBoolean to lock the user's account. true locks the account, false leaves the account unlocked.No. Default value is false.
passwordPassword. If not provided, a prompt is displayed.Yes.
passwordexpirationdaysPassword expiration time, in days. A value of 0 means that the password does not expire.No. Default value is 0.
realmAdd user to this local authentication realm.No. Default value is default-realm.
rolesComma separated list of roles to which this user belongs.Yes. At least one must be specified.
usernameUser name.Yes.

display command

Display local authentication realm users.

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

Table 8.127. display command parameters

NameDescriptionRequired
realmFilter output to a specific realm.No. All local authentication realms displayed by default.

remove command

Remove a user.

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

Table 8.128. remove command parameters

NameDescriptionRequired
realmRemove user from this local authentication realm.No. Default value is default-realm.
usernameUser name.Yes.

update command

Update an existing user's account values.

[Note]

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

Table 8.129. update command parameters

NameDescriptionRequired
lockedBoolean to lock the user's account. true locks the account, false leaves the account unlocked.No. Default value is false.
passwordexpirationdaysPassword expiration time, in days. A value of 0 means that the password does not expire.No. Default value is 0.
realmUpdate user in this local authentication realm.No. Default value is default-realm.
rolesComma separated list of roles to which this user belongs.Yes. At least one must be specified.
usernameUser name.Yes.

version target

Display product version information.

display command

Display product version information.

display version
display version --detailed

Table 8.130. display command parameters

NameDescriptionRequired
detailedBoolean value controlling whether to include detailed product version information.No. Default value is false.