Optional parameters

Home
Optional parameters

BackoutRequeueName (MQCFST)

Excessive backout requeue name (parameter identifier: MQCA_BACKOUT_REQ_Q_NAME).
Specifies the local name of the queue (not necessarily a local queue) to which a message is transferred if it is backed out more times than the value of BackoutThreshold.
The backout queue does not need to exist at this time but it must exist when the BackoutThreshold value is exceeded.
The maximum length of the string is MQ_Q_NAME_LENGTH.

BackoutThreshold (MQCFIN)

Backout threshold (parameter identifier: MQIA_BACKOUT_THRESHOLD).
The number of times a message can be backed out before it is transferred to the backout queue specified by BackoutRequeueName.
If the value is subsequently reduced, any messages already on the queue that have been backed out at least as many times as the new value remain on the queue, but such messages are transferred if they are backed out again.
Specify a value in the range 0 through 999 999 999.

BaseQName (MQCFST)

Queue name to which the alias resolves (parameter identifier: MQCA_BASE_Q_NAME).
This is the name of a local or remote queue that is defined to the local queue manager.
The maximum length of the string is MQ_Q_NAME_LENGTH.

CFStructure (MQCFST)

Coupling facility structure name (parameter identifier: MQCA_CF_STRUC_NAME). This parameter applies to z/OS only.
Specifies the name of the coupling facility structure where you want to store messages when you use shared 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 maximum length of the string is MQ_CF_STRUC_NAME_LENGTH.
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 local and model queues, when you use the Create Queue command with a value of MQRP_YES in the Replace parameter, or the Change Queue command, the following rules apply:

On a local queue with a value of MQQSGD_SHARED in the QSGDisposition parameter, CFStructure cannot change.
If we need to change either the CFStructure or QSGDisposition 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 a value of MQQDT_SHARED_DYNAMIC in the DefinitionType parameter, CFStructure cannot be blank.
On a local queue with a value other than MQQSGD_SHARED in the QSGDisposition parameter, or a model queue with a value other than MQQDT_SHARED_DYNAMIC in the DefinitionType parameter, the value of CFStructure does not matter.

For local and model queues, when you use the Create Queue command with a value of MQRP_NO in the Replace parameter, the Coupling Facility structure:

On a local queue with a value of MQQSGD_SHARED in the QSGDisposition parameter, or a model queue with a value of MQQDT_SHARED_DYNAMIC in the DefinitionType parameter, CFStructure cannot be blank.
On a local queue with a value other than MQQSGD_SHARED in the QSGDisposition parameter, or a model queue with a value other than MQQDT_SHARED_DYNAMIC in the DefinitionType parameter, the value of CFStructure does not matter.

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

ClusterName (MQCFST)

Cluster name (parameter identifier: MQCA_CLUSTER_NAME).
The name of the cluster to which the queue belongs.
Changes to this parameter do not affect instances of the queue that are open.
Only one of the resultant values of ClusterName and ClusterNamelist can be nonblank; we cannot specify a value for both.
The maximum length of the string is MQ_CLUSTER_NAME_LENGTH.

ClusterNamelist (MQCFST)

Cluster namelist (parameter identifier: MQCA_CLUSTER_NAMELIST).
The name of the namelist, that specifies a list of clusters to which the queue belongs.
Changes to this parameter do not affect instances of the queue that are open.
Only one of the resultant values of ClusterName and ClusterNamelist can be nonblank; we cannot specify a value for both.

CLWLQueuePriority (MQCFIN)

Cluster workload queue priority (parameter identifier: MQIA_CLWL_Q_PRIORITY).
Specifies the priority of the queue in cluster workload management. 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 parameter, see WebSphere MQ Queue Manager Clusters.

CLWLQueueRank (MQCFIN)

Cluster workload queue rank (parameter identifier: MQIA_CLWL_Q_RANK).
Specifies the rank of the queue in cluster workload management. 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 parameter, see WebSphere MQ Queue Manager Clusters.

CLWLUseQ (MQCFIN)

Cluster workload use remote queue (parameter identifier: MQIA_CLWL_USEQ).
Specifies whether remote and local queues are to be used in cluster workload distribution. The value can be:

MQCLWL_USEQ_AS_Q_MGR

Use the value of the CLWLUseQ parameter on the queue manager's definition.

