The parameter descriptions also apply to the ALTER QUEUE commands, with the following exceptions:
Table 6 shows the parameters that are relevant for each type of queue. There is a description of each parameter after the table.
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 |
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.
This parameter is supported only on local and model queues.
Apart from maintaining a value for this parameter, the queue manager takes no action based on its value.
This parameter is supported only on local and model queues.
Apart from maintaining a value for this parameter, the queue manager takes no action based on its value.
Specify a value in the range zero through 999 999 999.
This parameter is supported only on z/OS for local and model queues.
The name:
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:
If you need to change either the CFSTRUCT or QSGDISP value you must delete and redefine the queue. To preserve any of the messages on the queue you must 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.
For DEFINE QLOCAL with NOREPLACE and DEFINE QMODEL with NOREPLACE, the Coupling Facility structure:
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; you 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.
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; you 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.
CMDSCOPE must be blank, or the local queue manager, if QSGDISP is set to GROUP or SHARED.
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 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.
On z/OS, N and Y are accepted as synonyms of NO and YES.
This parameter is supported only on model queues.
On z/OS, the dynamic queue has a disposition of QMGR.
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.
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).
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).
This parameter is valid only on AIX, HP OpenVMS, HP-UX, Linux, i5/OS, Solaris, and Windows.
Specify this parameter to force completion of the command in the following circumstances.
For an alias queue, if both of the following are true:
For a local queue, if both of the following are true:
FORCE is also needed if both of the following are true:
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:
FORCE is also needed if both of the following are true:
If FORCE is not specified in the circumstances described, the command is unsuccessful.
This parameter can also be changed using the MQSET API call.
This parameter is supported only on local and model queues.
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 |
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, you 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.
This parameter is supported only on local and model queues.
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.
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.
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.
This parameter is supported only on local and model queues.
This parameter is supported only on local and model queues.
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.
You cannot set this parameter on z/OS.
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.
This parameter can also be changed using the MQSET API call.
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 Monitoring WebSphere MQ 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.
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 Monitoring WebSphere MQ 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.
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).
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).
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.
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. You can specify SHARED only if:
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 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.
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.
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 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.
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.
This parameter is supported only on remote queues.
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).
This parameter is supported only on remote queues.
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).
This parameter is supported only on alias, local, and remote queues.
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.
This parameter is supported only on local and model queues.
This parameter is valid only on i5/OS, UNIX systems, and Windows.
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 WebSphere MQ for 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.
If you specify QSGDISP(SHARED) or DEFTYPE(SHAREDYN), this parameter is ignored.
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):
This queue need not be defined until an application process opens the alias queue.
This parameter is supported only on local and model queues.
For a transmission queue on AIX, HP OpenVMS, HP-UX, Linux, i5/OS, Solaris, Windows, or z/OS, you 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.
This parameter is supported only on local and model queues.
This parameter can also be changed using the MQSET API call.
This parameter is supported only on local and model queues.
This parameter can also be changed using the MQSET API call.
This parameter can also be changed using the MQSET API call.
This parameter is supported only on local and model queues.
This parameter can also be changed using the MQSET API call.
This parameter is supported only on local and model queues.
If you specify this option, do not specify values for CLUSTER and CLUSNL and do not specify INDXTYPE(MSGTOKEN) or INDXTYPE(GROUPID).
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.
Notices |
Downloads |
Library |
Support |
Feedback
![]() ![]() |
csqzaj1048 |