See information about the latest product version
mqsichangebroker command - z/OS
Use the mqsichangebroker command on z/OS® to modify your broker.
Syntax
z/OS command - BIPCHBK
>>-mqsichangebroker--BrokerName--+-------------------+----------> '- -l --UserLilPath-' >--+----------------------------------+-------------------------> '- -g --ConfigurationChangeTimeout-' >--+------------------------------------+-----------------------> '- -k --InternalConfigurationTimeout-' >--+------------------------+-----------------------------------> '- -P --HTTPListenerPort-' >--+-------------------------------+----------------------------> '- -v --StatisticsMajorInterval-' >--+------------------------------------------+-----------------> '- -y--LdapPrincipal-- -z--LdapCredentials-' >--+------------------------+--+--------------------+-----------> '- -c --ICUConverterPath-' '- -x --UserExitPath-' >--+-----------------------+--+----------------------+----------> '- -e --ActiveUserExits-' '- -f --function level-' >--+--------------------+--+-------------------+----------------> '- -s --+-active---+-' '- -b --cachePolicy-' '-inactive-' >--+----------------------+------------------------------------>< '- -r --cachePortRange-'
z/OS console command
Synonym: cb
.------------------------------------. V | >>-+-changebroker-+----+-g=ConfigurationChangeTimeout---+-+-----> '-cb-----------' +-k=InternalConfigurationTimeout-+ +-l=UserLilPath -----------------+ +-v=StatisticsMajorinterval------+ '-P=HTTPListenerPort-------------' >--+------------------------------------+-----------------------> '-y=LdapPrincipal--z=LdapCredentials-' >--+--------------------+--+----------------+-------------------> '-c=ICUConverterPath ' '-x=UserExitPath-' >--+-------------------+--+------------------+------------------> '-e=ActiveUserExits-' '-f=function_level-' >--+-------------------+--+---------------+---------------------> '-s=security_status-' '-b=cachePolicy-' >--+------------------+---------------------------------------->< '-r=cachePortRange-'
Parameters
- BrokerName
- (Required) This parameter must be the first parameter. Specify
the name of the broker to modify.
This parameter is implied in the console form of the command.
- -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; WebSphere® Message Broker ignores them.
-
Create your own directory for storing your .lil or .jar files. Do not save them in the WebSphere Message Broker installation directory.
If you specify more than one additional directory, each directory must be separated by the default platform-specific path separator.
- -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 execution
group a configuration change that you have initiated. For example,
if you deploy a configuration from the WebSphere Message Broker 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 execution group 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 execution group.
The response time of each execution group differs according to system load and the load of its own processes. The value must reflect the longest response time that any execution group 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.
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 WebSphere Message Broker.
- -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 delimiter is a period (.).
- 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 execution groups in this broker. This path is added to the system library search path (PATH,LIBPATH,LD_LIBRARY_PATH,SHLIBPATH) for the execution group process only.
- -e ActiveUserExits
- (Optional) Active user exits. By default, user exits are inactive. Adding a userExit name to this colon-separated list changes its default state to active for this broker. You can use the mqsichangeflowuserexits command to override the default state at the execution group or message flow level. If you specify a user exit name, and no library is found to provide that user exit when the execution group starts, a BIP2314 message is written to the system log. The execution group fails to start.
- -f function level
- (Optional) Use this parameter to enable function that
becomes available in WebSphere Message
Broker fix
packs. Valid values that you can set are all, which enables all functions,
or a version string of the form V.R.M.F (for example, 8.0.0.2), which indicates the
maximum level of feature function to enable. You can use this parameter
to revert to a prior fix pack level, but you must first remove any
flows that are using the new functions.
This command does not disable all new features, and it is not possible to use this flag to run the broker at a different major version.
- -s security_status
- (Optional) Specify this parameter to change the administrative
security status of the broker.
- If you specify active, administrative security is enabled for the broker. The command creates authorization queues that are required, if they do not exist.
- If you specify inactive, administrative security is disabled for the broker. The command does not delete or clear the security queues that are associated with this broker and its execution groups.
- 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 execution group uses the values that you set. The execution group 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.
To change other broker properties, first delete and re-create the broker, and then use the WebSphere Message Broker Toolkit to redeploy the broker configuration. If you want to update the user ID credentials that the broker uses to access one or more databases from deployed message flows, use the mqsisetdbparms command. For more information, see Accessing databases from message flows.
Examples
When you run the console command, you must use a comma between each command option, as shown in these examples.
F MQP1BRK,cb g=100,k=200
/f MA05BRK,cb x='/u/test/wbi/MsgFlowTrackingUserExit/zOS',e='MqsiStrUserExit02:MqsiStrUserExit03'
F MQP1BRK,cb f=8.0.0.2
mqsichangebroker MB8BROKER -s active