Copyright © TIBCO Software Inc. All Rights Reserved
Copyright © TIBCO Software Inc. All Rights Reserved


Chapter 6 Using the EMS Administration Tool : Command Listing

Command Listing
The command line interface of the administration tool allows you to perform a variety of functions. Note that when a system uses shared configuration files, the actions performed using the administration tool take effect only when connected to the active server.
 
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.
See factories.conf on page 251 for the list of factory properties.
An example is:
addprop factory MyTopicFactory ssl_trusted=cert1.pem ssl_trusted=cert2.pem ssl_verify_host=disabled
addprop queue
addprop queue queue-name properties,...
Adds properties to the queue. Property names are separated by commas.
For information on properties that can be assigned to queues, see Destination Properties.
addprop route
addprop route route-name prop=value[ prop-value...]
Adds properties to the route.
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 properties, see Configuring Routes and Zones.
For the configuration file routes.conf, see routes.conf on page 259.
addprop topic
addprop topic topic_name properties,...
Adds properties to the topic. Property names are separated by commas.
For information on properties that can be assigned to topics, see Destination Properties.
autocommit
autocommit [on|off]
When autocommit is set to on, the changes made to the configuration files are automatically saved to disk after each command. 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.
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-name max-time
Compacts the store files for the specified store. Compaction is available for stores of type file and mstore, but is not available for stores of type dbstore.
Since compaction can be a lengthy operation and it blocks other operations, max-time specifies a time limit (in seconds) for the operation. Note that max-time must be a number greater than zero. For mstore files, you can optionally specify nolimit for the max-time. See below for more information.
For stores of type file:
If truncation is not enabled for the store file, the compact command does not reduce the file size. Enable truncation using the file_truncate parameter in the stores.conf file. See stores.conf on page 261 for more information.
For stores of type mstore:
Time-bound compact  Use max-time to specify a time limit (in seconds) for the compact operation. Time-bound compaction may increase the fragmentation of the store files. This feature is not available by default. Before using it, you need to run the tibemsdbconvert tool with option -version 8.3 on the required mstore files. See Using the tibemsdbconvert Tool for more information.
No-limit compact  Enter nolimit for max-time. This triggers a full re-write of the store with no time limit. Once started, it is not possible to interrupt the re-write. All other operations (creating new connections, sending and receiving messages, and so forth) are suspended until the store is fully re-written. This can take a very long time for large stores. Using nolimit effectively defragments a store file.
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]
Creates a bridge between destinations.
type is either topic or queue.
For further information, see bridges.conf on page 249.
create durable
create durable topic-name durable-name [property, ... ,property]
Creates a static durable subscriber.
For descriptions of parameters and properties, and information about conflict situations, see durables.conf on page 250.
create factory
create factory factory_name factory_parameters
Creates a new connection factory.
For descriptions of factory parameters, see factories.conf on page 251.
create group
create group group_name "description"
Creates a new group of users.
Initially, the group is empty. You can use the add member command to add users to the group.
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 jndiname 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. The possible queue properties are described in Destination Properties. Properties are listed in a comma-separated list, as described in queues.conf on page 258.
create route
create route name url=URL [properties ...]
Creates a route.
The name must be the name of the other server to which the route connects.
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.
The route properties are listed in routes.conf on page 259 and are specified 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 additional information on route parameters, see Configuring Routes and Zones.
create rvcmlistener
create rvcmlistener transport_name cm_name subject
Registers an RVCM listener with the server so that any messages exported to 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.
The parameters are:
transport_name — the name of the transport to which this RVCM listener applies.
cm_name — the name of the RVCM listener to which topic messages are to be exported.
subject — the RVCM subject name that messages are published to. This should be the same name as the topic names that specify the export property.
For more information, see tibrvcm.conf on page 265 and Rendezvous Certified Messaging (RVCM) Parameters.
create topic
create topic topic_name [properties]
Creates a topic with specified name and properties. See Destination Properties for the list of properties. Properties are listed in a comma-separated list, as described in topics.conf on page 267.
create user
create user user_name ["user_description"] [password=password]
Creates a new user. Following the user name, you can add an optional description of the user in quotes. The password is optional and can be added later using the set password command.
 
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
Delete the bridge between the specified source and target destinations.
type is either topic or queue.
See Destination Bridges for more information on bridges.
delete connection
delete connection connection-id
Delete 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 clientID
Delete the named durable subscriber.
When both the durable name and the client ID are specified, the EMS Server looks for a durable named clientID:durable-name in the list of durables. If a matching durable subscriber is not found, the administration tool prints an error message including the fully qualified durable name.
See also, Conflicting Specifications.
delete factory
delete factory factory-name
Delete the named connection factory.
delete group
delete group group-name
Delete the named group.
delete jndiname
delete jndiname jndiname
Delete the named JNDI name. Notice that deleting the last JNDI name of a connection factory object will remove the connection factory object as well.
See Chapter 13, Using the EMS Implementation of JNDI for more information.
delete message
delete message messageID
Delete the message with the specified message ID.
delete queue
delete queue queue-name
Delete the named queue.
delete route
delete route route-name
Delete the named route.
delete rvcmlistener
delete rvcmlistener transport_name cm_name subject
Unregister 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.
The parameters are:
transport_name — the name of the transport to which this RVCM listener applies.
cm_name — the name of the RVCM listener to which topic messages are exported.
subject — the RVCM subject name that messages are published to. This should be the same name as the topic names that specify the export property.
For more information, see tibrvcm.conf on page 265 and Rendezvous Certified Messaging (RVCM) Parameters.
delete topic
delete topic topic-name
Delete the named topic.
delete user
delete user user-name
Delete the named user.
disconnect
disconnect
Disconnect 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)
Exit 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-name user=name | group=name permissions
Grants specified permissions to specified user or group on specified queue. The name following the queue 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.
User permissions are:
For more information on queue permissions, see Table 47 in User Permissions.
Destination-level administrator permissions can also be granted with this command. The following are administrator permissions for queues.
For more information on destination permissions, see Destination-Level Permissions.
grant topic
grant topic topic-name 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.
Topic permissions are:
For more information on topic permissions, see Table 48 in User Permissions.
Destination-level administrator permissions can also be granted with this command. The following are administrator permissions for topics.
For more information on destination permissions, see Destination-Level Permissions.
grant admin
grant admin user=name | group=name admin_permissions
Grant the named global administrator permissions to the named user or group. For a complete listing of global administrator permissions, see Global Administrator Permissions.
help
help (aliases: h, ?)
Display help information.
Enter help commands for a summary of all available commands.
Enter help command for help on a specific command.
info
info (alias: i)
Shows server name and information about the connected server.
jaci clear
jaci clear
Empties the JACI permission cache of all entries.
jaci resetstats
jaci resetstats
Resets all statistics counters for the JACI cache to zero.
jaci showstats
jaci showstats
Prints statistics about JACI cache performance.
purge all queues
purge all queues [pattern]
Purge all or selected queues.
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]
Purge all or selected topics.
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
Purge all messages in the topic for the named durable subscriber
purge queue
purge queue queue-name
Purge all messages in the named queue.
purge topic
purge topic topic-name
Purge all messages for all subscribers on the named topic.
remove member
remove member group-name user-name[,user2,user3,...]
Remove one or more named users from the named group.
removeprop factory
removeprop factory factory-name properties
Remove the named properties from the named factory. See Connection Factory Parameters for a list of properties.
removeprop queue
removeprop queue queue-name properties
Remove the named properties from the named queue.
removeprop route
removeprop route route-name properties
Remove the named properties from the named route.
You cannot remove the URL.
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.conf on page 259.
removeprop topic
removeprop topic topic-name properties
Remove the named properties from the named topic.
resume route
resume route route-name
Resumes sending messages to named route, if messages were previously suspended using the suspend route command.
revoke admin
revoke admin user=name | group=name permissions
Revoke the specified global administrator permissions from the named user or group. See Chapter 8, Authentication and Permissions for more information about administrator permissions.
revoke queue
revoke queue queue-name user=name | group=name permissions
revoke queue queue-name * [user | admin | both]
Revoke the specified permissions from a user or group for the named queue.
User and group permissions for queues are receive, send, browse, and all. Administrator permissions for queues are view, create, delete, modify, and purge.
If you specify an asterisk (*), all user-level permissions on this queue are removed. You can use the optional admin parameter to revoke all administrative permissions, or the both parameter to revoke all user-level and administrative permissions on the queue.
For more information, see Chapter 8, Authentication and Permissions.
revoke topic
revoke topic topic-name user=name | group=name permissions
revoke topic topic-name * [user | admin | both]
Revoke the specified permissions from a user or group for the named topic.
User and group permissions for topics are subscribe, publish, durable, use_durable, and all. Administrator permissions for topics are view, create, delete, modify, and purge.
If you specify an asterisk (*), all user-level permissions on this topic are removed. You can use the optional admin parameter to revoke all administrative permissions, or the both parameter to revoke all user-level and administrative permissions on the topic.
For more information, see Chapter 8, Authentication and Permissions.
rotatelog
rotatelog
Force the current log file to be backed up and truncated. The server 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]
Set the password for the named user.
If you do not supply a password in the command, the server prompts you to type one.
 
