mqsicreatebroker command - z/OS

z/OS command - BIPCRBK

BrokerName

(Required) The name of the broker that you are creating. This parameter must be the first parameter. If you create a broker with an uppercase name, you must also specify the name in uppercase in the IBM® Integration Toolkit.

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.

-l UserLilPath

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

This name is case sensitive; enclose the names in single quotation marks if they are in mixed case.

Do not include environment variables in this path; IBM Integration Bus ignores them.

You must create your own directory for storing your .lil or .jar files. Do not save these files in the IBM Integration Bus install directory.

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

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

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

An interval of zero minutes indicates that the operating system has an external method of notification (the ENF timer), and is not using an internal timer within IBM Integration Bus.

-1

(Optional) The registry pass, which creates only the broker registry.

You must run the command with option 1 before you run the command with option 2, otherwise the command fails.

-2

(Optional) The WebSphere MQ pass, which creates only the broker WebSphere MQ queues.

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

The code page converters must be either of the form codepagename.cnv, or in an ICU data package called icudt48.dat. The code page converters must be located in a sub-directory named icudt48_<platform_suffix> of the specified directory where <platform_suffix> is one of the following values:

• l for little-endian ASCII platforms
• b for big-endian ASCII platforms
• e for EBCDIC platforms

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 with Version 6.0 and above, 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.

-s

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

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