[IBM i]

Work with MQ Queues (WRKMQMQ)

Where allowed to run
All environments (*ALL)
Threadsafe
Yes

The Work with MQ Queues (WRKMQMQ) command provides the function to work with multiple queues that are defined on the local queue manager. Using this command you can copy, change, display, delete, display authority and edit authority of an MQ Queue object.

Parameters

Table 1. Command parameters
Keyword Description Choices Notes
QNAME Queue name Character value, *ALL Optional, Positional 1
QTYPE Queue type *ALL, *ALS, *LCL, *MDL, *RMT Optional, Positional 2
MQMNAME Message Queue Manager name Character value, *DFT Optional, Positional 3
CLUSTER Cluster name Character value, *ALL Optional, Positional 4
CLUSNL Cluster namelist name Character value, *ALL Optional, Positional 5
WHERE Filter command Single values: *NONE Other values: Element list Optional, Positional 6
Element 1: Filter keyword *ACCTQ, *ALTDATE, *ALTTIME, *BKTTHLD, *BKTQNAME, *CLUSDATE, *CLUSNL, *CLUSQMGR, *CLUSQTYPE, *CLUSTER, *CLUSTIME, *CLWLPRTY, *CLWLRANK, *CLWLUSEQ, *CRDATE, *CRTIME, *CURDEPTH, *DEFBIND, *DFTPUTRESP, *DFNTYPE, *DFTMSGPST, *DFTPTY, *DFTSHARE, *DISTLIST, *FULLEVT, *GETDATE, *GETENBL, *GETTIME, *HDNBKTCNT, *HIGHEVT, *HIGHTHLD, *INITQNAME, *IPPROCS, *JOBS, *LOWEVT, *LOWTHLD, *MAXDEPTH, *MAXMSGLEN, *MEDIAREC, *MONQ, *MSGAGE, *MSGDLYSEQ, *MSGREADAHD, *NPMCLASS, *OPPROCS, *PRCNAME, *PROPCTL, *PUTDATE, *PUTENBL, *PUTTIME, *QMID, *QTYPE, *RMTMQMNAME, *RMTQNAME, *RTNITV, *SHARE, *SRVEVT, *SRVITV, *STATQ, *TARGTYPE, *TEXT, *TGTQNAME, *TMQNAME, *TRGDATA, *TRGDEPTH, *TRGENBL, *TRGMSGPTY, *TRGTYPE, *UNCOM, *USAGE
Element 2: Filter operator *GT, *LT, *EQ, *NE, *GE, *LE, *LK, *NL, *CT, *EX, *CTG, *EXG
Element 3: Filter value Character value

Queue name (QNAME)

The name or names of the queues to be selected. The queues selected by this parameter can be further limited to a particular type, if the QTYPE keyword is specified.

The possible values are:

*ALL
All queues are selected.
generic-queue-name
Specify the generic name of the queues to be selected. A generic name is a character string, followed by an asterisk (*). For example ABC*, it selects all queues having names that start with the character string.

Specify the name required within quotation marks. Using this format ensures that your selection is precisely what you entered.

You cannot select all the uppercase and lowercase versions of a generic name on a single panel, without requesting all the names.

queue-name
Specify the name of the queue.

Queue type (QTYPE)

This parameter can be specified to limit the queues that are displayed to a particular type.

The possible values are:

*ALL
All queue types.
*ALS
Alias queues.
*LCL
Local queues.
*MDL
Model queues.
*RMT
Remote queues.

Message Queue Manager name (MQMNAME)

Specifies the name of the message queue manager.

The possible values are:

*DFT
Use the default queue manager.
queue-manager-name
Specify the name of the queue manager.

Cluster name (CLUSTER)

This parameter can be specified to limit the queues that are displayed to be members of a particular cluster.

The possible values are:

*ALL
All clusters.
generic-cluster-name
The generic name of a cluster.
cluster-name
The name of a cluster.

Cluster namelist name (CLUSNL)

This parameter can be specified to limit the queues that are displayed to be members of clusters within a cluster namelist.

