UTerm Configurations

This section provides a complete reference of possible customizations and configurations available for the UTerm. This document discusses command configurations like providing UltraESB instance connection configurations to the connect command and UTerm preferences.

All these configurations are done via the uterm.properties file located in the conf directory of the UltraESB installation.

UltraESB server instance definition

You can define UltraESB instances that the UTerm is connecting frequently as named server instances via the uterm.properties file.

In a usual connect command you need to provide the complete remote JMX URL of the UltraESB instance. This has major drawbacks like you have to remember the JMX URL, or at least copy-paste it every time you want to monitor an UltraESB instance. Situation gets worst when the remote JMX access is secured with password authentication (which is the usual case in any production deployment), where you have to specify the –username and the –password options too.

While this might be convenient if you just need to connect to a random UltraESB instance just to check something, if you have a well known UltraESB instance or a cluster of instances that you monitor/manage day-today, or even once a week, it is more convenient for you to be able to ask the UTerm to connect to that instance passing a identifier.

The server instance definition in the uterm.properties file addresses exactly this. You can assign a server name or an identifier with a well-known UltraESB instance and optionally define credentials to be used when connecting to that instance. Once configured connecting to that UltraESB instance from the UTerm just requires the identifier or the server name that you used to define that UltraESB instance.

Best Practice - Use hostname as the instace Identifier
Use the hostname of the machine running the UltraESB instance when defining the individual instances, if you have a cluster, so that you can connect to any individual node by using the hostname passed to the connect command.

The definition of the JMX URL of an UltraESB instance should be configured as follows on the uterm.properties file.


Here the identifier could be any string, which can be used to connect to the specified JMX URL as follows.

uterm> con <identifier>

If the remote JMX access is secured the username and the password can be configured with the following properties in addition to the URL.


Multiple instances can be configured for different identifiers and the identifier can be used to connect to the specific instance.

For example the following configuration defines an UltraESB instance with the identifier "esb1";


Now to connect to the UltraESB instance running on esb1 from UTerm, you just need to use;

uterm> con esb1

The identifier "default" is treated as a special identifier, if configured, the UTerm treats it as the default connection URL and credentials. UTerm doesn’t require an explicit connection to the default instance, any command query will be executed over the default instance if you are not connected to any instance.

Default instance doesn’t require connect command
Default instance, if configured doesn’t require a connection. If you have only one UltraESB instance or if you have a preferred instance in a cluster which you most of the time connects to, you can define that as the default, so that you do not need to use the connect command before to query that instance.

Note that even if you have a cluster you could manage all the nodes in the cluster from any single node so having a default server to connect in the cluster will be quite useful too.

UTerm preferences

This sub sections introduces the preferences for the UTerm, where you can customize the behaviour and the look and feel of the UTerm.

Unlike in most of the UNIX based commands UTerm uses a print width of 120 characters by default. As the UTerm is intended to be run on your desktop to manage and monitor the UltraESB instances and today monitor resolutions support lot more than 80 characters (which is the UNIX default print-width), UTerm by default prints 120 characters per line.

However in case of a requirement to run UTerm on a server terminal with lessor resolution, or if you feel comfortable with any other print-width, you can do so by configuring the print-width property in the uterm.properties file.

The exact property name is "ultra.terminal.print-width" and you can assign any sensible integer as the value.


You may also increase the print width beyond 120 characters, using the print-width property.

In this topic
In this topic
Contact Us