DISPLAY QUEUE

Use DISPLAY QUEUE to display the attributes of one or more queues of any type.

  • DISPLAY QALIAS
  • DISPLAY QCLUSTER
  • DISPLAY QLOCAL
  • DISPLAY QMODEL
  • DISPLAY QREMOTE

Note that DISPLAY QUEUE might not show every clustered queue in the cluster when issued on a partial repository, because the partial repository only knows about a queue once it has tried to use it.

Synonym: DIS Q 

DISPLAY QUEUE
 
>>-DISPLAY QUEUE(generic-qname)--+-----+------------------------>
                                 '-ALL-'
 
                                   (2)
>--+-----------------------------+-------+---------------+------>
   '-CFSTRUCT-+----------------+-'       |          (1)  |
              '-(generic-name)-'         '-CLUSINFO------'
 
>--+--------------------------------+--------------------------->
   '-CLUSNL-+---------------------+-'
            |                (1)  |
            '-(generic-name)------'
 
>--+---------------------------------+-------------------------->
   '-CLUSTER-+---------------------+-'
             |                (1)  |
             '-(generic-name)------'
 
   .-CMDSCOPE(' ')------------. (2)
>--+--------------------------+--------------------------------->
   |                     (5)  |
   +-CMDSCOPE(qmgr-name)------+
   |             (5)          |
   '-CMDSCOPE(*)--------------'
 
>--+--------------------------+--------------------------------->
   |                     (2)  |
   '-PSID(-+-integer-+-)------'
           '- *------'
 
                   (5)
   .-QSGDISP(LIVE)--------. (2)
>--+----------------------+------------------------------------->
   +-QSGDISP(ALL)---------+
   +-QSGDISP(QMGR)--------+
   +-QSGDISP(COPY)--------+
   |                (5)   |
   +-QSGDISP(GROUP)-------+
   +-QSGDISP(PRIVATE)-----+
   |                 (5)  |
   '-QSGDISP(SHARED)------'
 
>--+----------------------------------+--+------------------+--->
   '-STGCLASS-+---------------------+-'  '-TYPE(queue-type)-'
              |                (2)  |
              '-(generic-name)------'
 
>--+---------------------+-------------------------------------><
   '-| requested attrs |-'
 
Requested attrs
 
|--+-----------------------+------------------------------------|
   | .-,-----------------. |
   | V           (1)     | |
   '---+-ALTDATE-------+-+-'
       |         (1)   |
       +-ALTTIME-------+
       +-BOQNAME-------+
       +-BOTHRESH------+
       |          (1)  |
       +-CLUSDATE------+
       |          (1)  |
       +-CLUSQMGR------+
       |        (1)    |
       +-CLUSQT--------+
       |          (1)  |
       +-CLUSTIME------+
       +-CRDATE--------+
       +-CRTIME--------+
       +-CURDEPTH------+
       |         (1)   |
       +-DEFBIND-------+
       +-DEFPRTY-------+
       +-DEFPSIST------+
       +-DEFSOPT-------+
       +-DEFTYPE-------+
       +-DESCR---------+
       |       (3)     |
       +-DISTL---------+
       +-GET-----------+
       +-HARDENBO------+
       |          (2)  |
       +-INDXTYPE------+
       +-INITQ---------+
       +-IPPROCS-------+
       +-MAXDEPTH------+
       +-MAXMSGL-------+
       +-MSGDLVSQ------+
       +-OPPROCS-------+
       +-PROCESS-------+
       +-PUT-----------+
       +-QDEPTHHI------+
       +-QDEPTHLO------+
       +-QDPHIEV-------+
       +-QDPLOEV-------+
       +-QDPMAXEV------+
       |      (1)      |
       +-QMID----------+
       +-QSVCIEV-------+
       +-QSVCINT-------+
       +-QTYPE---------+
       +-RETINTVL------+
       +-RNAME---------+
       +-RQMNAME-------+
       |       (4)     |
       +-SCOPE---------+
       +-SHARE---------+
       +-TARGQ---------+
       +-TRIGDATA------+
       +-TRIGDPTH------+
       +-TRIGGER-------+
       +-TRIGMPRI------+
       +-TRIGTYPE------+
       +-USAGE---------+
       '-XMITQ---------'

