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.
add member group_name user_name [,
user2,
user3,...]
See factories.conf on page 236 for the list of factory properties.
You can set the zone_name and
zone_type parameters when creating a route, but you cannot subsequently change them.
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).
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 244 for more information.
|
•
|
a, async, or asynchronous to compact the asynchronous file.
|
•
|
s, sync, or synchronous to compact the synchronous file.
|
|
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:
If a user name or password are not provided, the user is prompted to enter a user name and password, or only the password, if the user name was already specified in the command.
You can enter connect with no other options and the administrative tool tries to connect to the local server on the default port, which is
7222.
type is either
topic or
queue.
will create new JNDI name FOO referring the same object referred by JNDI name
BAR
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 242 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.
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.
•
|
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.
|
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.
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).
delete all topics|queues topic-name-pattern|
queue-name-pattern
type is either
topic or
queue.
See Destination Bridges for more information on bridges.
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.
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.
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.
•
|
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.
|
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 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 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.
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.
Enter help commands for a summary of all available commands.
Enter help command for help on a specific command.
When used with the pattern parameter, this command erases all messages in all queues that fit the pattern (for example:
foo.*).
When used with the pattern parameter, this command erases all messages in all topics that fit the pattern (for example:
foo.*).
You can set the zone_name and
zone_type parameters when creating a route, but you cannot subsequently change them.
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.
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.
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.
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.
|
|
|
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).
|
|
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.
|
|
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 64, Server Tracing Options.
•
|
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.
|
The following example sets the trace log to only show messages about access control violations.
The next example sets the trace log to show all default trace messages, in addition to SSL messages, but ADMIN messages are not shown.
|
console_trace=console-trace-items
|
Sets trace options for output to stderr. The values are the same as for log_trace. However, console tracing is independent of log file tracing.
If logfile is defined, you can stop console output by specifying:
Note that important error messages (and some other messages) are always output, overriding the trace settings.
This example sends a trace message to the console when a TIBCO Rendezvous advisory message arrives.
|
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).
Setting this parameter using the administration tool does not change its value in the configuration file tibemsd.conf.
|
|
Specify units as KB, MB or GB. The minimum value is 8MB. Zero is a special value, indicating no limit.
|
|
|
|
|
|
|
|
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.
|
|
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.
|
|
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.
|
|
Enables or disables statistic gathering for producers, consumers, destinations, and routes. By default this parameter is set to disabled.
|
|
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.
|
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.
|
|
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.
|
|
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.
|
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.
You can set the zone_name and
zone_type parameters when creating a route, but you cannot subsequently change them.
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 names of the destinations to which the specified destination has configured bridges are listed in the Target Name column. The type and the message selector (if one is defined) for the bridge are listed in the Type and Selector column.
Shows a summary of the destination bridges that are currently configured. The type option specifies the type of destination 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.
Source Name Queue Targets Topic Targets
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 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.
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:
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.
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.
|
|
|
•
|
- — 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
|
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
|
•
|
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.
|
|
|
|
If you supply the keyword address, then the table includes this column.
|
|
Connection user name. If a user name was not provided when the connection was created, it is assigned the default user name anonymous.
|
|
|
|
|
|
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.
|
|
|
See the show store on page 163 for details about a specific database.
If a pattern is entered (for example foo.*) this command shows a list of durable subscribers on topics that match that pattern.
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.
|
|
|
|
|
dynamic—created by a client
static—configured by an administrator
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
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.*) 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
|
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.
|
|
|
|
|
•
|
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.
|
|
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.
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.
The store-name must be the exact name of a specific store.
|
|
|
|
|
•
|
file indicates a file-based store.
|
•
|
dbstore indicates a database store.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
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.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
The maximum length of time that the EMS server takes to examine all messages in the mstore. This interval is controlled with the scan_iter_interval parameter in the stores.conf file.
|
Discard Scan Interval Bytes
|
The bytes read and processed every Discard Scan Interval. This number is proportional to the mstore file size, and must be kept within the limits of your storage medium. See Understanding mstore Intervals for more information.
|
|
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 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.*) 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
|
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.
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 29 describes the information shown in each column.
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:
then the XID is 0 6 2 branchid. Note that the spaces are required.
Table 30 describes the information shown in each column.
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).
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).
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 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)
Specifying on places a timestamp before each command’s output. By default, the timestamp is
off.
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.
Commits the transaction identified by the transaction ID. The transaction must be in the
ended or
prepared state. To obtain a transaction ID, issue the
show transactions command, and cut and paste the XID into this command.
Rolls back the transaction identified by the transaction ID. The transaction must be in the
ended,
rollback only, or the
prepared state. To obtain a transaction ID, issue the show transactions command, and cut and paste the XID into this command.