List servers command lists the locally running UltraESB instances. The short form of the command is ’ls` which is equivalent to calling it’s long form'list-servers’

Available options for the list servers command are described in the following table.

If no options were given it lists only the servers name followed by the process id separated with a hyphen (-), you can use this command to discover the UltraESB instances running locally on the same host.

This command is useful in identifying a specific instance, to connect to with the connect command, when there are more than one instances running locally on the same host.

Connect command connects to the specified UltraESB instance over its Java Management Extension (JMX) address. The short form of the command is ’con` which is equivalent to calling it’s long form'connect’

Available options for the connect command are described in the following table.

Use the JMX URL of the UltraESB instance to connect to it. If connecting to a locally running UltraESB instance, use the server name (as displayed by the 'ls' command) to connect to local servers. If no address or server name is provided the connect command tried to connect to a locally running UltraESB instance.

If connecting to a remote UltraESB instance over remote JMX with security, the username and password options should be given with the corresponding username and password to be used in password authentication at connection time. If wrong credentials or no credentials were given in connecting to an UltraESB instance with remote secure JMX access, the connection will fail.

Refreshes the specified UltraESB server. The short form of the command is ’con` which is equivalent to calling it’s long form'connect’

Available options for the connect command are described in the following table.

Check server state command is used to check the UltraESB server status. The short form of the command is ’sstchk` which is equivalent to calling it’s long form'server-state-check’

Available options for the check server state command are described in the following table.

Using the check server state with a script to periodically check it, you can check the status of the UltraESB server. This command prints the server status as one of the following strings with the respective meaning.

Restart server command is used to restart the running UltraESB instance or a cluster of UltraESB instances. The short form of the command is ’srstr` which is equivalent to calling it’s long form'server-restart’

Available options for the restart server command are described in the following table.

Using the restart command you can restart a server in 2 possible options.

The restart server command used with clustering by passing '-w' option allows the cluster restart to be done in a round robin fashion with the specified round robin delay between 2 server restarts in the cluster.

This command is very useful in managing a complete cluster.

Stop server command is used to stop the running UltraESB instances. The short form of the command is ’stps` which is equivalent to calling it’s long form'stop-server’

Available options for the stop server command are described in the following table.

Using the stop command you can stop a server in 2 possible options.

This command is useful in managing a cluster, where as a server can be stopped and wait for some action to take place and then start the server without terminating the JVM.

Start server command is used to start a stopped UltraESB instance. The short form of the command is ’strs` which is equivalent to calling it’s long form'start-server’

Available options for the start server command are described in the following table.

This command is useful in starting a server or a cluster and waiting for some action to take place and then start the server without terminating the JVM.

Shut down server command is used to shut down the UltraESB instances. The short form of the command is ’sshd` which is equivalent to calling it’s long form'server-shutdown’

Available options for the stop server command are described in the following table.

Using the shutdown command you can stop a server in 2 possible options.

Show connected server name command is used the check currently connected server name of the Uterm. The short form of the command is ’shcsn` which is equivalent to calling it’s long form'show-connected-server-name’

Available options for the show-connected-server-name command are described in the following table.

This command is useful to check whether Uterm is connected to the required server and if not user can connected to relevant node using connect command.

Show connected server name command is used the check currently connected server address of the Uterm. The short form of the command is ’shcsa` which is equivalent to calling it’s long form'show-connected-server-address’

Available options for the show-connected-server-address command are described in the following table.

This command is useful to check whether Uterm is connected to the required server and if not user can connected to relevant node using connect command.

Stop acting-as command is used to stop an UltraESB instance acting-as the given server name of an UltraESB node which this node previously started to act as. The short form of the command is ’stpact` which is equivalent to calling it’s long form'stop-acting-as’

Available options for the stop acting-as command are described in the following table.

This command is useful in stopping pinned proxy services that this node is running pinned to another server (may be because of a failure of that node), in a non clustered environment.

Start acting-as command is used to start an UltraESB instance acting-as the given server name of an UltraESB node which needs to be acted as. The short form of the command is ’stract` which is equivalent to calling it’s long form'start-acting-as’

Available options for the start acting-as command are described in the following table.

This command is useful in transferring pinned proxy services of a failed node into a running UltraESB instance, in a non clustered environment.

Check the user defined status code for the UltraESB server. The short form of the command is ’sudscg` which is equivalent to calling it’s long form'server-user-defined-status-code-get’

Available options for the start acting-as command are described in the following table.

Check the user defined status code for the UltraESB server. The short form of the command is ’sudscs` which is equivalent to calling it’s long form'server-user-defined-status-code-set’

