The WebSphere MQ display route application (dspmqrte) can be executed on all WebSphere MQ Version 6.0 queue managers, with the exception of WebSphere MQ for z/OS queue managers. You can execute the WebSphere(R) MQ display route application as a client to a WebSphere MQ for z/OS Version 6.0 queue manager by specifying the -c parameter when issuing the dspmqrte command.
Use dspmqrte to help determine the route a message has taken through a queue manager network. The WebSphere MQ display route application generates and puts a trace-route message into a queue manager network. As the trace-route message travels through the queue manager network, activity information is recorded. When the trace-route message reaches it's target queue the activity information is collected by the WebSphere MQ display route application and displayed. For more information, and examples of using the WebSphere MQ display route application, see the Monitoring WebSphere MQ book.
.-| Generation options |-----------. >>-dspmqrte--+------+--+----------------------------------+-----> '- -c -' ' -i CorrelId-| Display options |--' >-- -q TargetQName--+--------------+--------------------------->< '- -m QMgrName-' Generation options: |--+-----------------+--+-------------+--+-------------+--------> '- -ac -+-------+-' '- -d Deliver-' '- -f Forward-' '- -ar -' >--+----------------------+--+------+--+--------------+---------> | (1) | '- -o -' '- -p Priority-' '- -l Persistence------' >--+---------------------+--+----------------------------+------> '- -qm TargetQMgrName-' '- -ro -+- none -----------+-' | .-,------------. | | V | | '---ReportOption-+-' >--+-------------------------------------+----------------------> '- -rq ReplyToQ-+-------------------+-' '- -rqm ReplyToQMgr-' >--+----------------+--+------------+--+-----------------+------> '- -s Activities-' '- -t Detail-' '- -xp PassExpiry-' .-| Display options |-. >--+-------------+--+---------------------+---------------------| '- -xs Expiry-' | (2) | '-- -n ---------------' Display options: .- -v summary --------------------------------. |--+------+--+----------------------------------------------+---> '- -b -' ' -v --+- all ------------------------------+--' +- none -----------------------------+ '- outline --+---------------------+-' | .-,---------------. | | V | | '--- DisplayOption -+-' >--+--------------+---------------------------------------------| '- -w WaitTime-'
If the WebSphere MQ display route application is being used to view previously gathered activity information, TargetQName specifies the name of the queue where the activity information is stored.
If you do not specify this parameter, the WebSphere MQ display route application does not connect as a client application.
The format of CorrelId is a 48 character hexadecimal string.
If you do not specify this parameter, the default queue manager is used.
If you do not specify this parameter, activity information is not accumulated within the trace-route message.
For more information on trace-route reply messages, see the Monitoring WebSphere MQ book.
If you do not specify this parameter, a trace-route reply message will not be requested.
yes | On arrival, the trace-route message is put to the target queue, even if the queue manager does not support trace-route messaging. | |
no | On arrival, the trace-route message is not put to the target queue. |
If you do not specify this parameter, the trace-route message is not put to the target queue.
If you do not specify this parameter, the trace-route message will only be forwarded to a queue manager that will honor the Deliver parameter.
yes | The generated trace-route message is persistent. (MQPER_PERSISTENT). | |
no | The generated trace-route message is not persistent. (MQPER_NOT_PERSISTENT). | |
q | The generated trace-route message inherits it's persistence value from the queue specified by -q TargetQName. (MQPER_PERSISTENCE_AS_Q_DEF). |
If Persistence is specified as yes, you must specify the parameter -rq ReplyToQ. The reply-to queue must not resolve to a temporary dynamic queue.
If you do not specify this parameter, the generated trace-route message is not persistent.
If you do not specify this parameter, the target queue is bound to a specific destination.
If you do not specify this parameter, the priority value is taken from the queue specified by -q TargetQName.
If you do not specify this parameter, the queue manager to which the WebSphere MQ display route application is connected is used as the reply-to queue manager.
none | Specifies no report options are set. | |
ReportOption | Specifies report options for the
trace-route message. Multiple report options can be specified using a comma
as a separator. Possible values for ReportOption are:
|
If neither -ro ReportOption nor -ro none are specified, then the MQRO_ACTIVITY and MQRO_DISCARD_MSG report options are specified.
If you do not specify this parameter, the system default model queue, SYSTEM.DEFAULT.MODEL.QUEUE is used as the reply-to queue. Using this model queue causes a temporary dynamic queue, for the WebSphere MQ display route application, to be created.
If you do not specify this parameter, the queue manager to which the WebSphere MQ display route application is connected is used as the reply-to queue manager.
If you do not specify this parameter, an unlimited number of activities can be performed on behalf of the trace-route message.
low | Activities performed by user-defined application are recorded only. | |
medium | Activities specified in low are recorded. Additionally, activities performed by MCAs are recorded. | |
high | Activities specified in low, and medium are recorded. MCAs do not expose any further activity information at this level of detail. This option is available to user-defined applications that are to expose further activity information only. For example, if a user-defined application determines the route a message takes by considering certain message characteristics, the routing logic could be included with this level of detail. |
If you do not specify this parameter, medium level activities are recorded.
yes | The report option MQRO_PASS_DISCARD_AND_EXPIRY
is specified in the message descriptor of the trace-route message.
If a trace-route reply message, or activity reports, are generated for the trace-route message, the MQRO_DISCARD_MSG report option (if specified), and the remaining expiry time are passed on. This is the default value. |
|
no | The report option MQRO_PASS_DISCARD_AND_EXPIRY
is not specified.
If a trace-route reply message is generated for the trace-route message, the discard option and remaining expiry time from the trace-route message are not passed on. |
If you do not specify this parameter, the MQRO_PASS_DISCARD_AND_EXPIRY report option is not specified in the trace-route message.
If you do not specify this parameter, the expiry time is specified as 60 seconds.
If this parameter is accompanied by a request for a trace-route reply message, ( -ar), or any of the report generating options from ( -ro ReportOption), then a specific (non-model) reply-to queue must be specified using -rq ReplyToQ. By default, activity report messages are requested.
After the trace-route message is put to the specified target queue, a 48 character hexadecimal string is returned containing the message identifier of the trace-route message. The message identifier can be used by the WebSphere MQ display route application to display the activity information for the trace-route message at a later time, using the -i CorrelId parameter.
If you do not specify this parameter, activity information returned for the trace-route message is displayed in the form specified by the -v parameter.
If you do not specify this parameter, the WebSphere MQ display route application will destructively get activity reports or a trace-route reply message related to a message.
summary | The queues that the trace-route message was routed through are displayed. | |
all | All available information is displayed. | |
none | No information is displayed. | |
outline DisplayOption | Specifies display options for
the trace-route message. Multiple display options can be specified using a
comma as a separator.
If no values are supplied the following is displayed:
Possible values for DisplayOption are:
|
If you do not specify this parameter, a summary of the message route is displayed.
If you do not specify this parameter, the wait time is specified as the expiry time of the trace-route message, plus 60 seconds.
dspmqrte -q TARGET.Q -rq ACT.REPORT.REPLY.QProviding one or more activity reports are delivered to the reply-to queue, ACT.REPORT.REPLY.Q, the WebSphere MQ display route application orders and displays the activity information.
dspmqrte -ac -ar -ro discard -rq TRR.REPLY.TO.Q -q TARGET.QProviding a trace-route reply message is generated and is delivered to the reply-to queue TRR.REPLY.TO.Q, the WebSphere MQ display route application orders and displays the activity information that was accumulated in the trace-route message.
For more examples of using the WebSphere MQ display route application and its output, see the Monitoring WebSphere MQ book.
Notices |
Downloads |
Library |
Support |
Feedback
![]() ![]() |
dspmqrte |