Parameter descriptions

Home
Parameter descriptions

The parameter descriptions also apply to the ALTER QUEUE commands, with the following exceptions:

The FORCE parameter applies only to the ALTER QUEUE commands.
The LIKE parameter applies only to the DEFINE QUEUE commands.
The REPLACE and NOREPLACE parameter applies only to the DEFINE QUEUE commands.

Table 1 shows the parameters that are relevant for each type of queue. There is a description of each parameter after the table.

DEFINE and ALTER QUEUE parameters
Local queue Model queue Alias queue Remote queue
ACCTQ X X
BOQNAME X X
BOTHRESH X X
CFSTRUCT X X
CLUSNL X X X
CLUSTER X X X
CLWLPRTY X X X
CLWLRANK X X X
CLWLUSEQ X
CMDSCOPE X X X X
DEFBIND X X X
DEFPRTY X X X X
DEFPSIST X X X X
DEFSOPT X X
DEFTYPE X X
DESCR X X X X
DISTL X X
FORCE X X X
GET X X X
HARDENBO or NOHARDENBO X X
INDXTYPE X X
INITQ X X
LIKE X X X X
MAXDEPTH X X
MAXMSGL X X
MONQ X X
MSGDLVSQ X X
NOREPLACE X X X X
NPMCLASS X X
PROCESS X X
PUT X X X X
q-name X X X X
QDEPTHHI X X
QDEPTHLO X X
QDPHIEV X X
QDPLOEV X X
QDPMAXEV X X
QSGDISP X X X X
QSVCIEV X X
QSVCINT X X
REPLACE X X X X
RETINTVL X X
RNAME X
RQMNAME X
SCOPE X X X
SHARE or NOSHARE X X
STATQ X X
STGCLASS X X
TARGQ X
TRIGDATA X X
TRIGDPTH X X
TRIGGER or NOTRIGGER X X
TRIGMPRI X X
TRIGTYPE X X
USAGE X X
XMITQ X
(q-name)

Local name of the queue, except the remote queue where it is the local definition of the remote queue. This is required.
The name must not be the same as any other queue name (of whatever queue type) currently defined on this queue manager (unless REPLACE or ALTER is specified). See Rules for naming WebSphere MQ objects.

ACCTQ

Specifies whether accounting data collection is to be enabled for the queue. On z/OS, the data collected is class 3 accounting data (thread-level and queue-level accounting). In order for accounting data to be collected for this queue, accounting data for this connection must also be enabled by either the ACCTQ queue manager attribute or the options field in the MQCNO structure on the MQCONNX call.

QMGR

The collection of accounting data is based on the setting of the ACCTQ parameter on the queue manager definition.

ON

Accounting data collection is enabled for the queue unless the ACCTQ queue manager parameter has a value of NONE. On z/OS systems, we need to have switched on class 3 accounting by the START TRACE command.

OFF

Accounting data collection is disabled for the queue.

BOQNAME(string)

The excessive backout requeue name.
This parameter is supported only on local and model queues.
Use this parameter to set or change the value of the BackoutRequeueQName attribute of a local or model queue. Apart from allowing its value to be queried, the queue manager takes no action based on the value of this attribute. However, the Application Server Facilities (ASF) of WebSphere MQ classes for Java Message Service (WebSphere MQ JMS) use the attribute to determine where to transfer a message that has already been backed out the maximum number of times as specified by the BackoutThreshold attribute.

BOTHRESH(integer)

The backout threshold.
This parameter is supported only on local and model queues.
Use this parameter to set or change the value of the BackoutThreshold attribute of a local or model queue. Apart from allowing its value to be queried, the queue manager takes no action based on the value of this attribute. However, the Application Server Facilities (ASF) of WebSphere MQ classes for Java Message Service (WebSphere MQ JMS) use the attribute to determine how many times to allow a message to be backed out before transferring the message to the queue specified by the BackoutRequeueQName attribute.
Specify a value in the range zero through 999 999 999.

CFSTRUCT(structure-name)

Specifies the name of the Coupling Facility structure where you want messages stored when you use shared queues.
This parameter is supported only on z/OS for local and model queues.
The name:

Cannot have more than 12 characters
Must start with an uppercase letter (A through Z)
Can include only the characters A through Z and 0 through 9

The name of the queue-sharing group to which the queue manager is connected is prefixed to the name you supply. The name of the queue-sharing group is always four characters, padded with @ symbols if necessary. For example, if you use a queue-sharing group named NY03 and you supply the name PRODUCT7, the resultant Coupling Facility structure name is NY03PRODUCT7. Note that the administrative structure for the queue-sharing group (in this case NY03CSQ_ADMIN) cannot be used for storing messages.
For ALTER QLOCAL, ALTER QMODEL, DEFINE QLOCAL with REPLACE, and DEFINE QMODEL with REPLACE the following rules apply:

On a local queue with QSGDISP(SHARED), CFSTRUCT cannot change.
If we need to change either the CFSTRUCT or QSGDISP value delete and redefine the queue. To preserve any of the messages on the queue off-load the messages before you delete the queue and reload the messages after you have redefined the queue, or move the messages to another queue.
On a model queue with DEFTYPE(SHAREDYN), CFSTRUCT cannot be blank.
On a local queue with a QSGDISP other than SHARED, or a model queue with a DEFTYPE other than SHAREDYN, the value of CFSTRUCT does not matter.

For DEFINE QLOCAL with NOREPLACE and DEFINE QMODEL with NOREPLACE, the Coupling Facility structure:

