Added: incubator/activemq/site/ActiveMQ+Command+Line+Tools+Reference URL: http://svn.apache.org/viewcvs/incubator/activemq/site/ActiveMQ%2BCommand%2BLine%2BTools%2BReference?rev=374430&view=auto ============================================================================== --- incubator/activemq/site/ActiveMQ+Command+Line+Tools+Reference (added) +++ incubator/activemq/site/ActiveMQ+Command+Line+Tools+Reference Thu Feb 2 08:31:10 2006 @@ -0,0 +1,910 @@ + + + + + + + + ActiveMQ - ActiveMQ Command Line Tools Reference + + + + + + + + + + + + + + + +
+ + + + + + +
+

Overview

+ +

Community

+ +

Using ActiveMQ

+ +

Features

+ +

Connectivitiy

+ +

Utilities

+ +

External Tools

+ +

Related Projects

+ +

Support

+ +

Developers

+ +

Tools we use

+ +

Feeds

+ + + + + + + + + +
+
+
+ Site +
+ + + News +
+
+ +
+ + + + + +
+ ActiveMQ Command Line Tools Reference + + +
+
+ + +
+
+

Command Line Tools

+
    +
  • activemq - runs an activemq broker
  • +
  • shutdown - shutdowns an activemq broker
  • +
  • list - lists all running brokers in the specified JMX context
  • +
  • query - queries the JMX context for broker statistics and information
  • +
  • bstat - predefined query that displays useful broker statistics
  • +
  • browse - browse the messages of a specific queue
  • +
+

+

activemq script

+

+ + + + + + + + + + + + + + + +
Script Name activemq.bat, activemq
Task Usage activemq [options] [config] or java -jar run.jar start [options] [config]
Description Script to run an activemq broker either by specifying a broker configuration file or through a broker URI configuration.
+

+

Options:

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
Option Name Syntax Example Description
System Define Option -D<key>=<value> -Dactivemq.home=c:/ActiveMQ Sets a systems property. i.e Systems.getProperty("activemq.home"); will return c:/ActiveMQ
Help Option -h or -? or --help activemq --help Display the help messages for the activemq script.
Version Option --version activemq --version Display the activemq version information.
+

+

