Command Listing


The command line interface of the administration tool allows you to perform a variety of functions.

Many of the commands listed below accept arguments that specify the names of users, groups, topics or queues. For information about the syntax and naming conventions that apply to these names, see Naming Conventions.
Note that SSL commands are not listed in this table. SSL commands are listed in several tables in Chapter 12, Using the SSL Protocol.

The following is an alphabetical listing of the commands including command syntax and a description of each command.

add member

add member <group_name> <user_name> [,<user2>,<user3>,...] 

Add one or more users to the group. User names that are not already defined are added to the group as external users; see Administration Commands and External Users and Groups.

addprop factory

addprop factory <factory-name> <properties ...> 

Adds properties to the factory. Property names are separated by spaces.

Factory properties are url= <url-string>, clientID = <client-id> and SSL parameters.

An example is:

addprop factory MyTopicFactory ssl_trusted=cert1.pem ssl_trusted=cert2.pem ssl_verify_host=disabled

For descriptions of factory parameters, see factories .

For SSL parameters, see Table 41.

addprop queue

addprop queue <queue-name> <properties,...> 

Adds properties to the queue. Property names are separated by commas.

addprop route

addprop route <route-name> prop=value[ prop-value...]

Route properties are url=<url-string> and SSL parameters.

Note that destination (topic and queue) properties must be separated by commas but properties of routes and factories are separated with spaces.

You can set the zone_name and zone_type parameters when creating a route, but you cannot subsequently change them.
For route parameters, see Configuring Routes and Zones.
For the configuration file routes.conf, see routes .

addprop topic

addprop topic <topic_name> <properties,...> 

Adds properties to the topic. Property names are separated by commas.

autocommit

autocommit [on|off] 

When autocommit is set to on, each command causes the change the command made to the configuration files to be saved automatically. When autocommit is set to off, you must manually use the commit command to save configuration changes to the disk.

By default, autocommit is set to on when interactively issuing commands. If you are running a script, the entire script must complete without errors (or the ignore parameter can be specified to ignore errors) for the commit to occur. If there are errors in the script, and the ignore parameter is not specified, the administration tool immediately stops the script after the first error and does NOT perform the implicit commit.

Entering autocommit without parameters displays the current setting of autocommit (on or off).

commit

commit 

Commits all configuration changes into files on disk.

compact

compact <store_type> [ <max_time> ] 

Compacts the database store files.

Since compaction can be a lengthy operation, and it blocks other database operations, you may specify a time limit (in seconds). Zero is a special value, which specifies no time limit. When the time limit is absent, the default is zero, and the administration tool asks for confirmation.

We recommend compacting the database store files only when the database Used Space usage is 30% or less (see show db ).

connect

connect [ <server-url> <admin user name> <password> ] 

Connects the administration tool to the server. Any administrator can connect. An administrator is either the admin user, any user in the $admin group, or any user that has administrator permissions enabled. See Administrator Permissions for more information about administrator permissions.

<server-url> is usually in the form

<protocol>://<host-name>:<port-number> 

for example:

tcp://myhost:7222 

The protocol can be tcp or ssl.

If a user name or password are not provided, the user is prompted to enter a user name and password, or only the password, if the user name was already specified in the command.

You can enter connect with no other options and the administrative tool tries to connect to the local server on the default port, which is 7222.

create bridge

create bridge source=<type>:<dest_name> target=<type>:<dest_name> 
 [selector=<selector>] 

<type> is either topic or queue.

For further information, see bridges .

delete bridge

delete bridge source=<type>:<dest_name> target=<type>:<dest_name> 

<type> is either topic or queue.

create durable

create durable <topic-name> <durable-name> [<property>, ... ,<property>] 

For descriptions of parameters and properties, and information about conflict situations, see durables .

create factory

create factory factory-name type [URL=url] [clientID=client_id] 
 [metric=metric] ssl-properties 

Creates a new connection factory.

For descriptions of factory parameters, see factories .

For SSL parameters, see Table 41.

create group

create group <group-name> [<group-description>] 

Creates a new group. See Naming Conventions.

create jndiname

create jndiname <new-jndiname> <topic|queue|jndiname> <name> 

Creates a JNDI name for a topic or queue, or creates an alternate JNDI name for a topic that already has a JNDI name.

For example:

create FOO jndiname BAR

will create new JNDI name FOO referring the same object referred by JNDI name BAR

create queue

create queue <queue-name> [<properties>] 