On a local queue with QSGDISP(SHARED) or a model queue with a DEFTYPE(SHAREDYN), CFSTRUCT cannot be blank.
On a local queue with a QSGDISP other than SHARED, or a model queue with a DEFTYPE other than SHAREDYN, the value of CFSTRUCT does not matter.

Before we can use the queue, the structure must be defined in the Coupling Facility Resource Management (CFRM) policy data set.

CLUSNL(nlname)

The name of the namelist that specifies a list of clusters to which the queue belongs.
This parameter is supported only on alias, local, and remote queues.
Changes to this parameter do not affect instances of the queue that are already open.
Only one of the resultant values of CLUSTER or CLUSNL can be nonblank; we cannot specify a value for both.
On local queues, this parameter cannot be set for transmission, SYSTEM.CHANNEL.xx, SYSTEM.CLUSTER.xx, or SYSTEM.COMMAND.xx queues, and on z/OS only, for SYSTEM.QSG.xx queues.
This parameter is valid only on AIX, HP OpenVMS, HP-UX, Linux, Solaris, Windows, and z/OS.

CLUSTER(clustername)

The name of the cluster to which the queue belongs.
This parameter is supported only on alias, local, and remote queues.
The maximum length is 48 characters conforming to the rules for naming WebSphere MQ objects. Changes to this parameter do not affect instances of the queue that are already open.
Only one of the resultant values of CLUSNL or CLUSTER can be nonblank; we cannot specify a value for both.
On local queues, this parameter cannot be set for transmission, SYSTEM.CHANNEL.xx, SYSTEM.CLUSTER.xx, or SYSTEM.COMMAND.xx queues, and on z/OS only, for SYSTEM.QSG.xx queues.
This parameter is valid only on AIX, HP OpenVMS, HP-UX, Linux, i5/OS, Solaris, Windows, and z/OS.

CLWLPRTY(integer)

Specifies the priority of the queue for the purposes of cluster workload distribution. This parameter is valid only for local, remote, and alias queues. The value must be in the range zero through 9 where zero is the lowest priority and 9 is the highest. For more information about this attribute, see WebSphere MQ Queue Manager Clusters.

CLWLRANK(integer)

Specifies the rank of the queue for the purposes of cluster workload distribution. This parameter is valid only for local, remote, and alias queues. The value must be in the range zero through 9 where zero is the lowest rank and 9 is the highest. For more information about this attribute, see WebSphere MQ Queue Manager Clusters.

CLWLUSEQ

Specifies the behavior of an MQPUT operation when the target queue has a local instance and at least one remote cluster instance (except where the MQPUT originates from a cluster channel). This parameter is valid only for local queues.

QMGR

The behavior will be as specified by the CLWLUSEQ parameter of the queue manager definition.

ANY

The queue manager is to treat the local queue as another instance of the cluster queue for the purposes of workload distribution.

LOCAL

The local queue is the only target of the MQPUT operation.

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

DEFBIND

Specifies the binding to be used when the application specifies MQOO_BIND_AS_Q_DEF on the MQOPEN call, and the queue is a cluster queue.

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 particular instance of the cluster queue. This allows the queue manager to select a specific queue instance when the message is put using MQPUT, and to change that selection subsequently should the need arise.

The MQPUT1 call always behaves as if NOTFIXED had been specified.
This parameter is valid only on AIX, HP OpenVMS, HP-UX, Linux, i5/OS, Solaris, Windows, and z/OS.

DEFPRTY(integer)

The default priority of messages put on the queue. The value must be in the range zero, (the lowest priority) through to the MAXPRTY queue manager parameter. (MAXPRTY is 9.)

DEFPSIST

Specifies the message persistence to be used when applications specify the MQPER_PERSISTENCE_AS_Q_DEF option.

NO

Messages on this queue are lost across a restart of the queue manager. This is the default supplied with WebSphere MQ, but your installation might have changed it.

YES

Messages on this queue survive a restart of the queue manager.

On z/OS, N and Y are accepted as synonyms of NO and YES.

DEFSOPT

The default share option for applications opening this queue for input:

EXCL

The open request is for exclusive input from the queue

SHARED

The open request is for shared input from the queue

DEFTYPE

Queue definition type.
This parameter is supported only on model queues.

PERMDYN

A permanent dynamic queue is created when an application issues an MQOPEN MQI call with the name of this model queue specified in the object descriptor (MQOD).
On z/OS, the dynamic queue has a disposition of QMGR.

SHAREDYN

This option is available on z/OS only.
A permanent dynamic queue is created when an application issues an MQOPEN API call with the name of this model queue specified in the object descriptor (MQOD).
The dynamic queue has a disposition of SHARED.

TEMPDYN

A temporary dynamic queue is created when an application issues an MQOPEN API call with the name of this model queue specified in the object descriptor (MQOD).
On z/OS, the dynamic queue has a disposition of QMGR.
Do not specify this value for a model queue definition with a DEFPSIST parameter of YES.
If you specify this option, do not specify INDXTYPE(MSGTOKEN).

DESCR(string)

Plain-text comment. It provides descriptive information about the object when an operator issues the DISPLAY QUEUE command.
It should contain only displayable characters. The maximum length is 64 characters. In a DBCS installation, it can contain DBCS characters (subject to a maximum length of 64 bytes).
If characters are used that are not in the coded character set identifier (CCSID) for this queue manager, they might be translated incorrectly if the information is sent to another queue manager.

DISTL

Whether distribution lists are supported by the partner queue manager.

