llch -l WARN org.adroitlogic.ultraesb.core.ConfigurationImpl
This is the command reference of the UTerm, with commands arranged to the related groups. The complete list of available commands are as follows;
Short Command | Long Command | Description |
---|---|---|
sl |
list the locally running UltraESB instances |
|
srfr |
refresh the server |
|
con |
connects to the specified address, use the server name (as displayed by the 'ls' command) to connect to local servers |
|
sstchk |
check the state of the UltraESB server |
|
srstr |
restarts the UltraESB server or Cluster |
|
sstp |
stops the UltraESB server |
|
sstr |
starts the UltraESB server |
|
sshd |
shutdown the UltraESB server |
|
shcsn |
show name of the currently connected server |
|
shcsa |
show name of the currently connected server |
|
stpact |
stop acting as the given server name |
|
stract |
start acting as the given server name |
|
sudscg |
check the user defined status code for the UltraESB server |
|
sudscs |
set the user defined status code for the UltraESB server |
Short Command | Long Command | Description |
---|---|---|
duau |
add new child configuration or update existing child configuration |
|
dupa |
purge all outdated deployment units |
|
duu |
unload executing deployment unit/ |
Short Command | Long Command | Description |
---|---|---|
psl |
list the proxy services of the UltraESB server |
|
psv |
get the String serialization of the specified proxy service |
|
psdbd |
disable debug for the specified proxy service |
|
psdbe |
enable debug for the specified proxy service |
|
psstrst |
reset statistics for the specified proxy service |
|
psstp |
stop the specified proxy service |
|
psstr |
start the specified proxy service |
Short Command | Long Command | Description |
---|---|---|
epl |
list the endpoints of the UltraESB server |
|
getep |
get the String serialization of the specified endpoint |
|
epdbd |
disable debug for the specified endpoint |
|
epdbe |
enable debug for the specified endpoint |
|
epstrst |
reset statistics for the specified endpoint |
|
epstp |
stop the specified endpoint |
|
epstr |
start the specified endpoint |
Short Command | Long Command | Description |
---|---|---|
sql |
list the sequences of the UltraESB server |
|
sqv |
get the String serialization of the specified sequence |
|
sqdbd |
disable debug for the specified sequence |
|
sqdbe |
enable debug for the specified sequence |
|
sqstrst |
reset statistics for the specified sequence |
|
sqstp |
stop the specified sequence |
|
sqstr |
start the specified sequence |
Short Command | Long Command | Description |
---|---|---|
llch |
change the log level of a logger |
|
lls |
listing log levels of loggers |
|
lad |
adding a new logger |
|
ach |
change additivity of a logger |
|
lgw |
watch logs of the connected UltraESB server |
|
apu |
update appender pattern and threshold of the specified appender |
Short Command | Long Command | Description |
---|---|---|
zr |
zabbix-register |
register the zabbix elements for the current configuration |
zrs |
zabbix-reg-stat |
prints the Zabbix registration status |
Short Command | Long Command | Description |
---|---|---|
help |
help |
prints this command help |
quit |
exit |
exit from the uterm |
Short Command | Long Command | Description |
---|---|---|
jmssend |
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 |
|
jdelall |
deletes all the messages in the queue specified by the queue jndi name |
|
jread |
jms-read |
reads immediate message in the specified queue |
jreadAll |
reads all the messages in the specified queue |
Server management commands are used to manage and monitor an running UltraESB instance or a cluster of UltraESB instances. This section describes each and every command in the server management category.
The commands of UTerm under server management are;
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’
Short command |
sl |
Long command |
server-list |
Available options for the list servers command are described in the following table.
Short option key | Long option key | Description |
---|---|---|
-h |
–help |
prints the command help |
-s |
–service-url |
shows the service-url with the server name |
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.
Related Commands |
---|
Local instance connection is not mandatory You do not need use the connect command if there is only one local UltraESB instance running on the same host, upon giving the first command, UTerm automatically establishes the connection with that instance of UltraESB, if it is not already connected to any instance. |
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’
Short command |
con |
Long command |
connect |
Available options for the connect command are described in the following table.
Short option key | Long option key | Description |
---|---|---|
-h |
–help |
prints the command help |
-p <arg> |
–password <arg> |
password to be used in connecting |
-u <arg> |
–username <arg> |
username to be used in connecting |
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.
Related Commands |
---|
Configure UTerm to connect by passing the server name You could configure the JMX addresses with credentials in the uterm.properties file and use a given server name to connect to a remote UltraESB instance, which is very convenient. See the UTerm Configuration for more information. |
Refreshes the specified UltraESB server. The short form of the command is ’con` which is equivalent to calling it’s long form'connect’
Short command |
srfr |
Long command |
server-refresh |
Available options for the connect command are described in the following table.
Short option key | Long option key | Description |
---|---|---|
-h |
–help |
prints the command help |
-w |
–cluster-wide |
refresh all the servers in the cluster |
Related Commands |
---|
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’
Short command |
sstchk |
Long command |
server-state-check |
Available options for the check server state command are described in the following table.
Short option key | Long option key | Description |
---|---|---|
-h |
–help |
prints the command help |
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.
Started - server is started and running
Stopped - server is stopped and not running
Paused - server is paused, do not accept any new work
Failed - server has failed to start
Starting - server is being started, didn’t accept work until it become started
Stopping - server is being stopped, do not accept any new work, already accepted work might be in progress
Pausing - server is being pause, do not accept any more new work
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’
Short command |
srstr |
Long command |
server-restart |
Available options for the restart server command are described in the following table.
Short option key | Long option key | Description |
---|---|---|
-f |
–forced-instant |
forced restart the server instantly, applies only for non-clustered restarts |
-g <arg> |
–grace-period <arg> |
restart gracefully in the given grace period in seconds |
-h |
–help |
prints the command help |
-r <arg> |
–rr-delay <arg> |
applies in cluster-wide execution, round-robin restart with the specified delay in seconds, between 2 server restarts in the cluster |
-w |
–cluster-wide |
restart the complete cluster |
Using the restart command you can restart a server in 2 possible options.
Graceful restart - where the accepted requests are processed until the grace period exceeds to trying to deliver the response.
Hard/forced restart - instant hard restart without worrying about the messages in-flight.
Normal restart is graceful Restart server command without any option is graceful too, but the grace period is the default one which is 30 seconds. |
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.
Round-Robin graceful cluster restart Round-Robin graceful cluster restart allows the cluster to be restarted in a manner that the complete cluster has no down time. |
This command is very useful in managing a complete cluster.
Related Commands |
---|
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’
Short command |
stps |
Long command |
stop-server |
Available options for the stop server command are described in the following table.
Short option key | Long option key | Description |
---|---|---|
-f |
–forced-instant |
forced stop the server instantly, applies only for non-clustered stops |
-g <arg> |
–grace-period <arg> |
stop gracefully in the given grace period in seconds |
-h |
–help |
prints the command help |
-w |
–cluster-wide |
stop the complete cluster |
Using the stop command you can stop a server in 2 possible options.
Graceful stop - where the accepted requests are processed until the grace period exceeds to trying to deliver the response.
Hard/forced stop - instant hard stop without worrying about the messages in-flight.
Normal stop is graceful Stop server command without any option is graceful too, but the grace period is the default one which is 30 seconds. |
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.
Related Commands |
---|
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’
Short command |
strs |
Long command |
start-server |
Available options for the start server command are described in the following table.
Short option key | Long option key | Description |
---|---|---|
-h |
–help |
prints the command help |
-w |
–cluster-wide |
start the complete cluster |
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.
Related Commands |
---|
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’
Short command |
sshd |
Long command |
server-shutdown |
Available options for the stop server command are described in the following table.
Short option key | Long option key | Description |
---|---|---|
-f |
–forced-instant |
forced shut down the server instantly, applies only for non-clustered stops |
-g <arg> |
–grace-period <arg> |
shut down server gracefully in the given grace period in seconds |
-h |
–help |
prints the command help |
-w |
–cluster-wide |
shutdown the complete cluster |
Using the shutdown command you can stop a server in 2 possible options.
Graceful shutdown - where the accepted requests are processed until the grace period exceeds to trying to deliver the response.
Hard/forced shutdown - instant hard stop without worrying about the messages in-flight.
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’
Short command |
shcsn |
Long command |
show-connected-server-name |
Available options for the show-connected-server-name command are described in the following table.
Short option key | Long option key | Description |
---|---|---|
-h |
–help |
prints the command help |
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.
Related Commands |
---|
show-connected-server-address |
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’
Short command |
shcsa |
Long command |
show-connected-server-address |
Available options for the show-connected-server-address command are described in the following table.
Short option key | Long option key | Description |
---|---|---|
-h |
–help |
prints the command help |
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.
Related Commands |
---|
show-connected-server-name |
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’
Short command |
stpact |
Long command |
stop-acting-as |
Available options for the stop acting-as command are described in the following table.
Short option key | Long option key | Description |
---|---|---|
-h |
–help |
prints the command help |
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.
Automatically happen in a clustered deployment In a clustered environment, if the fail-over nodes are configured, this transition automatically happens once the failed node came back online and joins the cluster back. |
Related Commands |
---|
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’
Short command |
stract |
Long command |
start-acting-as |
Available options for the start acting-as command are described in the following table.
Short option key | Long option key | Description |
---|---|---|
-h |
–help |
prints the command help |
This command is useful in transferring pinned proxy services of a failed node into a running UltraESB instance, in a non clustered environment.
Automatically happen in a clustered deployment In a clustered environment, if the fail-over nodes are configured, this transition automatically happens once a node fails and gets removed from the cluster. |
Related Commands |
---|
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’
Short command |
sudscg |
Long command |
server-user-defined-status-code-get |
Available options for the start acting-as command are described in the following table.
Short option key | Long option key | Description |
---|---|---|
-h |
–help |
prints the command help |
Related Commands |
---|
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’
Short command |
sudscs |
Long command |
server-user-defined-status-code-set |
Available options for the start acting-as command are described in the following table.
Short option key | Long option key | Description |
---|---|---|
-h |
–help |
prints the command help |
-sc |
–status-code <arg> |
value of the user defined status code |
Related Commands |
---|
Check the user defined status code for the UltraESB server
Deployment unit management commands are used to manage dynamic configurations of an UltraESB instance or a cluster of UltraESB instances. This section describes each and every command in the deployment unit management category.
The commands of UTerm under deployment unit management are;
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’
Short command |
duau |
Long command |
deployment-unit-add-or-update |
Available options for the add or update deployment unit command are described in the following table.
Short option key | Long option key | Description |
---|---|---|
-h |
–help |
prints the command help |
-w |
–cluster-wide |
add/update cluster wide |
-n |
–name <arg> |
name of the deployment unit to be added |
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).
Related Commands |
---|
Note Once this command is invoked it result in the previously running deployment units to be stale after some time (after completing the processing of all the messages accepted by this deployment unit) this consumes a little it of memory and hence, you could use the deployment-unit-purge-all command to remove these stale deployment units. |
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’
Short command |
dupa |
Long command |
deployment-unit-purge-all |
Available options for the purge all deployment units command are described in the following table.
Short option key | Long option key | Description |
---|---|---|
-h |
–help |
prints the command help |
-w |
–cluster-wide |
purge all outdated deployment units cluster wide |
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.
Related Commands |
---|
Best Practice - Purge as late as possible after an update As a best practice, make sure to give the previous configuration a good long time to complete its messages, after an update. A configuration shouldn’t take much memory, so it is OK to purge even after a day or just before the next update. |
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’
Short command |
duu |
Long command |
deployment-unit-unload |
Available options for the unload configuration command are described in the following table.
Short option key | Long option key | Description |
---|---|---|
-a |
–all |
unload all deployment units |
-h |
–help |
prints the command help |
-n |
–name <arg> |
name of the deployment unit to be unloaded |
-w |
–cluster-wide |
unload cluster wide |
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.
Proxy service management commands are used to manage and monitor proxy service artifacts deployed in a running UltraESB instance or a cluster of UltraESB instances. This section describes each and every command in the proxy service management category.
The commands of UTerm under proxy service management are;
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’
Short command |
psl |
Long command |
proxy-service-list |
Available options for the list proxy services command are described in the following table.
Short option key | Long option key | Description |
---|---|---|
-a |
–all |
list all the proxy services |
-h |
–help |
prints the command help |
-i |
–with-info |
list proxy services with there respective information |
-s |
–with-state |
list proxy services with there respective states |
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.
Related Commands |
---|
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’
Short command |
psv |
Long command |
proxy-service-view |
Available options for the get proxy service command are described in the following table.
Short option key | Long option key | Description |
---|---|---|
-h |
–help |
prints the command help |
This command is useful in scripting where you want to get certain attributes of a proxy service to automate some action.
Related Commands |
---|
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’
Short command |
psdbd |
Long command |
proxy-service-debug-disable |
Available options for the disable debug of proxy service command are described in the following table.
Short option key | Long option key | Description |
---|---|---|
-h |
–help |
prints the command help |
-w |
–cluster-wide |
disable debug for proxy service cluster wide |
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.
Related Commands |
---|
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’
Short command |
psdbe |
Long command |
proxy-service-debug-enable |
Available options for the enable debug of proxy service command are described in the following table.
Short option key | Long option key | Description |
---|---|---|
-h |
–help |
prints the command help |
-w |
–cluster-wide |
enable debug for proxy service cluster wide |
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.
Related Commands |
---|
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’
Short command |
psstrst |
Long command |
proxy-service-statistics-reset |
Available options for the reset statistics of proxy service command are described in the following table.
Short option key | Long option key | Description |
---|---|---|
-h |
–help |
prints the command help |
-w |
–cluster-wide |
reset statistics for proxy service cluster wide |
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.
Clear the statistics frame to start looking at the current behaviour You may reset the statistics of a proxy service cluster wide and then monitor them again to see any more messages failing or any specific error which is occurring. |
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’
Short command | psstp |
---|---|
Long command |
proxy-service-stop |
Available options for the stop proxy service command are described in the following table.
Short option key | Long option key | Description |
---|---|---|
-h |
–help |
prints this command help |
-w |
–cluster-wide |
stop proxy service cluster wide |
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.
Related Commands |
---|
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'
Short command |
psstr |
Long command |
proxy-service-start |
Available options for the start proxy service command are described in the following table.
Short option key | Long option key | Description |
---|---|---|
-h |
–help |
prints this command help |
-w |
–cluster-wide |
start proxy service cluster wide |
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.
Related Commands |
---|
Endpoint management commands are used to manage and monitor endpoint artifacts deployed in a running UltraESB instance or a cluster of UltraESB instances. This section describes each and every command in the endpoint management category.
The commands of UTerm under endpoint management are;
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’
Short command |
epl |
Long command |
endpoint-list |
Available options for the list endpoints command are described in the following table.
Short option key | Long option key | Description |
---|---|---|
-a |
–all |
list all the endpoints |
-h |
–help |
prints the command help |
-i |
–with-info |
list endpoints with there respective information |
-s |
–with-state |
list endpoints with there respective states |
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.
Related Commands |
---|
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’
Short command |
getep |
Long command |
get-endpoint |
Available options for the get endpoint command are described in the following table.
Short option key | Long option key | Description |
---|---|---|
-h |
–help |
prints the command help |
This command is useful in scripting where you want to get certain attributes of a endpoint to automate some action.
Related Commands |
---|
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’
Short command |
epdbd |
Long command |
endpoint-debug-disable |
Available options for the disable debug of endpoint command are described in the following table.
Short option key | Long option key | Description |
---|---|---|
-h |
–help |
prints the command help |
-w |
–cluster-wide |
disable debug for endpoint cluster wide |
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.
Related Commands |
---|
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’
Short command |
epdbe |
Long command |
endpoint-debug-enable |
Available options for the enable debug of endpoint command are described in the following table.
Short option key | Long option key | Description |
---|---|---|
-h |
–help |
prints the command help |
-w |
–cluster-wide |
enable debug for endpoint cluster wide |
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.
Related Commands |
---|
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’
Short command |
epstrst |
Long command |
endpoint-statistics-reset |
Available options for the reset statistics of endpoint command are described in the following table.
Short option key | Long option key | Description |
---|---|---|
-h |
–help |
prints the command help |
-w |
–cluster-wide |
reset statistics for endpoint cluster wide |
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.
Clear the statistics frame to start looking at the current behaviour You may reset the statistics of a endpoint cluster wide and then monitor them again to see any more messages failing or any specific error which is occurring. |
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’
Short command |
epstp |
Long command |
endpoint-stop |
Available options for the stop endpoint command are described in the following table.
Short option key | Long option key | Description |
---|---|---|
-h |
–help |
prints this command help |
-w |
–cluster-wide |
stop endpoint cluster wide |
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.
Related Commands |
---|
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’
Short command |
epstr |
Long command |
endpoint-start |
Available options for the start endpoint command are described in the following table.
Short option key | Long option key | Description |
---|---|---|
-h |
–help |
prints this command help |
-w |
–cluster-wide |
start endpoint cluster wide |
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.
Related Commands |
---|
Sequence management commands are used to manage and monitor sequence artifacts deployed in a running UltraESB instance or a cluster of UltraESB instances. This section describes each and every command in the sequence management category.
The commands of UTerm under sequence management are;
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’
Short command |
sql |
Long command |
sequence-list |
Available options for the list sequences command are described in the following table.
Short option key | Long option key | Description |
---|---|---|
-a |
–all |
list all the sequences |
-h |
–help |
prints the command help |
-i |
–with-info |
list sequences with there respective information |
-s |
–with-state |
list sequences with there respective states |
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.
Related Commands |
---|
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’
Short command |
sqv |
Long command |
sequence-view |
Available options for the get sequence command are described in the following table.
Short option key | Long option key | Description |
---|---|---|
-h |
–help |
prints the command help |
This command is useful in scripting where you want to get certain attributes of a sequence to automate some action.
Related Commands |
---|
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’
Short command |
sqdbd |
Long command |
sequence-debug-disable |
Available options for the disable debug of sequence command are described in the following table.
Short option key | Long option key | Description |
---|---|---|
-h |
–help |
prints the command help |
-w |
–cluster-wide |
disable debug for sequence cluster wide |
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.
Related Commands |
---|
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’
Short command |
sqdbe |
Long command |
sequence-debug-enable |
Available options for the enable debug of sequence command are described in the following table.
Short option key | Long option key | Description |
---|---|---|
-h |
–help |
prints the command help |
-w |
–cluster-wide |
enable debug for sequence cluster wide |
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.
Related Commands |
---|
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’
Short command |
sqstrst |
Long command |
sequence-statistics-reset |
Available options for the reset statistics of sequence command are described in the following table.
Short option key | Long option key | Description |
---|---|---|
-h |
–help |
prints the command help |
-w |
–cluster-wide |
reset statistics for sequence cluster wide |
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.
Clear the statistics frame to start looking at the current behaviour You may reset the statistics of a sequence cluster wide and then monitor them again to see any more messages failing or any specific error which is occurring. |
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’
Short command |
sqstp |
Long command |
sequence-stop |
Available options for the stop sequence command are described in the following table.
Short option key | Long option key | Description |
---|---|---|
-h |
–help |
prints this command help |
-w |
–cluster-wide |
stop sequence cluster wide |
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.
Related Commands |
---|
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’
Short command |
sqstr |
Long command |
sequence-start |
Available options for the start sequence command are described in the following table.
Short option key | Long option key | Description |
---|---|---|
-h |
–help |
prints this command help |
-w |
–cluster-wide |
start sequence cluster wide |
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.
Related Commands |
---|
Logger management commands are used to manage loggers. This section describes each and every command in the logger management category.
The commands of UTerm under server management are;
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’
Short command |
llch |
Long command |
log-level-change |
Available options for the list servers command are described in the following table.
Short option key | Long option key | Description |
---|---|---|
-h |
–help |
prints the command help |
-l |
–logger-level <arg> |
new log level of logger |
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
llch -l WARN org.adroitlogic.ultraesb.core.ConfigurationImpl
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’
Short command |
lls |
Long command |
logger-list |
Available options for the list loggers command are described in the following table.
Short option key | Long option key | Description |
---|---|---|
-h |
–help |
prints the command help |
-p |
–package |
show log level of given package |
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,
lls -p org.adroitlogic.ultraesb.core
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’
Short command |
lad |
Long command |
logger-add |
Available options for the list loggers command are described in the following table.
Short option key | Long option key | Description |
---|---|---|
-h |
–help |
prints the command help |
-l |
–level <arg> |
set level of the logger |
-a |
–additivity |
sets whether the additivity of logger is true or false |
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'
Short command |
ach |
Long command |
additivity-change |
Available options for the change logger additivity are described in the following table.
Short option key | Long option key | Description |
---|---|---|
-h |
–help |
prints the command help |
-a |
–additivity <arg> |
new additivity of logger |
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
ach -a true org.adroitlogic.soapbox.CryptoSupport
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'
Short command |
lgw |
Long command |
log-watch |
Available options for the watch logs are described in the following table.
Short option key | Long option key | Description |
---|---|---|
-h |
–help |
prints the command help |
-i |
–refresh-interval <arg> |
set the refresh time interval for log fetching in seconds, which defaults to 3 seconds |
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
lgw -i 4
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'
Short command |
apu |
Long command |
appender-update |
Available options for the update log appender are described in the following table.
Short option key | Long option key | Description |
---|---|---|
-h |
–help |
prints the command help |
-p |
–appender-pattern <arg> |
new appender pattern |
-t |
–appender-threshold <arg> |
new appender threshold |
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,
apu -p %m%n -t WARN MEMORY_APPENDER
MS Client Commands provides the functionality to send and/or receive messages from JMS queues, and to delete messages containing in a queue. Before using the JMSclient commands it is necessary to copy the jar files needed by the JMS provider which is used. (E.g: for Websphere JMS provider com.ibm.ws.ejb.thinclient_X.jar, com.ibm.ws.orb_X.jar and com.ibm.ws.sib.client.thin.jms_X.jar are needed)
JMS Client commands will optionally need a profile. The specified profile will be looked up in the conf/management/uterm.properties file. A fragment of the uterm.properties file with a profile will be as follows
ultra.jms.providerUrl.prod=iiop://localhost:2809
ultra.jms.initialContextFactory.prod=com.ibm.websphere.naming.WsnInitialContextFactory
ultra.jms.connectionFactory.prod=jms/QCF.Test
ultra.jms.sendingDestination.prod=EsbIn
ultra.jms.receivingDestination.prod=EsbOut
The above profile is the "prod" profile. To create a like wise profile, simply replace "prod" with your preferred name and change the configuration values. Uterm is shipped with the default profile. However configuring these ultra.jms.* properties is optional if the corresponding values are specified via the corresponding command options. In the case where the profile is configured and the command option also provided, the value in the profile will be overwritten by the value specified by the command option.
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’
Short command |
jmssend |
Long command |
jms-connect-and-send |
Available options for the jms send command are described in the following table.
Short option key | Long option key | Description |
---|---|---|
prfl |
profile |
config to be used to load the host name, port, connection factory jndi name, producer jndi name and the consumer jndi name |
t |
send-type |
type of the message to be sent eg: map or text |
p |
properties |
properties to be set for the message, specified as key values pairs separated by commas |
s |
strings |
string values to be sent, specified as key values pairs separated by commas |
bf |
byte-files |
files to be sent as bytes, specified as key values pairs separated by commas |
sf |
string-files |
files to be sent as strings, specified as key values pairs separated by commas |
url |
provider-url |
the jms provider url - if the config file is provided this is optional |
initCntxFac |
init-context-factory |
InitialContextFactory which is used to lookup JMS connection factory objects as well as destination objects - if the config file is provided this is optional |
konFac |
kon-factory-jndi-name |
jndi name of the connection factory - if the config file is provided this is optional |
sender |
sender-jndi-name |
message producer’s jndi name - if the config file is provided this is optional |
receiver |
receiver-jndi-name |
message consumer’s jndi name - if the config file is provided this is optional |
Use Cases
Sending a message to a JMS queue using configuration profile
Configure the profile with only the following properties
ultra.jms.providerUrl.prod=iiop://localhost:2809
ultra.jms.initialContextFactory.prod=com.ibm.websphere.naming.WsnInitialContextFactory
ultra.jms.connectionFactory.prod=jms/QCF.Test
ultra.jms.sendingDestination.prod=EsbIn
Issue the command : jmssend -t map -prfl prod -s name:foo,age:24 -sf description:/home/Desktop/about.txt -bf cv:/home/Desktop/resume.pdf
Sending a message to a JMS queue using command options
Issue the command : jmssend -t map -s name:foo,age:24 -sf description:/home/Desktop/about.txt -bf cv:/home/Desktop/resume.pdf -url iiop://localhost:2809 -konFac jms/QCF.Test -sender EsbIn -initCntxFac com.ibm.websphere.naming.WsnInitialContextFactory
Sending and receiving message using the configuration profile and command options
If the profile in 1. is used, it does not specify the receiver destination. The receiver destination can be specified via command option
Issue the command : jmssend -t map -prfl prod -s name:foo,age:24 -sf description:/home/Desktop/about.txt -bf cv:/home/Desktop/resume.pdf -receiver EsbOut
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’
Short command |
jdelall |
Long command |
jms-delete-all |
Available options for the jms delete all command are described in the following table.
Short option key
Short option key | Long option key | Description |
---|---|---|
prfl |
profile |
the configuration to be used to load the provide url, initial context factory, connection factory JNDI name and the destination queue JNDI name. If the remaining options are provided |
q |
queue-jndi-name |
JNDI name of the queue, where the messages are to be deleted - if the queue name is provided in the config file. However if specified value in the configuration file will be overridden |
konFac |
kon-factory-jndi-name |
JNDI name of the connection factory - if the config file is provided this is optional. However if specified value in the configuration file will be overridden |
url |
provider-url |
the jms provider url - if the config file is provided this is optional. However if specified value in the configuration file will be overridden |
initContxFac |
init-context-factory |
InitialContextFactory which is used to lookup JMS connection factory objects as well as destination objects - if the config file is provided this is optional. However if specified value in the configuration file will be overridden |
Use Cases
Deleting messages using the profile
Configure the profile with only the following properties
ultra.jms.providerUrl.prod=iiop://localhost:2809
ultra.jms.initialContextFactory.prod=com.ibm.websphere.naming.WsnInitialContextFactory
ultra.jms.connectionFactory.prod=jms/QCF.Test
ultra.jms.ReceivingDestination.prod=EsbOut
NOTE: The queue which the messages to be deleted should be configured as ultra.jms.ReceivingDestination.profileName
Issue the command : jdelAll -prfl prod
Deleting messages using the profile and command options
Issue the command : jdelAll -prfl prod -q EsbIn
The "EsbOut" queue destination configured in the profile will be overridden by EsbIn
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’
Short command |
readNextMsg |
Long command |
jms-read-next |
Available options for the jms read next command are described in the following table.
Short option key | Long option key | Description |
---|---|---|
prfl |
profile |
the configuration to be used to load the provide url, initial context factory, connection factory JNDI name and the destination queue JNDI name. If the remaining options are provided |
q |
queue-jndi-name |
JNDI name of the queue, where the messages are to be deleted - if the queue name is provided in the config file. However if specified value in the configuration file will be overridden |
konFac |
kon-factory-jndi-name |
JNDI name of the connection factory - if the config file is provided this is optional. However if specified value in the configuration file will be overridden |
url |
provider-url |
the jms provider url - if the config file is provided this is optional. However if specified value in the configuration file will be overridden |
initContxFac |
init-context-factory |
InitialContextFactory which is used to lookup JMS connection factory objects as well as destination objects - if the config file is provided this is optional. However if specified value in the configuration file will be overridden |
msgid |
message-id |
specify the identifier of the message which is needed to be read |
Use Cases
Reading a messages using the profile
Configure the profile with only the following properties
ultra.jms.providerUrl.prod=iiop://localhost:2809
ultra.jms.initialContextFactory.prod=com.ibm.websphere.naming.WsnInitialContextFactory
ultra.jms.connectionFactory.prod=jms/QCF.Test
ultra.jms.ReceivingDestination.prod=EsbOut
NOTE: The queue which the messages to be read, should be configured as ultra.jms.ReceivingDestination.profileName Issue the command : readNextMsg -prfl prod
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’
Short command |
readAllMsg |
Long command |
jms-read-all |
Available options for the read all command are described in the following table.
Short option key | Long option key | Description |
---|---|---|
prfl |
profile |
the configuration to be used to load the provide url, initial context factory, connection factory JNDI name and the destination queue JNDI name. If the remaining options are provided |
q |
queue-jndi-name |
JNDI name of the queue, where the messages are to be deleted - if the queue name is provided in the config file. However if specified value in the configuration file will be overridden |
konFac |
kon-factory-jndi-name |
JNDI name of the connection factory - if the config file is provided this is optional. However if specified value in the configuration file will be overridden |
url |
provider-url |
the jms provider url - if the config file is provided this is optional. However if specified value in the configuration file will be overridden |
initContxFac |
init-context-factory |
InitialContextFactory which is used to lookup JMS connection factory objects as well as destination objects - if the config file is provided this is optional. However if specified value in the configuration file will be overridden |