Creates a queue with the specified name and properties. See Naming Conventions

Optional queue properties are:

See Destination Properties.

create route

create route <name> url=<URL> [<properties ...>]

Creates a route.

The name becomes the name of the new route.

The local server connects to the destination server at the specified URL. If you have configured fault-tolerant servers, you may specify the URL as a comma-separated list of URLs.

You can specify properties as a space-separated list of parameter name and value pairs.

You can set the zone_name and zone_type parameters when creating a route, but you cannot subsequently change them.
If a passive route with the specified name already exists, this command promotes it to an active-active route; see Active and Passive Routes.
For route parameters, see Configuring Routes and Zones.
For the configuration file routes.conf, see routes .

create rvcmlistener

create rvcmlistener [<transportName>] <name> <subject> 

Registers an RVCM listener with the server so that any messages forwarded through a tibrvcm transport (including the first message sent) are guaranteed for the specified listener. This causes the server to perform the TIBCO Rendezvous call tibrvcmTransport_AddListener.

You can optionally specify a transport name to which this RVCM listener applies. If no transport name is specified, the listener is assumed to be for the default RVCM transport.

For more information, see Rendezvous Certified Messaging (RVCM) Parameters.

create topic

create topic <topic-name> [<properties>] 

Creates a topic with specified name and properties. See Naming Conventions

Optional topic properties are:

See Destination Properties.

create user

create user <user-name>  [<user-description>][password=<password>] 

Creates a new user. The password is optional, and can be left empty in this command. If the password is not specified in this command, it can be added later using the set password command.

See Naming Conventions.

delete all

delete all <users|groups|topics|queues|durables> 
[<topic-name-pattern>|<queue-name-pattern>] 

If used as delete all <users|groups|topics|queues|durables> without the optional parameters, the command deletes all users, groups, topics, or queues (as chosen).

If used with a topic or queue, and the optional parameters, such as:

delete all <topics|queues>      <topic-name-pattern>|<queue-name-pattern>

the command deletes all topics and queues that match the topic or queue name pattern.

delete bridge

delete bridge source=<type>:<dest_name> target=<type>:<dest_name> 

<type> is either topic or queue.

delete connection

delete connection <connection-id> 

Deletes the named connection for the client. The connection ID is shown in the first column of the connection description printed by show connection.

delete durable

delete durable <durable-name> 

Deletes a durable subscriber.

See also, Conflicting Specifications.

delete factory

delete factory <factory-name> 

Deletes a factory.

delete group

delete group <group-name> 

Deletes a group.

delete jndiname

delete jndiname <jndiname> 

Deletes a jndiname. Notice that deleting the last JNDIname of a connection factory object will remove the connection factory object as well.

delete message

delete message <messageID> 

Deletes the message with the specified message ID.

delete queue

delete queue <queue-name> 

Deletes a queue.

delete route

delete route <route-name> 

Deletes a route.

delete rvcmlistener

delete rvcmlistener [<transport>] <name> <subject> 

Unregisters an RVCM listener with the server so that any messages being held for the specified listener in the RVCM ledger are released. This causes the server to perform the TIBCO Rendezvous call tibrvcmTransport_RemoveListener.

You can optionally specify a transport name from which this RVCM listener should be deleted. If no transport name is specified, the listener is assumed to be for the default RVCM transport.

For more information, see Rendezvous Certified Messaging (RVCM) Parameters.

delete topic

delete topic <topic-name> 

Deletes a topic with specified name.

delete user

delete user <user-name> 

Deletes a user.

disconnect

disconnect 

Disconnects the administrative tool from the server.

echo

echo [on|off] 

Echo controls the reports that are printed into the standard output. When echo is off the administrative tool only prints errors and the output of queries. When echo is on, the administrative tool report also contains a record of successful command execution.

Choosing the parameter on or off in this command controls echo. If echo is entered in the command line without a parameter, it displays the current echo setting (on or off). This command is used primarily for scripts.

The default setting for echo is on.

exit

exit  (aliases: quit, q, bye, end) 

Exits the administration tool.

The administrator may choose the exit command when there are changes in the configuration have which have not been committed to disk. In this case, the system will prompt the administrator to use the commit command before exiting.

grant queue

grant queue <queue> <user-name>|<group-name> <permissions> 

Grants specified permissions to specified user or group on specified queue. The name following the topic name is first checked to be a group name, then a user name.

Specified permissions are added to any existing permissions. Multiple permissions are separated by commas. Enter all in the <permissions> string if you choose to grant all possible user permissions.