YES

Distribution lists are supported by the partner queue manager.

NO

Distribution lists are not supported by the partner queue manager.

You should not normally change this parameter, because it is set by the MCA. However we can set this parameter when defining a transmission queue if the distribution list capability of the destination queue manager is known.
This parameter is valid only on AIX, HP OpenVMS, HP-UX, Linux, i5/OS, Solaris, and Windows.

FORCE

This parameter applies only to the ALTER command on alias, local and remote queues.
Specify this parameter to force completion of the command in the following circumstances.
For an alias queue, if both of the following are true:

The TARGQ parameter is specified
An application has this alias queue open

For a local queue, if both of the following are true:

The NOSHARE parameter is specified
One or more applications have the queue open for input

FORCE is also needed if both of the following are true:

The USAGE parameter is changed
Either one or more messages are on the queue, or one or more applications have the queue open

Do not change the USAGE parameter while there are messages on the queue; the format of messages changes when they are put on a transmission queue.
For a remote queue if both of the following are true:

The XMITQ parameter is changed
One or more applications has this queue open as a remote queue

FORCE is also needed if both of the following are true:

Any of the RNAME, RQMNAME, or XMITQ parameters are changed
One or more applications has a queue open that resolved through this definition as a queue manager alias

FORCE is not required if this definition is in use as a reply-to queue alias only.
If FORCE is not specified in the circumstances described, the command is unsuccessful.

GET

Whether applications are to be permitted to get messages from this queue:

ENABLED

Messages can be retrieved from the queue (by suitably authorized applications).

DISABLED

Applications cannot retrieve messages from the queue.

This parameter can also be changed using the MQSET API call.

HARDENBO and NOHARDENBO

Whether hardening should be used to ensure that the count of the number of times that a message has been backed out is accurate.
This parameter is supported only on local and model queues.

HARDENBO

The count is hardened.

NOHARDENBO

The count is not hardened.

On 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

The type of index maintained by the queue manager to expedite MQGET operations on the queue. For shared queues, the type of index determines the type of MQGET operations that can be used.
This parameter is supported only on local and model queues.
Messages can be retrieved using a selection criterion only if an appropriate index type is maintained, as the following table shows:

Retrieval selection criterion Index type required
Shared queue Other queue
None (sequential retrieval) Any Any
Message identifier MSGID or NONE Any
Correlation identifier CORRELID Any
Message and correlation identifiers MSGID or CORRELID Any
Group identifier GROUPID Any
Grouping GROUPID GROUPID
Message token Not allowed MSGTOKEN

where the value of INDXTYPE parameter has the following values:

NONE

No index is maintained. Use this when messages are usually retrieved sequentially or use both the message identifier and the correlation identifier as a selection criterion on the MQGET call.

MSGID

An index of message identifiers is maintained. Use this when messages are usually retrieved using the message identifier as a selection criterion on the MQGET call with the correlation identifier set to NULL.

CORRELID

An index of correlation identifiers is maintained. Use this when messages are usually retrieved using the correlation identifier as a selection criterion on the MQGET call with the message identifier set to NULL.

GROUPID

An index of group identifiers is maintained. Use this when messages need to be retrieved using message grouping selection criteria.

We cannot set INDXTYPE to GROUPID if the queue is a transmission queue.
We can only specify a shared queue with INDXTYPE(GROUPID) if the queue uses a CF structure at CFLEVEL(3).

MSGTOKEN

An index of message tokens is maintained. Use this when the queue is a WLM-managed queue that you are using with the Workload Manager functions of z/OS.
We cannot set INDXTYPE to MSGTOKEN if:

The queue is a model queue with a definition type of SHAREDYN
The queue is a temporary dynamic queue
The queue is a transmission queue
You specify QSGDISP(SHARED)

For queues that are not shared and do not use grouping or message tokens, the index type does not restrict the type of retrieval selection. However, the index is used to expedite GET operations on the queue, so choose the type that corresponds to the most common retrieval selection.
If you are altering or replacing an existing local queue, we can change the INDXTYPE parameter only in the cases indicated in the following table:

Queue type NON-SHARED SHARED
Queue state Uncommitted activity No uncommitted activity, messages present No uncommitted activity, and empty Open or messages present Not open, and empty
Change INDXTYPE from: To: Change allowed?
NONE MSGID No Yes Yes No Yes
NONE CORRELID No Yes Yes No Yes
NONE MSGTOKEN No No Yes - -
NONE GROUPID No No Yes No Yes
MSGID NONE No Yes Yes No Yes
MSGID CORRELID No Yes Yes No Yes
MSGID MSGTOKEN No No Yes - -
MSGID GROUPID No No Yes No Yes
CORRELID NONE No Yes Yes No Yes
CORRELID MSGID No Yes Yes No Yes
CORRELID MSGTOKEN No No Yes - -
CORRELID GROUPID No No Yes No Yes
MSGTOKEN NONE No Yes Yes - -
MSGTOKEN MSGID No Yes Yes - -
MSGTOKEN CORRELID No Yes Yes - -
MSGTOKEN GROUPID No No Yes - -
GROUPID NONE No No Yes No Yes
GROUPID MSGID No No Yes No Yes
GROUPID CORRELID No No Yes No Yes
GROUPID MSGTOKEN No No Yes - -

This parameter is supported only on z/OS. On other platforms, retrieval optimization might be provided, but it is not controlled by a queue parameter.

INITQ(string)