The possible values are:

*ALL
All cluster namelists.
generic-cluster-namelist-name
The generic name of a cluster namelist.
cluster-namelist-name
The name of a cluster namelist.

Filter command (WHERE)

This parameter can be used to selectively display only those queues with particular queue attributes.

The parameter takes three arguments, a keyword, an operator, and a value.

Generic strings are allowed for values which are names.

The operator can take one of the following values:

*GT
Greater than.

Applicable to integer and non-generic string values.

*LT
Less than.

Applicable to integer and non-generic string values

*EQ
Equal to.

Applicable to integer and non-generic string values.

*NE
Not equal to.

Applicable to integer and non-generic string values.

*GE
Greater than or equal to.

Applicable to integer and non-generic string values.

*LE
Less than or equal to.

Applicable to integer and non-generic string values.

*LK
Like.

Applicable to generic string values.

*NL
Not like.

Applicable to generic string values.

*CT
Contains.

Applicable to non-generic list values.

*EX
Excludes.

Applicable to non-generic list values.

*CTG
Contains generic.

Applicable to generic list values.

*EXG
Excludes generic.

Applicable to generic list values.

The keyword can take one of the following values:

*ACCTQ
Queue Accounting.

The filter value is one of the following values:

*QMGR
Accounting data collection is based upon the setting of the queue manager attribute ACCTQ.
*OFF
Accounting data collection for this queue is disabled.
*ON
Accounting data collection is enabled for this queue.
*ALTDATE
The date on which the definition or information was last altered.

The filter value is the data in the form yyyy-mm-dd.

*ALTTIME
The time at which the definition or information was last altered.

The filter value is the time in the form hh:mm:ss.

*BKTTHLD
Backout threshold.

The filter value is the integer threshold value.

*BKTQNAME
Backout requeue name.

The filter value is the name of the queue.

*CLUSDATE
The date on which the definition became available to the local queue manager.

The filter value is the date in the form yyyy-mm-dd.

*CLUSNL
The namelist that defines the clusters that the queue is in.

The filter value is the name of the namelist.

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

The filter value is the name of the queue manager.

*CLUSQTYPE
Cluster queue type.

The filter value is one of the following values:

*LCL
The cluster queue represents a local queue.
*ALS
The cluster queue represents an alias queue.
*RMT
The cluster queue represents a remote queue.
*MQMALS
The cluster queue represents a queue manager alias.
*CLUSTER
The name of the cluster that the queue is in.

The filter value is the name of the cluster.

*CLUSTIME
The time at which the definition became available to the local queue manager.

The filter value is the time in the form hh:mm:ss.

*CLWLPRTY
Cluster workload priority.

The filter value is the integer priority.

*CLWLRANK
Cluster workload rank.

The filter value is the integer rank.

*CLWLUSEQ
Cluster workload queue use.

The filter value is one of the following values:

*QMGR
The value is inherited from the Queue Manager CLWLUSEQ attribute.
*LOCAL
The local queue is the sole target of the MQPUT.
*ANY
The queue manager treats such a local queue as another instance of the cluster queue for the purposes of workload distribution.
*CRDATE
The date on which the queue was created.

The filter value is the date in the form yyyy-mm-dd.

*CRTIME
The time at which the queue was created.

The filter value is the time in the form hh:mm:ss.

*CURDEPTH
Current depth of queue.

The filter value is the integer depth value.

*DEFBIND
Default message binding.

The filter value is one of the following values:

*OPEN
The queue handle is bound to a specific instance of the cluster queue when the queue is opened.
*NOTFIXED
The queue handle is not bound to any instance of the cluster queue.
*GROUP
When the queue is opened, the queue handle is bound to a specific instance of the cluster queue for as long as there are messages in a message group. All messages in a message group are allocated to the same destination instance.
*DFTPUTRESP
Default Put Response.

The filter value is one of the following values:

*SYNC
The put operation is issued synchronously.
*ASYNC
The put operation is issued asynchronously.
*DFNTYPE
Queue definition type.

