Introducing UTerm

UltraESB has a lot of built in management and monitoring capabilities, for the user to select on there preference. All these options however goes via the raw Java Management Extension (JMX) interface. In other words the complete management and monitoring aspect of UltraESB is exposed only via JMX, while it has many mechanisms to connect to this interface. Those mechanisms are as follows;

  1. JMX management tool like JConsole

  2. UTerm

  3. Zabbix monitoring

While the use of JConsole to manage the UltraESB runtime has been briefly illustrated in the previous section, this section introduces Uterm. The Zabbix monitoring and JSON/REST service layer will be discussed under the Configuration and Administration. NOTE: Uterm - Brief Introduction
While this section very briefly introduces the users into UTerm, a descriptive introduction and a reference guide is available under the documentation on Ultra Terminal.

Ultra Terminal (UTerm)

UTerm is the command line management client of the UltraESB, which is shipped in with the standard binary distribution. This sub section introduces the UTerm and it shows the usage of UTerm to manage the UltraESB.

Starting the UTerm is just a matter of running the uterm script found in the bin directory of the ULTRA_HOME installation directory.

On Linux systems navigate to the "bin" directory of the installation home and execute the "" script to start the UTerm.

$ cd $ULTRA_HOME/bin
$ ./

Upon executing the above script the uterm prompt displays on the command line as follows;

$ sh bin/

Welcome to the UltraESB UTerm (interactive mode)
'Type 'help' for the list of commands


With this UTerm has entered into the interactive mode of operation, and provided that the UltraESB instance is running locally you can now interact with the UltraESB instance.

While this introduction uses the "Interactive mode" the UTerm is available in "Scriptable standalone mode" too, which will be useful in automated management with scripts. Further, if you want to manage a remote UltraESB instance you can use the "connect" command or the –server option to specify the connecting UltraESB instance. Follow the complete UTerm manual for more information on advance UTerm usages.

With the UTerm you can use the list proxy services (psl) command to list all the available proxy services of the connected (in this case locally running) UltraESB instance.

uterm> psl

You can also stop (psstp <proxy-service-name>) and start (psstr <proxy-service-name>) proxy services through UTerm. Let’s try stopping echo-proxy.

uterm> psstp echo-proxy
Stopped proxy service echo-proxy

Now when you list the proxy services (psl) again, you will not see 'echo-proxy' proxy service as the "echo-proxy" proxy service is now stopped.

List proxy services command defaults
List proxy services (psl) command by default lists the proxy services in the "Started" state. In order to list all proxy services use the "-a" option

So lets use the "-a" option to list all the proxy services.

uterm> psl -a

Now we want to see which proxy services are started and running, and which are not. So lets include another option "-s" to print the state of each and every proxy service, while listing.

uterm> psl -as
echo"-back     Started
health-check    Started
echo"-proxy    Stopped

Here you can see the echo-proxy is stopped and the echo-back is started. To get the complete information listing, use the "-asi" option.

uterm> psl -asi
echo-back     Started  echo-back-inSequence     --                        --                      --                         false
health-check  Started  health-check-inSequence  --                        --                      --                         false
echo-proxy    Stopped  --                       echo-proxy-inDestination  echo-proxy-outSequence  echo-proxy-outDestination  false

To start the proxy service "echo-proxy" that was previously stopped use start proxy service (psstr) command can be used.

uterm> psstr echo-proxy
Started proxy service echo-proxy

Now if you list the services with there states you will be able to see that the "echo-proxy" is in started state.

uterm> psl -as
echo-back     Started
health-check  Started
echo-proxy    Started

You may verify that the proxy service is running by sending a message to the proxy service with the SOA Toolbox as described in the previous section on Sending a Message through UltraESB.

Capabilities of UTerm are much more than what has been discussed in this introduction and it is used to manage a complete cluster gracefully with just one command and so forth. Please follow the Ultra Terminal documentation for all the commands and options available with UTerm.

In this topic
In this topic
Contact Us