Optional user permissions are:

Destination-level administrator permissions can also be granted with this command. The following are administrator permissions for queues.

For more information, see Chapter 9, Authentication and Permissions.

grant topic

grant topic <topic> <user-name>|<group-name> <permissions> 

Grants specified permissions to specified user or group on specified topic. The name following the topic name is first checked to be a group name, then a user name.

Specified permissions are added to any existing permissions. Multiple permissions are separated by commas. Enter all in the <permissions> string if you choose to grant all possible permissions.

Optional topic permissions are:

Destination-level administrator permissions can also be granted with this command. The following are administrator permissions for topics.

For more information, see Chapter 9, Authentication and Permissions.

grant admin

grant admin <group-name | user-name> <admin permissions> 

Grants the specified global administrator permissions to the specified user or group. For a complete listing of global administrator permissions, see Chapter 9, Authentication and Permissions.

help

help (aliases: h, ?) 

Usage help.

Enter help commands for a command summary.

Enter help <command> for help on a specific command.

info

info (alias: i) 

Shows server name and information about the connected server.

purge all queues

purge all queues [<pattern>] 

When used without the optional pattern parameter, this command erases all messages in all queues for all receivers.

When used with the pattern parameter, this command erases all messages in all queues that fit the pattern (for example: foo.*).

purge all topics

purge all topics [<pattern>] 

When used without the optional pattern parameter, this command erases all messages in all topics for all subscribers.

When used with the pattern parameter, this command erases all messages in all topics that fit the pattern (for example: foo.*).

purge durable

purge durable <durable-name> 

Erases all messages in the topic for a specified durable subscriber

purge queue

purge queue <queue-name> 

Erases all messages in the queue.

purge topic

purge topic <topic-name> 

Erases all messages in the topic.

remove member

remove member <group-name> <user-name>[,<user2>,<user3>,...] 

Removes one or more users from a group.

removeprop factory

removeprop factory <factory-name> <properties> 

Removes properties from a factory.

removeprop queue

removeprop queue <queue-name> <properties> 

Removes properties from a queue.

removeprop route

removeprop route <route-name> <properties> 

Removes properties from a route.

You cannot remove topic selectors.

You can set the zone_name and zone_type parameters when creating a route, but you cannot subsequently change them.
For route parameters, see Configuring Routes and Zones.
For the configuration file routes.conf, see routes .

removeprop topic

removeprop topic <topic-name> <properties> 

Removes properties from a topic.

revoke admin

revoke admin <user> <permissions> 

Revokes the specified global administrator permissions from the specified user. See Chapter 9, Authentication and Permissions for more information about administrator permissions.

revoke queue

revoke queue <queue> <user-name>|<group-name> [<permissions>] 

If used as revoke queue <queue-name> without the optional parameters, the command revokes all permissions for the specified queue.

Revokes specified permissions from a user or group in a specified queue. The name following the queue name is first checked to be a group name, then a user name. If you specify an asterisk (*), all permissions on this queue are removed.

User permissions for queues are receive, send, browse, and all.

Administrator permissions for queues are view, create, delete, modify, and purge.

For more information, see Chapter 9, Authentication and Permissions.

revoke topic

revoke topic <topic-name> [<user-name>|<group-name> <permissions>] 

If used as revoke topic <topic-name> without the optional parameters, the command revokes all permissions for the specified topic.

When used with the optional parameters, the command revokes specified permissions from a user or group on specified topic. The name following the topic name is first checked to be a group name, then a user name. If you specify an asterisk (*), all permissions on this queue are removed.

Permissions for topics are subscribe, publish, durable, and all.

Administrator permissions for topics are view, create, delete, modify, and purge.

For more information, see Chapter 9, Authentication and Permissions.

rotatelog

rotatelog  

Forces the current log file to be backed up and truncated. All entries in the current log file are purged, and the server then starts writing entries to the newly empty log file.

The backup file name is the same as the current log file name with a sequence number appended to the filename. The server queries the current log file directory and determines what the highest sequence number is, then chooses the next highest sequence number for the new backup name. For example, if the log file name is tibems.log and there is already a tibems.log.1 and tibems.log.2, the server names the next backup tibems.log.3.

set password

set password <user-name> [<password>] 

Sets the password for a user.

If you do not supply a password in the command, the server prompts you to type one.

After setting passwords (as with other commands) you must use the commit command to save the changes to the configuration file.

