mqsistopmsgflow command

Supported platforms

Purpose

Use the mqsistopmsgflow command to stop message flows.

Syntax

Parameters

-b BrokerName
(Required) The name of the broker on which to stop message flows.

If you do not specify the -e and -m flags, all message flows on the broker are stopped.

-e ExecutionGroupName
(Optional) The name of the execution group on which message flows are stopped.
-m msgFlowName
(Optional) The name of the message flow being stopped.

You can specify only one message flow in a single command. However, if you do not specify this parameter, all message flows on the execution group or broker are stopped.

If you specify this flag you must also specify the -e flag.

-n cfgParameterFileName
(Optional) The name of a .configmgr file that describes the connection parameters to the Configuration Manager.
The file is in XML, using the .configmgr format saved by the Eclipse GUI. For example:
<?xml version="1.0" encoding="UTF-8"?>
<configmgr host="localhost" listenerPort="1414" queueManager="QNAME"
           securityExit="test.myExit"/>
If you are using this file on z/OS you must remove the statement encoding="UTF-8" from the first line, to leave the statement as:
<?xml version="1.0"?>
and remove the value for the host attribute, to leave the statement as:
<configmgr host="" listenerPort="1414" queueManager="QNAME"
           securityExit="test.myExit"/>
Note: If you do not supply this parameter, you must supply the -i, -p, and -q parameters.
-i ipAddress
(Optional) The host name or IP address of the Configuration Manager.

If you are using this file on z/OS and want to connect to the local host you must set the value to "".

-p Port
(Optional) The port number of the Configuration Manager.
-q qMgr
(Optional) The name of the WebSphere MQ queue manager that the Configuration Manager is using.

If you do not supply the -i, -p, and -q parameters, you must specify the -n parameter.

-w timeoutValue
(Optional) The time in seconds that the utility waits to ensure that the stop command completed; the default value is 60.
-v TraceFileName
(Optional) Sends internal debug trace information to the specified file.

Authorization

To stop message flows you need to have sufficient authority defined in the Configuration Manager’s access control list.

The permissions required are the same as the permission required to do the equivalent function in the Message Brokers Toolkit; see ACL permissions for a list of permissions that can be defined in the Configuration Manager.

Responses

This command returns the following responses:
0
(Success) States that the request completed successfully and the state of all message flows has been updated.
2
(Failure) States that at least one message flow can not be put into the correct state for any reason.
98
States that the Configuration Manager cannot be reached.
99
States that the supplied arguments to the utility are not valid.

Examples

Stops all message flows on execution group default on broker B1, which is controlled by the Configuration Manager whose connection details are described in cm1.configmgr. Control is returned to the caller when all message flows in the execution group are reported as stopped, or the default time of one minute elapses, whichever is sooner.

   mqsistopmsgflow –n cm1.configmgr –b B1 -e default

Stops the message flow flow1 on execution group default on broker B1, which is controlled by the Configuration Manager whose connection details are described in cm1.configmgr. Control is returned to the caller when the message flow is reported as stopped, or the default time of one minute elapses, whichever is sooner.

   mqsistopmsgflow –n cm1.configmgr –b B1 -e default -m flow1

Enter mqsistopmsgflow to display usage information:

> mqsistopmsgflow 
BIP1025I: Stops message flows.

> Syntax:
mqsistopmsgflow (-n cfgParameterFileName | (-i ipAddress -p port -q qMgr))
 -b brokerName [-e executionGroupName [-m flowName]] [-w timeoutValue]
[-v traceFileName]
Command Options:
'-n cfgParameterFileName' Configuration
Manager connection file (.configmgr)
'-i ipAddress' IP address or host name of the Configuration
Manager
'-p port' port number of the Configuration
Manager
'-q qMgr' queue manager of the Configuration
Manager
'-b brokerName' name of the broker on which to stop message flows
'-e executionGroupName' name of the execution group on which to stop message flows. 
If this is not specified, all message flows on the broker will be stopped.
'-m flowName' name of the message flow to start. 
If this is not specified, all message flows on the execution group will be stopped.
'-w timeoutValue' time to wait (in seconds) for message flows to stop (Default=60)
'-v traceFileName' send verbose internal trace to the specified file.