mqsicreatebroker command - Windows systems
Use the mqsicreatebroker command to create an integration node on a Windows system.
Syntax
Parameters
- integrationNodeName
- (Required) The name of the integration node that you are creating. This parameter must be the first parameter. If you create an integration node with an uppercase name, you must also specify the name in uppercase in the IBM® Integration Toolkit.
- -i serviceUserId
- (Optional) The user ID under which the integration node runs.
- -i LocalSystem
- (Optional) You can specify LocalSystem instead
of serviceUserId.
If you are using a system and you do not specify -i, then the default is LocalSystem.
If you specify LocalSystem, the servicePassword parameter is not required.
If you specify the -e parameter, LocalSystem should not be used. When specifying the -e parameter, you must use a real userid for the -i option. For Windows, only the -i LocalSystem parameter is available. If you specify the -e parameter for a multi-instance integration node, the system issues an error (BIP8022E: Invalid service userid and password combination supplied).
Note: Either the LocalSystem or serviceUserId option must be specified for the -i parameter. - -a servicePassword
- (Required) The password for the serviceUserId.
- -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. You create the queues by running the script iib_createqueues.bat in the install_dir\server\sample\wmq directory. Alternatively, you can create the queues by running the WebSphere MQ define qlocal command. For more information about using the define qlocal command, see the WebSphere MQ product information. For more information about the IBM Integration Bus features that require system queues, see mqsicreatebroker command.
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 and Installing WebSphere MQ.
If 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 theworkPath
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. - -t
- (Optional) The integration node runs as a WebSphere MQ trusted application.
If you specify this parameter, add the serviceUserId (identified by the -i parameter) to the mqm group.
- -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.
- -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.
- -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 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 (:).
- -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 (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.
- -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.
- -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.
- -B brokerDomainGroup
- (Optional) Use this parameter to set the Windows Domain Group that is used to secure files in the sharedWorkPath of a multi-instance integration node. Use only with -e.
- -Q queueManagerDomainGroup
- (Optional) Use this parameter to set the Windows Domain Group that is used to secureWebSphere MQ files in the sharedWorkPath of a multi-instance integration node. Use only with -e, and if the queue manager does not exist and must be created.
Examples
mqsicreatebroker IBNODE -q myQmgr
mqsicreatebroker IBNODE -i wbrkuid -a wbrkpw -t
mqsicreatebroker IBNODE -i wbrkuid -a wbrkpw -x /opt/3rdparty/wmbexits
mqsicreatebroker IBNODE -s active
mqsicreatebroker IBNODE -o scale