Examples:

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Example Description
activemq Runs a broker using the default 'xbean:activemq.xml' as the broker configuration file.
activemq xbean:myconfig.xml Runs a broker using the file myconfig.xml as the broker configuration file that is located in the classpath.
activemq xbean:file:./conf/broker1.xml Runs a broker using the file broker1.xml as the broker configuration file that is located in the relative file path ./conf/broker1.xml
activemq xbean:file:C:/ActiveMQ/conf/broker2.xml Runs a broker using the file broker2.xml as the broker configuration file that is located in the absolute file path C:/ActiveMQ/conf/broker2.xml
activemq broker:(tcp://localhost:61616, tcp://localhost:5000)?useJmx=true Runs a broker with two transport connectors and JMX enabled.¹
+
activemq broker:(tcp://localhost:61616, network:tcp://localhost:5000)?persistent=false Runs a broker with 1 transport connector and 1 network connector with persistence disabled.¹
+

+

¹ For details on how to configure using broker URI refer to: Broker Configuration URI

+

+

shutdown script

+

+ + + + + + + + + + + + + + + +
Script Name shutdown.bat, shutdown
Task Usage shutdown [options] [broker names] or java -jar run.jar stop [options] [broker names]
Description Script to stop a running activemq broker. This script requires that JMX is enabled.
+

+

Options:

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Option Name Syntax Example Description
Stop All Option --all shutdown --all Stops all registered brokers in the specified JMX context
JMX URL Option --jmxurl <url> --jmxurl service:jmx:rmi:///jndi/rmi://localhost:1099/jmxrmi Change the JMX service url to connect to. By default it connects to: service:jmx:rmi:///jndi/rmi://localhost:1099/jmxrmi
System Define Option -D<key>=<value> -Dactivemq.home=c:/ActiveMQ Sets a systems property. i.e Systems.getProperty("activemq.home"); will return c:/ActiveMQ
Help Option -h or -? or --help --help Display the help messages for the shutdown script.
Version Option --version activemq --version Display the activemq version information.
+

+

Examples:

+

+ + + + + + + + + + + + + + + + + + + + + + + +
Example Description
shutdown Stops the only running broker in the default JMX context. It assumes that there is only one running broker.
shutdown --jmxurl service:jmx:rmi:///jndi/rmi://remotehost:1099/jmxrmi --all Stops all the running broker in the specified JMX context.
shutdown localhost Stops the broker named 'localhost' in the default JMX context.
shutdown localhost remotehost Stops the brokers 'localhost' and 'remotehost' in the default JMX context.
+

+

+

list script

+

+ + + + + + + + + + + + + + + +
Script Name list.bat, list
Task Usage list [options] or java -jar run.jar list [options]
Description Script to list the names of all running brokers in the specified JMX context. This script requires that JMX is enabled.
+

+

Options:

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Option Name Syntax Example Description
JMX URL Option --jmxurl <url> --jmxurl service:jmx:rmi:///jndi/rmi://remotehost:1099/jmxrmi Change the JMX service url to connect to. By default it connects to: service:jmx:rmi:///jndi/rmi://localhost:1099/jmxrmi
System Define Option -D<key>=<value> -Dactivemq.home=c:/ActiveMQ Sets a systems property. i.e Systems.getProperty("activemq.home"); will return c:/ActiveMQ
Help Option -h or -? or --help --help Display the help messages for the list script.
Version Option --version activemq --version Display the activemq version information.
+

+

Examples:

+

+ + + + + + + + + + + + + + + +
Example Description
list Lists the names of all running brokers in the default JMX context.
list --jmxurl service:jmx:rmi:///jndi/rmi://remotehost:1099/jmxrmi List the names of all running brokers in the specified JMX context.
+

+

+

query script

+

+ + + + + + + + + + + + + + + +
Script Name query.bat, query
Task Usage query [options] or java -jar run.jar query [options]
Description Script to query the specified JMX context for mbean attributes and information. This script requires that JMX is enabled.
+

+

Options:

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Option Name Syntax Example Description
Predefined Query Option -Q<type>=<name> -QTopic=TEST.FOO, -QBroker=*host Predefined object name query option that queries a specific type of mbean object based on its type and selected identifier. Refer to the mbean reference table below for details.
  -xQ<type>=<name> -xQTopic=ActiveMQ.Advisory.*, -xQNetworkConnector=* Predefined object name query option that removes all mbeans that matches the query from the search result. Refer to the mbean reference table below for details.
Object Name Query Option --objname <object name query> --objname Type=Connect,BrokerName=local* Query option loosely based on the JMX object name format, which lets you filter mbeans based on their object name information. Refer to the mbean reference table below for details.
  --xobjname <object name query> --xobjname Type=Topic,Destination=ActiveMQ.Advisory.* Object name query that removes all mbeans that matches the query from the search result. Refer to the mbean reference table below for details.
View Option --view <view list> --view Type,BrokerName,Destination,EnqueueCount,DequeueCount Lets you specify the attributes and object name information to view. If the view is omitted, all attributes and information will be displayed.
JMX URL Option --jmxurl <url> --jmxurl service:jmx:rmi:///jndi/rmi://remotehost:1099/jmxrmi Change the JMX service url to connect to. By default it connects to: service:jmx:rmi:///jndi/rmi://localhost:1099/jmxrmi
System Define Option -D<key>=<value> -Dactivemq.home=c:/ActiveMQ Sets a systems property. i.e Systems.getProperty("activemq.home"); will return c:/ActiveMQ
Help Option -h or -? or --help --help Display the help messages for the query script.
Version Option --version activemq --version Display the activemq version information.
+

+

Examples:

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Example Description
query Display all attributes and object name information of all registered mbeans in the default JMX context.
query -QTopic=TEST.FOO Display all the attributes and object name information of the destination topic 'TEST.FOO'
query -QQueue=* Display all the attributes and object name information of all registered queues.
query -QTopic=*.FOO -xQTopic=ActiveMQ.Advisory.* Display all the attributes and object name information of all topics that ends with '.FOO' except those that also begins with 'ActiveMQ.Advisory.'.
query -QBroker=local???? --view Type,BrokerName,EnqueueCount,DequeueCount Display the object type, broker name, enqueue count, and dequeue count information for all 9-letter brokers that begins with 'local'.
query --objname Type=Connect,BrokerName=localhost -xQNetworkConnector=* Display all the attributes and object name information for all connections and connectors for broker 'localhost' except its network connectors.
query --objname Type=Connection --xobjname Type=Connection,BrokerName=localhost Display all the attributes and object name information for all registered connections except those belonging to broker 'localhost'.
query -QQueue=???? --objname Type=Connection --xobjname BrokerName=remote* Display all the attributes and object name information for all 4-letter queues and connections except those belonging to a broker that begins with 'remote'.
+

+

ActiveMQ MBean Reference:

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Mbean Type
+
Properties / ObjectName Attributes
Broker +
    +
  • Type=Broker
  • +
  • BrokerName=<broker identifier>
  • +
+
+
    +
  • BrokerId
  • +
  • TotalEnqueueCount
  • +
  • TotalDequeueCount
  • +
  • TotalConsumerCount
  • +
  • TotalMessages
  • +
  • TotalMessagesCached
  • +
  • MemoryLimit
  • +
  • MemoryPercentageUsed
  • +
+
Destination +
    +
  • Type=Queue|Topic
  • +
  • Destination=<destination identifier>
  • +
  • BrokerName=<name of broker>
  • +
+
+
    +
  • EnqueueCount
  • +
  • DequeueCount
  • +
  • ConsumerCount
  • +
  • Messages
  • +
  • MessagesCached
  • +
+
NetworkConnector +
    +
  • Type=NetworkConnector
  • +
  • BrokerName=<connector identifierr>
  • +
+
+
+
Connector +
    +
  • Type=Connector
  • +
  • ConnectorName=<connector identifier>
  • +
  • BrokerName=<name of broker>
  • +
+
+
    +
  • EnqueueCount
  • +
  • DequeueCount
  • +
+
Connection +
    +
  • Type=Connection
  • +
  • Connection=<connection identifier>
  • +
  • BrokerName=<name of broker>
  • +
+
+
    +
  • EnqueueCount
  • +
  • DequeueCount
  • +
  • DispatchQueueSize
  • +
  • Active
  • +
  • Blocked
  • +
  • Connected
  • +
  • Slow
  • +
+
+

+

+

bstat script

+

+ + + + + + + + + + + + + + + +
Script Name bstat.bat, bstat
Task Usage bstat [broker name]
Description Predefined query script that displays useful statistics regarding a broker and its components.
+

+

Examples:

+

+ + + + + + + + + + + + + + + +
Example Description
bstat Display useful statistics for all registered brokers in the default JMX context.
bstat localhost Display useful statistics for the registered broker 'localhost'.
+

+

+

browse script

+

+ + + + + + + + + + + + + + + +
Script Name browse.bat, browse
Task Usage browse --amqurl <broker url> [options] <destinations> or java -jar run.jar browse --amqurl <broker url> [options] <destinations>
Description Script to browse selected destinations' messages.
+

+

Options:

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Option Name Syntax Example Description
Broker URL Option --amqurl <url> --amqurl tcp://localhost:61616 Specify the broker URL to connect to.
Message Selector Option --msgsel <msgsel1,msgsel2,...> --msgsel JMSMessageID='*:10',JMSPriority>5 Allows you to filter the specific messages to view. You can use wildcard queries by enclosing the string message property in ' '. Other than using wildcard queries to filter string properties, other queries follows the message selector format.
Group View Option -V[header | custom | body] -Vheader, -Vcustom, -Vbody Let's you specify a specific group of message attributes to view. The header view shows all the standard JMS message headers. The custom view shows all the custom fields added to each JMS message. The body view shows the message body of the JMS message.
Specific View Option --view <attr1>,[header:|custom:]<attr2>,... --view JMSMessageID='*:10',custom:MyCustomField Let's you specifically select a specific message attribute. It allows you to select specific attributes from the JMS and custom headers. You could add the tags header: and custom: to explicitly specify where the attribute belongs to. Refer to the message header table below for details.
System Define Option -D<key>=<value> -Dactivemq.home=c:/ActiveMQ Sets a systems property. i.e Systems.getProperty("activemq.home"); will return c:/ActiveMQ
Help Option -h or -? or --help --help Display the help messages for the browse script.
Version Option --version activemq --version Display the activemq version information.
+

+

Examples:

+

+ + + + + + + + + + + + + + + + + + + + + + + +
Example Description
browse --amqurl tcp://localhost:61616 TEST.FOO Prints the JMS message header, custom message header, and message body of all the messages in the queue 'TEST.FOO'
browse --amqurl tcp://localhost:61616 -Vheader,body TEST.FOO Prints the JMS message header and message body of all the messages in the queue 'TEST.FOO'
browse --amqurl tcp://localhost:61616 -Vheader --view custom:MyCustomField TEST.FOO TEST.BAR Prints all the JMS message header and the custom field 'MyCustomField' of all the messages in the queue 'TEST.FOO' and 'TEST.BAR'.
browse --amqurl tcp://localhost:61616 --msgsel JMSMessageID='*:10',JMSPriority>5 TEST.FOO Prints all the attributes of the messages in the queue 'TEST.FOO' that has a JMSMessageID that matches the wildcard query *:10 and has a JMSPriority greater than 5.
+

+

JMS Message Header Reference:

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Header Name Header Type
JMSCorrelation ID String
JMSDelivery Mode int (1-Non-Persistent, 2-Persistent)
JMSDestination javax.jms.Destination
JMSExpiration long
JMSMessageID String
JMSPriority int
JMSRedelivered boolean
JMSReplyTo javax.jms.Destination
JMSTimestamp long
JMSType String
+

+
+
+ +   +