mqsichangebroker command - Linux and UNIX systems

Use the mqsichangebroker command on Linux® and UNIX systems to modify your integration node.

Syntax

Read syntax diagramSkip visual syntax diagrammqsichangebrokerintegrationNodeName -t  -n  -q queueManagerName -l userLilPath -g configurationChangeTimeout -k internalConfigurationTimeout -P httpListenerPort -v statisticsMajorInterval -y ldapPrincipal -z ldapCredentials -c ICU converter path -x userExitPath -e activeUserExits -f function level -s activeinactive -d definedundefined -b cachePolicy -r cachePortRange -C CCSID

Parameters

integrationNodeName

(Required) This parameter must be the first parameter. Specify the name of the integration node to modify.

-q queueManagerName
(Optional) The name of the queue manager that is associated with the integration node. This parameter changes the queue manager for the integration node to the specified queue manager name. If a queue manager with that name does not exist, the command completes successfully, with the assumption that a queue manager with that name will be created later.
You can remove an association between an integration node and a queue manager by specifying the -q parameter followed by double quotation marks. For example:
mqsichangebroker IB10NODE -q "" 
You cannot remove the queue manager association if the integration node was created as multi-instance by using the -e parameter. Similarly, you cannot change the queue manager name if -d was defined.

If a queue manager is specified on the integration node and administration security is active, the queue-based (mq) mode of security is used by default, and the required queues that are used for setting authorization are created automatically when the integration node is created. If the queue-based mode of security is set and the queue manager is subsequently removed from the integration node, all access to the integration node is denied until a queue manager is specified on the integration node again, or until the authorization mode is changed to file and the required permissions are set. For information about using the mqsichangeauthmode command to specify the mode of administration security, see Configuring administration security to use file-based, queue-based, or LDAP authorization.

If you want to use the IBM® Integration Bus functions that require access to WebSphere® MQ queues, you can use the script iib_queues_create.mqsc to define them. The script is in the directory install_dir/server/sample/wmq or install_dir\server\sample\wmq. To learn which features require access to WebSphere MQ, see IBM Integration features and Enhanced flexibility in interactions with WebSphere MQ.

-t
(Optional) The integration node runs as a WebSphere MQ trusted application.

For more details about using WebSphere MQ trusted applications, see the Intercommunication section of the WebSphere MQ Version 7.5 product documentation online.

-n

(Optional) The integration node ceases to run as a WebSphere MQ trusted application.

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

On Linux and UNIX systems, directory names are case-sensitive. 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 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 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) The time interval (in minutes) at which statistics and accounting archive records are 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 ICU converter path
(Optional) A set of directories to search for additional code page converters, delimited by a colon (:).
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 in a subdirectory 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
-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.
-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 integration node. You can use the mqsichangeflowuserexits command to override the default state at the integration server or message flow level. If you specify a user exit name, and no library is found to provide that user exit when the integration server starts, a BIP2314 message is written to the system log. The integration server fails to start.
-f function level
(Optional) Use this parameter to enable function that becomes available in IBM Integration Bus 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, 9.0.0.3), 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 integration node at a different major version.

-s security_status
(Optional) Preserved for compatibility. To change the administration security status and set the authorization mode for the integration node, use the mqsichangeauthmode command instead of using this parameter. To view the authorization mode, use the mqsireportauthmode command.
Specify this parameter to change the administrative security status of the integration node.
  • If you specify active, administrative security is enabled for the integration node. If the queue-based mode of administration security has been set, this command creates the required authorization queues, if they do not exist. The queue-based mode of administration security is used by default if a queue manager is specified on the integration node. You can check which administration security mode is set by using the mqsireportauthmode command, and you can change it by using the mqsichangeauthmode command.
  • If you specify inactive, administrative security is disabled for the integration node. The command does not delete or clear the security queues that are associated with this integration node and its integration servers.
If you omit this parameter, the security status is unchanged.
For more information about security, see Administration security overview and Authorizing users for administration.
-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.

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.

To change other integration node properties, first delete and re-create the integration node, and then use the IBM Integration Toolkit to redeploy the integration node configuration. If you want to update the user ID credentials that the integration node 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

Define the path to user-defined exits:
mqsichangebroker IBNODE -x /opt/3rdparty/wmbexit
Enable the new function that is supplied in WebSphere Message Broker Version 8.0.0.2:
mqsichangebroker IBNODE -f 8.0.0.2
Assign a queue manager named IBQMGR to the integration node:
mqsichangebroker IBNODE -q IBQMGR
Set the WebSphere MQ status of the integration node to defined, so that the integration node starts and stops when its associated queue manager starts and stops.
mqsichangebroker IBNODE -d defined
Set the WebSphere MQ service status to undefined, so that the integration node no longer starts and stops when its associated queue manager starts and stops. The integration node starts only when using the mqsistart command.
mqsichangebroker IBNODE -d undefined
Change the user ID that is used to run the integration node:
mqsichangebroker IBNODE -i wbrkuid -a wbrkpw
Change the configuration timeout:
mqsichangebroker IBNODE -g 500