The local name of a local queue (known as the initiation queue) on this queue manager, to which trigger messages relating to this queue are written. See Rules for naming WebSphere MQ objects.
This parameter is supported only on local and model queues.

LIKE(qtype-name)
The name of a queue, whose parameters will be used to model this definition.
This parameter applies only to the appropriate DEFINE Queue command.
If this field is not filled in, and you do not complete the parameter fields related to the command, the values are taken from one of the following, depending upon the queue type:

SYSTEM.DEFAULT.ALIAS.QUEUE Alias queue
SYSTEM.DEFAULT.LOCAL.QUEUE Local queue
SYSTEM.DEFAULT.MODEL.QUEUE Model queue
SYSTEM.DEFAULT.REMOTE.QUEUE Remote queue

This is equivalent to defining the following object:
LIKE(SYSTEM.DEFAULT.ALIAS.QUEUE)
for an alias queue, and similarly for other queue types.
These default queue definitions can be altered by the installation to the default values required.
On z/OS, the queue manager searches for an object with the name and queue type you specify with a disposition of QMGR, COPY, or SHARED. The disposition of the LIKE object is not copied to the object you are defining.

QSGDISP (GROUP) objects are not searched.
LIKE is ignored if QSGDISP(COPY) is specified.
MAXDEPTH(integer)

The maximum number of messages allowed on the queue.
This parameter is supported only on local and model queues.
On AIX, HP OpenVMS, HP-UX, Linux, i5/OS, Solaris, Windows, and z/OS, specify a value in the range zero through 999 999 999.
On any other WebSphere MQ platform, specify a value in the range zero through 640 000.
Other factors can still cause the queue to be treated as full, for example, if there is no further DASD space available.
If this value is reduced, any messages that are already on the queue that exceed the new maximum remain intact.

MAXMSGL(integer)

The maximum length (in bytes) of messages on this queue.
This parameter is supported only on local and model queues.
On AIX, HP OpenVMS, HP-UX, Linux, i5/OS, Solaris, and Windows, specify a value in the range zero through to the maximum message length for the queue manager. See the MAXMSGL parameter of the ALTER QMGR command for more information.
On z/OS, specify a value in the range zero through 100 MB (104 857 600 bytes).
On other platforms, specify a value in the range zero through 4 MB (4 194 304 bytes).
For a transmission queue, this value includes the space required for headers. It is recommended that the value should be at least 4000 bytes larger than the maximum expected length of user data in any message that could be put on a transmission queue.
If this value is reduced, any messages that are already on the queue whose length exceeds the new maximum are not affected.
Applications can use this parameter to determine the size of buffer they need to retrieve messages from the queue. Therefore, the value should only be reduced if it is known that this will not cause an application to operate incorrectly.

MONQ

Controls the collection of online monitoring data for queues.
This parameter is supported only on local and model queues.

QMGR

Collect monitoring data according to the setting of the queue manager parameter MONQ. This is the default value.

OFF

Online monitoring data collection is turned off for this queue.

LOW

If the value of the queue manager's MONQ parameter is not NONE, online monitoring data collection is turned on, with a low rate of data collection, for this queue.

MEDIUM

If the value of the queue manager's MONQ parameter is not NONE, online monitoring data collection is turned on, with a moderate rate of data collection, for this queue.

HIGH

If the value of the queue manager's MONQ parameter is not NONE, online monitoring data collection is turned on, with a high rate of data collection, for this queue.

MSGDLVSQ

Message delivery sequence.
This parameter is supported only on local and model queues.

PRIORITY

Messages are delivered (in response to MQGET API calls) in first-in-first-out (FIFO) order within priority.

FIFO

Messages are delivered (in response to MQGET API calls) in FIFO order. Priority is ignored for messages on this queue.

If the message delivery sequence is changed from PRIORITY to FIFO while there are messages on the queue, the order of the messages already on the queue is not changed. Messages added to the queue subsequently take the default priority of the queue, and so might be processed before some of the existing messages.
If the message delivery sequence is changed from FIFO to PRIORITY, the messages put on the queue while the queue was set to FIFO take the default priority.
If INDXTYPE(GROUPID) is specified with MSGDLVSQ(PRIORITY), the priority in which groups are retrieved is based on the priority of the first message within each group. The priorities zero and one are used by the queue manager to optimize the retrieval of messages in logical order, thus the first message in each group should not use these priorities. If it does, the message is stored as if it was priority two.

NPMCLASS

The level of reliability to be assigned to non-persistent messages that are put to the queue:

NORMAL

Non-persistent messages are lost after a failure, or queue manager shutdown. These messages are discarded on a queue manager restart.

HIGH

The queue manager attempts to retain non-persistent messages on this queue over a queue manager restart.

We cannot set this parameter on z/OS.

PROCESS(string)

The local name of the WebSphere MQ process.
This parameter is supported only on local and model queues.
This is the name of a process instance that identifies the application started by the queue manager when a trigger event occurs. See Rules for naming WebSphere MQ objects.
The process does not have to be defined when the local queue is defined, but it must be available for a trigger event to occur.
If the queue is a transmission queue, the process definition contains the name of the channel to be started. This parameter is optional for transmission queues on AIX, HP OpenVMS, HP-UX, Linux, i5/OS, Solaris, Windows, and z/OS; if you do not specify it, the channel name is taken from the value specified for the TRIGDATA parameter.

PUT

Whether messages can be put on the queue.

ENABLED

Messages can be added to the queue (by suitably authorized applications).

DISABLED

Messages cannot be added to the queue.

