mqsimode command

Use the mqsimode command to configure and retrieve operation mode information.

Purpose

Use the mqsimode command to change the operation mode of an integration node, or to retrieve information about the mode in which the integration node is currently working.

Syntax

Read syntax diagramSkip visual syntax diagrammqsimodeintegrationNodeSpec -o operationMode -w timeoutSecs -v traceFileName -x modeExtensions
integrationNodeSpec
Read syntax diagramSkip visual syntax diagram integrationNodeName  -n integrationNodeFileName -i ipAddress -p port -i ipAddress -p port

Parameters

integrationNodeSpec
(Required) You must specify at least one parameter to identify the target integration node for this command, in one of the following forms:
integrationNodeName
This parameter identifies the name of a specified integration node. To connect to a remote integration node, you must also specify -i and -p.
-n integrationNodeFileName
This parameter identifies the name of a .broker file that contains the connection details for a local or remote integration node. Include the location (path) and file name when you specify this parameter. You must ensure that the location is accessible when you run this command.

Use this option if multiple users want to connect to the same integration node, or if you are using advanced connection parameters such as SSL. To learn more about creating and using a .broker file, see Connecting to an integration node by creating a .broker file.

If you want to run a command that uses SSL to administer a remote integration node over a secured channel, you must specify the keystore and truststore password for the connection that is using the IBM_JAVA_OPTIONS environment variable. For more information, see Resolving problems when running commands.

-i ipAddress, -p port
These parameters identify the connection details for the integration node.

Use this option for connections to remote integration nodes that do not require advanced connection parameters.

If you are connecting to a remote integration node, you can additionally prefix integrationNodeName to explicitly set which integration node to connect to. You cannot use -n integrationNodeFileName in the same command.

Parameters that you omit assume default values:

  • -i ipAddress: The host name or IP address of the computer on which the integration node is running. If you do not specify this parameter, a value that represents the local computer is used.

    If you want to connect to a secured integration server as a specific user, provide the security credentials as a URI in the following format: tcp://user:password@hostname. If your password contains URI Reserved characters, you must convert these characters to the percent-encoded format. For more information, see A correct URL and password returns error BIP1939 when you attempt to connect to a remote host name in Resolving problems when running commands.

  • -p port: The port on which the web user interface HTTP connection listener is listening. If you do not specify this parameter, the value 4414 is used.
-o operationMode
(Optional) This parameter sets the mode of the target integration node. Valid values 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), standard (Standard Edition), express (Express Edition), scale (Scale 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 specify the -o parameter, the command displays the mode in which the integration node is running.

If you have purchased a license for the Standard Edition, you are entitled to run your integration nodes in either standard or scale mode.

-x modeExtensions
(Optional) This parameter uses a comma separated list of to specify the mode extensions to which the integration node is entitled. You can also use the -x parameter to switch off all mode extensions (See Examples).

If the mode extension is DecisionServices, you do not need to specify the integration node name. If you do specify an integration node name, it is ignored.

-w timeoutSecs
(Optional) This parameter specifies the time in seconds that the utility waits to ensure that the command completed; the default value is 60.
-v traceFileName
(Optional) This parameter sends internal debug trace information to the specified file.

Deprecation of the -q parameter

In previous versions of IBM Integration Bus, you might have used the -q parameter for this command to define a connection to a queue manager. A queue manager connection is no longer used to connect to an integration node. The -q parameter is now deprecated, and is ignored if used. If you use the -q parameter, a BIP1922 warning is displayed.

Responses

This command returns the following responses:
0
The command completed successfully.
2
(Failure) The integration node received the deployment request but was unable to process it successfully. See the messages issued from the utility (or the Administration log) for more information.
9
(Failure) The request has been submitted to the integration node, but no response was received before the timeout expired.
10
(Failure) Another user or application canceled the request operation before the integration node was able to process it.
98
The integration node is not running.
99
One or more of the parameters that you specified is invalid.

Examples

Running the mqsimode command specifying the -o parameter

When you run the mqsimode command for integration node INODE1, and specify the -o parameter, the mode is updated, and you receive a report about all errors. For example, if you run the following mqsimode command to change your integration node to the Remote Adapter Deployment mode, and your integration node is in the following state:
  • integrationNodeName is the name of your integration node.
  • Message_Flow is the name of your message flow.
  • Integration_Server is the name of your integration server.
  • The command changes integrationNodeName to the Remote Adapter Deployment mode, but contains a node Node_Type that is not valid in this mode.
mqsimode INODE1 -o adapter
You receive the following messages:

BIP1045: Connecting to the integration node...
BIP1805: The mode for integration node 'integrationNodeName' has been changed to 'adapter'.
BIP1823: WARNING: Integration node 'integrationNodeName' has a message flow called 'Message_Flow' 
 in integration server 'Integration_Server', which contains one or more nodes that are not 
 valid in this mode: Node_Type.
BIP8229: The command completed with the following number of warnings: 1.

Running the mqsimode command without the -o parameter

When you run the mqsimode command without the -o parameter, you receive a report about the mode being used by your integration node, a report about all mode violations, and a report for any mode extensions that are required and not set. For example, if you run the following mqsimode command, and your integration node is in the following state:
  • integrationNodeName is the name of your integration node.
  • Your integration node is in Standard Edition mode.
  • Your integration node has no violations.
mqsimode integrationNodeName
You receive the following messages:
BIP1807: Discovering mode information from integration node 'integrationNodeName'...
BIP1802: Integration node 'integrationNodeName' is in 'standard' mode.
BIP8071: Successful command completion.

Switching off all mode extensions

To switch off all mode extensions, run the mqsimode command with the -x parameter:
mqsimode integrationNodeName -x
where integrationNodeName is the name of your integration node.