Available options for the start acting-as command are described in the following table.

Check the user defined status code for the UltraESB server

Add or update deployment unit command adds new deployment unit or update an existing deployment unit via a dynamic sub context of an UltraESB instance or a cluster of instances. The short form of the command is ’duau` which is equivalent to calling it’s long form'deployment-unit-add-or-update’

Available options for the add or update deployment unit command are described in the following table.

To invoke this command it is mandatory to specify the deployment unit name as the name argument, this provides the folder name of the deployment unit to look for configurations to be added or updated.

This command is useful in updating the configuration of a production UltraESB cluster or a single instance without any down time, yet the transition being completely graceful (live updates of the UltraESB).

Purge all deployment units command removes outdated deployment units of an UltraESB instance or a cluster of instances. The short form of the command is ’dupa` which is equivalent to calling it’s long form'deployment-unit-purge-all’

Available options for the purge all deployment units command are described in the following table.

To remove stale deployment units which are being stacked due to execution of deployment-unit-add-or-update command, use this command. This command removes all the outdated deployment units at the execution point. The execution of this command should be done after making sure all the messages accepted by the deployment unit before the last update.

This command is useful in removing stale deployment units of a production UltraESB cluster to gain a little bit of memory.

Unload deployment command unloads an existing live deployment unit of an UltraESB instance or a cluster of instances. The short form of the command is ’duu` which is equivalent to calling it’s long form'deployment-unit-unload’

Available options for the unload configuration command are described in the following table.

To invoke this command the '-a' or '-n' option is mandatory. The '-a' option unloads all the executing deployment units. The '-n' option  will unload only the deployment unit, which is specified as the argument.

This command is useful in unloading a particular deployment unit or all the deployment units of an UltraESB cluster or a single instance in an integration environment.

List proxy services command lists the proxy services deployed on a running UltraESB instance. The short form of the command is ’psl` which is equivalent to calling it’s long form'proxy-service-list’

Available options for the list proxy services command are described in the following table.

If no options were given it lists only the proxy services in the started state, you can use this command with '-a' option to list all the proxy services regardless of the state. You can get a tabular dataset describing the proxy while listing it by passing the '-i' option.

If '-i' option is passed, the '-s' option makes no sense as it already prints the state.

Get proxy service command gives a representation of a proxy service with the given identifier deployed on a running UltraESB instance. The short form of the command is ’psv` which is equivalent to calling it’s long form'proxy-service-view’

Available options for the get proxy service command are described in the following table.

This command is useful in scripting where you want to get certain attributes of a proxy service to automate some action.

Disable debug of proxy service command disables debugging of the proxy service with the given identifier deployed on a running UltraESB instance. The short form of the command is ’ddbps` which is equivalent to calling it’s long form'proxy-service-debug-disable’

Available options for the disable debug of proxy service command are described in the following table.

This command is useful to disable debug for a specific proxy service that has been enabled debug previously to figure out some situation with that proxy, cluster wide, both in integration as well as production environments.

Enable debug of proxy service command enables debugging of the proxy service with the given identifier deployed on a running UltraESB instance. The short form of the command is ’psdbe` which is equivalent to calling it’s long form'proxy-service-debug-enable’

Available options for the enable debug of proxy service command are described in the following table.

This command is useful to enable debug for a specific proxy service that needs to examine the debug logs to figure out some situation with that proxy, cluster wide, both in integration as well as production environments.

Reset statistics of proxy service command resets the collected statistics at that point of the proxy service with the given identifier deployed on a running UltraESB instance. The short form of the command is ’psstrst` which is equivalent to calling it’s long form'proxy-service-statistics-reset’

Available options for the reset statistics of proxy service command are described in the following table.

This command is useful to reset statistics for a specific proxy service collected so far (or to set the statistics meter to zero) that needs to examined, cluster wide, on production environments.

Stop proxy service command is used to stop a running proxy service deployed on an UltraESB instance. The short form of the command is ’psstp` which is equivalent to calling it’s long form'proxy-service-stop’

Available options for the stop proxy service command are described in the following table.

This command is useful in stopping a specific proxy service in a single instance or a cluster of instances which needs to be stopped for maintenance.

Start proxy service command is used to start a stopped proxy service deployed on a running UltraESB instance. The short form of the command is ’psstr’ which is equivalent to calling it’s long form 'proxy-service-start'

Available options for the start proxy service command are described in the following table.

This command is useful in starting a proxy service in a single instance or a cluster of instances which has been stopped previously for some maintenance.

List endpoints command lists the endpoints deployed on a running UltraESB instance. The short form of the command is ’lep` which is equivalent to calling it’s long form'list-endpoints’

