mqsistopmsgflow command

• Windows
• Linux and UNIX systems
• z/OS®. Run this command by customizing and submitting BIPSPMF; see Contents of the broker PDSE

To use this command, you must have already deployed message flows, if specified, to the broker in a broker archive (BAR) file.

The broker processes all inflight messages and associated transactions for each message flow before the broker stops. For information about how outstanding units of work are handled in this situation, see Message flow transactions.

brokerSpec

(Required) You must specify at least one parameter to identify the target broker for this command, in one of the following forms:

brokerName

This parameter identifies the name of a locally defined broker. You cannot use this option if the broker is on a remote computer.

-n brokerFileName

This parameter identifies the name of a file that contains the connection details for a local or remote broker.

Use this option if multiple users want to connect to the same broker, or if you are using advanced connection parameters such as SSL.

To create this file, right-click the broker in the IBM® Integration Explorer and select Export *.broker file. When prompted, navigate to the location in which you want to save the file and enter the file name; the extension .broker is appended automatically when you click Save. 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.

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

-i ipAddress, -p port, -q qMgr

These parameters identify the connection details for the broker.

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

If you choose this option, you must specify at least one of these three parameters; the order in which you specify them is insignificant. You cannot specify each parameter more than once.

Parameters that you omit assume default values:

• -i ipAddress: The host name or the IP address of the computer on which the broker is running. If you do not specify this parameter, a value that represents the local computer is used.
• -p port: The TCP port on which the broker's queue manager is listening. If you do not specify this parameter, the value 1414 is used.
• -q qMgr: The name of the broker's queue manager. If you do not specify this parameter, a value that represents the default queue manager on the local computer is used.

You cannot connect to a remote queue manager on z/OS; see Usage note.

-e integrationServerName

(Optional) The name of the integration server for which to stop message flows. You must specify either -e or -g.

If you specify -e without -m or -j, the integration server is stopped. The state of every message flow (stopped or started) is retained, and started message flows are started when the integration server is started again.

If you specify -e with -m or -j, the integration server must be running. If the integration server is stopped, the request is rejected.

-f

(Optional) Used with the –m, –e, and –k parameters to force the named message flow to stop within the named integration server or the named application.

The –f parameter specifies how the named message flow is stopped. Currently, restartExecutionGroup is the only option that can be specified, which causes the named message flow to be flagged as stopped and then restarts the named integration server. When the integration server restarts, the message flow is in the stop state.

-g

(Optional) The specified message flow or flows are stopped on all integration servers on the specified broker. You must specify either -e or -g.

If you specify -g without -m or -j, all integration servers are stopped. The state of every message flow (stopped or started) is retained for each integration server, and started message flows are started when the integration server is started again.

If you specify -g with -m or -j, the specified message flow or flows are stopped only if the integration server is running. The request checks all integration servers, and stops message flows on integration servers that are currently running. Error BIP2851 is reported for each integration server that is not running.

-j

(Optional) All message flows in the specified integration server are stopped; the integration server is not stopped.

If you set this parameter, all message flows in the integration server are stopped, regardless of whether they are at the integration server level, in an application, or in a library. No applications are stopped. If you set the -j parameter with the -z parameter, all applications in the integration server are stopped, and the message flows that are at the integration server level or in libraries at the integration server level are stopped. The combination of -j and -z parameters does not stop message flows inside applications, or message flows inside libraries inside applications.

If you do not specify -j or -m, the integration server that is identified by -e (if specified), or all integration servers on this broker, are stopped.

-k applicationName

(Optional) The name of an application to which to target a stop request.

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 stopped. When an application is stopped, the message flows that it contains do not run. If you set the –m parameter, the named message flow in the application is stopped.

If you set the –j parameter with the -k parameter, all message flows in the specified application are stopped, including the message flows in referenced libraries. Message flows in other applications or at integration server level are not stopped. The application is not stopped.

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 stop message flows in an application that is not started.

You cannot set both the –k parameter and the –z parameter.

-m flowName

(Optional) The name of the message flow being stopped.

You can specify only one message flow in a single command. If you want to stop all message flows deployed to the broker, or to the integration server identified by -e, specify -j.

If you do not specify -m or -j, the integration server identified by -e (if specified), or all integration servers on this broker, are stopped.

-v traceFileName

(Optional) This parameter sends internal debug trace information to the specified file.

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

-y libraryName

(Optional) The name of a library to which to target a stop request.

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

If you set the –j parameter with the –y parameter, all message flows in the specified library are stopped. Message flows in other libraries or at integration server level are not stopped.

To stop 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 the flows in the named library in the named application are stopped. No flows are stopped at the application level, or in any other libraries in the application. No flows are stopped in any other application or at integration server level. The application is not stopped.

-z

(Optional) The -z parameter indicates that all applications in an integration server are to be stopped.

If you set the -j parameter with the -z parameter, all applications in the integration server are stopped, and the message flows that are at the integration server level or in libraries at the integration server level are stopped. The combination of -j and -z parameters does not stop message flows inside applications, or message flows inside libraries inside applications.

If you try to connect to a remote broker by specifying the i, p, and q parameters, or by using a connection parameter file (.broker), the command attempts to use WebSphere® MQ Java™ client code. This option is not supported on z/OS, and returns the following error:

BIP1046E: Unable to connect with the broker (name)

The reported reason code is MQRC_ENVIRONMENT_ERROR. You must specify a local queue manager.