MQCLWL_USEQ_ANY

Use remote and local queues.

MQCLWL_USEQ_LOCAL

Do not use remote queues.

For more information about this parameter, see WebSphere MQ Queue Manager Clusters.

CommandScope (MQCFST)

Command scope (parameter identifier: MQCACF_COMMAND_SCOPE). This parameter applies to z/OS only.
Specifies how the command is executed when the queue manager is a member of a queue-sharing group. You can specify one of the following:

blank (or omit the parameter altogether). The command is executed on the queue manager on which it was entered.
a queue manager name. The command is executed on the queue manager you specify, providing it is active within the queue sharing group. If you specify a queue manager name other than the queue manager on which it was entered, be using a queue-sharing group environment, and the command server must be enabled.
an asterisk (*). The command is executed on the local queue manager and is also passed to every active queue manager in the queue-sharing group.

The maximum length is MQ_QSG_NAME_LENGTH.

DefBind (MQCFIN)

Bind definition (parameter identifier: MQIA_DEF_BIND).
The parameter specifies the binding to be used when MQOO_BIND_AS_Q_DEF is specified on the MQOPEN call. The value can be:

MQBND_BIND_ON_OPEN

The binding is fixed by the MQOPEN call.

MQBND_BIND_NOT_FIXED

The binding is not fixed.

Changes to this parameter do not affect instances of the queue that are open.

DefinitionType (MQCFIN)

Queue definition type (parameter identifier: MQIA_DEFINITION_TYPE).
The value can be:

MQQDT_PERMANENT_DYNAMIC

Dynamically defined permanent queue.

MQQDT_SHARED_DYNAMIC

Dynamically defined shared queue. This option is available on z/OS only.

MQQDT_TEMPORARY_DYNAMIC

Dynamically defined temporary queue.

DefInputOpenOption (MQCFIN)

Default input open option (parameter identifier: MQIA_DEF_INPUT_OPEN_OPTION).
Specifies the default share option for applications opening this queue for input.
The value can be:

MQOO_INPUT_EXCLUSIVE

Open queue to get messages with exclusive access.

MQOO_INPUT_SHARED

Open queue to get messages with shared access.

DefPersistence (MQCFIN)

Default persistence (parameter identifier: MQIA_DEF_PERSISTENCE).
Specifies the default for message-persistence on the queue. Message persistence determines whether or not messages are preserved across restarts of the queue manager.
The value can be:

MQPER_PERSISTENT

Message is persistent.

MQPER_NOT_PERSISTENT

Message is not persistent.

DefPriority (MQCFIN)

Default priority (parameter identifier: MQIA_DEF_PRIORITY).
Specifies the default priority of messages put on the queue. The value must be in the range zero through to the maximum priority value that is supported (9).

DistLists (MQCFIN)

Distribution list support (parameter identifier: MQIA_DIST_LISTS).
Specifies whether distribution-list messages can be placed on the queue.
This attribute is set by the sending message channel agent (MCA) which removes messages from the queue; this happens each time the sending MCA establishes a connection to a receiving MCA on a partnering queue manager. The attribute is not normally set by administrators, although it can be set if the need arises.
This parameter is supported in the following environments: AIX, HP-UX, i5/OS, Solaris, Windows and Linux.
The value can be:

MQDL_SUPPORTED

Distribution lists supported.

MQDL_NOT_SUPPORTED

Distribution lists not supported.

Force (MQCFIN)

Force changes (parameter identifier: MQIACF_FORCE).
Specifies whether the command should be forced to complete when conditions are such that completing the command would affect an open queue. The conditions depend upon the type of the queue that is being changed:
Alias QType: BaseQName is specified with a queue name and an application has the alias queue open.
Local QType: Either of the following conditions indicate that a local queue would be affected:

Shareability is specified as MQQA_NOT_SHAREABLE and more than one application has the local queue open for input.
The Usage value is changed and one or more applications has the local queue open, or there are one or more messages on the queue. (The Usage value should not normally be changed while there are messages on the queue; the format of messages changes when they are put on a transmission queue.)

Remote QType: Either of the following conditions indicate that a remote queue would be affected:

XmitQName is specified with a transmission-queue name (or blank) and an application has a remote queue open that would be affected by this change.
Any of the RemoteQName, RemoteQMgrName or XmitQName parameters is specified with a queue or queue-manager name, and one or more applications has a queue open that resolved through this definition as a queue-manager alias.