Available options for the list endpoints command are described in the following table.

If no options were given it lists only the endpoints in the started state, you can use this command with '-a' option to list all the endpoints regardless of the state. You can get a tabular dataset describing the endpoints while listing it by passing the '-i' option.

If '-i' option is passed, the '-s' option makes no sense as it already prints the state.

Get endpoint command gives a representation of an endpoint with the given identifier deployed on a running UltraESB instance. The short form of the command is ’getep` which is equivalent to calling it’s long form'get-endpoint’

Available options for the get endpoint command are described in the following table.

This command is useful in scripting where you want to get certain attributes of a endpoint to automate some action.

Disable debug of endpoint command disables debugging of the endpoint with the given identifier deployed on a running UltraESB instance. The short form of the command is ’ddbep` which is equivalent to calling it’s long form'disable-debug-endpoint’

Available options for the disable debug of endpoint command are described in the following table.

This command is useful to disable debug for a specific endpoint that has been enabled debug previously to figure out some situation with that endpoint, cluster wide, both in integration as well as production environments.

Enable debug of endpoint command enables debugging of the endpoint with the given identifier deployed on a running UltraESB instance. The short form of the command is ’edbep` which is equivalent to calling it’s long form'endpoint-debug-enable’

Available options for the enable debug of endpoint command are described in the following table.

This command is useful to enable debug for a specific endpoint that needs to examine the debug logs to figure out some situation with that endpoint, cluster wide, both in integration as well as production environments.

Reset statistics of endpoint command resets the collected statistics at that point of the endpoint with the given identifier deployed on a running UltraESB instance. The short form of the command is ’rststep` which is equivalent to calling it’s long form'endpoint-statistics-reset’

Available options for the reset statistics of endpoint command are described in the following table.

This command is useful to reset statistics for a specific endpoint collected so far (or to set the statistics meter to zero) that needs to examined, cluster wide, on production environments.

Stop endpoint command is used to stop a running endpoint deployed on an UltraESB instance. The short form of the command is ’epstp` which is equivalent to calling it’s long form'endpoint-stop’

Available options for the stop endpoint command are described in the following table.

This command is useful in stopping a specific endpoint in a single instance or a cluster of instances which needs to be stopped for maintenance.

Start endpoint command is used to start a stopped endpoint deployed on a running UltraESB instance. The short form of the command is ’epstr` which is equivalent to calling it’s long form'endpoint-start’

Available options for the start endpoint command are described in the following table.

This command is useful in starting a endpoint in a single instance or a cluster of instances which has been stopped previously for some maintenance.

List sequences command lists the sequences deployed on a running UltraESB instance. The short form of the command is ’sql` which is equivalent to calling it’s long form'sequence-list’

Available options for the list sequences command are described in the following table.

If no options were given it lists only the sequences in the started state, you can use this command with '-a' option to list all the sequences regardless of the state. You can get a tabular dataset describing the sequences while listing it by passing the '-i' option.

If '-i' option is passed, the '-s' option makes no sense as it already prints the state.

Get sequence command gives a representation of a sequence with the given identifier deployed on a running UltraESB instance. The short form of the command is ’sqv` which is equivalent to calling it’s long form'sequence-view’

Available options for the get sequence command are described in the following table.

This command is useful in scripting where you want to get certain attributes of a sequence to automate some action.

Disable debug of sequence command disables debugging of the sequence with the given identifier deployed on a running UltraESB instance. The short form of the command is ’sqdbd` which is equivalent to calling it’s long form'sequence-debug-disable’

Available options for the disable debug of sequence command are described in the following table.

This command is useful to disable debug for a specific sequence that has been enabled debug previously to figure out some situation with that sequence, cluster wide, both in integration as well as production environments.

Enable debug of sequence command enables debugging of the sequence with the given identifier deployed on a running UltraESB instance. The short form of the command is ’ sqdbe` which is equivalent to calling it’s long form'sequence-debug-enable’

Available options for the enable debug of sequence command are described in the following table.

This command is useful to enable debug for a specific sequence that needs to examine the debug logs to figure out some situation with that sequence, cluster wide, both in integration as well as production environments.