Notes:

  1. Valid only on AIX, Compaq OpenVMS, HP-UX, Linux, OS/2 Warp, OS/400, Solaris, Windows, and z/OS.

  2. Valid only on z/OS.

  3. Valid only on AIX, Compaq OpenVMS, , HP-UX, Linux, OS/2 Warp, OS/400, Solaris, and Windows.

  4. Not valid on z/OS or OS/400.

  5. Valid only on full function WebSphere MQ for z/OS when the queue manager is a member of a queue-sharing group.

 

Parameter descriptions

You must specify the name of the queue definition you want to display. This can be a specific queue name or a generic queue name. By using a generic queue name, you can display either:

  • All queue definitions

  • One or more queues that match the specified name

(generic-q-name)
The local name of the queue definition to be displayed (see Rules for naming WebSphere MQ objects). A trailing asterisk (*) matches all queues with the specified stem followed by zero or more characters. An asterisk (*) on its own specifies all queues. The names must all be defined to the local queue manager.

ALL
Specify this to display all the attributes. If this parameter is specified, any attributes that are also requested specifically have no effect; all attributes are still displayed.

On AIX, Compaq OpenVMS, HP-UX, Linux, OS/2 Warp, OS/400, Solaris, Windows, and z/OS, this is the default if you do not specify a generic name and do not request any specific attributes.

CFSTRUCT(generic-name)
This parameter is optional and limits the information displayed to those queues where the value of the coupling facility structure is specified in brackets.

The value can be a generic name. If you do not enter a value for this parameter, CFSTRUCT is treated as a requested parameter.

CLUSINFO
This requests that, in addition to information about attributes of queues defined on this queue manager, information about these and other queues in the cluster that match the selection criteria is displayed. In this case, there might be multiple queues with the same name displayed. The cluster information is obtained from the repository on this queue manager.

This parameter is valid only on AIX, Compaq OpenVMS, HP-UX, Linux, OS/2 Warp, OS/400, Solaris, Windows, and z/OS.

CLUSNL(generic-name)
This is optional, and limits the information displayed if entered with a value in brackets:

  • For queues defined on the local queue manager, only those with the specified cluster list. The value can be a generic name. Only queue types for which CLUSNL is a valid parameter are restricted in this way; other queue types that meet the other selection criteria are displayed.

  • For cluster queues, only those belonging to clusters in the specified cluster list if the value is not a generic name. If the value is a generic name, no restriction is applied to cluster queues.

If you do not enter a value to qualify this parameter, it is treated as a requested parameter, and cluster list information is returned about all the queues displayed.

This parameter is valid only on AIX, Compaq OpenVMS, HP-UX, Linux, OS/2 Warp, OS/400, Solaris, Windows, and z/OS.

Note:
If the disposition requested is SHARED, CMDSCOPE must be blank or the local queue manager.

CLUSTER(generic-name)
This is optional, and limits the information displayed to queues with the specified cluster name if entered with a value in brackets. The value can be a generic name. Only queue types for which CLUSTER is a valid parameter are restricted in this way by this parameter; other queue types that meet the other selection criteria are displayed.

If you do not enter a value to qualify this parameter, it is treated as a requested parameter, and cluster name information is returned about all the queues displayed.

This parameter is valid only on AIX, Compaq OpenVMS, HP-UX, Linux, OS/2 Warp, OS/400, Solaris, Windows, and z/OS.

CMDSCOPE
This parameter applies to z/OS only and specifies how the command is executed when the queue manager is a member of a queue-sharing group.

CMDSCOPE must be blank, or the local queue manager, if QSGDISP is set to GROUP or SHARED.

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

PSID(integer)
The identifier of the page set where a queue resides. This is optional. Specifying a value limits the information displayed to queues that have an active association to the specified page set. The value consists of two numeric characters, in the range 00 through 99. An asterisk (*) on its own specifies all page set identifiers. If you do not enter a value, page set information is returned about all the queues displayed.

The page set identifier is displayed only if there is an active association of the queue to a page set, that is, after the queue has been the target of an MQPUT request. The association of a queue to a page set is not active when:

  • the queue has just been defined

  • the queue's STGCLASS attribute has been changed, and there has been no subsequent MQPUT request to the queue

  • the queue manager has been restarted and there are no messages on the queue

This parameter is valid only on z/OS.

QSGDISP
Specifies the disposition of the objects for which information is to be displayed. Values are:

LIVE
This is the default value and displays information for objects defined with QSGDISP(QMGR) or QSGDISP(COPY). If there is a shared queue manager environment, and the command is being executed on the queue manager where it was issued, also display information for objects defined with QSGDISP(SHARED).