Passwords are a significant point of vulnerability for any enterprise. We recommend enforcing strong standards for passwords.
For security equivalent to single DES (an industry minimum), security experts recommend passwords that contain 8–14 characters, with at least one upper case character, at least one numeric character, and at least one punctuation character.

set server

set server <parameter=value> [<parameter=value> ...]

The set server command can control many parameters. Multiple parameters are separated by spaces. Table 20 describes the parameters you can set with this command.

Table 20 Set server parameters (Sheet 1 of 6)
Parameter
Description
password[=string]
Sets server password used by the server to connect to other routed servers. If the value is omitted it is prompted for by the administration tool. Entered value will be stored in the main server configuration file in mangled form (but not encrypted).
To reset this password, enter the empty string twice at the prompt.
authorization=<enabled|disabled>
Sets authorization mode.
After a transition from disabled to enabled, the server checks ACL permissions for all subsequent requests. While the server requires valid authentication for existing producers and consumers, it does not retroactively reauthenticate them; it denies access to users without valid prior authentication.
log_trace=<trace-items>
Sets the trace preference on the file defined by the logfile parameter. If logfile is not set, the values are stored but have no effect.
The value of this parameter is a comma-separated list of trace options. For a list of trace options and their meanings, see Table 35, Server tracing options (Sheet 1 of 2).
You may specify trace options in three forms:
  • plain  A trace option without a prefix character replaces any existing trace options.
  • +  A trace option preceded by + adds the option to the current set of trace options.
  • -  A trace option preceded by - removes the option from the current set of trace options.
Examples

The following example sets the trace log to only show messages about access control violations.

log_trace=ACL 
  
The next example sets the trace log to show all default trace messages, in addition to SSL messages, but ADMIN messages are not shown.
log_trace=DEFAULT,-ADMIN,+SSL 
console_trace=<console-trace-items>
Sets trace options for output to stderr. The values are the same as for log_trace. However, console tracing is independent of log file tracing.
If logfile is defined, you can stop console output by specifying:
console_trace=-DEFAULT 
  
Note that important error messages (and some other messages) are always output, overriding the trace settings.
Examples
This example sends a trace message to the console when a TIBCO Rendezvous advisory message arrives.
console_trace=RVADV 
client_trace={enabled | disabled}
 [target=
<location>] [<filter>=<value>]
Administrators can trace a connection or group of connections. When this property is enabled, the server generates trace output for opening or closing a connection, message activity, and transaction activity. This type of tracing does not require restarting the client program.
The server sends trace output to <location>, which may be either stderr (the default) or stdout.
You can specify a filter to selectively trace specific connections. The <filter> can be user, connid or clientid. The <value> can be a user name or ID (as appropriate to the filter).
When the filter and value clause is absent, the default behavior is to trace all connections.
Setting this parameter using the administration tool does not change its value in the configuration file tibemsd.conf.
max_msg_memory=<value>
Maximum memory the server can use for messages.
For a complete description, see max_msg_memory in Table 18.
Specify units as KB, MB or GB. The minimum value is 8MB. Zero is a special value, indicating no limit.
Lowering this value will not immediately free memory occupied by messages.
track_message_ids=<enabled|disabled>
Enables or disables tracking messages by MessageID.
track_correlation_ids=<enabled|disabled>
Enables or disables tracking messages by CorrelationID.
ssl_password[=string]
This sets a password for SSL use only.
Sets private key or PKCS#12 file password used by the server to decrypt the content of the server identity file. Password stored in mangled form.
ft_ssl_password[=string]

This sets a password for SSL use with Fault Tolerance.

Sets private key or PKCS#12 file password used by the server to decrypt the content of the FT identity file. Password stored in mangled form.
server_rate_interval=<num>

Sets the interval (in seconds) over which overall server statistics are averaged. This parameter can be set to any positive integer greater than zero.

Overall server statistics are always gathered, so this parameter cannot be set to zero. By default, this parameter is set to 1.

Setting this parameter allows you to average message rates and message size over the specified interval.

statistics=<enabled | disabled>

Enables or disables statistic gathering for producers, consumers, destinations, and routes. By default this parameter is set to disabled.

Disabling statistic gathering resets the total statistics for each object to zero.

rate_interval=<num>

Sets the interval (in seconds) over which statistics for routes, destinations, producers, and consumers are averaged. By default, this parameter is set to 3 seconds. Setting this parameter to zero disables the average calculation.