Reset statistics of sequence command resets the collected statistics at that point of the sequence with the given identifier deployed on a running UltraESB instance. The short form of the command is ’sqstrst` which is equivalent to calling it’s long form'sequence-statistics-reset’

Available options for the reset statistics of sequence command are described in the following table.

This command is useful to reset statistics for a specific sequence collected so far (or to set the statistics meter to zero) that needs to examined, cluster wide, on production environments.

Stop sequence command is used to stop a running sequence deployed on an UltraESB instance. The short form of the command is ’sqstp` which is equivalent to calling it’s long form'sequence-stop’

Available options for the stop sequence command are described in the following table.

This command is useful in stopping a specific sequence in a single instance or a cluster of instances which needs to be stopped for maintenance.

Start sequence command is used to start a stopped sequence deployed on a running UltraESB instance. The short form of the command is ’sqstr` which is equivalent to calling it’s long form' sequence-start’

Available options for the start sequence command are described in the following table.

This command is useful in starting a sequence in a single instance or a cluster of instances which has been stopped previously for some maintenance.

Change logger level command can be used to change the level of a logger. The short form of the command is ’llch` which is equivalent to calling it’s long form'log-level-change’

Available options for the list servers command are described in the following table.

To invoke this command the '-l' option is mandatory where you have to give the new logger level as the argument. As an example , to change the log level of logger org.adroitlogic.ultraesb.core.ConfigurationImpl from INFO to WARN use command 

List loggers command lists the loggers available in given  . The short form of the command is ’lls` which is equivalent to calling it’s long form'logger-list’

Available options for the list loggers command are described in the following table.

If no option was given it lists all the loggers available in given package level as well as loggers of sub package levels.

As an example to view loggers of all the sub packages of  org.adroitlogic.ultraesb.core, use lls  org.adroitlogic.ultraesb.core which shows shows log levels of o.a.u.core.helper.LoggerUtilsManager,

o.a.u.core.mgt.EndpointManagement, o.a.u.core.Sequence.error-handler . To view the package level logger use,

Add new logger command can be used to add a new command . The short form of the command is ’lad` which is equivalent to calling it’s long form'logger-add’

Available options for the list loggers command are described in the following table.

To invoke this command the '-l' option is mandatory where you have to define the log level of the newly creating logger as an argument. Option '-a' is used to set the additivity of the logger. If you use option '-a' additivity will set to 'true' otherwise to 'false'. As an example to create a new logger with loglevel 'INFO' and additivity 'true' use,

lad -a -l INFO  org.adroitlogic.ultraesb.core.myPackage

Change logger additivity command can be used to change the additivity. The short form of the command is ’ach’ which is equivalent to calling it’s long form 'additivity-change'

Available options for the change logger additivity are described in the following table.

To invoke this command the '-a' option is mandatory where you have to define the additivity you want to change to(true/false) as an argument. As an example, to change the additivity of the logger org.adroitlogic.soapbox.CryptoSupport from false to true use

Watch logs command can be used to watch logs of the connected UltraESB server. The short form of the command is ’lgw’ which is equivalent to calling it’s long form 'log-watch'

Available options for the watch logs are described in the following table.

If no options were given it use default refresh interval which is 3 seconds for log fetching. You can define a custom refresh interval as well. As an example , to watch logs with refresh interval 4 use

Update log appender command can be used to update the Log appenders defined for logging. The short form of the command is 'apu' which is equivalent to calling it’s long form 'log-watch'

Available options for the update log appender are described in the following table.

To change the appender pattern user option '-p' with pattern as parameter. To change the appender thresholdI use option '-t' with threshold as a parameter. You can use one or both options at a time.

As an example to update the appender MEMORY_APPENDER with new pattern %m%n and new threshold WARN use, 

JMS connect and send command connects to the specified connection factory, send messages from the specified producer and receive messages from the consumer specified in the properties file. If a consumer is not specified the command exists after delivering the message. The short form of the command is ’jmssend` which is equivalent to calling it’s long form'jms-connect-and-send’

Available options for the jms send command are described in the following table.

Use Cases

JMS delete all command deletes all the messages in the queue specified by the queue jndi name. The short form of the command is ’jdelall` which is equivalent to calling it’s long form'jms-delete-all’

Available options for the jms delete all command are described in the following table.

Short option key

Use Cases

The read next command reads immediate message in the specified queue. The short form of the command is ’readNextMsg` which is equivalent to calling it’s long form'jms-read-next’

Available options for the jms read next command are described in the following table.

Use Cases

The read all command reads all the messages in the specified queue. The short form of the command is ’jreadAll` which is equivalent to calling it’s long form'jms-read-all’

Available options for the read all command are described in the following table.