Use the mqsistartmsgflow command to start integration servers, applications, and message flows.
To use this command, you must have already deployed message flows, if specified, to the integration node in a BAR file. You can start message flows only if the integration server to which the message flow is deployed is running.
>>-mqsistartmsgflow--| brokerSpec |-----------------------------> >--+- -e --integrationServerName-+--+--------------+------------> '- -g ------------------------' +- -m flowName-+ '- -j ---------' >--+---------------------+--+---------------------+-------------> +- -k applicationName-+ '- -v --traceFileName-' '- -z ----------------' >--+-------------------+--+-------------------+---------------->< '- -w --timeoutSecs-' '- -y --libraryName-' brokerSpec |--+- integrationNodeName ---------+----------------------------| +- -n --integrationNodeFileName-+ +- -i --ipAddress-- -p --port---+ '-+- -i --ipAddress-+-----------' '- -p --port------'
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.
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:
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.
If you specify -e without -m or -j, the integration server is started. Message flows are started only if they were running when the integration server was stopped.
If you specify -e with -m or -j, the integration server must be running. If the integration server is stopped, the request is rejected.
If you specify -g without -m or -j, all integration servers are started, but message flows are started only if they were running when the integration server was stopped.
If you specify -g with -m or -j, the specified message flow or flows are started only if the integration server is running. The request checks all integration servers, and starts message flows on integration servers that are currently running. Error BIP2851 is reported for each integration server that is not running.
(Optional) All message flows in the specified integration server are started.
If you set this parameter, all message flows in the integration server are started, regardless of whether they are at the integration server level, in an application, or in a library. No applications are started. If you set the -j parameter with the -z parameter, all applications in the integration server are started, and the message flows that are at the integration server level or in libraries at the integration server level are started. The combination of -j and -z parameters does not start message flows inside applications, or message flows inside libraries inside applications.
If you do not specify -j or -m, the integration server identified by -e (if specified), or all integration servers on this integration node, are started. Message flows that were running when the integration server was last stopped are also restarted.
If you set the -k parameter, you must also set the -e parameter. If you set the -k parameter but do not set the -m parameter, the application is started. If you set the -m parameter, the named message flow in the application is started.
If you set the -j parameter with the -k parameter, all message flows in the application are started, including those in referenced libraries. Message flows in other applications or at integration server level are not started. The application is not started.
If you set the -k parameter with the -m or -j parameters, ensure that the application that is specified by the -k parameter is running. You cannot start message flows in an application that is not started.
You cannot set both the -k parameter and the -z parameter.
If you set the -y parameter, you must also set the -e parameter. If you set the -m parameter, the named message flow in the library is started.
If you set the -j parameter with the -y parameter, all message flows in the library are started. Message flows in other libraries or at integration server level are not started.
To start all flows in a specific library in an application, use the -y parameter with the -k parameter. When you use a combination of the -y and -k parameters, only flows in the named library in the named application are started. No flows are started at the application level, or in any other libraries in the application. No flows are started in any other application or at integration server level. The application is not started.
If you set the -j parameter with the -z parameter, all applications in the integration server are started, and the message flows that are at the integration server level or in libraries at the integration server level are started. The combination of -j and -z parameters does not start message flows inside applications, or message flows inside libraries inside applications.
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.
Start a named message flow that you have deployed to integration server eg1 on the integration node IBNODE:
mqsistartmsgflow IBNODE -e eg1 -m simpleflow
Ensure that all message flows are running on the local integration node IBNODE:
mqsistartmsgflow IBNODE -g -j
Start the message flow myFlow1 in the application myApplication in the default integration server:
mqsistartmsgflow IBNODE -e default -k myApplication -m myFlow1
Start the message flow myFlow1 in the library myLibrary, which is referenced by the application myApplication, in the default integration server:
mqsistartmsgflow IBNODE -e default -k myApplication -y myLibrary -m myFlow1
Start all message flows and start all applications in the default integration server:
mqsistartmsgflow IBNODE -e default -z -j