Model QType: This parameter is not valid for model queues.
A value of MQFC_YES is not required if this definition is in use as a reply-to queue definition only.
The value can be:

MQFC_YES

Force the change.

MQFC_NO

Do not force the change.

HardenGetBackout (MQCFIN)

Whether to harden backout count (parameter identifier: MQIA_HARDEN_GET_BACKOUT).
Specifies whether the count of backed out messages is saved (hardened) across restarts of the message queue manager.
WebSphere MQ for iSeries always hardens the count, regardless of the setting of this attribute.
The value can be:

MQQA_BACKOUT_HARDENED

Backout count remembered.

MQQA_BACKOUT_NOT_HARDENED

Backout count might not be remembered.

IndexType (MQCFIN)

Index type (parameter identifier: MQIA_INDEX_TYPE). This parameter applies to z/OS only.
Specifies the type of index maintained by the queue manager to expedite MQGET operations on the queue. For shared queues, the type of index determines what type of MQGETs can be used. The value can be:

MQIT_NONE

No index.

MQIT_MSG_ID

The queue is indexed using message identifiers.

MQIT_CORREL_ID

The queue is indexed using correlation identifiers.

MQIT_MSG_TOKEN

The queue is indexed using message tokens.

MQIT_GROUP_ID

The queue is indexed using group identifiers.

Messages can be retrieved using a selection criterion only if an appropriate index type is maintained, as the following table shows:

Retrieval selection criterion IndexType required
Shared queue Other queue
None (sequential retrieval) Any Any
Message identifier MQIT_MSG_ID or MQIT_NONE Any
Correlation identifier MQIT_CORREL_ID Any
Message and correlation identifiers MQIT_MSG_ID or MQIT_CORREL_ID Any
Group identifier MQIT_GROUP_ID Any
Grouping MQIT_GROUP_ID MQIT_GROUP_ID
Message token Not allowed MQIT_MSG_TOKEN

InhibitGet (MQCFIN)

Whether get operations are allowed (parameter identifier: MQIA_INHIBIT_GET).
The value can be:

MQQA_GET_ALLOWED

Get operations are allowed.

MQQA_GET_INHIBITED

Get operations are inhibited.

InhibitPut (MQCFIN)

Whether put operations are allowed (parameter identifier: MQIA_INHIBIT_PUT).
Specifies whether messages can be put on the queue.
The value can be:

MQQA_PUT_ALLOWED

Put operations are allowed.

MQQA_PUT_INHIBITED

Put operations are inhibited.

InitiationQName (MQCFST)

Initiation queue name (parameter identifier: MQCA_INITIATION_Q_NAME).
The local queue for trigger messages relating to this queue. The initiation queue must be on the same queue manager.
The maximum length of the string is MQ_Q_NAME_LENGTH.

MaxMsgLength (MQCFIN)

Maximum message length (parameter identifier: MQIA_MAX_MSG_LENGTH).
The maximum length for messages on the queue. Because applications might use the value of this attribute to determine the size of buffer they need to retrieve messages from the queue, change this value only if it is known that this will not cause an application to operate incorrectly.
Do not set a value that is greater than the queue manager’s MaxMsgLength attribute.
The lower limit for this parameter is 0. The upper limit depends on the environment:

On AIX, HP OpenVMS, Compaq NonStop Kernel, HP-UX, i5/OS, Solaris, Linux, Windows, and z/OS, the maximum message length is 100 MB (104 857 600 bytes).
On UNIX systems not listed above, the maximum message length is 4 MB (4 194 304 bytes).

MaxQDepth (MQCFIN)

Maximum queue depth (parameter identifier: MQIA_MAX_Q_DEPTH).
The maximum number of messages allowed on the queue. Note that other factors may cause the queue to be treated as full; for example, it will appear to be full if there is no storage available for a message.
Specify a value greater than or equal to 0, and less than or equal to:

999 999 999 if the queue is on AIX, HP-UX, i5/OS, Solaris, Linux, Windows, or z/OS
640 000 if the queue is on any other Websphere MQ platform.

MsgDeliverySequence (MQCFIN)

Whether priority is relevant (parameter identifier: MQIA_MSG_DELIVERY_SEQUENCE).
The value can be:

