IBM Integration Bus, Version Operating Systems: AIX, HP-Itanium, Linux, Solaris, Windows, z/OS

See information about the latest product version

mqsicreatebroker command - Linux and UNIX systems

Use the mqsicreatebroker command to create a broker on a Linux or UNIX systems.


Read syntax diagramSkip visual syntax diagram
>>-mqsicreatebroker--brokerName-- -q --queueManagerName--------->

   '- -w --workPath-'  '- -t -'  '- -m -'   

   '- -l --userLilPath-'   

   '- -g --configurationChangeTimeout-'   

   '- -k --internalConfigurationTimeout-'   

   '- -P --httpListenerPort-'   

   '- -v --statisticsMajorInterval-'   

   '- -y --ldapPrincipal-- -z --ldapCredentials-'   

   '- -c --icuConverterPath-'  '- -x --userExitPath-'   

   '- -o --operationMode-'  '- -s --+-active---+-'   

   '- -e --sharedWorkPath-'  '- -d --+-defined---+-'   

   '- -b --cachePolicy-'  '- -r --cachePortRange-'   

   '- -4 --integrationRegistryHostname-'   


(Required) The name of the broker that you are creating. This parameter must be the first parameter, and it is case sensitive.

For restrictions on the character set that you can use, see Characters allowed in object names.

-q queueManagerName
(Required) The name of the queue manager, (or multi-instance queue manager if creating a multi instance broker ) that is associated with this broker instance. 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.

The default behavior is to create a queue manager using the default mqm path, if the queue manager does not already exist on the same server.

When creating a multi-instance broker where the queue manager does not exist on the server, a multi-instance queue manager is created beneath the multi-instance broker shared work path using the WebSphere® MQ crtmqm command as follows:
  crtmqm –md /<broker sharedWorkPath>/mqm/qmdata
         -ld //<broker sharedWorkPath>/mqm/qmlog queueManagerName

If this shared queue manager path is not appropriate, create the multi-instance queue manager on the server before you run this command.

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 object names.

-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.

When a broker has been enabled for multi-instance mode using the –e flag, the broker workPath is divided between data that is specific to this broker instance, and that which is shared between this broker and any of its instances created using the mqsiaddbrokerinstance command. Data specific to the multi-instance enabled broker is stored in the workPath directory on the local server, whereas the shared data is held in a directory on network storage at the location specified using the –e flag.

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.

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 re-create 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.

(Optional) The broker runs as a WebSphere MQ trusted application.

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 the Intercommunication section of the WebSphere MQ Version 7 product documentation online.

-l userLilPath
(Optional) A list of paths (directories) from which the broker loads Loadable implementation libraries (LIL files) for user-defined message processing nodes.

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 IBM® Integration Bus installation directory.

If you specify more than one directory, separate directories by using a colon (:).

-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 integration server a configuration change that you have initiated. For example, if you deploy a configuration from the IBM Integration Toolkit, 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 integration server 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 - 3600. The default is 300.

For information about how to set the value for this timeout, see Setting configuration timeout values.

-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 integration server.

The response time of each integration server differs according to system load and the load of its own processes. The value must reflect the longest response time that any integration server 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 - 3600. The default is 60.

For information about how to set the value for this timeout, see Setting configuration timeout values.

-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 statistics and accounting archive records are to be written. The valid range is from 1 minute to 43200 minutes; the default value is 60.
-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 set of directories to search for additional code page converters, delimited by 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.
-x userExitPath
(Optional) The path that contains the location of all user exits to be loaded for integration servers in this broker. This path is added to the system library search path (PATH,LIBPATH,LD_LIBRARY_PATH,SHLIBPATH) for the integration server process only.
-o operationMode
(Optional) Use this parameter to set the mode of your broker; for more information, see Operation modes. Valid values that you can set are advanced (the full package, advanced mode), express (Express Edition mode), scale (Scale mode), standard (Standard Edition mode), and adapter (Remote Adapter Deployment mode). The default value is advanced, unless you have the Developer Edition, in which case the default value is developer. If you do not set the -o parameter, the default value is used automatically.