This parameter can also be changed using the MQSET API call.

QDEPTHHI(integer)

The threshold against which the queue depth is compared to generate a Queue Depth High event.
This parameter is supported only on local and model queues. For more information about the effect that shared queues on z/OS have on this event, see the WebSphere MQ Monitoring book.
This event indicates that an application has put a message on a queue, and this has caused the number of messages on the queue to become greater than or equal to the queue depth high threshold. See the QDPHIEV parameter.
The value is expressed as a percentage of the maximum queue depth (MAXDEPTH parameter), and must be greater than or equal to zero, and less than or equal to 100.

QDEPTHLO(integer)

The threshold against which the queue depth is compared to generate a Queue Depth Low event.
This parameter is supported only on local and model queues. For more information about the effect that shared queues on z/OS have on this event, see the WebSphere MQ Monitoring book.
This event indicates that an application has retrieved a message from a queue, and this has caused the number of messages on the queue to become less than or equal to the queue depth low threshold. See the QDPLOEV parameter.
The value is expressed as a percentage of the maximum queue depth (MAXDEPTH parameter), and must be in the range zero through 100.

QDPHIEV

Controls whether Queue Depth High events are generated.
This parameter is supported only on local and model queues.
A Queue Depth High event indicates that an application has put a message on a queue, and this has caused the number of messages on the queue to become greater than or equal to the queue depth high threshold (see the QDEPTHHI parameter).
The value of this parameter can change implicitly. For more information on this, and the effect that shared queues on z/OS have on this event, see the description of the Queue Depth High event in the WebSphere MQ Monitoring book.

ENABLED

Queue Depth High events are generated

DISABLED

Queue Depth High events are not generated

QDPLOEV

Controls whether Queue Depth Low events are generated.
This parameter is supported only on local and model queues.
A Queue Depth Low event indicates that an application has retrieved a message from a queue, and this has caused the number of messages on the queue to become less than or equal to the queue depth low threshold (see the QDEPTHLO parameter).
The value of this parameter can change implicitly. For more information on this, and the effect that shared queues on z/OS have on this event, see the description of the Queue Depth Low event in the WebSphere MQ Monitoring book.

ENABLED

Queue Depth Low events are generated

DISABLED

Queue Depth Low events are not generated

QDPMAXEV

Controls whether Queue Full events are generated.
This parameter is supported only on local and model queues.
A Queue Full event indicates that a put to a queue has been rejected because the queue is full, that is, the queue depth has already reached its maximum value.
The value of this parameter can change implicitly. For more information on this, and the effect that shared queues on z/OS have on this event, see the description of the Queue Full event in the WebSphere MQ Monitoring book.

ENABLED

Queue Full events are generated

DISABLED

Queue Full events are not generated

QSGDISP
This parameter applies to z/OS only.
Specifies the disposition of the object within the group.
QSGDISP ALTER DEFINE
COPY The object definition resides on the page set of the queue manager that executes the command. The object was defined using a command that had the parameters QSGDISP(COPY). Any object residing in the shared repository, or any object defined using a command that had the parameters QSGDISP(QMGR), is not affected by this command. The object is defined on the page set of the queue manager that executes the command using the QSGDISP(GROUP) object of the same name as the ‘LIKE’ object.
For local queues, messages are stored on the page sets of each queue manager and are available only through that queue manager.
GROUP
The object definition resides in the shared repository. The object was defined using a command that had the parameters QSGDISP(GROUP). Any object residing on the page set of the queue manager that executes the command (except a local copy of the object), or any object defined using a command that had the parameters QSGDISP(SHARED), is not affected by this command. If the command is successful, the following command is generated and sent to all active queue managers in the queue-sharing group to attempt to refresh local copies on page set zero:
DEFINE QUEUE(q-name)
REPLACE QSGDISP(COPY)
The ALTER for the group object takes effect regardless of whether the generated command with QSGDISP(COPY) fails.
The object definition resides in the shared repository. This is allowed only if there is a shared queue manager environment. If the definition is successful, the following command is generated and sent to all active queue managers to attempt to make or refresh local copies on page set zero:
DEFINE QUEUE(q-name)
REPLACE QSGDISP(COPY)
The DEFINE for the group object takes effect regardless of whether the generated command with QSGDISP(COPY) fails.
PRIVATE The object resides on the page set of the queue manager that executes the command, and was defined with QSGDISP(QMGR) or QSGDISP(COPY). Any object residing in the shared repository is unaffected. Not permitted.
QMGR The object definition resides on the page set of the queue manager that executes the command. The object was defined using a command that had the parameters QSGDISP(QMGR). Any object residing in the shared repository, or any local copy of such an object, is not affected by this command. This is the default value. The object is defined on the page set of the queue manager that executes the command. This is the default value. For local queues, messages are stored on the page sets of each queue manager and are available only through that queue manager.
SHARED This value applies only to local queues. The object definition resides in the shared repository. The object was defined using a command that had the parameters QSGDISP(SHARED). Any object residing on the page set of the queue manager that executes the command, or any object defined using a command that had the parameters QSGDISP(GROUP), is not affected by this command. If the queue is clustered, a command is generated and sent to all active queue managers in the queue-sharing group to notify them of this clustered, shared queue. This option applies only to local queues. The object is defined in the shared repository. Messages are stored in the Coupling Facility and are available to any queue manager in the queue-sharing group. We can specify SHARED only if:

CFSTRUCT is nonblank
INDXTYPE is not MSGTOKEN
The queue is not one of the following:

