mqsicreatebroker command - Linux and UNIX systems

Use the mqsicreatebroker command to create an integration node on a Linux® or UNIX systems.

Syntax

Read syntax diagramSkip visual syntax diagrammqsicreatebrokerintegrationNodeName -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 activeinactive -e sharedWorkPath -d definedundefined -b cachePolicy -r cachePortRange -C CCSID

Parameters

integrationNodeName
(Required) The name of the integration node 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
(Optional) The name of the queue manager associated with the integration node. Use the same name for your integration node and 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. This queue manager is used by default for WebSphere® MQ processing in the message flow if no queue manager has been specified explicitly on the MQ node.

The queue manager specified on the integration node is also required for message flow nodes that use system queues to store state information about messages, such as the CD and FTE nodes, and for event-driven processing nodes that are used for aggregation and timeout flows, message collections, and message sequences. These nodes require a queue manager to be specified on the integration node, and they also require a set of system queues to be created. For information about creating the system queues, see Creating the default IBM Integration Bus queues on a WebSphere MQ queue manager. For more information about the IBM Integration Bus features that require system queues, see Installing WebSphere MQ.

You cannot use a secured queue manager as the local default queue manager for an integration node.

If you specify a queue manager that does not exist, you must create it before the flow is deployed.

If the -q parameter is not specified, some features that require access to WebSphere MQ will be unavailable. For more information about using WebSphere MQ with IBM Integration Bus, see Enhanced flexibility in interactions with WebSphere MQ.

When creating a multi-instance integration node where the queue manager does not exist on the server, a multi-instance queue manager is created beneath the multi-instance integration node shared work path using the WebSphere MQ crtmqm command as follows:
  crtmqm -md /<integration node sharedWorkPath>/mqm/qmdata
         -ld //<integration node 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. For more information, see Creating a multi-instance integration node.

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 integration node are stored. If you do not specify this parameter, the files are stored in the default work path, which was specified when the product was installed. If you specify a directory name that does not exist, it is created automatically. You must have permission to create this directory, or the command fails and returns an error.

When an integration node has been enabled for multi-instance mode using the -e flag, the integration node workPath is divided between data that is specific to this integration node instance, and that which is shared between this integration node and any of its instances created using the mqsiaddbrokerinstance command. Data specific to the multi-instance enabled integration node 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 that is 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 integration node.

Error logs that are written by the integration node 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 by using the mqsichangebroker command. To specify or change the work path, delete and re-create the integration node.

Specifying this parameter creates a separate working directory for the integration node. This working directory is a subset of the default working directory structure that contains fewer subdirectories and no common\profiles subdirectory.

-t
(Optional) The integration node 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.5 product documentation online.

-l userLilPath
(Optional) A list of paths (directories) from which the integration node 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 integration node 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 integration node 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 integration node 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 integration node 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 integration node 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 integration node 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 integration node. 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 integration node. 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 integration node; for more information, see Operation modes. Valid values that you can set are advanced (Advanced mode, which includes all IBM Integration Bus features apart from the SalesforceRequest node), applicationIntegrationSuite (the Application Integration Suite mode, which includes the same functionality as the Advanced mode, plus the entitlement to use the SalesforceRequest node), 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 integration nodes in either standard or scale mode.

-s
(Optional) Preserved for compatibility. To set and view the administration security mode, use the mqsichangeauthmode command and mqsireportauthmode command instead of using this parameter.

Specify the administrative security status for the integration node. If you specify -s active, administration security is enabled. Only user IDs that you authorize are permitted to complete actions on the integration node. Read, write, and execute authority is always granted on the integration node to all user IDs that belong to the security group mqbrkrs. When the integration node has been created, you can add further user ID authorizations.

If you are using queue-based security, the queue SYSTEM.BROKER.AUTH.integration_server_name is created when you create an integration server on an integration node for which administrative security is enabled. Populate the queue with the appropriate user authorization.

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

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

For more information about security, see Administration security overview and Authorizing users for administration.
-e sharedWorkPath
(Optional) Setting this value enables the integration node for the multi-instance mode of operation.
You must specify a queue manager (-q) for the integration node to use this parameter. You must ensure the integration node has access to this network storage location before you start the integration node, and that the queue manager for the integration node has been configured as a WebSphere MQ multi-instance queue manager. The information that is stored in this shared directory includes:
  • The integration node registry
  • Component directories
  • Internal integration node tables and files for deployed message flows
  • Configurable service properties.
-d
Note: You must be a member of the mqm group to run the mqsicreatebroker command with the -d parameter.
(Optional) Specify whether you enable an integration node to be started and stopped as a WebSphere MQ service when the queue manager starts and stops. If you set this parameter, you cannot later change this setting. You must specify a queue manager (-q) for the integration node to use this parameter.

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

If you specify -d defined, the MQ Service is defined to the queue manager, and the integration node starts and stops when the queue manager starts and stops.
Note: Ensure that the mqm user ID is a member of the mqbrkrs operating system group because the integration node is started by the mqm user ID.

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

For more information about running the integration node as an MQ Service, see Creating a multi-instance integration node.

-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 integration node 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 integration nodes 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 integration node generates a range of ports that are not being used by another integration node on that computer. The integration node chooses a range that starts from 2800. If, for example, another integration node is using ports 2800 to 2819, the integration node generates a range from 2820 to 2839.
-C CCSID
(Optional) The internal CCSID of the integration node. The default is set during installation and is based on the values that are set for the locale and language variables. If these variables are not set, a default value of 1208 is used.

Examples

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