MQMDS_PRIORITY

Messages are returned in priority order.

MQMDS_FIFO

Messages are returned in FIFO order (first in, first out).

NonPersistentMessageClass (MQCFIN)

The level of reliability to be assigned to non-persistent messages that are put to the queue (parameter identifier: MQIA_NPM_CLASS).
The value can be:

MQNPM_CLASS_NORMAL

Non-persistent messages persist as long as the lifetime of the queue manager session. They are discarded in the event of a queue manager restart. This is the default value.

MQNPM_CLASS_HIGH

The queue manager attempts to retain non-persistent messages for the lifetime of the queue. Non-persistent messages may still be lost in the event of a failure.

This parameter is valid only on local and model queues. It is not valid on z/OS.

ProcessName (MQCFST)

Name of process definition for the queue (parameter identifier: MQCA_PROCESS_NAME).
Specifies the local name of the WebSphere MQ process that identifies the application to be started when a trigger event occurs.

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 TriggerData parameter.
In other environments, the process name must be nonblank for a trigger event to occur (although it can be set after the queue has been created).

The maximum length of the string is MQ_PROCESS_NAME_LENGTH.

QDepthHighEvent (MQCFIN)

Controls whether Queue Depth High events are generated (parameter identifier: MQIA_Q_DEPTH_HIGH_EVENT).
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 QDepthHighLimit parameter.
The value of this attribute can change implicitly. See Definitions of the Programmable Command Formats.
The value can be:

MQEVR_DISABLED

Event reporting disabled.

MQEVR_ENABLED

Event reporting enabled.

QDepthHighLimit (MQCFIN)

High limit for queue depth (parameter identifier: MQIA_Q_DEPTH_HIGH_LIMIT).
The threshold against which the queue depth is compared to generate a Queue Depth High event.
This event indicates that an application has put a message to 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 QDepthHighEvent parameter.
The value is expressed as a percentage of the maximum queue depth (MaxQDepth attribute), and must be greater than or equal to zero and less than or equal to 100.

QDepthLowEvent (MQCFIN)

Controls whether Queue Depth Low events are generated (parameter identifier: MQIA_Q_DEPTH_LOW_EVENT).
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 QDepthLowLimit parameter.
The value of this attribute can change implicitly. See Definitions of the Programmable Command Formats.
The value can be:

MQEVR_DISABLED

Event reporting disabled.

MQEVR_ENABLED

Event reporting enabled.

QDepthLowLimit (MQCFIN)

Low limit for queue depth (parameter identifier: MQIA_Q_DEPTH_LOW_LIMIT).
The threshold against which the queue depth is compared to generate a Queue Depth Low event.
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 QDepthLowEvent parameter.
Specify the value as a percentage of the maximum queue depth (MaxQDepth attribute), in the range 0 through 100.

QDepthMaxEvent (MQCFIN)

Controls whether Queue Full events are generated (parameter identifier: MQIA_Q_DEPTH_MAX_EVENT).
A Queue Full event indicates that an MQPUT call 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 attribute can change implicitly. See Definitions of the Programmable Command Formats.
The value can be:

MQEVR_DISABLED

Event reporting disabled.

MQEVR_ENABLED

Event reporting enabled.

QDesc (MQCFST)

Queue description (parameter identifier: MQCA_Q_DESC).
Text that briefly describes the object.
The maximum length of the string is MQ_Q_DESC_LENGTH.
Use characters from the character set identified by the coded character set identifier (CCSID) for the message queue manager on which the command is executing to ensure that the text is translated correctly if it is sent to another queue manager.

QServiceInterval (MQCFIN)

Target for queue service interval (parameter identifier: MQIA_Q_SERVICE_INTERVAL).
The service interval used for comparison to generate Queue Service Interval High and Queue Service Interval OK events. See the QServiceIntervalEvent parameter.
Specify a value in the range 0 through 999 999 999 milliseconds.

QServiceIntervalEvent (MQCFIN)

Controls whether Service Interval High or Service Interval OK events are generated (parameter identifier: MQIA_Q_SERVICE_INTERVAL_EVENT).
A Queue Service Interval High event is generated when a check indicates that no messages have been retrieved from or put to the queue for at least the time indicated by the QServiceInterval attribute.
A Queue Service Interval OK event is generated when a check indicates that a message has been retrieved from the queue within the time indicated by the QServiceInterval attribute.
The value of this attribute can change implicitly. See Definitions of the Programmable Command Formats.
The value can be:

MQQSIE_HIGH

Queue Service Interval High events enabled.

Queue Service Interval High events are enabled and
Queue Service Interval OK events are disabled.

MQQSIE_OK

Queue Service Interval OK events enabled.

Queue Service Interval High events are disabled and
Queue Service Interval OK events are enabled.

MQQSIE_NONE

No queue service interval events enabled.

Queue Service Interval High events are disabled and
Queue Service Interval OK events are also disabled.
QSGDisposition (MQCFIN)
Disposition of the object within the group (parameter identifier: MQIA_QSG_DISP). This parameter applies to z/OS only.
Specifies the disposition of the object to which you are applying the command (that is, where it is defined and how it behaves). The value can be:
QSGDisposition Change Copy, Create
MQQSGD_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 parameter MQQSGD_COPY. Any object residing in the shared repository, or any object defined using a command that had the parameters MQQSGD_Q_MGR, is not affected by this command. The object is defined on the page set of the queue manager that executes the command using the MQQSGD_GROUP object of the same name as the ToQName object (for Copy) or the QName object (for Create). For local queues, messages are stored on the page sets of each queue manager and are available only through that queue manager.
MQQSGD_GROUP
The object definition resides in the shared repository. The object was defined using a command that had the parameter MQQSGD_GROUP. Any object residing on the page set of the queue manager that executes the command (except a local copy of the object) is not affected by this command.
If the command is successful, the following MQSC 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 Change 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 in a shared queue manager environment.
If the definition is successful, the following MQSC 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 Copy or Create for the group object takes effect regardless of whether the generated command with QSGDISP(COPY) fails.
MQQSGD_PRIVATE The object resides on the page set of the queue manager that executes the command, and was defined with MQQSGD_Q_MGR or MQQSGD_COPY. Any object residing in the shared repository is unaffected. Not permitted.
MQQSGD_Q_MGR 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 parameter MQQSGD_Q_MGR. 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.
MQQSGD_SHARED This value applies only to local queues. The object definition resides in the shared repository. The object was defined by a command using the parameter MQQSGD_SHARED. Any object residing on the page set of the queue manager that executes the command, or any object defined by a command using the parameter MQQSGD_GROUP, is not affected by this command. 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 MQQSGD_SHARED only if:

CFStructure is nonblank
IndexType is not MQIT_MSG_TOKEN
The queue is not one of the following:

SYSTEM.CHANNEL.INITQ
SYSTEM.COMMAND.INPUT
QueueAccounting (MQCFIN)

Controls the collection of accounting data (parameter identifier: MQIA_ACCOUNTING_Q).
The value can be:

MQMON_Q_MGR

The collection of accounting data for the queue is performed based upon the setting of the QueueAccounting parameter on the queue manager.

MQMON_OFF

Accounting data collection is disabled for the queue.

MQMON_ON

If the value of the queue manager's QueueAccounting parameter is not MQMON_NONE, accounting data collection is enabled for the queue.

QueueMonitoring (MQCFIN)

Online monitoring data collection (parameter identifier: MQIA_MONITORING_Q).
Specifies whether online monitoring data is to be collected and, if so, the rate at which the data is collected. The value can be:

MQMON_OFF

Online monitoring data collection is turned off for this queue.

MQMON_Q_MGR

The value of the queue manager's QueueMonitoring parameter is inherited by the queue.

MQMON_LOW

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

MQMON_MEDIUM

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

MQMON_HIGH

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

QueueStatistics (MQCFIN)

Statistics data collection (parameter identifier: MQIA_STATISTICS_Q).
Specifies whether statistics data collection is enabled. The value can be:

MQMON_Q_MGR

The value of the queue manager's QueueStatistics parameter is inherited by the queue.

MQMON_OFF

Statistics data collection is disabled

MQMON_ON

If the value of the queue manager's QueueStatistics parameter is not MQMON_NONE, statistics data collection is enabled

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

RemoteQMgrName (MQCFST)