If you have purchased a license for the Standard Edition, you are entitled to run your brokers in either standard or scale mode.

(Optional) Specify the administrative security status for the broker.

If you specify -s active, administration security is enabled. Only user IDs that you authorize are permitted to complete actions on the broker. Read, write, and execute authority is always granted on the security queue SYSTEM.BROKER.AUTH to all user IDs that belong to the security group mqbrkrs. When the broker has been created, you can add further user ID authorizations to this queue.

When you create an integration server on a broker for which administrative security is enabled, the queue SYSTEM.BROKER,AUTH.egroup_name is created. Populate the queue with the appropriate user authorization.

If you specify -s inactive, or omit this parameter, broker administration security is not enabled. All users are able to complete all actions against the broker and all integration servers.

If broker administration security is not enabled, web users can access the web user interface as the default user, with unrestricted access to data and broker resources.

For further information about using security, see Administration security overview and Authorizing users for administration.
-e sharedWorkPath
(Optional) Setting this value enables the broker for the multi-instance mode of operation.
You must ensure the broker has access to this network storage location before you start the broker, and that the queue manager for the broker has been configured as a WebSphere MQ multi-instance queue manager. The information stored in this shared directory includes:
  • The broker registry
  • Component directories
  • Internal broker tables and files for deployed message flows
  • Configurable service properties.
(Optional) Specify whether you enable a broker to be started and stopped as a WebSphere MQ service when the queue manager starts and stops.

This option is an alternative to starting a multi-instance broker in standby mode using the mqsistart command.

If you specify -d defined, the WebSphere MQ service is defined to the queue manager and the broker starts and stops when the queue manager starts and stops.

If you specify -d undefined, the WebSphere MQ service is not defined to the queue manager and the broker does not start and stop when the queue manager starts and stops. This is the default setting.

-i serviceUserId
(Deprecated) This parameter is included for compatibility with earlier versions.
-a servicePassword
(Deprecated) This parameter is included for compatibility with earlier versions.
-b cachePolicy
(Optional) The policy to use for the cache manager. Set this parameter to default, disabled, none, or the fully qualified name of an XML policy file.
  • If you specify default, the default cache policy is used.
  • If you specify disabled, the global cache components in the broker are disabled. The cache is disabled by default.
  • If you specify none, the cache manager in each integration server uses the values that you set. The integration server properties that were set most recently by the broker-level policy are retained as a starting point for customization.
  • If you specify the fully qualified name of a policy file, the brokers listed in the policy file are configured to share the data in the global cache. The path must be absolute, not relative.
-r cachePortRange
(Optional) The range of ports to be used by the cache manager. Set this parameter to generate or to a specific range of ports.
  • If you specify a range of ports, the value of this parameter must be in the format xxxx-yyyy, and the range must contain at least 20 ports.
  • If you specify generate, the broker generates a range of ports that are not being used by another broker on that computer. The broker chooses a range that starts from 2800. If, for example, another broker is using ports 2800 to 2819, the broker generates a range from 2820 to 2839.
-4 integrationRegistryHostname
The host name of the Integration Registry. If this parameter is not set, the host name of the machine is used. Use this parameter only to configure multi-instance brokers. For more information, see Integration Registry configuration for multi-instance integration nodes.


Create a broker to run as a trusted application:
mqsicreatebroker IB9NODE 
	-q IB9QMGR -t
Create a broker that references user exits:
mqsicreatebroker IB9NODE 
	-q IB9QMGR -x /opt/3rdparty/wmbexits
Create a broker with administrative security enabled:
mqsicreatebroker IB9NODE 
	-q IB9QMGR -s active
Create a broker, by using the multi-instance queue manager MyQMGR and the shared work path MyNetworkSharedWorkpath, where the broker starts as a WebSphere MQ service:
mqsicreatebroker IB9NODE 
	-q MyQmgr -e MyNetworkSharedWorkpath -d defined
Create a broker in Scale mode:
mqsicreatebroker IB9NODE -q IB9QMGR -o scale 

an28135_.htm | Last updated Friday, 21 July 2017