> 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.

> | 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 18, 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.
> See factories.conf on page 218 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 224.
> 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).

> | Regardless of the autocommit setting, the EMS server acts on each admin command immediately making it part of the configuration. The autocommit feature only determines when the configuration is written to the files.

> commit
> commit
> Commits all configuration changes into files on disk.
> compact
> compact store_name max_time
> Compacts the store files for the specified store.
> Since compaction can be a lengthy operation, and it blocks other database operations, max_time specifies a time limit (in seconds) for the operation. Note that max_time must be a number greater than zero.
> If truncation is not enabled for the store file, the compact command will not reduce the file size. Truncation is enabled using the file_truncate parameter in the stores.conf file. See stores.conf on page 226 for more information.
> We recommend compacting the store files only when the Used Space usage is 30% or less (see show store on page 153).

> | If you have not configured your EMS server application with multiple store files, the compact command syntax is: compact store_type max_time where store_type is:
> ● | a, async, or asynchronous to compact the asynchronous file.
> ● | s, sync, or synchronous to compact the synchronous file.
> The file will not be compacted unless the store_truncate parameter is enabled in the tibemsd.conf 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 213.
> 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 217.
> create factory
> create factory factory_name factory_parameters
> Creates a new connection factory.
> For descriptions of factory parameters, see factories.conf on page 218.
> 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 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 223.
> 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 224 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 229 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 229.
> 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.

> | User names cannot contain colon (:) characters.

> 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 12, 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 229 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:

> ● | receive

> ● | send

> ● | browse

> For more information on queue permissions, see Table 38 in User Permissions.
> Destination-level administrator permissions can also be granted with this command. The following are administrator permissions for queues.

> ● | view

> ● | create

> ● | delete

> ● | modify

> ● | purge

> 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:

> ● | subscribe

> ● | publish

> ● | durable

> ● | use_durable

> For more information on topic permissions, see Table 39 in User Permissions.
> Destination-level administrator permissions can also be granted with this command. The following are administrator permissions for topics.

> ● | view

> ● | create

> ● | delete

> ● | modify

> ● | purge

> 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 224.
> removeprop topic
> removeprop topic topic-name properties
> Remove the named properties from the named topic.
> 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.

> ● | To reset a password, type:

> set password user-name
> Type a new password at the prompt.

> ● | To remove a password, use this command without supplying a password, and press the Enter key at the prompt (without typing a password).

> | 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 16 describes the parameters you can set with this command.

> Table 16 Set server parameters
> 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 the authorization mode in the tibemsd.conf file. 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 62, Server Tracing Options. 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 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). 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 tibemsd.conf on page 165. 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.
> msg_swapping=enabled|disabled | Enables or disables the ability to swap messages to disk.
> 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. The password is 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. The password is 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,CHANNELS | Specifies which objects should have detailed statistic tracking. Detailed statistic tracking is only appropriate for routes, channels, 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 disables detailed statistic tracking. You can specify any combination of PRODUCERS, CONSUMERS, ROUTES, or CHANNELS 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 ...
> 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 224 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 channel
> show channel channel-name
> Show the details of a specific multicast channel. The channel-name must be the exact name of a specific channel. Wildcards and partial names are invalid.
> This command prints a table of information described in Table 17.

> Table 17 Description of output fields
> Heading | Description
> Channel | Name of the multicast channel.
> Address | The multicast group IP address and port destination to which messages are broadcast, in the form: <multicast-group-IP-address>:<multicast-port>
> TTL | The maximum number of number of network hops allowed for data on the channel.
> Priority | The transmission priority of messages on this channel when the EMS server allocates bandwidth. The highest priority is -5 and the lowest is 5.
> Max Rate | The maximum rate at which the server broadcasts messages over the channel.
> Max Time | The maximum length of time, in seconds, that the server holds sent messages for retransmission.
> Interface | The IP address over which the server sends multicast traffic on this channel. A value of 0.0.0.0 indicates that the default interfaces is being used.
> Status | The status of the channel, either active or inactive.
> Server Backlog | The number of messages and the total number of bytes pending broadcast over the channel. See Multicast and Flow Control for more information about controlling backlog.
> Transmitted | The total number of bytes sent on the channel. This number does not include retransmissions.
> Retransmitted | The total number of bytes sent in retransmissions on the channel.
> Retransmission Buffer | The total number of bytes that are currently buffered for retransmission.

