NAME | SYNOPSIS | DESCRIPTION | OPTIONS | USAGE | EXAMPLES | ENVIRONMENT VARIABLES | EXIT STATUS | ATTRIBUTES | SEE ALSO
imqcmd manages the Message Queue broker, including resources such as connection services, physical destinations, durable subscriptions, and transactions. The utility provides a number of subcommands for managing these resources.
imqcmd supports many subcommands. Basic connection and authentication is required for the execution of every imqcmd subcommand. Use the -secure option to specify secure connections. Subcommands and their corresponding arguments and options follow the imqcmd command on the command line. See USAGE and OPTIONS.
The following options are supported:
Specify the name of the host on which the broker instance is running and the port number it is using.
The default value is localhost:7676. If you do not specify the -b option, imqcmd uses the default.
To specify port only, use: -b :7878. This is equivalent to -b localhost:7878
To specify name only, use: -b somehost. This is equivalent to -b somehost:7676.
Specify the ID of the durable subscriber to a topic.
Specify the name of the topic.
Use this option with the list dur and destroy dur subcommands.
Perform action without user confirmation.
Use this option with any subcommand.
Display usage help. Execute nothing else on the command line.
Display usage help, attribute list, and examples. Execute nothing else on the command line.
Specify the interval, in seconds, at which imqcmd displays broker metrics.
Use this option with the the metrics subcommand.
Specify an alternate Java 2 compatible runtime to use.
Specify the type of metric information to display.
Use one of the following values to specify metricType:
Total of messages in and out of the broker (default)
Provides the same information as ttl, but specifies the number of messages per second
Connections, virtual memory heap, threads
Use this option with the either the metrics bkr or metrics svc subcommand. The following command displays connection, VM heap, and threads metric information for the default broker instance (localhost:7676) every five seconds:
imqcmd metrics bkr -m cxn -int 5 |
Specify the name of the subcommand argument. Depending on the subcommand, this might be the name of a service, a physical destination, a durable subscription, or a transaction ID.
Specify the value of an attribute. Depending on the subcommand argument, this might be the attribute of a broker, service, or destination.
Specify the administrator password.
If you omit this value, you are prompted for it.
Silent mode. No output is displayed.
Use this option with any subcommand.
Specify a secure administration connection to the broker instance. You must first configure the broker to enable a secure connection service.
Use this option whenever you want a secure communication with the broker.
Specify the type of a destination: t (topic) or q (queue).
Include temporary destinations when listing destinations using the list dst subcommand.
Specify the administrator user name.
If you omit this value, you are prompted for it.
Display version information. Execute nothing else on the command line.
The following subcommands and associated arguments and options are supported:
Commit the specified transaction
Create a destination of the specified type, with the specified name, and the specified attributes. Destination names must contain only alphanumeric characters (no spaces) and can begin with an alphabetic character or the underscore character (_).
Destroy the destination of the specified type and name.
Destroy the specified durable subscription for the specified Client Identifier.
List all destinations, with option of listing temporary destinations as well .
List all durable subscriptions for the specified destination.
List all connection services on the broker instance.
List all transactions, being tracked by the broker.
Display broker metrics for the broker instance.
Use the -m option to specify the type of metric to display. Use one of the following values to specify metricType:
Total of messages in and out of the broker (default)
Provides the same information as ttl, but specifies the number of messages per second
Connections, virtual memory heap, threads
Use the -int option to specify the interval (in seconds) at which to display the metrics. The default is 5 seconds
List metrics for the specified service on the broker instance. Use the -m option to specify the type of metric to display. Use one of the following values to specify metricType:
Total of messages in and out of the broker (default)
Provides the same information as ttl, but specifies the number of messages per second
Connections, virtual memory heap, threads
Use the -int option to specify the interval (in seconds) at which to display the metrics. The default is 5 seconds.
Pause the broker instance.
Pause the specified service running on the broker instance. You cannot pause the administative service.
Purge messages at the destination with the specified type and name.
Purge all messages for the specified client identifier.
List the current settings of properties of the broker instance. Show the list of running brokers (in a multi-broker cluster) that are connected to the specified broker.
List information about the destination of the specified type and name.
Display information about the specified service running on the broker instance.
List information about the specified transaction.
Forces all the brokers in a cluster to reload the imq.cluster.brokerlist property and update cluster information. This subcommand only applies to broker clusters.
Shut down and restart the broker instance. This command restarts the broker using the options specified when the broker was first started. If you want different options to be in effect, you must shut down the broker and then start it again, specifying the options you want.
Resume the broker instance.
Resume the specified service running on the broker instance.
Roll back the specified transaction.
Shut down the broker instance
Change the specified attributes for the broker instance.
Update the value of the specified attributes at the specified destination..
Update the specified attribute of the specified service running on the broker instance.
You can specify attributes with the create and update subcommands. Applicable attributes depend on the subcommand arguments.
The following attributes are supported:
Queue (dst):
Value: String (f = Failover, r = Round Robin, s = Single)
Default: s
Value: Integer (maximum total size of messages, in bytes)
Default: 0 (unlimited)
Value: Integer (maximum size of a single message, in bytes)
Default: 0 (unlimited)
Value: Integer (maximum total number of messages)
Default: 0 (unlimited)
Topic (dst):
Value: Integer (maximum size of a single message, in bytes)
Default: 0 (unlimited)
Broker (bkr):
Value: Boolean
Default: true
Value: Boolean
Default: true
Value: String (location of cluster configuration file)
Default: none
Value: Integer (maximum size of a log file, in bytes)
Default: 0 (no rollover based on size)
Value: Integer (maximum age of a log file, in seconds)
Default: 0 (no rollover based on age)
Value: String (NONE, ERROR, WARNING, INFO)
Default: INFO
Value: Integer (maximum size of a single message, in bytes)
Default: 70m
Value: Integer
Default: 7676
Value: String (f = Failover, r = Round Robin, s = Single)
Default: s
Value: Integer (maximum total number of messages)
Default: 0 (no limit)
Value: Integer (maximum total size of messages, in bytes)
Default: 0 (no limit)
Service (svc):
Value: Integer (maximum threads assigned)
Default: Depends on service
Value: Integer (minimum threads assigned)
Default: Depends on service
Value: Integer
Default: 0 (dynamically allocated)
The following command shuts down a broker for hostname myserver on port 7676:
mqcmd shutdown bkr -b myserver:7676 |
The following command restarts a broker for hostname myserver:
imqcmd restart bkr -b myserver |
The following command pauses a broker for hostname localhost on port 7676, with a serviceName of jms:
imqcmd pause svc -n jms -b :7676 |
The following command resumes a service for hostname localhost on port 7676, with a serviceName of jms:
imqcmd resume svc -n jms -b myserver:7676 |
The following command creates a queue destination for hostname myserver on port 7676, with a destName of myFQ, a queueDeliveryPolicy of Failover, and a maxBytesPerMsg of 10000:
imqcmd create dst -n myFQ -t q -o "queueDeliveryPolicy=f" \ -o "maxBytesPerMsg=10000" -b myserver:7676 |
The following command purges a queue destination for hostname myserver on port 7676, with a destName of myFQ:
imqcmd purge dst -n myFQ -t q -b myserver:7676 |
The following command lists destinations for hostname myserver on port 7676:
imqcmd list dst -b myserver:7676 |
The following command updates a portmapper port on hostname myserver from port 7676 to 7878:
imqcmd update bkr -o "imq.portmapper.port=7878" |
The following command updates the maximum number of messages in the queue to 2000 for myserver on port 8080 with a destName of TestQueue:
imqcmd update dst -b myserver:8080 -n TestQueue -t q -o "maxNumMsgs=2000" |
The following command updates the maximum threads jms connection service to 200 for hostname localhost on port 7676:
imqcmd update svc -n jms -o "minThreads=200" |
The following command lists durable subscriptions for a topic with hostname localhost on port 7676 with a destName of myTopic:
imqcmd list dur -d myTopic |
The following command destroys subscriptions for hostname localhost on port 7676 with a dursubName of myDurSub and a client_ID of 111.222.333.444:
imqcmd destroy dur -n myDurSub -c "111.222.333.444" |
The following command lists all transactions on a broker with hostname localhost on port 7676:
imqcmd list txn |
The following command displays information about a transaction with hostname localhost on port 7676, and a transactionID of 1234567890
imqcmd query txn -n 1234567890 |
The following command commits a transaction with hostname localhost on port 7676, and a transactionID of 1234567890:
imqcmd commit txn -n 1234567890 |
The following environment variables affect the execution of this command:
IMQ_JAVAHOME
Specify the Java 2 compatible runtime. When this environment variable is not set it defaults to /usr/j2se.
See attributes(5) for descriptions of the following attributes:
ATTRIBUTE TYPE |
ATTRIBUTE VALUE |
---|---|
Availability |
SUNWiqu |
imqadmin(1M), imqbrokerd(1M), imqdbmgr(1M), imqkeytool(1M), imqobjmgr(1M), imqusermgr(1M), attributes(5)
Sun ONE Message Queue Administrator's Guide
NAME | SYNOPSIS | DESCRIPTION | OPTIONS | USAGE | EXAMPLES | ENVIRONMENT VARIABLES | EXIT STATUS | ATTRIBUTES | SEE ALSO