detailed_statistics = < NONE | PRODUCERS,CONSUMERS,ROUTES>

Specifies which objects should have detailed statistic tracking. Detailed statistic tracking is only appropriate for routes, producers that specify no destination, or consumers that specify wildcard destinations. When detailed tracking is enabled, statistics for each destination are kept for the object.

Setting this parameter to NONE disabled detailed statistic tracking. You can specify any combination of PRODUCERS, CONSUMERS, or ROUTES to enable tracking for each object. If you specify more than one type of detailed tracking, separate each item with a comma.

statistics_cleanup_interval=<num>

Specifies how long (in seconds) the server should keep detailed statistics if the destination has no activity. This is useful for controlling the amount of memory used by detailed statistic tracking. When the specified interval is reached, statistics for destinations with no activity are deleted.

max_stat_memory=<num>

Specifies the maximum amount of memory to use for detailed statistic gathering. If no units are specified, the amount is in bytes, otherwise you can specify the amount using KB, MB, or GB as the units.

Once the maximum memory limit is reached, the server stops collecting detailed statistics. If statistics are deleted and memory becomes available, the server resumes detailed statistic gathering.

setprop factory

setprop factory <factory-name> <properties ...> 

Sets the properties for a factory, overriding any existing properties. Multiple properties are separated by spaces.

setprop queue

setprop queue <queue-name> <properties, ...> 

Sets the properties for a queue, overriding any existing properties. Multiple properties are separated by commas.

setprop route

setprop route <route-name> <properties ...> 

Sets the properties for a route, overriding any existing properties. Topic and queue names are separated by commas. Multiple properties are separated by spaces.

You can set the zone_name and zone_type parameters when creating a route, but you cannot subsequently change them.
For route parameters, see Configuring Routes and Zones.
For the configuration file routes.conf, see routes .

setprop topic

setprop topic <topic-name> <properties> 

Sets topic properties overriding any existing properties. Multiple properties are separated by commas.

show bridge

show bridge <topic | queue> <name> 

Displays information about the configured bridges for the specified topic or queue. The following is example output for this command:

Target Name    Type Selector 
queue.dest        Q 
topic.dest.1      T "urgency in ('high', 'medium')" 
topic.dest.2      T 

The names of the destinations to which the specified destination has configured bridges are listed in the Target Name column. The type and the message selector (if one is defined) for the bridge are listed in the Type and Selector column.

show bridges

show bridges [type=<topic | queue>] [<pattern>] 

Shows a summary of the destination bridges that are currently configured. The type option specifies the type of destination. For example, show bridges topic shows a summary of configured bridges for all topics. The pattern specifies a pattern to match for destination names. For example show bridges foo.* returns a summary of configured bridges for all destinations that match the name foo.*. The type and pattern are optional.

The following is example output for this command:

 
  Source Name        Queue Targets  Topic Targets 
Q queue.source                   1              1 
T topic.source                   1              2 
 

Destinations that match the specified pattern and/or type are listed in the Source Name column. The number of bridges to queues for each destination is listed in the Queue Targets column. The number of bridges to topics for each destination is listed in the Topic Targets column.

show config

show config 

Shows the configuration parameters for the connected server.

show connections

show connections [type=q|t|s] [host=<hostname>] [user=<username>] 
[version] [address] 

Shows connections between clients and server; Table 22 describes the output table. The type parameter selects a subset of connections to display; see Table 21. The hostname and username parameters can further narrow the output to only those connections involving a specific host or user. When the version flag is present, the display includes the client’s version number.

Table 21 show connections: type Parameter 
Type
Description
type=q
Show queue connections only.
type=t
Show topic connections only.
type=s
Show system connections only.
absent
Show queue and topic connections, but not system connections.

Table 22 show connections Table Information (Sheet 1 of 3)
Heading
Description
L
The type of client. Can be one of the following:
  • J — Java client
  • C — C client
  • # — C# client
  • - — unknown system connection
Version
The TIBCO Enterprise Message Service version of the client.
ID
Unique connection ID. Each connection is assigned a unique, numeric ID that can be used to delete the connection.
FSXT
Connection type information.
The F column displays whether the connection is fault-tolerant.
  • - — not a fault-tolerant connection, that is, this connection has no alternative URLs
  • + — fault-tolerant connection, that is, this connection has alternative URLs
The S column displays whether the connection is using the SSL protocol.
  • - — connection is not SSL
  • + — connection is SSL
  • / — the client uses SSL, but connects by way of an external SSL accelerator to one of the server's TCP ports