> show channels
> show channels
> Print a summary of the server’s multicast channels, including each channel’s multicast address and status.
> show config
> show config
> Shows the configuration parameters for the connected server. The output includes:

> ● | configuration files

> ● | server database

> ● | listen ports

> ● | configuration settings

> ● | message tracking

> ● | server tracing parameters

> ● | statistics settings

> ● | fault-tolerant setup

> ● | external transport setup

> ● | server SSL setup

> ● | server LDAP parameters

> 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.
> 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.

> Table 18 Description of output fields
> Heading | Description
> Id | Consumer ID.
> Conn | Consumer's connection ID or '-' if this is a disconnected durable topic subscriber.
> Sess | Consumer's session ID or '-' if this is a disconnected durable topic subscriber.
> T | Consumer type character which can be one of: For topic consumer:
> ● | T - non-durable topic subscriber.
> ● | D - durable topic subscriber.
> ● | R - system-created durable for a routed topic.
> ● | P - proxy subscriber on route's temporary topic.
> For queue consumer:
> ● | Q - regular queue receiver.
> ● | q - inactive queue receiver.
> ● | P - system-created receiver on global queue for user receiver created in one of routes.
> Topic/Queue | Name of the subscription topic or queue.
> Name | (Topics Only.) Durable subscription name. This column is shown if at least one topic subscriber is a durable subscriber.
> SAS[N] | Description of columns:
> ● | S - '+' if consumer's connection started, '-' otherwise.
> ● | A - acknowledge mode of consumer's session, values are:
> − | N - no acknowledge
> − | A - auto acknowledge
> − | D - dups_ok acknowledge
> − | C - client acknowledge
> − | T - session is transactional
> − | X - XA or MS DTC session
> − | Z - connection consumer
> ● | S - '+' if consumer has a selector, '-' otherwise.
> ● | N - (TOPICS ONLY) '+' if subscriber is "NoLocal."
> Pre | Prefetch value of the consumer's destination.
> Pre Dlv | Number of prefetch window messages delivered to consumer
> Msgs Sent | Current number of messages sent to consumer which are not yet acknowledged by consumer's session.
> Size Sent | Combined size of unacknowledged messages currently sent to consumer. Value is rounded and shown in bytes, (K)ilobytes, (M)egabytes or (G)igabytes.
> Pend Msgs | (Topics Only.) Total number of messages pending for the topic consumer.
> Pend Size | (Topics Only.) Combined size of messages pending for the topic consumer. Value is rounded and shown in bytes, (K)ilobytes, (M)egabytes or (G)igabytes.
> Uptime | Uptime of the consumer.
> Last Sent | Approximate time elapsed since last message was sent by the server to the consumer. Value is approximate with precision of 1 second.
> Last Akcd | Approximate time elapsed since last time a message sent to the consumer was acknowledged by consumer's session. Value is approximate with precision of 1 second.
> Total Sent | Total number of messages sent to consumer since it was created. This includes resends due to session recover or rollback.
> Total Acked | Total number of messages sent to the consumer and acknowledged by consumer's session since consumer created.

> 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.