SYSTEM.CHANNEL.INITQ
SYSTEM.COMMAND.INPUT

If the queue is clustered, a command is generated and sent to all active queue managers in the queue-sharing group to notify them of this clustered, shared queue.
QSVCIEV

Controls whether Service Interval High or Service Interval OK events are generated.
This parameter is supported only on local and model queues and has no effect if it is specified on a shared queue.
A Service Interval High event is generated when a check indicates that no messages have been retrieved from the queue for at least the time indicated by the QSVCINT parameter.
A Service Interval OK event is generated when a check indicates that messages have been retrieved from the queue within the time indicated by the QSVCINT parameter.
The value of this parameter can change implicitly. For more information, see the description of the Service Interval High and Service Interval OK events in the WebSphere MQ Monitoring book.

HIGH

Service Interval High events are generated

OK

Service Interval OK events are generated

NONE

No service interval events are generated

QSVCINT(integer)

The service interval used for comparison to generate Service Interval High and Service Interval OK events.
This parameter is supported only on local and model queues and has no effect if it is specified on a shared queue.
See the QSVCIEV parameter.
The value is in units of milliseconds, and must bein the range zero through 999 999 999.

REPLACE and NOREPLACE

This option controls whether any existing definition (and on WebSphere MQ for z/OS of the same disposition) is to be replaced with this one. Any object with a different disposition is not changed. The default is NOREPLACE.

REPLACE

If the object does exist, the effect is similar to issuing the ALTER command without the FORCE option and with all the other parameters specified. In particular, note that any messages that are on the existing queue are retained.
This parameter applies only to the DEFINE Queue command.
(The difference between the ALTER command without the FORCE option, and the DEFINE command with the REPLACE option, is that ALTER does not change unspecified parameters, but DEFINE with REPLACE sets all the parameters. When you use REPLACE, unspecified parameters are taken either from the object named on the LIKE option, or from the default definition, and the parameters of the object being replaced, if one exists, are ignored.)
The command fails if both of the following are true:

The command sets parameters that would require the use of the FORCE option if you were using the ALTER command
The object is open

The ALTER command with the FORCE option succeeds in this situation.
If SCOPE(CELL) is specified on HP OpenVMS, UNIX systems, or Windows, and there is already a queue with the same name in the cell directory, the command fails, whether or not REPLACE is specified.

NOREPLACE

The definition should not replace any existing definition of the object.

RETINTVL(integer)

The number of hours from the queue creation date and time (the date and time at which the queue was defined), after which the queue is no longer needed. The value must be in the range zero through 999 999 999.
This parameter is supported only on local and model queues.
The CRDATE and CRTIME can be displayed using the DISPLAY QUEUE command.
This information is available for use by an operator or a housekeeping application to delete queues that are no longer required.
The queue manager does not delete queues based on this value, nor does it prevent queues from being deleted if their retention interval has not expired. It is the user’s responsibility to take any required action.

RNAME(string)

Name of remote queue. This is the local name of the queue as defined on the queue manager specified by RQMNAME.
This parameter is supported only on remote queues.

If this definition is used for a local definition of a remote queue, RNAME must not be blank when the open occurs.
If this definition is used for a queue manager alias definition, RNAME must be blank when the open occurs.
In a queue manager cluster, this definition applies only to the queue manager that made it. To advertise the alias to the whole cluster, add the CLUSTER attribute to the remote queue definition.
If this definition is used for a reply-to alias, this name is the name of the queue that is to be the reply-to queue.
The name is not checked to ensure that it contains only those characters normally allowed for queue names (see Rules for naming WebSphere MQ objects).

RQMNAME(string)

The name of the remote queue manager on which the queue RNAME is defined.
This parameter is supported only on remote queues.

If an application opens the local definition of a remote queue, RQMNAME must not be blank or the name of the local queue manager. When the open occurs, if XMITQ is blank there must be a local queue of this name, which is to be used as the transmission queue.
If this definition is used for a queue manager alias, RQMNAME is the name of the queue manager that is being aliased. It can be the name of the local queue manager. Otherwise, if XMITQ is blank, when the open occurs there must be a local queue of this name, which is to be used as the transmission queue.
If this definition is used for a reply-to alias, this name is the name of the queue manager that is to be the reply-to queue manager.
The name is not checked to ensure that it contains only those characters normally allowed for WebSphere MQ object names (see Rules for naming WebSphere MQ objects).

SCOPE

Specifies the scope of the queue definition.
This parameter is supported only on alias, local, and remote queues.

QMGR

The queue definition has queue manager scope. This means that the definition of the queue does not extend beyond the queue manager that owns it. To open the queue for output from some other queue manager, either the name of the owning queue manager must be specified, or the other queue manager must have a local definition of the queue.

CELL

The queue definition has cell scope. This means that the queue is known to all the queue managers in the cell, and can be opened for output merely by specifying the name of the queue; the name of the queue manager that owns the queue need not be specified.
If there is already a queue with the same name in the cell directory, the command fails. The REPLACE option has no effect on this.
This value is valid only if a name service supporting a cell directory has been configured (note that the DCE name service is no longer supported).

This parameter is valid only on HP OpenVMS, UNIX systems, and Windows.

SHARE and NOSHARE

Whether multiple applications can get messages from this queue.
This parameter is supported only on local and model queues.

SHARE

More than one application instance can get messages from the queue

NOSHARE

A single application instance only can get messages from the queue

STATQ

Whether statistics data collection is enabled:

QMGR