The X column displays whether the connection is XA.
  • - — connection is not XA
  • + — connection is an XA connection
The T column displays the connection type.
  • C — generic user connection
  • T — user TopicConnection
  • Q — user QueueConnection
  • A — administrative connection
  • R — system connection to another route server
  • F — system connection to the fault-tolerant server
S
Connection started status, + if started, - if stopped.
Host
Connection's host name. (If the name is not available, this column displays the host’s IP address.)
Address
Connection's IP address.
If you supply the keyword address, then the table includes this column.
User
Connection user name. If a user name was not provided when the connection was created, it is assigned the default user name anonymous.
ClientID
Client ID of the connection.
Sess
Number of sessions on this connection.
Uptime
Time that the connection has been in effect.

show db

show db <store_type>

Print a summary of the server’s databases.

show durable

show durable <durable-name> 

Show information about a durable subscriber.

Table 23 show durable Table Information (Sheet 1 of 2)
Heading
Description
Durable Subscriber
Fully qualified name of the durable subscriber. This name concatenates the client ID (if any) and the subscription name (separated by a colon).
Subscription name
Full name of the durable subscriber.
Client ID
Client ID of the subscriber’s connection.
Topic
The topic from which the durable subscription receives messages.
Type
dynamic—created by a client
static—configured by an administrator
Status
online
offline
Username
Username of the durable subscriber (that is, of the client’s connection).
If the durable subscriber is currently offline, the value in this column is offline.
Consumer ID
This internal ID number is not otherwise available outside the server.
No Local
enabled—the subscriber does not receive messages sent from its local connection (that is, the same connection as the subscriber).
disabled—the subscriber receives messages from all connections.
Selector
The subscriber receives only those messages that match this selector.
Pending Msgs
Number of all messages in the topic. (This count includes the number of delivered messages.)
Delivered Msgs
Number of messages in the topic that have been delivered to the durable subscriber, but not yet acknowledged.
Pending Msgs Size
Total size of all pending messages

show durables

show durables [<pattern>] 

If a pattern is not entered, this command shows a list of all durable subscribers on all topics.

If a pattern is entered (for example foo.*) this command shows a list of durable subscribers on topics that match that pattern.

This command prints a table of information described in Table 24.

Table 24 show durables Table Information 
Heading
Description
Topic Name
Name of the topic.
An asterisk preceding this name indicates a dynamic durable subscriber. Otherwise the subscriber is static (configured by an administrator).
Durable
Full name of the durable subscriber.
User
Name of the user of this durable subscriber. If the durable subscriber is currently offline, the value in this column is offline.
For users defined externally, there is an asterisk in front of the user name.
Msgs
Number of pending messages
Size
Total size of pending messages

For more information, see Destination Properties.

show factory

show factory <factory-name> 

Shows properties of specified factory.

show factories

show factories 

Shows all factories

show jndiname

show jndiname <jndiname> 

Shows the object that the specified name is bound to by the JNDI server.

show jndinames

show jndinames [<type>] 

The optional parameter <type> can be:

When type is specified only JNDI names bound to objects of the specified type are shown. When type is not specified, all JNDI names are shown.

show group

show group <group-name> 

Shows group name, description, and number of members in the group.

For groups defined externally, there is an asterisk in front of the group name. Only groups with at least one currently connected user are shown.

show groups

show groups 

Shows all groups.

For groups defined externally, there is an asterisk in front of the group name. Only groups with at least one currently connected user are shown.

show members

show members <group-name> 

Shows all user members of specified group.

show message

show message <messageID> 

Shows the message for the specified message id.

This command requires that tracking by message ID be turned on using the track_message_ids configuration parameter.

show messages

show messages <correlationID> 

Shows the message IDs of all messages with the specified correlation ID set as JMSCorrelationID message header field. You can display the message for each ID returned by this command by using the show message <messageID> command.

This command requires that tracking by correlation ID be turned on using the track_correlation_ids configuration parameter.

show parents

show parents <user-name> 

Shows the user’s parent groups. This command can help you to understand the user’s permissions.

show queue

show queue <queue-name> 

Table 25 show queue Table Information (Sheet 1 of 2)
Heading
Description
Queue
Full name of the queue.
Type
dynamic—created by a client
static—configured by an administrator
Properties

A list of property names that are set on the queue, and their values. For an index list of property names, see Destination Properties.