> Table 19 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 20 Description of output fields
> 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 EMS 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 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
> 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.
> IP Address | Shows client IP address. The address or full parameter must be specified to display this field.
> 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.
> Prod | Number of producers on this connection. The counts or full parameter must be specified to display this field.
> Cons | Number of consumers on this connection. The counts or full parameter must be specified to display this field.
> TmpT | Number of temporary topics created by this connection. For clients prior to 4.4 this is not known and shows "?." The counts or full parameter must be specified to display this field.
> TmpQ | Number of temporary queues created by this connection. For clients prior to 4.4 this is not known and shows "?." The counts or full parameter must be specified to display this field.
> Uncomm | Number of messages in uncommitted transactions on the connection. The counts or full parameter must be specified to display this field.
> UncommSize | The combined size, in bytes, of messages in uncommitted transactions on the connection. The counts or full parameter must be specified to display this field.
> Uptime | Time that the connection has been in effect.

> 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 153 for details about a specific database.
> show durable
> show durable durable-name
> Show information about a durable subscriber.

> Table 21 show durable Table Information
> 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 22.

> Table 22 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 [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:

> ● | destination

> ● | topic

> ● | queue

> ● | factory

> ● | topicConnectionFactory

> ● | queueConnectionFactory

> 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.

> | If the queue is a routed queue, specify only the name of the queue (do not specify the server using the queue-name@server form).

> Table 23 show queue Table Information
> 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 [notemp|static|dynamic]]
> 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. 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

> This command prints a table of information described in Table 24. A * appearing before the queue name indicates a dynamic queue.

> Table 24 show queues Table Information
> 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 followed by 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 25.

> Table 25 show routes Table Information
> 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 connected.
> 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 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 channel name [topic=name]
> 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, destinations, or channels. 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 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.

> Table 26 show store Table Information
> Heading | Description
> Store | Name of the store.
> Type | Type of store:
> ● | file indicates a file-based store.
> ● | dbstore indicates a database store.
> Message Count | The number of messages that are stored in the file.
> Swapped Count | The number of messages that have been swapped from process memory to store file.
> These headings are specific to file-based stores:
> File | File name associated with this store file, as it is set by the file parameter in the stores.conf file.
> Access Mode | 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.
> Pre-allocation Minimum | The amount of disk space, if any, that is preallocated to this file.
> CRC | 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.
> Periodic Truncation | 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.
> File Size | The size of the store file, including unused allocated file space.
> Free Space | The amount of unused allocated file space.
> Used Space | The amount of used space in the file.
> Message Size | Total size of all messages in the file.
> Swapped Size | The total size of swapped messages in the file.
> These headings are specific to database stores:
> JDBC Driver Name | The name of the JDBC database server.
> JDBC URL | The location of the JDBC database server.
> Username | The username that the EMS server uses to access the database.
> Dialect | The SQL dialect used to construct SQL commands.

> show stores
> show stores
> Print a list of the server’s stores.
> show topic
> show topic topic-name

> Table 27 show topic Table Information
> 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 | The total number of messages sent but not yet acknowledged by the consumer. This count includes copies sent to multiple subscribers.
> 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 [notemp|static|dynamic]]
> 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. 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

> This command prints a table of information described in Table 28.

> Table 28 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.
> SNFGEIBCTM | 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 (M)ulticast 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 | The total number of messages sent but not yet acknowledged by the consumer. This count includes copies sent to multiple subscribers. To see the count of actual messages (not multiplied by the number of topic subscribers) sent to all destinations, use the show server command.
> Size | Total size of pending messages

> For more information, see Destination Properties.
> 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 29 describes the information shown in each column.

> Table 29 Show transactions table information
> Heading | Description
> State | Transaction state:
> ● | A active
> ● | E ended
> ● | R rollback only
> ● | P prepared
> ● | S suspended
> Suspended transactions can be rolled back, but cannot be rolled forward (committed).
> Format ID | The XA transaction format identifier. 0 = OSI CCR naming is used >0 = some other format is used -1 = NULL
> GTrid Len | The number of bytes that constitute the global transaction ID.
> Bqual Len | The number of bytes that constitute the branch qualifier.
> Data | 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 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)

> | The output from this command displays inherited permissions prefixed with a '*'. Inherited permissions cannot be changed. An attempt to revoke an inherited permission for the principal user will not change the permission.

> 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.
> 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.