- brokername
- (Required) The name of the broker that you are creating. This
parameter must be the first parameter, and if you create a broker with an
uppercase name, the name must be specified in uppercase in the workbench.
For restrictions on the character set that you can use, see Characters allowed in commands.
- -q QueueManagerName
- (Required) The name of the queue manager that is associated
with this broker. Use the same name for your broker and the queue manager
to simplify the organization and administration of your network. Queue manager
names are limited to 48 characters in length, and they are case sensitive.
Each
broker must have its own unique queue manager. A broker cannot share
a queue manager with another broker.
If the queue manager does not
already exist, it is created by this command. It is not created as the default
queue manager; if you want this queue manager to be the default queue manager
on this system, either create the queue manager before you issue this command,
or change the settings of this queue manager to make it the default. Use either
the WebSphere MQ Explorer, or the WebSphere MQ Services
snap-in, depending on which version of WebSphere MQ you
are using.
The queue manager attribute MAXMSGLN (the
maximum length of messages that can be put to queues) is updated to 100 MB.
This attribute is updated regardless of whether the queue manager is created
by this command.
For restrictions on the character set that you can
use, see Characters allowed in commands.
- -n DB2Location
- (Required) The location of the database in which the broker tables are
created.
- -u DB2TableOwner
- (Required) The user ID with which databases that contain broker tables
and user data are to be accessed.
This user ID must have the authority
to create tables within this database, and read from and write to those tables.
If
you have an application database in DB2 that
was created by this user ID, or to which this user ID has appropriate read,
write, or create authority, message flows that run in this broker can access
and manipulate the application data that is held within it, without having
to specify explicit schema names.
- -s UserNameServerQueueManagerName
- (Optional) The name of the WebSphere MQ queue
manager that is associated with the User Name Server.
You must specify this parameter if you require either
authentication services or publish/subscribe access
control. If this parameter is not specified, the broker assumes that there
is no User Name Server defined.
- -j
- (Optional) You must specify this parameter in conjunction
with the -s UserNameServerQueueManagerName parameter
to enable publish/subscribe access control.
- -l UserLilPath
- (Optional) A list of paths (directories) from which the broker
loads LILs (loadable implementation libraries) for user-defined message processing
nodes.
This name is case sensitive, and you must include the names
in single quotes if they contain mixed case characters.
You cannot
include environment variables in this path; if you do so, they are ignored.
-
You must create your own directory for storing your .lil or .jar files.
Do not save them in the WebSphere
Event Broker install
directory.
If you specify more than one additional directory, each directory
must be separated by the default platform-specific path separator: semicolon
(;) on Windows systems;
colon (:) on Linux and UNIX systems.
- -P HTTPListenerPort
- (Optional) Enter the number of the port on which the Web services
support is listening.
This listener is started by the broker when a message
flow that includes Web services support is started, and has a default value
of 7080.
Ensure that the port that you specify has not been specified
for any other purpose.
- -g ConfigurationTimeout
- (Optional) This parameter defines the length of time (in seconds)
that an execution group in the broker can take to apply a change in configuration
(for example, an update that you have deployed from the workbench).
When a message flow is processing an application message, it cannot respond
to a configuration change. If any one of the message flows within the execution
group that has been requested to change its configuration does not finish
processing an application message, and apply the configuration change within
this timeout, the execution group returns a negative response to the deployed
configuration message.
The value that you set for this timeout depends
on the system load (including CPU utilization) and on each execution group's
load. You can make an initial estimate by deploying the broker's entire configuration.
The time taken for this to complete successfully gives you an indication of
the minimum value to set.
The value is specified in seconds and can
range from 10 to 3600. The default value is 300.
The sum of the ConfigurationTimeout and
the ConfigurationDelayTimeout (described below) represents
the maximum length of time that a broker is allowed to process a deployed
configuration message before it generates a negative response.
- -k ConfigurationDelayTimeout
- (Optional) The length of time (in seconds) that a broker can
take to process a minimal change in configuration (for example, an update
that you have deployed from the workbench).
This represents the time it takes for a minimal deployed configuration
message to be processed by the broker and its execution groups, and depends
on queue manager network delays, the load on the broker's queue manager, and
system load.
You can estimate this value by issuing a command to request
a simple configuration change, for example:
F MQP1BRK,reporttrace u=yes,e='exgrp1'
The
name is case sensitive, and you must include any names in single quotes if
they contain mixed-case characters.
The response time of each execution group differs according
to system load and the load of its own processes. The value that you set must
reflect the longest response time that any execution group takes to respond.
If the value that you set is too low, the broker returns a negative response,
and might issue error messages to the local error log.
The value is
specified in seconds and can range from 10 to 3600. The default value is 60.
If
the broker is on a production system, increase the values for both ConfigurationTimeout and ConfigurationDelayTimeout to allow for application messages that are currently being processed by
message flows to be completed before the configuration change is applied.
If
the broker is on a development or test system, you might want to reduce time-outs
(in particular, the ConfigurationTimeout) to improve perceived
response times, and to force a response from a broker that is not showing
expected behavior. However, reducing the timeout values decreases the probability
of deploying a configuration change successfully.
- -v statisticsMajorInterval
- (Optional) Specify the timer interval (in minutes) at which WebSphere
Event Broker statistics and accounting is notified
that archive records are to be output. For internal accounting, the valid
range is from 10 to 14400 minutes.
An interval of zero minutes indicates that the operating
system has an external method of notification and is not using an internal
timer within WebSphere
Event Broker.
- -1
- (Optional) The registry pass, which creates only the broker registry.
- -2
- (Optional) The WebSphere MQ pass, which creates
only the broker WebSphere MQ queues.
- -3
- (Optional) The DB2 pass, which creates
only the broker DB2 tables and indexes.
- -y LdapPrincipal
- (Optional, but mandatory when LdapCredentials is
provided.) The user principal for access to an optional LDAP directory that
holds the JNDI administered Initial Context for the JMS provider.
- -z LdapCredentials
- (Optional, but mandatory when LdapPrincipal is
provided.) The user password for access to LDAP.
- -c ICUConverterPath
- (Optional) A delimited set of directories to search for additional
code page converters.
The code page converters must be either of the form icudt32_codepagename.cnv,
or in an ICU data package called icudt32.dat.
Do not use this parameter to set the converter
path if you are using a converter that matches one of the built-in converters
that are provided with Version 6.0, and that
converter is the local code page for the broker. Use the ICU_DATA environment
variable instead.