ALL
Display information for objects defined with QSGDISP(QMGR) or QSGDISP(COPY).

If there is a shared queue manager environment, and the command is being executed on the queue manager where it was issued, this option also displays information for objects defined with QSGDISP(GROUP) or QSGDISP(SHARED).

In a shared queue manager environment, use 

   DISPLAY QUEUE(name) CMDSCOPE(*) QSGDISP(ALL)

to list ALL objects matching 

name

in the queue-sharing group without duplicating those in the shared repository.

COPY
Display information only for objects defined with QSGDISP(COPY).

GROUP
Display information only for objects defined with QSGDISP(GROUP). This is allowed only if there is a shared queue manager environment.

PRIVATE
Display information only for objects defined with QSGDISP(QMGR) or QSGDISP(COPY).

QMGR
Display information only for objects defined with QSGDISP(QMGR).

SHARED
Display information only for objects defined with QSGDISP(SHARED). This is allowed only in a shared queue manager environment.

Note:
For cluster queues, this is always treated as a requested parameter. The value returned is the disposition of the real queue that the cluster queue represents.

If QSGDISP(LIVE) is specified or defaulted, or if QSGDISP(ALL) is specified in a shared queue manager environment, the command might give duplicated names (with different dispositions) .

Note:
In the QSGDISP(LIVE) case, this occurs only where a shared and a non-shared queue have the same name; such a situation should not occur in a well-managed system.

QSGDISP displays one of the following values if it is specified, or if there is a shared queue manager environment:

QMGR
The object was defined with QSGDISP(QMGR).

GROUP
The object was defined with QSGDISP(GROUP).

COPY
The object was defined with QSGDISP(COPY).

SHARED
The object was defined with QSGDISP(SHARED).

STGCLASS(generic-name)
This is optional, and limits the information displayed to queues with the storage class specified if entered with a value in brackets. The value can be a generic name.

If you do not enter a value to qualify this parameter, it is treated as a requested parameter, and storage class information is returned about all the queues displayed.

This parameter is valid only on z/OS.

TYPE(queue-type)
This is optional, and specifies the type of queues you want to be displayed. The default is to display all queue types; this includes cluster queues if CLUSINFO is also specified.

You can specify any of the queue types allowed for a DEFINE command (QLOCAL, QALIAS, QREMOTE, or their synonyms). A queue type of QCLUSTER can be specified to display only cluster queue information on AIX, Compaq OpenVMS, HP-UX, Linux, OS/2 Warp, OS/400, Solaris, Windows, and z/OS.

If QCLUSTER is specified, any selection criteria specified by the CFSTRUCT, STGCLASS, or PSID parameters are ignored.

On AIX, Compaq OpenVMS, HP-UX, Linux, OS/2 Warp, OS/400, Solaris, and Windows, QTYPE(type) can be used as a synonym for this parameter.

If no parameters are specified (and the ALL parameter is not specified or defaulted), the queue name and queue type are displayed.

 

Requested parameters

Specify one or more parameters that define the data to be displayed. The parameters can be specified in any order, but do not specify the same parameter more than once.

Most parameters are relevant only for queues of a particular type or types. Parameters that are not relevant for a particular type of queue cause no output, nor is an error raised.

ALTDATE
The date on which the definition or information was last altered, in the form yyyy-mm-dd.

ALTTIME
The time at which the definition or information was last altered, in the form hh.mm.ss.

BOQNAME
Backout requeue name.

BOTHRESH
Backout threshold.

CLUSDATE
The date on which the definition became available to the local queue manager, in the form yyyy-mm-dd.

CLUSNL
The namelist that defies the cluster that the queue is in.

CLUSQMGR
The name of the queue manager that hosts the queue.

CLUSQT
Cluster queue type. This can be:

QALIAS
The cluster queue represents an alias queue.

QLOCAL
The cluster queue represents a local queue.

QMGR
The cluster queue represents a queue manager alias.

QREMOTE
The cluster queue represents a remote queue.

CLUSTER
The name of the cluster that the queue is in.

CLUSTIME
The time at which the definition became available to the local queue manager, in the form hh.mm.ss.

CRDATE
The date on which the queue was defined (in the form yyyy-mm-dd).

CRTIME
The time at which the queue was defined (in the form hh.mm.ss).

CURDEPTH
Current depth of queue.

