add member group_name user_name [,
user2,
user3,...]
See factories.conf on page 250 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.
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:
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 route properties are listed in routes.conf on page 260 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]
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.
•
|
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
grant topic topic-name user=
name | group=
name 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 set server command can control many parameters. Multiple parameters are separated by spaces.
Table 17 describes the parameters you can set with this command.
|
|
|
|
|
|
|
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.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
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.
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.
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 20. 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.
|
|
|
|
|
|
|
|
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 171 for details about a specific database.
|
|
|
|
|
|
|
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.
|
|
|
|
|
|
|
|
|
If a pattern is entered (for example foo.*) this command shows a list of durable subscribers on topics that match that pattern.
|
|
|
|
|
|
|
Y to indicate that this is a shared durable subscription, N otherwise.
|
|
|
|
|
|
|
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.* or
foo.>) this command shows a list of queues that match that pattern. See
Wildcards * and > for more information about using wildcards.
•
|
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 25. 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.
|
|
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.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
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.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
dynamic—created by a client
static—configured by an administrator
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
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.
•
|
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 29.
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 30.
|
|
|
|
|
•
|
T — non-durable subscription
|
|
|
|
|
|
|
•
|
S - '+' if the subscription has a selector, ' -' otherwise.
|
•
|
S - '+' if the subscription is shared, ' -' otherwise.
|
|
|
|
|
|
|
|
|
|
Table 31 describes the information shown in each column.
then the XID is 0 6 2 branchid. Note that the spaces are required.
Table 32 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.
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.