set password user-name
Type a new password at the prompt.
 
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 17 describes the parameters you can set with this command.
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.
+  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.
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:
Administrators can trace a connection or group of connections. When this property is enabled, the client 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 client 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).
Specify units as KB, MB or GB. The minimum value is 8MB. Zero is a special value, indicating no limit.
setprop factory
setprop factory factory-name properties ...
Set the properties for a connection factory, overriding any existing properties. Multiple properties are separated by spaces. See Connection Factory Parameters for the list of the properties that can be set for a connection factory.
setprop queue
setprop queue queue-name properties, ...
Set the properties for a queue, overriding any existing properties. Any properties on a queue that are not explicitly specified by this command are removed.
Multiple properties are separated by commas. See Destination Properties for the list of the properties that can be set for a queue.
setprop route
setprop route route-name properties ...
Set the properties for a route, overriding any existing properties. Any properties on a route that are not explicitly specified by this command are removed.
You can set the zone_name and zone_type parameters when creating a route, but you cannot subsequently change them.
Multiple properties are separated by spaces. For route parameters, see routes.conf on page 259 and Configuring Routes and Zones.
setprop topic
setprop topic topic-name properties
Set topic properties, overriding any existing properties. Any properties on a topic that are not explicitly specified by this command are removed.
Multiple properties are separated by commas. See Destination Properties for the list of the properties that can be set for a topic.
show bridge
show bridge topic|queue bridge_source
Display information about the configured bridges for the named topic or queue. The bridge_source is the name of the topic or queue established as the source of the bridge.
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 established as the bridge source. For example, show bridges topic shows a summary of configured bridges for all topics that are established as a bridge source. The pattern specifies a pattern to match for source destination names. For example show bridges foo.* returns a summary of configured bridges for all source 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. The output includes:
show consumer
show consumer consumerID
Shows details about a specific consumer. The consumerID can be obtained from the show consumers output.
show consumers
show consumers [topic=name | queue=name] [durable] [user=name] [connection=id] [sort=conn|user|dest|msgs] [full]
Shows information about all consumers or only consumers matching specified filters. Output of the command can be controlled by specifying the sort or full parameter. If the topic or queue parameter is specified, then only consumers on destinations matching specified queue or topic are shown. The user and/or connection parameters show consumers only for the specified user or connection. Note that while the queue browser is open, it appears as a consumer in the EMS server.
The durable parameter shows only durable topic subscribers and queue receivers, but it does not prevent queue consumers to be shown. To see only durable topic consumers, use:
show consumers topic=> durable
The sort parameter sorts the consumers by either connection ID, user name, destination name, or number of pending messages. The full parameter shows all columns listed below and can be as wide as 120-140 characters or wider. Both topic and queue consumers are shown in separate tables, first the topic consumers and then the queue consumers.
 
