Script (MQSC) Command Reference: DISPLAY QSTATUS

DISPLAY QSTATUS

Use DISPLAY QSTATUS to display the status of one or more queues.
Synonym: DIS QS
DISPLAY QSTATUS
 
>>-DISPLAY QSTATUS(generic-qname)--+-----+---------------------->
                                   '-ALL-'
 
   .-CMDSCOPE(' ')------------. (6)
>--+--------------------------+--------------------------------->
   |                     (5)  |
   +-CMDSCOPE(qmgr-name)------+
   |             (5)          |
   '-CMDSCOPE(*)--------------'
 
   .-TYPE(QUEUE)-----------------------.
>--+-----------------------------------+------------------------>
   |              .-OPENTYPE(ALL)----. |
   '-TYPE(HANDLE)-+------------------+-'
                  +-OPENTYPE(INPUT)--+
                  '-OPENTYPE(OUTPUT)-'
 
>--+------------------+--+-------------------+-----------------><
   '-| queue status |-'  '-| handle status |-'
 
Queue status
 
|--+----------------------+-------------------------------------|
   | .-,----------------. |
   | V                  | |
   '---+-CURDEPTH-----+-+-'
       +-IPPROCS------+
       +-OPPROCS------+
       |         (6)  |
       +-QSGDISP------+
       '-UNCOM--------'
 
Handle status
 
|--+----------------------+-------------------------------------|
   | .-,----------------. |
   | V                  | |
   '---+-APPLTAG------+-+-'
       +-APPLTYPE-----+
       |      (6)     |
       +-ASID---------+
       +-BROWSE-------+
       |         (1)  |
       +-CHANNEL------+
       |         (1)  |
       +-CONNAME------+
       +-INPUT--------+
       +-INQUIRE------+
       +-OUTPUT-------+
       |     (7)      |
       +-PID----------+
       |         (2)  |
       +-PSBNAME------+
       |       (2)    |
       +-PSTID--------+
       |         (6)  |
       +-QSGDISP------+
       +-SET----------+
       |        (3)   |
       +-TASKNO-------+
       |     (7)      |
       +-TID----------+
       |         (3)  |
       +-TRANSID------+
       |      (4)     |
       +-URID---------+
       '-USERID-------'
 
 
Notes:

Channel initiator only
IMS only
CICS only
RRSBATCH only
Valid only on full function WebSphere MQ for z/OS when the queue manager is a member of a queue-sharing group.
Valid on z/OS only.
Not valid on Compaq NSK or z/OS.

Parameter descriptions

You must specify the name of the queue for which you want to display status information. This can be a specific queue name or a generic queue name. By using a generic queue name you can display either:

Status information for all queues, or
Status information for one or more queues that match the specified name and other selection criteria

You must also specify whether you want status information about:

Queues
Handles that are accessing the queues

Note:

You cannot use the DISPLAY QSTATUS command to display the status of an alias queue or remote queue. If you specify the name of one of these types of queue, no data is returned. You can, however, specify the name of the local queue or transmission queue to which the alias queue or remote queue resolves.

(generic-qname)

The name of the queue for which status information is to be displayed. A trailing asterisk (*) matches all queues with the specified stem followed by zero or more characters. An asterisk (*) on its own matches all queues. The queues must all be defined to the local queue manager or queue-sharing group.

ALL

Display all the status information for each specified queue.
This is the default if you do not specify a generic name, and do not request any specific parameters.

CMDSCOPE

This parameter specifies how the command is executed when the queue manager is a member of a queue-sharing group. It is valid on z/OS only.

' '

The command is executed on the queue manager on which it was entered. This is the default value.

qmgr-name

The command is executed on the queue manager you specify, providing the queue manager is active within the queue-sharing group.
You can specify a queue manager name, other than the queue manager on which the command was entered, only if you are using a queue-sharing group environment and if the command server is enabled.

*

The command is executed on the local queue manager and is also passed to every active queue manager in the queue-sharing group. The effect of this is the same as entering the command on every queue manager in the queue-sharing group.

OPENTYPE

Restricts the queues selected to those that have handles with the specified type of access:

ALL

Selects queues that are open with any type of access. This is the default if the OPENTYPE parameter is not specified.

INPUT

Selects queues that are open for input only. This option does not select queues that are open for browse.

OUTPUT

Selects queues that are open only for output.

The OPENTYPE parameter is valid only if TYPE(HANDLE) is also specified.

TYPE

Specifies the type of status information required:

QUEUE

Status information relating to queues is displayed. This is the default if the TYPE parameter is not specified.

HANDLE

Status information relating to the handles that are accessing the queues is displayed.

Queue status

For queue status, the following information is always returned for each queue that satisfies the selection criteria, except where indicated:

Queue name
Type of information returned (TYPE parameter)
Current queue depth (CURDEPTH parameter)
Queue-sharing group disposition (QSGDISP parameter) - only if there is a queue-sharing group environment. (z/OS only)

The following parameters can be specified for TYPE(QUEUE) to request additional information for each queue. If a parameter is specified that is not relevant for the queue, operating environment, or type of status information requested, that parameter is ignored.

CURDEPTH

The current depth of the queue, that is, the number of messages on the queue. This includes both committed messages and uncommitted messages.

IPPROCS

The number of handles that are currently open for input for the queue (either input-shared or input-exclusive). This does not include handles that are open for browse.
For shared queues, the number returned applies only to the queue manager generating the reply. The number is not the total for all the queue managers in the queue-sharing group.

OPPROCS

Number of handles that are currently open for output for the queue.
For shared queues, the number returned applies only to the queue manager generating the reply. The number is not the total for all the queue managers in the queue-sharing group.

QSGDISP