Name of remote queue manager (parameter identifier: MQCA_REMOTE_Q_MGR_NAME).
If an application opens the local definition of a remote queue, RemoteQMgrName must not be blank or the name of the connected queue manager. If XmitQName 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, RemoteQMgrName is the name of the queue manager, which can be the name of the connected queue manager. Otherwise, if XmitQName is blank, when the queue is opened 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 maximum length of the string is MQ_Q_MGR_NAME_LENGTH.

RemoteQName (MQCFST)

Name of remote queue as known locally on the remote queue manager (parameter identifier: MQCA_REMOTE_Q_NAME).
If this definition is used for a local definition of a remote queue, RemoteQName must not be blank when the open occurs.
If this definition is used for a queue-manager alias definition, RemoteQName must be blank when the open occurs.
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 maximum length of the string is MQ_Q_NAME_LENGTH.

Replace (MQCFIN)

Replace attributes (parameter identifier: MQIACF_REPLACE). This parameter is not valid on a Change Queue command.
If the object already exists, the effect is similar to issuing the Change Queue command without the MQFC_YES option on the Force parameter, and with all of the other attributes specified. In particular, note that any messages which are on the existing queue are retained.
(The difference between the Change Queue command without MQFC_YES on the Force parameter, and the Create Queue command with MQRP_YES on the Replace parameter, is that the Change Queue command does not change unspecified attributes, but Create Queue with MQRP_YES sets all the attributes. When you use MQRP_YES, unspecified attributes are taken from the default definition, and the attributes of the object being replaced, if one exists, are ignored.)
The command fails if both of the following are true:

The command sets attributes that would require the use of MQFC_YES on the Force parameter if you were using the Change Queue command
The object is open

The Change Queue command with MQFC_YES on the Force parameter succeeds in this situation.
If MQSCO_CELL is specified on the Scope parameter on OS/2 or UNIX systems, and there is already a queue with the same name in the cell directory, the command fails, whether or not MQRP_YES is specified.
The value can be:

MQRP_YES

Replace existing definition.

MQRP_NO

Do not replace existing definition.

RetentionInterval (MQCFIN)

Retention interval (parameter identifier: MQIA_RETENTION_INTERVAL).
The number of hours for which the queue might be needed, based on the date and time when the queue was created.
This information is available to a housekeeping application or an operator and can be used to determine when a queue is no longer required. The queue manager does not delete queues 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.
Specify a value in the range 0 through 999 999 999.

Scope (MQCFIN)

Scope of the queue definition (parameter identifier: MQIA_SCOPE).
Specifies whether the scope of the queue definition does not extend beyond the queue manager which owns the queue, or whether the queue name is contained in a cell directory, so that it is known to all of the queue managers within the cell.
If this attribute is changed from MQSCO_CELL to MQSCO_Q_MGR, the entry for the queue is deleted from the cell directory.
Model and dynamic queues cannot be changed to have cell scope.
If it is changed from MQSCO_Q_MGR to MQSCO_CELL, an entry for the queue is created in the cell directory. If there is already a queue with the same name in the cell directory, the command fails. The command also fails if no name service supporting a cell directory has been configured.
The value can be:

MQSCO_Q_MGR

Queue-manager scope.

MQSCO_CELL

Cell scope.
This value is not supported on i5/OS.

This parameter is not available on z/OS.

Shareability (MQCFIN)

Whether the queue can be shared (parameter identifier: MQIA_SHAREABILITY).
Specifies whether multiple instances of applications can open this queue for input.
The value can be:

MQQA_SHAREABLE

Queue is shareable.

MQQA_NOT_SHAREABLE

Queue is not shareable.

StorageClass (MQCFST)

Storage class (parameter identifier: MQCA_STORAGE_CLASS). This parameter applies to z/OS only.
Specifies the name of the storage class.
The maximum length of the string is MQ_STORAGE_CLASS_LENGTH.

TriggerControl (MQCFIN)

Trigger control (parameter identifier: MQIA_TRIGGER_CONTROL).
Specifies whether trigger messages are written to the initiation queue.
The value can be:

MQTC_OFF

Trigger messages not required.

MQTC_ON

Trigger messages required.

TriggerData (MQCFST)

Trigger data (parameter identifier: MQCA_TRIGGER_DATA).
Specifies user data that the queue manager includes in the trigger message. This data is made available to the monitoring application that processes the initiation queue and to the application that is started by the monitor.
The maximum length of the string is MQ_TRIGGER_DATA_LENGTH.

