- brokerName
- (Required) The name of the broker that you are creating.
This parameter must be the first parameter. It is case sensitive on Linux® and UNIX® systems.
For restrictions on the character set that you can
use, see Characters allowed in commands.
- -i serviceUserId
- (Required)
-
The user ID under which components run. You can
specify the serviceUserId in any valid user name
syntax.
On Windows® systems,
valid formats are:

- \\server\username
- .\username
- username
On Linux and UNIX systems, only the last format, username,
is valid.
Do not use a domain name as part of the serviceUserId parameter.
If
you use the unqualified form for this user ID (username)
on Windows systems, the operating
system searches for the user ID throughout its domain, starting with
the local system. This search might take some time to complete.
The serviceUserId that
you specify must be a member of the mqbrkrs local
group. On Windows systems, the
ID can be a direct or indirect member of the group. The serviceUserId must
also be authorized to access the home directory (where WebSphere® Event
Broker has been installed), and the
working directory (if specified by the -w parameter).
On Windows systems, if you specify
that the broker is to run as a WebSphere MQ trusted
application (-t parameter), you must also add
the service user ID to the mqm group.
On Linux and UNIX systems, specify the serviceUserId as mqm if
you set the -t parameter.
The security
requirements for the serviceUserId are described
in Security requirements for Windows platforms, and in Security requirements for Linux and UNIX platforms.
- -a servicePassword
- (Required) The password for the serviceUserId.
For compatibility with existing systems, you can
specify <password>. However, if you do not specify
a password with this parameter when you run the command, you are prompted
to enter a password during its invocation, and to enter the password
a second time to verify that you have entered it correctly.
On Linux and UNIX systems, -a is
required for compatibility with Windows systems,
but is not used in relation to serviceUserId. -a is
used as a default only if -p is not specified.
See the -p parameter description for further
details.
- -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 after it has been created.
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 MAXMSGLEN (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 dataSourceName
- (Required) The ODBC data source name (DSN) of the database in
which the broker tables are created. If you have not used the same
name for both the DSN and the database, this parameter must specify
the DSN, not the name of the database.
This database must already
exist. You must create a System DSN ODBC connection for this DSN,
if you have not already done so.
If you have
a DB2® database on Linux, enter the appropriate DB
database alias name; an ODBC DSN is not required.
- -u dataSourceUserId
- (Optional) The user ID with which databases that contain broker
tables to be accessed. If
you do not specify this ID, it defaults to the value that is specified
by the -i parameter.
This user ID must have
authority to create tables within this database, and read from and
write to those tables.
On Windows systems, if your broker
database exists in DB2, and
this user ID is not known to DB2,
it is created for you within DB2.

On Linux and UNIX systems, the service user must
have been granted the correct privilege before entering this command.
If your database is SQL Server, you must create this user ID as a
SQL Server login ID and give it the correct access before you create
the broker.
- -p dataSourcePassword
- (Optional) The password of the user ID with which databases that
contain broker tables are to be
accessed. If you do not specify this parameter, it defaults to the servicePassword that
is specified by the -a parameter.
For compatibility
with existing systems, you can specify <password>.
However, if you do not specify a password with this parameter when
you run the command, you are prompted to enter a password during its
invocation, and to enter the password a second time to verify that
you have entered it correctly.

For DB2 on Linux and UNIX systems, you can specify -u and -p as
empty strings (two quotation marks ""). In this case, you are using
the serviceUserId and its servicePassword for
theDB2 connection and that stores
the password. If you specify -a as an empty string
as well as -u and -p, WebSphere Event
Broker stores no passwords; in this
case the command prompts you to set a password and stores that.
- -s unsQMgrName
- (Optional) The name of the WebSphere MQ queue manager that is associated
with the User Name Server.
Specify this parameter if you require either authentication
services or publish/subscribe access control.
If you do not specify this parameter, the broker assumes that no User Name Server is defined. To enable publish/subscribe access control, specify the -s and -j parameters.
- -j
- (Optional) If you require publish/subscribe access control, specify this
parameter. You must also specify the -s parameter.
- -w workPath
- (Optional) The directory in which working files for this broker
are stored. If you do not specify this parameter, files are stored
in the default work path, which was specified when the product was
installed. If you specify this parameter, you must create this directory
before you start the broker. On Windows systems,
this directory cannot be on a networked drive.
This directory is
also used for trace records that are created when tracing is active.
These records are written to a subdirectory, log,
which you must create before you start the broker.
Error logs
that are written by the broker when a process ends abnormally are
stored in this directory. On Windows systems,
use this parameter to specify a directory on a drive other than the
one on which the product is installed.
The error log is unbounded
and continues to grow. Check this directory periodically and clear
out old error information.
You cannot change this parameter
using the mqsichangebroker command.
To specify or change the work path, delete and recreate the broker.
Specifying this parameter creates a separate working directory
for the broker. This working directory is a subset of the default
working directory structure that contains fewer subdirectories and
no common\profiles subdirectory.
- -t
- (Optional) The broker runs as a WebSphere MQ trusted application.
If
you specify this parameter on Windows systems,
add the serviceUserId (identified by the -i parameter)
to the mqm group.
If
you specify this parameter on HP-UX and Solaris, specify the serviceUserId as mqm.
For more details about using WebSphere MQ trusted applications, see WebSphere MQ Intercommunication.
- -m
- (Optional) Migrate an existing WebSphere MQ Publish/Subscribe broker.
If you specify this parameter, the queue manager that is identified
by the -q parameter must be the queue manager
that the WebSphere MQ Publish/Subscribe broker is using.
- -l userLilPath
- (Optional) A list of paths (directories) from which
the broker loads 32-bit loadable implementation libraries (LILs) for
user-defined message processing nodes. Use the -l flag
for 32–bit LILs.
On Linux and UNIX systems, directory names are
case sensitive, and you must include the names in single quotation
marks if they contain mixed case characters.
Do not include
environment variables in the path; the broker ignores them.
-
Create your own directory for storing your .lil or .jar files.
Do not save them in the WebSphere Event
Broker installation
directory.
If you specify more than one directory, separate
directories by a semicolon (;) on Windows systems, or a colon (:)
on Linux and UNIX systems.
- -g configurationChangeTimeout
(Optional) The maximum time (in seconds) that
is allowed for a user configuration request to be processed. It defines
the length of time taken within the broker to apply to an execution
group a configuration change that you have initiated. For example,
if you deploy a configuration from the workbench, the broker must respond to
the Configuration
Manager within this time.A
message flow cannot respond to a configuration change while it is
processing an application message. An execution group that has been
requested to change its configuration returns a negative response
to the deployed configuration message if any one of its message flows
does not finish processing an application message and apply the configuration
change within this timeout.
Specify the value in seconds, in
the range 10 to 3600. The default is 300.
For information about
how to set the value for this timeout, see Setting configuration timeouts.

- -k internalConfigurationTimeout
(Optional) The maximum time (in seconds)
that is allowed for an internal configuration change to be processed.
For example, it defines the length of time taken within the broker
to start an execution group.
The response time of each execution group differs
according to system load and the load of its own processes. The value
must reflect the longest response time that any execution group takes
to respond. If the value is too low, the broker returns a negative
response, and might issue error messages to the local error log.
Specify
the value in seconds, in the range 10 to 3600. The default is 60.
For
information about how to set the value for this timeout, see Setting configuration timeouts.
- -P httpListenerPort
- (Optional) Enter the number of the port on which the
Web services support is listening.
The broker starts
this listener when a message flow that includes HTTP nodes or Web
services support is started; the default is 7080. 
Ensure that
the port that you specify has not been specified for any other purpose.
- -v statisticsMajorInterval
- (Optional) Specify the interval (in minutes) at which WebSphere Event
Broker statistics and accounting is
notified that archive records are to be output. 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.
- -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. On Windows systems, the delimiter is
a semicolon (;). On UNIX and Linux systems, the delimiter is
a colon (:).
- 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, and that converter is the
local code page for the broker. Use the ICU_DATA environment
variable instead.