1imqbrokerd(1M) System Administration Commands imqbrokerd(1M)
2
6 imqbrokerd - start a Message Queue broker instance
7
9 /usr/bin/imqbrokerd [option...]
10 /usr/bin/imqbrokerd -h
13
16 imqbrokerd starts an instance of the Message Queue broker. The Message
17 Queue broker is the main component of a Message Queue message server.
18 The broker performs reliable delivery of messages to and from Java Mes‐
19 sage Service (JMS) clients.
20 imqbrokerd uses command line options to specify broker configuration
23 properties.
24
26 The following options are supported:
27 -backup fileName
29 Back up a Master Broker's configuration change record to fileName.
31 This option only applies to broker clusters.
32 -cluster brokerList
35 Specify the list of broker instances which are connected in a clus‐
37 ter. This list is merged with the list in the imq.cluster.bro‐
38 kerlist property. This option only applies to broker clusters.
39 brokerList is a comma-separated list of broker instances, each
41 specified by hostName:port (the host on which the broker instance
42 is running and the port number it is using) If you don't specify a
43 value for hostName, localhost is used. If you don't specify a value
44 for port, the value of 7676 is used. For example:
45 host1:8899,host2,:7878.
46 -dbpassword password
49 Specify the password for a plugged-in JDBC-compliant database used
51 as a Message Queue data store.
52 -dbuser userName
55 Specify the user name for a plugged-in JDBC-compliant data store.
57 -Dproperty-=value
60 Set the specified broker configuration property to the value. The
62 system does not validate either the configuration property or
63 value. Therefore, spelling, formatting, and case is important. Mes‐
64 sage Queue can not set incorrect values passed using the -D option.
65 -force
68 Perform action without user confirmation. This option only applies
70 when you use the -remove instance option, which normally requires
71 confirmation.
72 -h
75 Display usage help. Execute nothing else on the command line.
77 -javahome path
80 Specify the path to an alternate Java 2-compatible Java Development
82 Kit (JDK) or Java Runtime Environment (JRE) The default is to use
83 the runtime bundled with the operating system.
84 -ldappassword password
87 Specify the password for accessing an LDAP user repository when
89 using an LDAP server (as opposed to a built-in flat-file reposi‐
90 tory) to authenticate users of a Message Queue message server.
91 -license [name]
94 Specify the license to load, if different from the default for your
96 Message Queue product edition. If you don't specify a license name,
97 this lists all licenses installed on the system. Depending on the
98 installed Message Queue edition, the values for name are pe (Plat‐
99 form Edition-basic features), try (Platform Edition-90-day trial
100 enterprise features), and unl (Enterprise Edition).
101 -loglevel level
104 Specify the logging level. Valid values for level are NONE, ERROR,
106 WARNING, or INFO. The default value is INFO.
107 -metrics int
110 Report metrics at a specific interval. Specify int as the number of
112 seconds.
113 -name brokerName
116 Specify the instance name of this broker and use the corresponding
118 instance configuration file. If you do not specify a broker name,
119 the name of the file is set to imqbroker. If you run more than one
120 instance of a broker on the same host, each must have a unique
121 name.
122 -passfile filename
125 Specify the name of the file from which to read the passwords for
127 the SSL keystore, LDAP user repository, or JDBC-compliant database.
128 -password keypassword
131 Specify the password for the SSL certificate keystore.
133 -port number
136 Specify the broker's Port Mapper port number. By default, this is
138 set to 7676. To run two instances of a broker on the same server,
139 each broker's Port Mapper must have a different port number. JMS
140 clients connect to the broker instance using this port number.
141 -remove instance
144 Remove the broker instance. Delete the instance configuration file,
146 log files, data store, and other files and directories associated
147 with the broker instance. This option requires user confirmation
148 unless you also specify the -force option.
149 -reset store|messages|durables|props
152 Reset the data store (or a subset of the store) or resets the con‐
154 figuration properties of the broker instance when the broker
155 instance is started. The action depends on the argument provided.
156 store Clear all persistent data in the data store, including
158 messages, durable subscriptions, and transaction infor‐
159 mation store.
160 messages Clear all persistent messages durable.
163 durables Clear all durable subscriptions.
166 props Clear all configuration information in the config.props
169 instance configuration file. All properties assume
170 default values.
171 -restore filename
175 Replace the Master Broker's configuration change record with the
177 specified backup file. This file must have been previously created
178 using the -backup option. This option only applies to broker clus‐
179 ters.
180 -shared
183 Specify that the jms connection service be implemented using the
185 shared threadpool model, in which threads are shared among connec‐
186 tions to increase the number of connections supported by a broker
187 instance.
188 -silent
191 Turn off logging to the console.
193 -tty
196 Display all messages be to the console. WARNING and ERROR level
198 messages are displayed on the console by default.
199 -upgrade-store-nobackup
202 Specify that an earlier, incompatible version Message Queue data
204 store is automatically removed when migrating to Message Queue 3.5
205 format.
206 If you do not use this option, you must manually delete the earlier
208 data store. This applies to both built-in (flat-file) persistence
209 and plugged-in (JDBC-compliant) persistence. Migration of the ear‐
210 lier data store to a Message Queue 3.5 data store takes place the
211 first time you start a Message Queue 3.5 broker instance on an ear‐
212 lier version data store.
213 -version
216 Display the version number of the installed product.
218 -vmargs are [[arg]...]
221 Specify arguments to pass to the Java VM. Separate arguments with
223 spaces. If you want to pass more than one argument or if an argu‐
224 ment contains a space, use enclosing quotation marks. For example:
225 imqbrokerd -tty -vmargs " -Xmx128m -Xincgc"
227
232 The following environment variables affect the execution of this com‐
233 mand:
234 IMQ_JAVAHOME Specify the Java 2 compatible runtime. When this envi‐
236 ronment variable is not set it defaults to /usr/j2se.
237
240 The following exit values are returned:
241 0 Successful completion.
243 >0 An error occurred.
246
249 /etc/init.d/imq
250 Shell script for starting imqbrokerd. This file looks at the
252 /etc/imq/imqbrokerd.conf file.
253 /etc/imq/imqbrokerd.conf
256 Configuration file which controls the behavior of the broker
258 startup script.
259 /etc/imq/passwd
262 Flat file user repository for authenticating users.
264 /etc/imq/accesscontrol.properties
267 Controls client access to broker functionality.
269 /etc/imq/passfile.sample
272 Sample passfile used by the -passfile option.
274 /var/imq/instances/brokerName/props/config.properties
277 Broker instance configuration file.
279
282 See attributes(5) for descriptions of the following attributes:
283 ┌─────────────────────────────┬─────────────────────────────┐
288 │ ATTRIBUTE TYPE │ ATTRIBUTE VALUE │
289 ├─────────────────────────────┼─────────────────────────────┤
290 │Availability │SUNWiqu │
291 └─────────────────────────────┴─────────────────────────────┘
292
294 imqadmin(1M), imqcmd(1M), imqdbmgr(1M), imqkeytool(1M), imqobjmgr(1M),
295 imqusermgr(1M), attributes(5)
296 Sun Java System Message Queue Administrator's Guide
299SunOS 5.11 11 Mar 2004 imqbrokerd(1M)