On z/OS, CURDEPTH is returned as zero for queues defined with a disposition of GROUP. It is also returned as zero for queues defined with a disposition of SHARED if the CF structure that they use is unavailable or has failed.

DEFBIND
Default message binding.

DEFPRTY
Default priority of the messages put on the queue.

DEFPSIST
Whether the default persistence of messages put on this queue is set to NO or YES. NO means that messages are lost across a restart of the queue manager.

DEFSOPT
Default share option on a queue opened for input.

DEFTYPE
Queue definition type. This can be:

  • PREDEFINED (Predefined)

    The queue was created with a DEFINE command, either by an operator or by a suitably authorized application sending a command message to the service queue.

  • PERMDYN (Permanent dynamic)

    Either the queue was created by an application issuing MQOPEN with the name of a model queue specified in the object descriptor (MQOD), or (if this is a model queue) this determines the type of dynamic queue that can be created from it.

    On z/OS the queue was created with QSGDISP(QMGR).

  • TEMPDYN (Temporary dynamic)

    Either the queue was created by an application issuing MQOPEN with the name of a model queue specified in the object descriptor (MQOD), or (if this is a model queue) this determines the type of dynamic queue that can be created from it.

    On z/OS the queue was created with QSGDISP(QMGR).

  • SHAREDYN

    A permanent dynamic queue was created when an application issued an MQOPEN API call with the name of this model queue specified in the object descriptor (MQOD).

    On z/OS, in a queue-sharing group environment, the queue was created with QSGDISP(SHARED).

DESCR
Descriptive comment.

DISTL
Whether distribution lists are supported by the partner queue manager. (Supported only on AIX, Compaq OpenVMS, HP-UX, Linux, OS/2 Warp, OS/400, Solaris, and Windows.)

GET
Whether the queue is enabled for gets.

HARDENBO
Whether to harden the get back out count.

Note:
On MQSeries for Compaq NonStop Kernel, this parameter is ignored. The backout count of a message is always hardened for persistent messages, and never hardened for non-persistent messages.

INDXTYPE
Index type (supported only on z/OS).

INITQ
Initiation queue name.

IPPROCS
Number of handles indicating that the queue is open for input.

On z/OS, IPPROCS is returned as zero for queues defined with a disposition of GROUP. With a disposition of SHARED, only the handles for the queue manager sending back the information are returned, not the information for the whole group.

MAXDEPTH
Maximum depth of queue.

MAXMSGL
Maximum message length.

MSGDLVSQ
Message delivery sequence.

OPPROCS
Number of handles indicating that the queue is open for output.

On z/OS, OPPROCS is returned as zero for queues defined with a disposition of GROUP. With a disposition of SHARED, only the handles for the queue manager sending back the information are returned, not the information for the whole group.

PROCESS
Process name.

PUT
Whether the queue is enabled for puts.

QDEPTHHI
Queue Depth High event generation threshold.

QDEPTHLO
Queue Depth Low event generation threshold.

QDPHIEV
Whether Queue Depth High events are generated.

QDPLOEV
Whether Queue Depth Low events are generated.

QDPMAXEV
Whether Queue Full events are generated.

QMID
The internally generated unique name of the queue manager that hosts the queue.

QSVCIEV
Whether service interval events are generated.

QSVCINT
Service interval event generation threshold.

QTYPE
Queue type.

On AIX, Compaq OpenVMS, HP-UX, Linux, OS/2 Warp, OS/400, Solaris, and Windows, the queue type is always displayed if you specify a generic queue name and do not request any other parameters. On z/OS, the queue type is always displayed.

On AIX, Compaq OpenVMS, HP-UX, Linux, OS/2 Warp, OS/400, Solaris, and Windows, TYPE(type) can be used as a synonym for this parameter.

RETINTVL
Retention interval.

RNAME
Name of the local queue, as known by the remote queue manager.

RQMNAME
Remote queue manager name.

SCOPE
Scope of queue definition (not supported on z/OS).

SHARE
Whether the queue can be shared.

STGCLASS
Storage class.

TARGQ
Local name of aliased queue.

TRIGDATA
Trigger data.

TRIGDPTH
Trigger depth.

TRIGGER
Whether triggers are active.

TRIGMPRI
Threshold message priority for triggers.

TRIGTYPE
Trigger type.

USAGE
Whether or not the queue is a transmission queue.

XMITQ
Transmission queue name.

 

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.