mqsiaddbrokerinstance command - Windows systems

Use the mqsiaddbrokerinstance command to add a multi-instance integration node on Windows systems.

Syntax

Read syntax diagramSkip visual syntax diagrammqsiaddbrokerinstanceintegrationNodeName -e  sharedWorkpath   -w  Workpath  -i  serviceUserId   -a  servicePassword 

Parameters

integrationNodeName
(Required) The name of the integration node instance that you are adding. You must specify the name as the first parameter and the name is case-sensitive. The integration node instance name must match that of a multi-instance enabled integration node previously created using the mqsicreatebroker command.

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

-e sharedWorkpath
(Required) The value represents the directory in which globally accessible working files for this integration node are located in shared network storage (NFS or NAS).

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 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.
-w Workpath
(Optional) The directory in which working files specific to this integration node instance are stored locally on the server where the integration node instance is going to run. If you do not specify this parameter, files are stored in the default Work path, which is the one you specified when the product was installed. If you specify this parameter, you must create this directory before you start the integration node.

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.

-i serviceUserId
(Required) The user ID under which the integration node runs.

You can specify the serviceUserId in any valid user name syntax:

  • As a local name:

    username

    .\username

  • As a User Principal Name (UPN):

    username@domain

  • As a traditional style of logon name:

    domain\username

  • As a request to a specific server:

    \\server\username

If you use the unqualified form for this user ID (username), 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 direct or indirect member of the mqbrkrs local group. The serviceUserId must also be authorized to access the home directory (where IBM® Integration Bus has been installed), and the working directory (if specified by the -w parameter).

If you specify that the integration node is to run as a WebSphere MQ trusted application (-t parameter), you must also add the service user ID to the mqm group.

The security requirements for the serviceUserId are described in Security requirements for Windows systems.

-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. You must enter the password a second time to verify that you have entered it correctly.