Statistics data collection is based on the setting of the queue manager's STATQ parameter.

ON

If the value of the queue manager's STATQ parameter is not NONE, statistics data collection for the queue is enabled.

OFF

Statistics data collection for the queue is disabled.

This parameter is valid only on i5/OS, UNIX systems, and Windows.

STGCLASS(string)

The name of the storage class.
This parameter is supported only on local and model queues.
This is an installation-defined name.
This parameter is valid on z/OS only. For more information, see the z/OS Concepts and Planning Guide.
The first character of the name must be uppercase A through Z, and subsequent characters either uppercase A through Z or numeric 0 through 9.
We can change this parameter only if the queue is empty and closed.
If you specify QSGDISP(SHARED) or DEFTYPE(SHAREDYN), this parameter is ignored.

TARGQ(string)

The local name of the base queue being aliased. (See Rules for naming WebSphere MQ objects.) The maximum length is 48 characters.
This parameter is supported only on alias queues.
This must be one of the following (although this is not checked until the alias queue is opened by an application):

A local queue (not a model queue)
A local definition of a remote queue

This queue need not be defined until an application process opens the alias queue.

TRIGDATA(string)

The data that is inserted in the trigger message. The maximum length of the string is 64 bytes.
This parameter is supported only on local and model queues.
For a transmission queue on AIX, Compaq NonStop Kernel, HP OpenVMS, HP-UX, Linux, i5/OS, Solaris, Windows, or z/OS, we can use this parameter to specify the name of the channel to be started.
This parameter can also be changed using the MQSET API call.

TRIGDPTH(integer)

The number of messages that have to be on the queue before a trigger message is written, if TRIGTYPE is DEPTH. The value must be in the range 1 through 999 999 999.
This parameter is supported only on local and model queues.
This parameter can also be changed using the MQSET API call.

TRIGGER and NOTRIGGER

Whether trigger messages are written to the initiation queue (named by the INITQ parameter) to trigger the application (named by the PROCESS parameter):

TRIGGER

Triggering is active, and trigger messages are written to the initiation queue.

NOTRIGGER

Triggering is not active, and trigger messages are not written to the initiation queue.
This parameter is supported only on local and model queues.

This parameter can also be changed using the MQSET API call.

TRIGMPRI(integer)

The message priority number that triggers this queue. The value must be in the range zero through to the MAXPRTY queue manager parameter (see DISPLAY QMGR for details).
This parameter can also be changed using the MQSET API call.

TRIGTYPE

Whether and under what conditions a trigger message is written to the initiation queue (named by the INITQ parameter).
This parameter is supported only on local and model queues.

FIRST

Whenever the first message of priority equal to or greater than that specified by the TRIGMPRI parameter of the queue arrives on the queue.

EVERY

Every time a message arrives on the queue with priority equal to or greater than that specified by the TRIGMPRI parameter of the queue.

DEPTH

When the number of messages with priority equal to or greater than that specified by TRIGMPRI is equal to the number indicated by the TRIGDPTH parameter.

NONE

No trigger messages are written.

This parameter can also be changed using the MQSET API call.

USAGE

Queue usage.
This parameter is supported only on local and model queues.

NORMAL

The queue is not a transmission queue.

XMITQ

The queue is a transmission queue, which is used to hold messages that are destined for a remote queue manager. When an application puts a message to a remote queue, the message is stored on the appropriate transmission queue whilst awaiting transmission to the remote queue manager.
If you specify this option, do not specify values for CLUSTER and CLUSNL and do not specify INDXTYPE(MSGTOKEN) or INDXTYPE(GROUPID).

XMITQ(string)

The name of the transmission queue to be used for forwarding messages to the remote queue, for either a remote queue or for a queue manager alias definition.
This parameter is supported only on remote queues.
If XMITQ is blank, a queue with the same name as RQMNAME is used as the transmission queue.
This parameter is ignored if the definition is being used as a queue manager alias and RQMNAME is the name of the local queue manager.
It is also ignored if the definition is used as a reply-to queue alias definition.
Parent topic:
DEFINE queues

sc11240_

Home

	Local queue	Model queue	Alias queue	Remote queue
ACCTQ	X	X
BOQNAME	X	X
BOTHRESH	X	X
CFSTRUCT	X	X
CLUSNL	X		X	X
CLUSTER	X		X	X
CLWLPRTY	X		X	X
CLWLRANK	X		X	X
CLWLUSEQ	X
CMDSCOPE	X	X	X	X
DEFBIND	X		X	X
DEFPRTY	X	X	X	X
DEFPSIST	X	X	X	X
DEFSOPT	X	X
DEFTYPE	X	X
DESCR	X	X	X	X
DISTL	X	X
FORCE	X		X	X
GET	X	X	X
HARDENBO or NOHARDENBO	X	X
INDXTYPE	X	X
INITQ	X	X
LIKE	X	X	X	X
MAXDEPTH	X	X
MAXMSGL	X	X
MONQ	X	X
MSGDLVSQ	X	X
NOREPLACE	X	X	X	X
NPMCLASS	X	X
PROCESS	X	X
PUT	X	X	X	X
q-name	X	X	X	X
QDEPTHHI	X	X
QDEPTHLO	X	X
QDPHIEV	X	X
QDPLOEV	X	X
QDPMAXEV	X	X
QSGDISP	X	X	X	X
QSVCIEV	X	X
QSVCINT	X	X
REPLACE	X	X	X	X
RETINTVL	X	X
RNAME				X
RQMNAME				X
SCOPE	X		X	X
SHARE or NOSHARE	X	X
STATQ	X	X
STGCLASS	X	X
TARGQ			X
TRIGDATA	X	X
TRIGDPTH	X	X
TRIGGER or NOTRIGGER	X	X
TRIGMPRI	X	X
TRIGTYPE	X	X
USAGE	X	X
XMITQ				X