Indicates the disposition of the queue. The value displayed is one of the following:

QMGR

The object was defined with QSGDISP(QMGR).

COPY

The object was defined with QSGDISP(COPY).

SHARED

The object was defined with QSGDISP(SHARED).

This parameter is valid on z/OS only.
This parameter is returned if requested, or if there is a queue-sharing group environment.
For shared queues, if the CF structure used by the queue is unavailable or has failed, the status information might be unreliable.

UNCOM

Indicates whether there are any uncommitted changes (puts and gets) pending for the queue. The value displayed is one of the following:

YES

There are uncommitted changes pending.

NO

There are no uncommitted changes pending.

For shared queues, the value returned applies only to the queue manager generating the reply. The value does not apply to all the queue managers in the queue-sharing group.

Handle status

For handle status, the following information is always returned for each queue that satisfies the selection criteria, except where indicated:

Queue name
Type of information returned (TYPE parameter)
User identifier (USERID parameter) -not returned for APPLTYPE(SYSTEM)
Process ID (PID parameter)
Thread ID (TID parameter)
Application tag (APPLTAG parameter)
Application type (APPLTYPE parameter)
Whether handle is providing input access (INPUT parameter)
Whether handle is providing output access (OUTPUT parameter)
Whether handle is providing browse access (BROWSE parameter)
Whether handle is providing inquire access (INQUIRE parameter)
Whether handle is providing set access (SET parameter)

The following parameters can be specified for TYPE(HANDLE) to request additional information for each queue. If a parameter that is not relevant is specified for the queue, operating environment, or type of status information requested, that parameter is ignored.

APPLTAG

A string containing the tag of the application connected to the queue manager. It is one of the following:

z/OS batch job name
TSO USERID
CICS APPLID
IMS region name
Channel initiator job name
OS/400 job name
UNIX process
Windows process

Application name represents the name of the process or job that has connected to the queue manager. In the instance that this process or job is connected via a channel, the application name represents the remote process or job rather than the local channel process or job name.

APPLTYPE

A string indicating the type of the application that is connected to the queue manager. It is one of the following:

BATCH

Application using a batch connection

RRSBATCH

RRS-coordinated application using a batch connection

CICS

CICS transaction

IMS

IMS transaction

CHINIT

Channel initiator

SYSTEM

Queue manager

USER

A user application

ASID

A 4-character address-space identifier of the application identified by APPLTAG. It distinguishes duplicate values of APPLTAG.
This parameter is returned only when the queue manager owning the queue is running on z/OS, and the APPLTYPE parameter does not have the value SYSTEM.

BROWSE

Indicates whether the handle is providing browse access to the queue. The value is one of the following:

YES

The handle is providing browse access.

NO

The handle is not providing browse access.

CHANNEL

The name of the channel that owns the handle. If there is no channel associated with the handle, this parameter is blank.
This parameter is returned only when the handle belongs to the channel initiator.

CONNAME

The connection name associated with the channel that owns the handle. If there is no channel associated with the handle, this parameter is blank.
This parameter is returned only when the handle belongs to the channel initiator.

INPUT

Indicates whether the handle is providing input access to the queue. The value is one of the following:

SHARED

The handle is providing shared-input access.

EXCL

The handle is providing exclusive-input access.

NO

The handle is not providing input access.

INQUIRE

Indicates whether the handle is providing inquire access to the queue. The value is one of the following:

YES

The handle is providing inquire access.

NO

The handle is not providing inquire access.

OUTPUT

Indicates whether the handle is providing output access to the queue. The value is one of the following:

YES

The handle is providing output access.

NO

The handle is not providing output access.

PID

Number specifying the process identifier of the application that has opened the specified queue.
This parameter is not valid on Compaq NSK and z/OS.

PSBNAME

The 8-character name of the program specification block (PSB) associated with the running IMS transaction. You can use the PSBNAME and PSTID to purge the transaction using IMS commands. It is valid on z/OS only.
This parameter is returned only when the APPLTYPE parameter has the value IMS.

PSTID

The 4-character IMS program specification table (PST) region identifier for the connected IMS region. It is valid on z/OS only.
This parameter is returned only when the APPLTYPE parameter has the value IMS.

QSGDISP

Indicates the disposition of the queue. It is valid on z/OS only. The value is one of the following:

QMGR

The object was defined with QSGDISP(QMGR).

COPY

The object was defined with QSGDISP(COPY).

SHARED

The object was defined with QSGDISP(SHARED).

This parameter is returned if requested, or if there is a queue-sharing group environment.

SET

Indicates whether the handle is providing set access to the queue. The value is one of the following:

YES

The handle is providing set access.

NO

The handle is not providing set access.

TASKNO

A 7-digit CICS task number. This number can be used in the CICS command "CEMT SET TASK(taskno) PURGE" to end the CICS task. This parameter is valid on z/OS only.
This parameter is returned only when the APPLTYPE parameter has the value CICS.

TID

Number specifying the thread identifier within the application process that has opened the specified queue.
This parameter is not valid on Compaq NSK and z/OS.

TRANSID

A 4-character CICS transaction identifier. This parameter is valid on z/OS only.
This parameter is returned only when the APPLTYPE parameter has the value CICS.

URID

The 32-character hexadecimal form of the 16-byte RRS unit-of-recovery identifier associated with the handle. This parameter is valid on z/OS only.
This parameter is returned only when the APPLTYPE parameter has the value RRSBATCH.

USERID

The user identifier associated with the handle.
This parameter is not returned when APPLTYPE has the value SYSTEM.

WebSphere is a trademark of the IBM Corporation in the United States, other countries, or both.

IBM is a trademark of the IBM Corporation in the United States, other countries, or both.