TriggerDepth (MQCFIN)

Trigger depth (parameter identifier: MQIA_TRIGGER_DEPTH).
Specifies (when TriggerType is MQTT_DEPTH) the number of messages that will initiate a trigger message to the initiation queue. The value must be in the range 1 through 999 999 999.

TriggerMsgPriority (MQCFIN)

Threshold message priority for triggers (parameter identifier: MQIA_TRIGGER_MSG_PRIORITY).
Specifies the minimum priority that a message must have before it can cause, or be counted for, a trigger event. The value must be in the range of priority values that is supported (0 through 9).

TriggerType (MQCFIN)

Trigger type (parameter identifier: MQIA_TRIGGER_TYPE).
Specifies the condition that initiates a trigger event. When the condition is true, a trigger message is sent to the initiation queue.
The value can be:

MQTT_NONE

No trigger messages.

MQTT_EVERY

Trigger message for every message.

MQTT_FIRST

Trigger message when queue depth goes from 0 to 1.

MQTT_DEPTH

Trigger message when depth threshold exceeded.

Usage (MQCFIN)

Usage (parameter identifier: MQIA_USAGE).
Specifies whether the queue is for normal usage or for transmitting messages to a remote message queue manager.
The value can be:

MQUS_NORMAL

Normal usage.

MQUS_TRANSMISSION

Transmission queue.

XmitQName (MQCFST)

Transmission queue name (parameter identifier: MQCA_XMIT_Q_NAME).
Specifies the local name of the transmission queue to be used for messages destined for either a remote queue or for a queue-manager alias definition.
If XmitQName is blank, a queue with the same name as RemoteQMgrName is used as the transmission queue.
This attribute is ignored if the definition is being used as a queue-manager alias and RemoteQMgrName is the name of the connected queue manager.
It is also ignored if the definition is used as a reply-to queue alias definition.
The maximum length of the string is MQ_Q_NAME_LENGTH.

Parent topic:
Change, Copy, and Create Queue

pc11200_

Home

Retrieval selection criterion	IndexType required
	Shared queue	Other queue
None (sequential retrieval)	Any	Any
Message identifier	MQIT_MSG_ID or MQIT_NONE	Any
Correlation identifier	MQIT_CORREL_ID	Any
Message and correlation identifiers	MQIT_MSG_ID or MQIT_CORREL_ID	Any
Group identifier	MQIT_GROUP_ID	Any
Grouping	MQIT_GROUP_ID	MQIT_GROUP_ID
Message token	Not allowed	MQIT_MSG_TOKEN

QSGDisposition	Change	Copy, Create
MQQSGD_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 parameter MQQSGD_COPY. Any object residing in the shared repository, or any object defined using a command that had the parameters MQQSGD_Q_MGR, is not affected by this command.	The object is defined on the page set of the queue manager that executes the command using the MQQSGD_GROUP object of the same name as the ToQName object (for Copy) or the QName object (for Create). For local queues, messages are stored on the page sets of each queue manager and are available only through that queue manager.
MQQSGD_GROUP	The object definition resides in the shared repository. The object was defined using a command that had the parameter MQQSGD_GROUP. Any object residing on the page set of the queue manager that executes the command (except a local copy of the object) is not affected by this command. If the command is successful, the following MQSC 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 Change 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 in a shared queue manager environment. If the definition is successful, the following MQSC 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 Copy or Create for the group object takes effect regardless of whether the generated command with QSGDISP(COPY) fails.
MQQSGD_PRIVATE	The object resides on the page set of the queue manager that executes the command, and was defined with MQQSGD_Q_MGR or MQQSGD_COPY. Any object residing in the shared repository is unaffected.	Not permitted.
MQQSGD_Q_MGR	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 parameter MQQSGD_Q_MGR. 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.
MQQSGD_SHARED	This value applies only to local queues. The object definition resides in the shared repository. The object was defined by a command using the parameter MQQSGD_SHARED. Any object residing on the page set of the queue manager that executes the command, or any object defined by a command using the parameter MQQSGD_GROUP, is not affected by this command.	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 MQQSGD_SHARED only if: CFStructure is nonblank IndexType is not MQIT_MSG_TOKEN The queue is not one of the following: SYSTEM.CHANNEL.INITQ SYSTEM.COMMAND.INPUT