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 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.
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.
Adds properties to the queue. Property names are separated by commas.
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.
zone_name
and zone_type
parameters when creating a route, but you cannot subsequently change them.
routes.conf
, see routes
.
Adds properties to the topic. Property names are separated by commas.
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)
.
Commits all configuration changes into files on disk.
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
).
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
for example:
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
.
<type>
is either topic
or queue
.
For further information, see bridges
.
<type>
is either topic
or queue
.
For descriptions of parameters and properties, and information about conflict situations, see durables
.
Creates a new connection factory.
For descriptions of factory parameters, see factories
.
For SSL parameters, see Table 41.
Creates a new group. See Naming Conventions.
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
Creates a queue with the specified name and properties. See Naming Conventions
Optional queue properties are:
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.
zone_name
and zone_type
parameters when creating a route, but you cannot subsequently change them.
routes.conf
, see routes
.
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.
Creates a topic with specified name and properties. See Naming Conventions
Optional topic properties are:
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.
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.
<type>
is either topic
or queue
.
Deletes the named connection for the client. The connection ID is shown in the first column of the connection description printed by show connection
.
Deletes a durable subscriber.
See also, Conflicting Specifications.
Deletes a factory.
Deletes a group.
Deletes a jndiname. Notice that deleting the last JNDIname of a connection factory object will remove the connection factory object as well.
Deletes the message with the specified message ID.
Deletes a queue.
Deletes a route.
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.
Deletes a topic with specified name.
Deletes a user.
Disconnects the administrative tool from the server.
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
.
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.
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.
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.
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.
Usage help.
Enter help commands
for a command summary.
Enter help <
command
>
for help on a specific command.
Shows server name and information about the connected server.
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.*
).
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.*
).
Erases all messages in the topic for a specified durable subscriber
Erases all messages in the queue.
Erases all messages in the topic.
Removes one or more users from a group.
Removes properties from a factory.
Removes properties from a queue.
Removes properties from a route.
You cannot remove topic selectors.
zone_name
and zone_type
parameters when creating a route, but you cannot subsequently change them.
routes.conf
, see routes
.
Removes properties from a topic.
Revokes the specified global administrator permissions from the specified user. See Chapter 9, Authentication and Permissions for more information about administrator 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.
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.
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
.
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.
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.
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:
Examples
The following example sets the trace log to only show messages about access control violations.
The next example sets the trace log to show all default trace messages, in addition to SSL messages, but ADMIN messages are not shown.
|
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:
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.
|
client_trace={enabled | disabled} <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. |
Sets the properties for a factory, overriding any existing properties. Multiple properties are separated by spaces.
Sets the properties for a queue, overriding any existing properties. Multiple properties are separated by commas.
Sets the properties for a route, overriding any existing properties. Topic and queue names are separated by commas. Multiple properties are separated by spaces.
zone_name
and zone_type
parameters when creating a route, but you cannot subsequently change them.
routes.conf
, see routes
.
Sets topic properties overriding any existing properties. Multiple properties are separated by commas.
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.
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:
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.
Shows the configuration parameters for the connected server.
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.
show db
<store_type>
Print a summary of the server’s databases.
Show information about a durable subscriber.
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.
For more information, see Destination Properties.
Shows properties of specified factory.
Shows all factories
Shows the object that the specified name is bound to by the JNDI server.
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.
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.
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.
Shows all user members of specified group.
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.
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.
Shows the user’s parent groups. This command can help you to understand the user’s permissions.
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
|
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.
For more information, see Destination Properties.
show route <
route-name
>
Shows the properties (URL and SSL properties) of a route.
show routes
Shows the properties (URL and SSL properties) of all created routes.
These commands print the information described in Table 27.
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.
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.
Shows all RVCM listeners that have been created using the create rvcmlistener
command or by editing the tibrvcm.conf
file.
Shows server name and information about the connected server.
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.
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.
|
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.
For more information, see Destination Properties.
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:
Displays the configuration for the specified transport defined in transports.conf
.
Lists all configured transport names in transports.conf
.
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.
Shows all users.
For users defined externally, there is an asterisk in front of the user name. Only currently connected external users are shown.
Shows all permissions set for a given group. Shows the group and the set of permissions.
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.
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.
Shows all permissions set for a given user. Shows the user and the set of permissions.
Shuts down currently connected server.
Specifying on
places a timestamp before each command’s output. By default, the timestamp is off
.
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.
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.
Immediately update the server’s certificate revocation list (CRL).
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 |