Sun GlassFish Message Queue 4.4 Administration Guide

Broker Utility

The Broker utility (imqbrokerd) starts a broker. Command line options override values in the broker configuration files, but only for the current broker session.

Table 16–1 shows the options to the imqbrokerd command and the configuration properties, if any, overridden by each option.

Table 16–1 Broker Utility Options


Properties Overridden 


-name instanceName


Instance name of broker

Multiple broker instances running on the same host must have different instance names.  

Default value: imqbroker

-port portNumber


Port number for broker’s Port Mapper

Message Queue clients use this port number to connect to the broker. Multiple broker instances running on the same host must have different Port Mapper port numbers.  

Default value: 7676

-cluster broker1 [ [ ,broker2 ] … ]


Connect brokers into cluster [Applies only to broker clusters]

The specified brokers are merged with the list in the imq.cluster.brokerlist property. Each broker argument has one of the forms




If hostName is omitted, the default value is localhost; if portNumber is omitted, the default value is 7676.


Corresponding property in instance configuration file 

Set configuration property 

See Chapter 17, Broker Properties Reference for information about broker configuration properties.

Caution: Be careful to check the spelling and formatting of properties set with this option. Incorrect values will be ignored without notification or warning.

-reset props


Reset configuration properties 

Replaces the broker’s existing instance configuration file with an empty file; all properties assume their default values.

-reset store


Reset persistent data store

Clears all persistent data from the data store (including persistent messages, durable subscriptions, and transaction information), allowing you to start the broker instance with a clean slate. To prevent the persistent store from being reset on subsequent restarts, restart the broker instance without the -reset option.

To clear only persistent messages or durable subscriptions, use -reset messages or -reset durables instead.

-reset messages


Clear persistent messages from data store 

-reset durables


Clear durable subscriptions from data store 

-backup fileName


Back up configuration change record to file

See Managing a Conventional Cluster's Configuration Change Record for more information.

-restore fileName


Restore configuration change record from backup file

The backup file must have been previously created using the -backup option.

See Managing a Conventional Cluster's Configuration Change Record for more information.

-remove instance


Remove broker instance [Requires user confirmation unless -force is also specified]

Deletes the instance configuration file, log files, persistent store, and other files and directories associated with the instance.  

-dbuser userName


User name for JDBC-based persistent data store

-passfile filePath

Location of password file

Sets the broker’s imq.passfile.enabled property to true, imq.passfile.dirpath to the path containing the password file, and to the file name itself.

See Password Files for more information.



Use shared thread pool model to implement jms connection service

Execution threads will be shared among connections to increase the number of connections supported.  

Sets the broker’s imq.jms.threadpool_model property to shared.

-javahome path


Location of alternative Java runtime

Default behavior: Use runtime installed on system or bundled with Message Queue.

-vmargs arg1 [ [ arg2 ] … ]


Pass arguments to Java virtual machine 

Arguments are separated with spaces. To pass more than one argument, or an argument containing a space, enclose the argument list in quotation marks.  

VM arguments can be passed only from the command line; there is no associated configuration property in the instance configuration file.



Start RMI registry at broker startup



Use external RMI registry



Port number of RMI registry



Automatically remove old data store on upgrade to Message Queue 3.5 or 3.5 SPx from an incompatible version

See the Message Queue Installation Guide for more information.



Perform action without user confirmation 

This option applies only to the -remove instance and -upgrade-store-nobackup options, which normally require confirmation.

-loglevel level

Logging level:





Default value: INFO

-metrics interval


Logging interval for broker metrics, in seconds



Log all messages to console 

Sets the broker’s imq.log.console.output property to ALL.

If not specified, only error and warning messages will be logged.  

-s | -silent


Silent mode (no logging to console)

Sets the broker’s imq.log.console.output property to NONE.



Display version information [Any other options specified on the command line are ignored. ]

-h | -help


Display usage help