Retrieval selection criterion	Index type required
	Shared queue	Other queue
None (sequential retrieval)	Any	Any
Message identifier	MSGID or NONE	Any
Correlation identifier	CORRELID	Any
Message and correlation identifiers	MSGID or CORRELID	Any
Group identifier	GROUPID	Any
Grouping	GROUPID	GROUPID
Message token	Not allowed	MSGTOKEN

Queue type		NON-SHARED			SHARED
Queue state		Uncommitted activity	No uncommitted activity, messages present	No uncommitted activity, and empty	Open or messages present	Not open, and empty
Change INDXTYPE from:	To:	Change allowed?
NONE	MSGID	No	Yes	Yes	No	Yes
NONE	CORRELID	No	Yes	Yes	No	Yes
NONE	MSGTOKEN	No	No	Yes	-	-
NONE	GROUPID	No	No	Yes	No	Yes
MSGID	NONE	No	Yes	Yes	No	Yes
MSGID	CORRELID	No	Yes	Yes	No	Yes
MSGID	MSGTOKEN	No	No	Yes	-	-
MSGID	GROUPID	No	No	Yes	No	Yes
CORRELID	NONE	No	Yes	Yes	No	Yes
CORRELID	MSGID	No	Yes	Yes	No	Yes
CORRELID	MSGTOKEN	No	No	Yes	-	-
CORRELID	GROUPID	No	No	Yes	No	Yes
MSGTOKEN	NONE	No	Yes	Yes	-	-
MSGTOKEN	MSGID	No	Yes	Yes	-	-
MSGTOKEN	CORRELID	No	Yes	Yes	-	-
MSGTOKEN	GROUPID	No	No	Yes	-	-
GROUPID	NONE	No	No	Yes	No	Yes
GROUPID	MSGID	No	No	Yes	No	Yes
GROUPID	CORRELID	No	No	Yes	No	Yes
GROUPID	MSGTOKEN	No	No	Yes	-	-

SYSTEM.DEFAULT.ALIAS.QUEUE	Alias queue
SYSTEM.DEFAULT.LOCAL.QUEUE	Local queue
SYSTEM.DEFAULT.MODEL.QUEUE	Model queue
SYSTEM.DEFAULT.REMOTE.QUEUE	Remote queue

QSGDISP	ALTER	DEFINE
COPY	The object definition resides on the page set of the queue manager that executes the command. The object was defined using a command that had the parameters QSGDISP(COPY). Any object residing in the shared repository, or any object defined using a command that had the parameters QSGDISP(QMGR), is not affected by this command.	The object is defined on the page set of the queue manager that executes the command using the QSGDISP(GROUP) object of the same name as the ‘LIKE’ object. For local queues, messages are stored on the page sets of each queue manager and are available only through that queue manager.
GROUP	The object definition resides in the shared repository. The object was defined using a command that had the parameters QSGDISP(GROUP). Any object residing on the page set of the queue manager that executes the command (except a local copy of the object), or any object defined using a command that had the parameters QSGDISP(SHARED), is not affected by this command. If the command is successful, the following command is generated and sent to all active queue managers in the queue-sharing group to attempt to refresh local copies on page set zero: DEFINE QUEUE(q-name) REPLACE QSGDISP(COPY) The ALTER for the group object takes effect regardless of whether the generated command with QSGDISP(COPY) fails.	The object definition resides in the shared repository. This is allowed only if there is a shared queue manager environment. If the definition is successful, the following command is generated and sent to all active queue managers to attempt to make or refresh local copies on page set zero: DEFINE QUEUE(q-name) REPLACE QSGDISP(COPY) The DEFINE for the group object takes effect regardless of whether the generated command with QSGDISP(COPY) fails.
PRIVATE	The object resides on the page set of the queue manager that executes the command, and was defined with QSGDISP(QMGR) or QSGDISP(COPY). Any object residing in the shared repository is unaffected.	Not permitted.
QMGR	The object definition resides on the page set of the queue manager that executes the command. The object was defined using a command that had the parameters QSGDISP(QMGR). Any object residing in the shared repository, or any local copy of such an object, is not affected by this command. This is the default value.	The object is defined on the page set of the queue manager that executes the command. This is the default value. For local queues, messages are stored on the page sets of each queue manager and are available only through that queue manager.
SHARED	This value applies only to local queues. The object definition resides in the shared repository. The object was defined using a command that had the parameters QSGDISP(SHARED). Any object residing on the page set of the queue manager that executes the command, or any object defined using a command that had the parameters QSGDISP(GROUP), is not affected by this command. If the queue is clustered, a command is generated and sent to all active queue managers in the queue-sharing group to notify them of this clustered, shared queue.	This option applies only to local queues. The object is defined in the shared repository. Messages are stored in the Coupling Facility and are available to any queue manager in the queue-sharing group. We can specify SHARED only if: CFSTRUCT is nonblank INDXTYPE is not MSGTOKEN The queue is not one of the following: SYSTEM.CHANNEL.INITQ SYSTEM.COMMAND.INPUT If the queue is clustered, a command is generated and sent to all active queue managers in the queue-sharing group to notify them of this clustered, shared queue.