JNDI Names
A list of explicitly assigned JNDI names that refer to this queue.
Bridges
A list of bridges from this queue to other destinations.
Receivers
Number of consumers on this queue.
Pending Msgs
Number of all messages in the queue. (This count includes the number of delivered messages.)
Delivered Msgs
Number of messages in the queue that have been delivered to a consumer, but not yet acknowledged.
Pending Msgs Size
Total size of all pending messages

show queues

show queues [<pattern-name>] 

If a pattern-name is not entered, this command shows a list of all queues.

If a pattern-name is entered (for example foo.*) this command shows a list of queues that match that pattern.

A * appearing before the queue name indicates a dynamic queue.

This command prints a table of information described in Table 26.

Table 26 show queues Table Information (Sheet 1 of 2)
Heading
Description
Queue Name
Name of the queue. If the name is prefixed with an asterisk (*), then the queue is temporary or was created dynamically. Properties of dynamic and temporary queues cannot be changed.
SNFGXIBCT
Prints information on the topic properties in the order
(S)ecure (N)sender_name or sender_name_enforced (F)ailsafe (G)lobal e(X)clusive (I)mport (B)ridge (C)flowControl (T)race
The characters in the value section show:
- Property not present
+ Property is present, and was set on the topic itself
* Property is present, and was inherited from another queue
Note that inherited properties cannot be removed.
Pre
Prefetch value. if the value is prefixed with an asterisk (*), then it is inherited from another queue or is the default value.
Rcvrs
Number of currently active receivers
Msgs
Number of pending messages
Size
Total size of pending messages

For more information, see Destination Properties.

show route

show route <route-name>

Shows the properties (URL and SSL properties) of a route.

show routes

show routes

Shows the properties (URL and SSL properties) of all created routes.

These commands print the information described in Table 27.

Table 27 show routes Table Information (Sheet 1 of 2)
Heading
Description
Route
Name of the route.
T
Type of route:
  • A indicates an active route.
  • P indicates a passive route.
ConnID
Unique ID number of the connection from this server to the server at the other end of the route.
A hyphen (-) in this column indicates that the other server is not running.
URL
URL of the server at the other end of the route.
ZoneName
Name of the zone for the route.
ZoneType
Type of the zone:
  • m indicates a multi-hop zone.
  • 1 indicates a multi-hop zone.

show rvcmledger

show rvcmledger [<subject or wildcard>] 

This command is provided for backward compatibility with earlier releases and an earlier mechanism for specifying RVCM transports. If you are using the newer mechanism for specifying transports, use the command show rvcmtransportledger instead.

Displays the TIBCO Rendezvous certified messaging (RVCM) ledger file entries for the specified subject. You can specify a subject name, use wildcards to retrieve all matching subjects, or specify no subject name to retrieve all ledger file entries.

For more information about ledger files and the format of ledger file entries, see TIBCO Rendezvous documentation.

show rvcmtransportledger

show rvcmtransportledger <transport> [<subject or wildcard>] 

Displays the TIBCO Rendezvous certified messaging (RVCM) ledger file entries for the specified transport and the specified subject. You can specify a subject name, use wildcards to retrieve all matching subjects, or omit the subject name to retrieve all ledger file entries.

For more information about ledger files and the format of ledger file entries, see TIBCO Rendezvous documentation.

show rvcmlisteners

show rvcmlisteners 

Shows all RVCM listeners that have been created using the create rvcmlistener command or by editing the tibrvcm.conf file.

show server

show server (aliases: info, i) 

Shows server name and information about the connected server.

show stat

show stat consumers [topic=<name> | queue=<name>] [user=<name>]  
          [connection=<id>] [total] 
show stat producers [topic=<name> | queue=<name>] [user=<name>]  
          [connection=<id>] [total] 
show stat route [topic=<name> | queue=<name>] [total] [wide] 
show stat topic <name> [total] [wide] 
show stat queue <name> [total] [wide] 

Displays statistics for the specified item. You can display statistics for consumers, producers, routes, or destinations. Statistic gathering must be enabled for statistics to be displayed. Also, detailed statistics for each item can be displayed if detailed statistic tracking is enabled. Averages for inbound/outbound messages and message size are available if an interval is specified in the rate_interval configuration parameter.

The total keyword specifies that only total number of messages and total message size for the item should be displayed. The wide keyword displays inbound and outbound message statistics on the same line.

See Working with Server Statistics for a complete description of statistics and how to enable/disable statistic gathering options.

show topic

show topic <topic-name> 