show connections
show connections [type=q|t|s] [host=hostname] [user=username] [version] [address] [counts] [full]
Show connections between clients and server. Table 20 describes the output.
The type parameter selects the subset of connections to display as shown in Table 19. The host and user 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.
If the address parameter is specified, then the IP address is printed in the output table. If the counts parameter is specified, then number of producers, consumers and temporary destinations are printed. Specifying the full parameter prints all of the available information.
 
J — Java client
C — C client
# — C# client
- — unknown system connection
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 uses SSL.
- — connection is not SSL
+ — connection is SSL
The X column displays whether the connection is an XA or MS DTC transaction.
- — connection is not XA or MS DTC
+ — connection is either an XA or MS DTC connection
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
Connection started status, + if started, - if stopped.
The address or full parameter must be specified to display this field.
The address or full parameter must be specified to display this field.
If you supply the keyword address, then the table includes this column.
The counts or full parameter must be specified to display this field.
The counts or full parameter must be specified to display this field.
The counts or full parameter must be specified to display this field.
The counts or full parameter must be specified to display this field.
The counts or full parameter must be specified to display this field.
The counts or full parameter must be specified to display this field.
show db
show db
Print a summary of the server’s databases. Databases are also printed by show stores, the preferred command.
See the show store on page 170 for details about a specific database.
show durable
show durable durable-name
Show information about a durable subscriber.
 