The filter value is one of the following values:

*PREDEF
Predefined queue.
*PERMDYN
Permanent dynamic queue.
*TEMPDYN
Temporary dynamic queue.
*DFTMSGPST
Default persistence of the messages put on this queue.

The filter value is one of the following values:

*NO
Messages on this queue are lost across a restart of the queue manager.
*YES
Messages on this queue survive a restart of the queue manager.
*DFTPTY
Default priority of the messages put on the queue.

The filter value is the integer priority value.

*DFTSHARE
Default share option on a queue opened for input.

The filter value is one of the following values:

*NO
The open request is for exclusive input from the queue.
*YES
The open request is for shared input from the queue.
*DISTLIST
Whether distribution lists are supported by the partner queue manager.

The filter value is one of the following values:

*NO
Distribution lists are not supported by the partner queue manager.
*YES
Distribution lists are supported by the partner queue manager.
*FULLEVT
Whether Queue Depth Full events are generated.

The filter value is one of the following values:

*NO
Queue Depth Full events are not generated.
*YES
Queue Depth Full events are generated.
*GETDATE
The date on which the last message was got from the queue since queue manager start. This field is only present when Queue Monitoring is not set to *OFF.

The filter value is the data in the form yyyy-mm-dd.

*GETENBL
Whether applications are permitted to get messages from the queue.

The filter value is one of the following values:

*NO
Applications cannot retrieve messages from the queue.
*YES
Authorized applications can retrieve messages from the queue.
*GETTIME
The time at which the last message was got from the queue since queue manager start. This field is only present when Queue Monitoring is not set to *OFF.

The filter value is the time in the form hh:mm:ss.

*HDNBKTCNT
Whether the backout count is hardened.

The filter value is one of the following values:

*NO
The backout count is not hardened.
*YES
The backout count is hardened.
*HIGHEVT
Whether Queue Depth High events are generated.

The filter value is one of the following values:

*NO
Queue Depth High events are not generated.
*YES
Queue Depth High events are generated.
*HIGHTHLD
Queue Depth High event generation threshold.

The filter value is the integer threshold value.

*INITQNAME
Initiation queue.

The filter value is the name of the queue.

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

The filter value is the integer number of handles.

*JOBS
The current number of jobs that have the queue open.

The filter value is the integer number of jobs.

*LOWEVT
Whether Queue Depth Low events are generated.

The filter value is one of the following values:

*NO
Queue Depth Low events are not generated.
*YES
Queue Depth Low events are generated.
*LOWTHLD
Queue Depth Low event generation threshold.

The filter value is the integer threshold value.

*MAXDEPTH
Maximum depth of queue.

The filter value is the integer number of messages.

*MAXMSGLEN
Maximum message length.

The filter value is the integer message length.

*MEDIAREC
The journal receiver containing the last media recovery image. This field is only present for local queues.

The filter value is the journal receiver string.

*MONQ
Online Monitoring Data.

The filter value is one of the following values:

*QMGR
The collection of Online Monitoring Data is inherited from the setting of the queue manager attribute MONQ.
*OFF
Online Monitoring Data collection for this queue is disabled.
*LOW
Monitoring data collection is turned on with a low ratio of data collection.
*MEDIUM
Monitoring data collection is turned on with a moderate ratio of data collection.
*HIGH
Monitoring data collection is turned on with a high ratio of data collection.
*MSGAGE
The age in seconds of the oldest message on the Queue. This field is only present when Queue Monitoring is not set to *OFF.

The filter value is the integer message age.

*MSGDLYSEQ
Message delivery sequence.

The filter value is one of the following values:

*PTY
Messages are delivered in FIFO order within priority.
*FIFO
Messages are delivered in FIFO order regardless of priority.
*NPMCLASS
Non-persistent message class.

The filter value is one of the following values:

*NORMAL
Non-persistent message class is normal.
*HIGH
Non-persistent message class is high.
*MSGREADAHD
Message read ahead.

The filter value is one of the following values:

*DISABLED
Read ahead is disabled.
*NO
Non-persistent messages are not sent to the client ahead of an application requesting them.
*YES
Non-persistent messages are sent to the client ahead of an application requesting them.
*OPPROCS
Number of handles indicating that the queue is open for output.

The filter value is the integer number of handles.

*PRCNAME
Process name.

The filter value is the name of the process.

*PROPCTL
Message Property Control.

The filter value is one of the following values:

*COMPAT
Compatibility mode
*NONE
No properties are returned to the application.
*ALL
All properties are returned to the application.
*FORCE
Properties are returned to the application in one or more MQRFH2 headers.
*V6COMPAT
An MQRFH2 header is returned formatted as it was sent. Its code page and encoding might be altered. If the message is a publication it might have a psc folder inserted into its contents.
*PUTDATE
The date on which the last message was put to the queue since queue manager start. This field is only present when Queue Monitoring is not set to *OFF.

The filter value is the data in the form yyyy-mm-dd.

*PUTENBL
Whether applications are permitted to put messages to the queue.

The filter value is one of the following values:

*NO
Messages cannot be added to the queue.
*YES
Messages can be added to the queue by authorized applications.
*PUTTIME
The time at which the last message was put to the queue since queue manager start. This field is only present when Queue Monitoring is not set to *OFF.

The filter value is the time in the form hh:mm:ss.

*QMID
Internally generated unique name of the queue manager that hosts the queue.

The filter value is the name of the queue manager.

*QTYPE
Queue type.

The filter value is one of the following values:

*LCL
Local queue.
*ALS
Alias queue.
*RMT
Remote queue.
*MDL
Model queue.
*RMTMQMNAME
Remote queue manager name.

The filter value is the name of the queue manager.

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

The filter value is the name of the queue.

*RTNITV
Retention interval.

The filter value is the integer interval value.

*SHARE
Whether the queue can be shared.

The filter value is one of the following values:

*NO
Only a single application instance can open the queue for input.
*YES
More than one application instance can open the queue for input.
*SRVEVT
Whether service interval events are generated.

The filter value is one of the following values:

*HIGH
Service Interval High events are generated.
*OK
Service Interval OK events are generated.
*NONE
No service interval events are generated.
*SRVITV
Service interval event generation threshold.

The filter value is the integer threshold value.

*STATQ
Statistics data.

The filter value is one of the following values:

*QMGR
Statistics data collection is based upon the setting of the queue manager attribute STATQ.
*OFF
Statistics data collection for this queue is disabled.
*ON
Statistics data collection is enabled for this queue.
*TARGTYPE
Target Type.

The filter value is one of the following values:

*QUEUE
Queue object.
*TOPIC
Topic object.
*TEXT
Descriptive comment.

The filter value is the text description of the queue.

*TGTQNAME
Target queue for which this queue is an alias.

The filter value is the name of the queue.

*TMQNAME
Transmission queue name.

The filter value is the name of the queue.

*TRGDATA
Trigger data.

The filter value is the text of the trigger message.

*TRGDEPTH
Trigger depth.

The filter value is the integer number of messages.

*TRGENBL
Whether triggering is enabled.

The filter value is one of the following values:

*NO
Triggering is not enabled.
*YES
Triggering is enabled.
*TRGMSGPTY
Threshold message priority for triggers.

The filter value is the integer priority value.

*TRGTYPE
Trigger type.

The filter value is one of the following values:

*FIRST
When the number of messages on the queue goes from 0 to 1.
*ALL
Every time a message arrives on the queue.
*DEPTH
When the number of messages on the queue equals the value of the TRGDEPTH attribute.
*NONE
No trigger messages are written.
*UNCOM
The number of uncommitted changes pending for the queue.

The filter value is one of the following values:

*NO
There are no uncommitted changes pending.
*YES
There are uncommitted changes pending.
*USAGE
Whether the queue is a transmission queue.

The filter value is one of the following values:

*NORMAL
The queue is not a transmission queue.
*TMQ
The queue is a transmission queue.