Table 28 show topic Table Information (Sheet 1 of 2)
Heading
Description
Topic
Full name of the topic.
Type
dynamic—created by a client
static—configured by an administrator
Properties

A list of property names that are set on the topic, and their values. For an index list of property names, see Destination Properties.

JNDI Names
A list of explicitly assigned JNDI names that refer to this topic.
Bridges
A list of bridges from this topic to other destinations.
Consumers
Number of consumers on this topic. (This count also includes durable consumers.)
Durable Consumers
Number of durable consumers on this topic.
Pending Msgs
Number of all messages in the topic. (This count includes the number of delivered messages.)
Pending Msgs Size
Total size of all pending messages
The server accumulates the following statistics only when the administrator has enabled statistics. Otherwise these items are zero.
Total Inbound Msgs
Cumulative count of all messages delivered to the topic.
Total Inbound Bytes
Cumulative total of message size over all messages delivered to the topic.
Total Outbound Msgs
Cumulative count of messages consumed from the topic by consumers. Each consumer of a message increments this count independently of other consumers, so one inbound message results in n outbound messages (one per consumer).
Total Outbound Bytes
Cumulative total of message size over all messages consumed from the topic by consumers. Each consumer of a message contributes this total independently of other consumers.

show topics

show topics [<pattern-name>] 

If a pattern-name is not entered, this command shows a list of all topics.

If a pattern-name is entered (for example foo.*) this command shows a list of topics that match that pattern.

This command prints a table of information described in Table 29.

Table 29 Show topics table information 
Heading
Description
Topic Name
Name of the topic. If the name is prefixed with an asterisk (*), then the topic is temporary or was created dynamically. Properties of dynamic and temporary topics cannot be changed.
SNFGEIBCT
Prints information on the topic properties in the order
(S)ecure (N)sender_name or sender_name_enforced (F)ailsafe (G)lobal (E)xport (I)mport (B)ridge (C)flowControl (T)race
The characters in the value section show:
- Property not present
+ Property is present, and was set on the topic itself
* Property is present, and was inherited from another topic
Note that inherited properties cannot be removed.
Subs
Number of current subscribers on the topic, including durable subscribers
Durs
Number of durable subscribers on the topic
Msgs
Number of pending messages, including messages to durable receivers
Size
Total size of pending messages

For more information, see Destination Properties.

show transactions

show transactions  

Shows all transactions that were created using the XA interface of the C or Java clients. Each transaction is displayed on its own line containing the transaction state followed by the transaction identifier (XID). The transaction state can be one of the following:

show transport

show transport <transport> 

Displays the configuration for the specified transport defined in transports.conf.

show transports

show transports 

Lists all configured transport names in transports.conf.

show user

show user <user-name>  

Shows user name and description. If no user name is specified, this command displays the currently logged in user.

For users defined externally, there is an asterisk in front of the user name.

show users

show users 

Shows all users.

For users defined externally, there is an asterisk in front of the user name. Only currently connected external users are shown.

showacl group

showacl group <group-name> 

Shows all permissions set for a given group. Shows the group and the set of permissions.

showacl queue

showacl queue <queue-name> 

Shows all permissions set for a queue. Lists all entries from the acl file. Each entry shows the “grantee” (user or group) and the set of permissions.

showacl topic

showacl topic <topic-name> 

Shows all permissions set for a topic. Lists all entries from the acl file. Each entry shows the “grantee” (user or group) and the set of permissions.

showacl user

showacl user <user-name> 

Shows all permissions set for a given user. Shows the user and the set of permissions.

shutdown

shutdown  

Shuts down currently connected server.

time

time [on | off] 

Specifying on places a timestamp before each command’s output. By default, the timestamp is off.

transaction commit

transaction commit <XID>  

Commits the transaction identified by the transaction ID. The transaction must be in the ended or prepared state. To obtain a transaction ID, issue the show transactions command, and cut and paste the XID into this command.

transaction rollback

transaction rollback <XID>  

Rolls back the transaction identified by the transaction ID. The transaction must be in the ended, rollback only, or the prepared state. To obtain a transaction ID, issue the show transactions command, and cut and paste the XID into this command.

updatecrl

updatecrl 

Immediately update the server’s certificate revocation list (CRL).

whoami

whoami 

Alias for the show user command to display the currently logged in user.


TIBCO Enterprise Message Service™ User’s Guide
Software Release 4.3, February 2006
Copyright © TIBCO Software Inc. All rights reserved
www.tibco.com