yes if this is a shared durable subscription, no otherwise.
dynamic—created by a client
static—configured by an administrator
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.
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 22.
Y to indicate that this is a shared durable subscription, N otherwise.
Name of the user of this durable subscriber. If the durable subscriber is currently offline, the value in this column is offline. If this is a shared durable subscription, the value of this column is shared.
For more information, see Destination Properties.
show factory
show factory factory-name
Shows properties of specified factory.
show factories
show factories [generic|topic|queue]
Shows all factories. You can refine the listed output by specifying only generic, topic, or queue factories be listed.
show jndiname
show jndiname jndi-name
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 external groups with at least one currently connected user are shown.
show groups
show groups
Shows all user groups.
For groups defined externally, there is an asterisk in front of the group name.
show members
show members group-name
Shows all user members of specified user 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
Shows the details for the specified queue.
 
 
dynamic—created by a client
static—configured by an administrator
show queues
show queues [pattern-name [notemp|static|dynamic] [first=n|next=n|last=n]]
If a pattern-name is not entered, this command shows a list of all queues.
If a pattern-name is entered (for example foo.* or foo.>) this command shows a list of queues that match that pattern. See Wildcards * and > for more information about using wildcards.
You can further refine the list of queues that match the pattern by using one of the following parameters:
notemp — do not show temporary queues
static — show only static queues
dynamic — show only dynamic queues
When a pattern-name is entered, you can also cursor through the list of queues using one of the following commands, where n is whole number:
first=n — show the first n queues
next=n — show the next n queues
last=n — show the next n queues and terminate the cursor
The cursor examines n queues and displays queues that match the pattern-name. Because it does not traverse the full list of queues, the cursor may return zero or fewer than n queues. To find all matching queues, continue to use next until you receive a Cursor complete message.
The show queues command prints a table of information described in Table 24. A * appearing before the queue name indicates a dynamic queue.
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.
Prefetch value. If the value is followed by an asterisk (*), then it is inherited from another queue or is the default value.
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 25.
A indicates an active route.
P indicates a passive route.
A hyphen (-) in this column indicates that the other server is not connected.
m indicates a multi-hop zone.
1 indicates a one-hop zone.
show rvcmtransportledger
show rvcmtransportledger transport_name [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 name [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 state
show state
Shows the state and a minimal subset of the information about the connected EMS server.
show store
show store store-name
Show the details of a specific store. This command can be used to get details about either a file-based store or a database store.
The store-name must be the exact name of a specific store.
This command prints a table of information described in Table 26.
file indicates a file-based store.
dbstore indicates a database store.
mstore indicates an mstore.
asynchronous—the server stores messages in the file using asynchronous I/O calls.
synchronous—the server stores messages in the file using synchronous I/O calls.
enabled—the server uses CRC to validate checksum data when reading the store file.
disabled—the server does not validate checksum data when reading the store file.
enabled—the EMS server occasionally truncates the store file, relinquishing unused disk space.
disabled—the EMS server does not truncate the store file to relinquish unused disk space.
asynchronous — the server writes messages in the mstore files using asynchronous I/O calls.
synchronous — the server writes messages in the mstore files using synchronous I/O calls.
available — this mstore can be compacted in a time-bound manner or through the mstore_truncate property.
unavailable — this mstore cannot be compacted in a time-bound manner or through the mstore_truncate property.
enabled — the server occasionally truncates the mstore files, relinquishing unused disk space.
disabled — the server does not truncate the mstore files to relinquish unused disk space.
true—all the data in the store has been examined at least once since the EMS server startup.
false—not all data has been examined since the EMS server last started. When false, certain server statistics (such as the Message Count field) may be underreported as a result of expired or purged messages still in the store. See Implications for Statistics for more information.
show stores
show stores
Print a list of the server’s stores.
show topic
show topic topic-name
 
dynamic—created by a client
static—configured by an administrator
show topics
show topics [pattern-name [notemp|static|dynamic] [first=n|next=n|last=n]]
If a pattern-name is not entered, this command shows a list of all topics.
If a pattern-name is entered (for example foo.* or foo.>) this command shows a list of topics that match that pattern. See Wildcards * and > for more information about using wildcards.
You can further refine the list of topics that match the pattern by using one of the following parameters:
notemp — do not show temporary topics
static — show only static topics
dynamic — show only dynamic topics
When a pattern-name is entered, you can also cursor through the list of topics using one of the following commands, where n is whole number:
first=n — show the first n topics
next=n — show the next n topics
last=n — show the next n topics and terminate the cursor
The cursor examines n topics and displays topics that match the pattern-name. Because it does not traverse the full list of topics, the cursor may return zero or fewer than n topics. To find all matching topics, continue to use next until you receive a Cursor complete message.
The show topics command prints a table of information described in Table 28.
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.
For more information, see Destination Properties.
show subscriptions
show subscriptions [topic=name] [name=sub-name] [shared=only|none] [durable=only|none] [sort=msgs|topic|name|cons|id]
This command prints information about all topic subscriptions, or only subscriptions matching specified filters. Command output is controlled using the sort parameter.
If topic=name is specified, then only subscriptions on destinations matching specified topic are shown. If name=sub-name is specified, then only subscriptions of that name are shown.
If durable=only is specified, then only durable subscriptions are shown.
If durable=none is specified, then only non-durable subscriptions are shown.
If shared=only is specified, then only shared subscriptions are shown.
If shared=none is specified, then only unshared subscriptions are shown.
The parameter sort allows you to specify how the command output is sorted in the output table. You can use to sort by number of pending messages, topic name, subscription name, number of consumers on that subscription, or the subscription's identifier.
The show subscriptions command prints a table of information described in Table 29.
T — non-durable subscription
D — durable subscription
S - '+' if the subscription has a selector, '-' otherwise.
S - '+' if the subscription is shared, '-' otherwise.
show transaction
show transaction XID
Shows a list of messages that were sent or received within the specified transaction. This command returns information on transactions in prepared, ended, and roll back states only. Transactions in a suspended or active state are not included.
Table 30 describes the information shown in each column.
A active
E ended
R rollback only
P prepared
S suspended
The message ID of the message. null indicates the message ID could not be obtained or was disabled. If track_message_ids is not enabled, this field displays Disabled.
Q queue
T topic
The destination name to which the message was sent. null indicates that destination could not be found.
The message ID of the message. null indicates the message ID could not be obtained or was disabled. If track_message_ids is not enabled, this field displays Disabled.
Q queue
T topic
The destination name to which the message was sent. null indicates that destination could not be found.
show transactions
show transactions
Shows the XID for all client transactions that were created using the XA or MS DTC interfaces. Each row presents information about one transaction. The XID is the concatenation of the Format ID, GTrid Len, Bqual Len, and Data fields for a transaction. For example, if show transactions returns the row:
State Format ID GTrid Len Bqual Len Data
  E      0          6          2        branchid
then the XID is 0 6 2 branchid. Note that the spaces are required.
Table 31 describes the information shown in each column.
A active
E ended
R rollback only
P prepared
S suspended
The global transaction identifier (gtrid) and the branch qualifier (bqual).
show transport
show transport transport
Displays the configuration for the specified transport defined in transports.conf.
See Configuring EMS Transports for TIBCO FTL, Configuring Transports for Rendezvous, and Configuring Transports for SmartSockets for details.
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 admin
showacl admin
Shows all administrative permissions for all users and groups, but does not include administrative permissions on destinations.
showacl group
showacl group group-name [admin]
Shows all permissions set for a given group. Shows the group and the set of permissions. You can optionally specify admin to show only the administrative permissions for destinations or principals. Specifying showacl admin shows all administrative permissions for all users and groups (not including administrative permissions on destinations).
showacl queue
showacl queue queue-name [admin]
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. You can optionally specify admin to show only the administrative permissions for destinations or principals. Specifying showacl admin shows all administrative permissions for all users and groups (not including administrative permissions on destinations).
showacl topic
showacl topic topic-name [admin]
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. You can optionally specify admin to show only the administrative permissions for destinations or principals. Specifying showacl admin shows all administrative permissions for all users and groups (not including administrative permissions on destinations).
showacl user
showacl user user-name [admin | all | admin-all]
Shows the user and the set of permissions granted to the user for destinations and principals.
showacl user username — displays permissions granted directly to the user. (An administrator can use this form of the command to view own permissions, even without permissions to view any other user permissions.)
showacl user username admin — displays administrative permissions granted directly to the user.
showacl user username all — displays direct and inherited (from groups to which the user belongs) permissions.
showacl user username admin-all — displays all administrative permissions for a given user (direct and inherited)
 
shutdown
shutdown
Shuts down currently connected server.
suspend route
suspend route route-name
Suspends outgoing messages to the named route.
Message flow can be recovered later using the command resume route.
time
time [on | off]
Specifying on places a timestamp before each command’s output. By default, the timestamp is off.
timeout
timeout [seconds]
Show or change the current command timeout value. The timeout value is the number of seconds the Administration Tool will wait for a response from the server after sending a command.
By default, the timeout is 30 seconds. When timeout is entered with the optional seconds parameter, the timeout value is reset to the specified number of seconds. When entered without parameter, the current timeout value is returned.
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.
 
Messages sent to a queue with prefetch=none and maxRedelivery=number properties are not received number times by an EMS application that receives in a loop and does an XA rollback after the XA prepare phase.
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.

Copyright © TIBCO Software Inc. All Rights Reserved
Copyright © TIBCO Software Inc. All Rights Reserved