JavaScript is required to for searching.
Skip Navigation Links
Exit Print View
Oracle GlassFish Server Message Queue 4.5 Administration Guide
search filter icon
search icon

Document Information


Part I Introduction to Message Queue Administration

1.  Administrative Tasks and Tools

2.  Quick-Start Tutorial

Part II Administrative Tasks

3.  Starting Brokers and Clients

4.  Configuring a Broker

5.  Managing a Broker

6.  Configuring and Managing Connection Services

7.  Managing Message Delivery

8.  Configuring Persistence Services

9.  Configuring and Managing Security Services

10.  Configuring and Managing Broker Clusters

11.  Managing Administered Objects

12.  Configuring and Managing Bridge Services

13.  Monitoring Broker Operations

14.  Analyzing and Tuning a Message Service

15.  Troubleshooting

Part III Reference

16.  Command Line Reference

Command Line Syntax

Broker Utility

Command Utility

General Command Utility Options

Broker Management

Connection Service Management

Connection Management

Physical Destination Management

Durable Subscription Management

Transaction Management

JMX Management

Object Manager Utility

Database Manager Utility

User Manager Utility

Bridge Manager Utility

Service Administrator Utility

Key Tool Utility

17.  Broker Properties Reference

18.  Physical Destination Property Reference

19.  Administered Object Attribute Reference

20.  JMS Resource Adapter Property Reference

21.  Metrics Information Reference

22.  JES Monitoring Framework Reference

Part IV Appendixes

A.  Distribution-Specific Locations of Message Queue Data

B.  Stability of Message Queue Interfaces

C.  HTTP/HTTPS Support

D.  JMX Support

E.  Frequently Used Command Utility Commands


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 cluster1

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

  • hostName:portNumber

  • hostName

  • :portNumber

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

Literal IP addresses as host names: You can use a literal IPv4 or IPv6 address as a host name. If you use a literal IPv6 address, its format must conform to RFC2732, Format for Literal IPv6 Addresses in URL's.

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
-reset takeover-then-exit
Clear any takeover locks and then exit.

If a broker fails before completing the takeover of another broker's store, the failed broker retains a takeover lock even though it is not running. Use -reset takeover-then-exit to cause the failed broker to initiate startup, release the takeover lock, and then exit without actually starting up.

-backup fileName
Back up configuration change record to file1

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

-restore fileName
Restore configuration change record from backup file1

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 instance2

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 version2
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:
  • NONE



  • INFO

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 information3
-h | -help
Display usage help3

1Applies only to broker clusters

2Requires user confirmation unless -force is also specified

3Any other options specified on the command line are ignored.