ALTER QMGR
Use the MQSC command ALTER QMGR to alter the queue manager parameters for the local queue manager.
Use MQSC commands
For information on how we use MQSC commands, see Performing local administration tasks using MQSC commands.
Parameters not specified in the ALTER QMGR command result in the existing values for those parameters being left unchanged.We can issue this command from sources 2CR. For an explanation of the source symbols, see Sources from which we can issue MQSC commands on z/OS .
This information is divided into three sections:
ALTER QMGR
Synonym: ALT QMGRQueue manager attributesNotes:- 1 Valid only on z/OS when the queue manager is a member of a queue sharing group.
- 2 Valid only on z/OS.
- 3 Not valid on z/OS.
- 4 Valid only on UNIX, Linux, and Windows.
- 5 Not valid on IBM i.
Parameter descriptions for ALTER QMGR
The parameters you specify override the current values. Attributes that we do not specify are unchanged. Note:- If we do not specify any parameters, the command completes successfully, but no queue manager options are changed.
- Changes made using this command persist when the queue manager is stopped and restarted.
- FORCE
- Specify this parameter
to force completion of the command if both of the following statements are true:
- The DEFXMITQ parameter is specified
- An application has a remote queue open, the resolution for which would be affected by this change
If FORCE is not specified in these circumstances, the command is unsuccessful.
Queue manager parameters
These parameters are the queue manager parameters for the ALTER QMGR command:
- ACCTCONO
- Specifies whether
applications can override the settings of the ACCTQ and
ACCTMQI queue manager parameters:
- DISABLED
- Applications cannot override the settings of the ACCTQ and
ACCTMQI parameters.
This is the queue manager's initial default value.
- ENABLED
- Applications can override the settings of the ACCTQ and ACCTMQI parameters by using the options field of the MQCNO structure of the MQCONNX API call.
Changes to this parameter are effective for connections to the queue manager that occur after the change.
This parameter is valid only on Multiplatforms.
- ACCTINT(integer)
- The time interval, in
seconds, at which intermediate accounting records are written.
Specify a value in the range 1 through 604800.
Changes to this parameter are effective for connections to the queue manager that occur after the change.
This parameter is valid only on Multiplatforms.
- ACCTMQI
- Specifies whether
accounting information for MQI data is to be collected:
- OFF
- MQI accounting data collection is disabled.
This is the queue manager's initial default value.
- ON
- MQI accounting data collection is enabled.
If queue manager attribute ACCTCONO is set to ENABLED, the value of this parameter can be overridden using the options field of the MQCNO structure.
Changes to this parameter are effective for connections to the queue manager that occur after the change.
This parameter is valid only on Multiplatforms.
- ACCTQ
- Specifies whether accounting data is to be collected for all queues.
On z/OS, the data collected is class 3 accounting data (thread-level and queue-level accounting).
- OFF
- Accounting data collection is disabled for all queues which specify QMGR as the value for their ACCTQ parameter.
- ON
- Accounting data collection is enabled for all queues which specify QMGR as the value of their ACCTQ parameter.
- On z/OS systems, we must switch on class 3 accounting by the START TRACE command.
- NONE
- Accounting data collection for all queues is disabled regardless of the value of the ACCTQ parameter of the queue.
Changes to this parameter are effective only for connections to the queue manager occurring after the change to the parameter.
- ACTCHL(integer)
- The maximum number of channels that can be active at any time, unless the
value is reduced below the number of currently active channels.
Specify a value from 1 through 9999 that is not greater than the value of MAXCHL. MAXCHL defines the maximum number of channels available.
If we change this value, we must also review the MAXCHL, LU62CHL, and TCPCHL values to ensure that there is no conflict of values
For an explanation of which channel states are considered active; see Channel states.
If the value of ACTCHL is reduced to less than its value when the channel initiator was initialized, channels continue to run until they stop. When the number of running channels falls below the value of ACTCHL, more channels can be started. Increasing the value of ACTCHL to more than its value when the channel initiator was initialized does not have immediate effect. The higher value of ACTCHL takes effect at the next channel initiator restart.
Sharing conversations do not contribute to the total for this parameter.
This parameter is valid only on z/OS.
- ACTIVREC
- Specifies whether
activity reports are generated if requested in the message:
- DISABLED
- Activity reports are not generated.
- MSG
- Activity reports are generated and sent to the reply queue specified by the originator in the
message causing the report.
This is the queue manager's initial default value.
- QUEUE
- Activity reports are generated and sent to SYSTEM.ADMIN.ACTIVITY.QUEUE
See Activity recording.
- ACTVCONO
- Specifies whether
applications can override the settings of the ACTVTRC queue manager parameter:
- DISABLED
- Applications cannot override the settings of the ACTVTRC queue manager
parameter.
This is the queue manager's initial default value.
- ENABLED
- Applications can override the settings of the ACTVTRC queue manager parameter by using the options field of the MQCNO structure of the MQCONNX API call.
Changes to this parameter are effective for connections to the queue manager that occur after the change.
This parameter is valid only on Multiplatforms.
- ACTVTRC
- Specifies whether MQI
application activity tracing information is to be collected. See Set ACTVTRC to control
collection of activity trace information.
- OFF
- IBM MQ MQI application activity tracing information
collection is not enabled.
This is the queue manager's initial default value.
- ON
- IBM MQ MQI application activity tracing information
collection is enabled.
If the queue manager attribute ACTVCONO is set to ENABLED, the value of this parameter can be overridden using the options field of the MQCNO structure.
Changes to this parameter are effective for connections to the queue manager that occur after the change.
This parameter is valid only on Multiplatforms.
- ADOPTCHK
- Specifies which elements are checked to determine whether an MCA is adopted. The check
is made when a new inbound channel is detected with the same name as an already active MCA.
- ALL
- Check the queue manager name and the network address. Perform this check to prevent your
channels from being inadvertently or maliciously shut down.
This is the queue manager's initial default value.
- NETADDR
- Check the network address.
- NONE
- Do no checking.
- QMNAME
- Check the queue manager name.
Changes to this parameter take effect the next time that a channel attempts to adopt an MCA.
This parameter is valid only on z/OS.
- ADOPTMCA
- Specifies whether an orphaned instance of an MCA restarts immediately when a new
inbound channel request matching the ADOPTCHK parameter is detected:
- ALL
- Adopt all channel types.
This is the queue manager's initial default value.
- NO
- Adoption of orphaned channels is not required.
Changes to this parameter take effect the next time that a channel attempts to adopt an MCA.
This parameter is valid only on z/OS.
- AUTHOREV
- Specifies whether
authorization (Not Authorized) events are generated:
- DISABLED
- Authorization events are not generated.
This is the queue manager's initial default value.
- ENABLED
- Authorization events are generated.
This value is not supported on z/OS.
- BRIDGEEV
- Specifies whether IMS bridge events are generated.
- DISABLED
- IMS bridge events are not generated.
This is the queue manager's initial default value.
- ENABLED
- All IMS bridge events are generated.
This parameter is valid only on z/OS.
- CCSID(integer)
-
The coded character set identifier for the
queue manager. The CCSID is the identifier used with all character string fields defined by the API.
If the CCSID in the message descriptor is set to the value MQCCSI_Q_MGR, the value
applies to application data in the body of a message. The value is set when the message is put to a
queue.
Specify a value in the range 1 through 65535. The CCSID specifies a value that is defined for use on the platform, and use a character set that is appropriate to the platform.
If you use this parameter to change the CCSID, applications that are running when the change is applied continue to use the original CCSID. Therefore, stop and restart all running applications before you continue including the command server and channel programs. To stop and restart all running applications, stop and restart the queue manager after changing the parameter value.
This parameter is valid only on Multiplatforms. See Code page conversion for details of the supported CCSIDs for each platform.
To carry out the equivalent tasks on z/OS, use CSQ6SYSP to set the system parameters.
- CERTLABL
- Certificate label for this queue manager to use. The label identifies which personal certificate
in the key repository has been selected. The default and migrated queue manager values are:
- On UNIX, Linux, and Windows: ibmwebspheremqxxxx where xxxx is the queue manager name folded to lowercase.
- On IBM i:
- If you specified SSLKEYR(*SYSTEM), the value is blank.
Note that it is forbidden to use a nonblank queue manager CERTLABL with SSLKEYR(*SYSTEM). Attempting to do so results in an MQRCCF_Q_MGR_ATTR_CONFLICT error.
- Otherwise, ibmwebspheremqxxxx where xxxx is the queue manager name folded to lowercase.
- If you specified SSLKEYR(*SYSTEM), the value is blank.
- On z/OS: ibmWebSphereMQXXXX where XXXX is the queue manager name.
We should specify the preceding values. However, leaving CERTLABL as a blank value on the queue manager is interpreted by the system to mean the default values specified.
Important: We must run a REFRESH SECURITY TYPE(SSL) command if you make any changes to CERTLABL on the queue manager. However, we do not need to run the REFRESH SECURITY TYPE(SSL) command if you make any changes to CERTLABL on a channel. - CERTQSGL
- Queue sharing group (QSG) certificate label.
This parameter takes precedence over CERTLABL in the event that the queue manager is a member of a QSG.
The default value for this parameter is ibmWebSphereMQXXXX where XXXX is the queue sharing group name.
This parameter is valid only on z/OS.
- CERTVPOL
- Specifies which TLS certificate validation policy is used to validate digital certificates
received from remote partner systems. This attribute can be used to control how strictly the
certificate chain validation conforms to industry security standards.
- ANY
- Apply each of the certificate validation policies supported by the secure sockets library and accept the certificate chain if any of the policies considers the certificate chain valid. This setting can be used for maximum backwards compatibility with older digital certificates which do not comply with the modern certificate standards.
- RFC5280
- Apply only the RFC 5280 compliant certificate validation policy. This setting provides stricter validation than the ANY setting, but rejects some older digital certificates.
For more information about certificate validation policies, see Certificate validation policies in IBM MQ.
Changes to the parameter take effect only after a REFRESH SECURITY TYPE(SSL) command is issued.
This parameter is valid only on Multiplatforms.
- CFCONLOS
- Specifies the action to be taken when the queue manager loses connectivity to the
administration structure, or any CF structure with CFCONLOS set to
ASQMGR.
- TERMINATE
- The queue manager terminates when connectivity to CF structures is lost.
- TOLERATE
- The queue manager tolerates loss of connectivity to CF structures without terminating.
This parameter is valid only on z/OS.
- CHAD
-
Specifies whether receiver and server-connection channels can be defined automatically:
- DISABLED
- Auto-definition is not used.
This is the queue manager's initial default value.
- ENABLED
- Auto-definition is used.
Cluster-sender channels can always be defined automatically, regardless of the setting of this parameter.
This parameter is valid only on Multiplatforms.
- CHADEV
- Specifies whether channel auto-definition events are generated.
- DISABLED
- Auto-definition events are not generated.
This is the queue manager's initial default value.
- ENABLED
- Auto-definition events are generated.
This parameter is valid only on Multiplatforms.
- CHADEXIT(string)
- Auto-definition exit name.
If this name is nonblank, the exit is called when an inbound request for an undefined receiver, server-connection, or cluster-sender channel is received. It is also called when starting a cluster-receiver channel.
The format and maximum length of the name depends on the environment:- On UNIX and Linux, it is of the form libraryname(functionname). The maximum length is 128 characters.
- On Windows, it is of the form dllname(functionname) where dllname is specified without the suffix .DLL. The maximum length is 128 characters.
- On IBM i, it is of the form:
progname libname
where program name occupies the first 10 characters and libname the second 10 characters (both blank-padded to the right if necessary). The maximum length of the string is 20 characters. - On z/OS, it is a load module name, the maximum length is eight characters.
On z/OS, the CHADEXIT parameter applies only to cluster-sender and cluster-receiver channels.
- CHIADAPS(integer)
- The number of channel initiator adapter subtasks to use for processing IBM MQ calls. Specify a value in the range 0 - 9999. Suggested
settings are:
- Test system: 8
- Production system: 30
Changes to this parameter take effect when the channel initiator is restarted.
For more information about the relationship between CHIADAPS, CHIDISPS and MAXCHL, see Tailor the channel initiator parameters.
This parameter is valid only on z/OS.
- CHIDISPS ( integer )
- The number of dispatchers to use in the channel initiator. Specify a value in the
range 1 through 9999. Suggested settings are:
- Test system: 5
- Production system: 20
Changes to this parameter take effect when the channel initiator is restarted.
For more information about the relationship between CHIADAPS, CHIDISPS and MAXCHL, see Tailor the channel initiator parameters.
This parameter is valid only on z/OS.
- CHISERVP
- This parameter is reserved for IBM use
only; it is not for general use.
This parameter is valid only on z/OS.
- CHLAUTH
- Specifies whether the
rules defined by channel authentication records are used. CHLAUTH rules can still
be set and displayed regardless of the value of this attribute.
Changes to this parameter take effect the next time that an inbound channel attempts to start. Channels that are currently started are unaffected by changes to this parameter.
- DISABLED
- Channel authentication records are not checked.
- ENABLED
- Channel authentication records are checked.
- CHLEV
- Specifies whether
channel events are generated.
- DISABLED
- Channel events are not generated. This is the queue manager's initial default value.
- ENABLED
- All channel events are generated.
- EXCEPTION
- All exception channel events are generated.
- CLWLDATA(string)
- Cluster workload
exit data. The maximum length of the string is 32 characters.
This string is passed to the cluster workload exit when it is called.
- CLWLEXIT(string)
- Cluster workload
exit name. If this name is nonblank, the exit is called when a message is put to a cluster queue.
The format and maximum length of the name depends on the environment:
- On UNIX, and Linux, it is of the form libraryname(functionname). The maximum length is 128 characters.
- On Windows, it is of the form dllname(functionname), where dllname is specified without the suffix .DLL. The maximum length is 128 characters.
- On z/OS, it is a load module name. The maximum length is eight characters.
- On IBM i, it is of the form:
progname libname
where program name occupies the first 10 characters and libname the second 10 characters (both blank-padded to the right if necessary). The maximum length is 20 characters.
- CLWLLEN(integer)
- The maximum number of bytes of message data that is passed to the cluster workload
exit. Specify a value in the range:
- 0 - 999,999,999 on UNIX, Linux, and Windows.
- 0 - 999,999,999 on IBM i.
- 0 - 100 MB on z/OS systems.
- CLWLMRUC(integer)
- The maximum number
of most recently used outbound cluster channels.
Specify a value in the range 1 through 999,999,999.
- CLWLUSEQ
- The attribute
applies to queues with the queue attribute CLWLUSEQ set to
QMGR. It specifies the behavior of an MQPUT operation when the
target queue has a local instance and at least one remote cluster instance. It does not apply if the
MQPUT originates from a cluster channel. Specify either:
- LOCAL
- The local queue is the only target for MQPUT operations.
This is the queue manager's initial default value.
- ANY
- The queue manager treats the local queue as another instance of the cluster queue for the purposes of workload distribution.
- CMDEV
- Specifies whether
command events are generated:
- DISABLED
- Command events are not generated.
This is the queue manager's initial default value.
- ENABLED
- Command events are generated for all successful commands.
- NODISPLAY
- Command events are generated for all successful commands, other than DISPLAY commands.
- CMDSCOPE
- Specifies how the command is run when the queue manager is a member of a queue sharing group.
- '
- The command is run on the queue manager on which it was entered.
- qmgr-name
- The command is run on the queue manager you specify, providing the queue manager is active
within the queue sharing group.
We can specify a different queue manager. We can do so if you are using a queue sharing group environment, and if the command server is enabled. We can then specify a different queue manager to the one on which the command is entered.
- *
-
The command is run on the local queue manager and is also passed to every active queue manager in the queue sharing group. The effect of entering this value is the same as entering the command on every queue manager in the queue sharing group.
This parameter is valid only on z/OS.
- CONFIGEV
- Specifies whether
configuration events are generated:
- ENABLED
- Configuration events are generated. After setting this value, issue REFRESH QMGR TYPE(CONFIGEV) commands for all objects to bring the queue manager configuration up to date.
- DISABLED
- Configuration events are not generated.
This is the queue manager's initial default value.
- CONNAUTH
-
The name of an authentication information object that is used to provide the
location of user ID and password authentication. If CONNAUTH is blank, no
user ID and password checking is done by the queue manager. The maximum length of the string is
MQ_AUTH_INFO_NAME_LENGTH. Only authentication information objects with type
IDPWOS or IDPWLDAP can be specified; other types result in an error message when:
- The OAM reads the configuration on Multiplatforms.
- The security component reads the configuration on z/OS.
Changes to this configuration, or the object to which it refers, take effect when a REFRESH SECURITY TYPE(CONNAUTH) command is issued. If you leave CONNAUTH blank, and attempt to connect to a channel that has one of the following options set in the CHCKCLNT field, the connection fails:
- REQDADM
- REQUIRED
- CUSTOM(string)
- The custom attribute
for new features.
This attribute is reserved for the configuration of new features before named attributes are introduced. It can contain the values of zero or more attributes as pairs of attribute name and value, separated by at least one space. The attribute name-value pairs have the form NAME(VALUE. Escape a single quotation mark with another single quotation mark.
No values are defined for Custom.
- DEADQ(string)
- The local name of a
dead-letter queue (or undelivered-message queue) on which messages that cannot be routed to their
correct destination are put.
The queue named must be a local queue; see Rules for naming IBM MQ objects.
- DEFCLXQ
-
The DFTCLXQ attribute controls which transmission queue is selected by default by cluster-sender channels to get messages from, to send the messages to cluster-receiver channels.
- SCTQ
-
All cluster-sender channels send messages from SYSTEM.CLUSTER.TRANSMIT.QUEUE. The correlID of messages placed on the transmission queue identifies which cluster-sender channel the message is destined for.
SCTQ is set when a queue manager is defined. This behavior is implicit in versions of IBM WebSphere MQ, earlier than Version 7.5. In earlier versions, the queue manager attribute DEFCLXQ was not present.
- CHANNEL
- Each cluster-sender channel sends messages from a different transmission queue. Each transmission queue is created as a permanent dynamic queue from the model queue SYSTEM.CLUSTER.TRANSMIT.MODEL.QUEUE.
If the queue manager attribute, DEFCLXQ, is set to CHANNEL,the default configuration is changed to cluster-sender channels being associated with individual cluster transmission queues. The transmission queues are permanent-dynamic queues created from the model queue SYSTEM.CLUSTER.TRANSMIT.MODEL.QUEUE. Each transmission queue is associated with one cluster-sender channel. As one cluster-sender channel services a cluster transmission queue, the transmission queue contains messages for only one queue manager in one cluster. We can configure clusters so that each queue manager in a cluster contains only one cluster queue. In this case, the message traffic from a queue manager to each cluster queue is transferred separately from messages to other queues.
- DEFXMITQ(string)
- Local name of the
default transmission queue on which messages destined for a remote queue manager are put. The
default transmission queue is used if there is no other suitable transmission queue defined.
The cluster transmission queue must not be used as the default transmission queue of the queue manager.
The queue named must be a local transmission queue; see Rules for naming IBM MQ objects.
- DESCR(string)
- Plain-text comment. It
provides descriptive information about the queue manager.
It contains only displayable characters. The maximum length of the string is 64 characters. In a DBCS installation, it can contain DBCS characters (subject to a maximum length of 64 bytes).
If the characters in the descriptive information are in the coded character set identifier (CCSID) for this queue manager they are translated correctly. They are translated when the descriptive information is sent to another queue manager. If they are not in the CCSID for this queue manager, they might be translated incorrectly.
- DNSGROUP(string)
- This parameter is no longer used. See z/OS: WLM/DNS no longer supported.
- DNSWLM
- This parameter is no longer used. See z/OS: WLM/DNS no longer supported.
- NO
- This value is the only value accepted.
- EXPRYINT
- Specifies how often queues are scanned to discard expired messages:
- OFF
- Queues are not scanned. No internal expiry processing is performed.
- integer
- The approximate interval in seconds at which queues are scanned. Each time that the expiry
interval is reached, the queue manager looks for candidate queues that are worth scanning to discard
expired messages.
The queue manager maintains information about the expired messages on each queue, and therefore whether a scan for expired messages is worthwhile. So, only a selection of queues is scanned at any time.
The value must be in the range 1 through 99999999. The minimum scan interval used is 5 seconds, even if we specify a lower value.
We must set the same EXPRYINT value for all queue managers within a queue sharing group that support this attribute. Shared queues are scanned by only one queue manager in a queue sharing group. This queue manager is either the first queue manager to restart, or the first queue manager for which EXPRYINT is set.
Changes to EXPRYINT take effect when the current interval expires. Changes also take effect if the new interval is less than the unexpired portion of the current interval. In this case, a scan is scheduled and the new interval value takes immediate effect.
This parameter is valid only on z/OS.
- GROUPUR
- This parameter controls whether CICS
and XA client applications can establish transactions with a GROUP unit of recovery disposition.
The property can be enabled only when the queue manager is a member of a queue sharing group.
- ENABLED
- CICS and XA client applications can establish transactions with a group unit of recovery disposition by specifying a queue sharing group name when they connect.
- DISABLED
- CICS and XA client applications must connect using a queue manager name.
This parameter is valid only on z/OS.
- IGQ
- Specifies whether intra-group queuing is used.
The IGQ parameter is valid only on z/OS when the queue manager is a member of a queue sharing group.
- ENABLED
- Message transfer between queue managers within a queue sharing group uses the shared transmission queue, SYSTEM.QSG.TRANSMIT.QUEUE.
- DISABLED
- Message transfer between queue managers within a queue sharing group uses non-shared transmission queues and channels. Queue managers that are not part of a queue sharing group also use this mechanism.
If intra-group queuing is enabled, but the intra-group queuing agent is stopped, use the following command to restart it:
ALTER QMGR IGQ(ENABLED)
This parameter is valid only on z/OS.
- IGQAUT
- Specifies the type of authority checking and, therefore, the user IDs, to be used by
the IGQ agent (IGQA). This parameter establishes the authority to put messages to a
destination queue.
The IGQAUT parameter is valid only on z/OS when the queue manager is a member of a queue sharing group.
- DEF
- Indicates that the default user ID is used to establish authority to put messages to a
destination queue.
For a one user ID check, the default user ID is the user ID of a queue manager within the queue sharing group. The default user ID is the user ID of the queue manager that put the messages to the SYSTEM.QSG.TRANSMIT.QUEUE. This user ID is referred to as the QSGSEND user ID.
For two user ID checks, the default second user ID is the IGQ user ID.
- CTX
- Indicates that the user ID from a UserIdentifier field is used to establish
authority to put messages to a destination queue. The user ID is the
UserIdentifier field in the message descriptor of a message on the
SYSTEM.QSG.TRANSMIT.QUEUE.
For one user ID check, the QSGSEND user ID is used.
For two user ID checks, the QSGSEND user ID, the IGQ user ID and the alternate user ID are used. The alternate user ID is taken from the UserIdentifier field in the message descriptor of a message on the SYSTEM.QSG.TRANSMIT.QUEUE. The alternate user ID is referred to as ALT.
- ONLYIGQ
- Indicates that only the IGQ user ID is used to establish authority to put
messages to a destination queue.
For all ID checks, the IGQ user ID is used.
- ALTIGQ
- Indicates that the IGQ user ID and the ALT user ID are used to
establish authority to put messages to a destination queue.
For one user ID check, the IGQ user ID is used.
For two user ID checks, the IGQ user ID and the ALT user ID are used.
This parameter is valid only on z/OS.
- IGQUSER
- Nominates a user ID to be used by the IGQ agent (IGQA) to establish
authority to put messages to a destination queue. The user ID is referred to as the
IGQ user ID. This parameter is valid only on z/OS when the queue manager is a member of a queue sharing group. Possible values are:
- Blanks
- Indicates that the user ID of the receiving queue manager within the queue sharing group is used.
- Specific user ID
- Indicates that the user ID specified in the IGQUSER parameter of the receiving queue manager is used.
Note:
- As the receiving queue manager has authority to all queues it can access, security checking might not be performed for this user ID type.
- As the value of blanks has a special meaning, we cannot use IGQUSER to specify a real user ID of blanks.
This parameter is valid only on z/OS.
- IMGINTVL
- The target frequency with which the queue manager automatically writes media images, in minutes
since the previous media image for the object. Possible values are:
- 1 - 999 999 999
- The time in minutes at which the queue manager automatically writes media images.
The default value is 60 minutes.
- OFF
- Automatic media images are not written on a time interval basis.
This parameter is valid only on Multiplatforms.
- IMGLOGLN
- The target size of recovery log, written before the queue manager automatically writes media
images, in number of megabytes since the previous media image for the object. This limits the amount
of log to be read when recovering an object. Possible values are:
- 1 - 999 999 999
- The target size of the recovery log in megabytes.
- OFF
- Automatic media images are not written based on the size of log written.
OFF is the default value.
This parameter is valid only on Multiplatforms.
- IMGRCOVO
- Specifies whether authentication information, channel, client connection, listener, namelist,
process, alias queue, remote queue, and service objects are recoverable from a media image, if
linear logging is being used. Possible values are:
- NO
- The rcdmqimg (record media image) andrcrmqobj (re-create object) commands are not permitted for these objects, and automatic media images, if enabled, are not written for these objects.
- YES
- These objects are recoverable.
YES is the default value.
This parameter is valid only on Multiplatforms.
- IMGRCOVQ
- Specifies the default IMGRCOVQ attribute for local and permanent dynamic
queue objects, when used with this parameter. Possible values are:
- NO
- The IMGRCOVQ attribute for local and permanent dynamic queue objects is set to NO.
- YES
- The IMGRCOVQ attribute for local and permanent dynamic queue objects is set
to YES.
YES is the default value.
This parameter is valid only on Multiplatforms.
- IMGSCHED
- Whether the queue manager automatically writes media images.Possible values are:
- AUTO
- The queue manager attempts to automatically write a media image for an object, before
IMGINTVL minutes have elapsed, or IMGLOGLN megabytes of
recovery log have been written, since the previous media image for the object was taken.
The previous media image might have been taken manually or automatically, depending on the settings of IMGINTVL or IMGLOGLN.
- MANUAL
- Automatic media images are not written.
MANUAL is the default value.
This parameter is valid only on Multiplatforms.
- INHIBTEV
- Specifies whether
inhibit events are generated. The events are generated for Inhibit Get and Inhibit Put.
- ENABLED
- Inhibit events are generated.
- DISABLED
- Inhibit events are not generated.
This is the queue manager's initial default value.
- IPADDRV
- Specifies which IP
protocol is to be used for channel connections.
- IPV4
- The IPv4 IP address is to be used.
This is the queue manager's initial default value.
- IPV6
- The IPv6 IP address is to be used.
This parameter is used only in systems running IPv4 and IPv6. It applies to channels defined only with a TRPTYPE of TCP when either of the following two conditions is true:
- The CONNAME parameter of the channel contains a host name that resolves to both an IPv4 and an IPv6 address, and the LOCLADDR parameter is not specified.
- The value of the CONNAME and LOCLADDR parameters of the channel is a host name that resolves to both an IPv4 and IPv6 address.
- LOCALEV
- Specifies whether
local error events are generated, caused by an application or the queue manager not being able to
access a local queue or other local object, for example, because the object has not been defined:
- ENABLED
- Local error events are generated.
- DISABLED
- Local error events are not generated.
This is the queue manager's initial default value.
- LOGGEREV
- Specifies whether
recovery log events are generated:
- DISABLED
- Logger events are not generated.
This is the queue manager's initial default value.
- ENABLED
- Logger events are generated.
This parameter is valid only on Multiplatforms.
- LSTRTMR(integer)
- The time interval, in seconds, between attempts by IBM MQ to restart a listener after an APPC or TCP/IP failure.
When the listener is restarted on TCP/IP, it uses the same port and IP address as it used when it
first started.
Specify a value in the range 5 through 9999.
Changes to this parameter take effect for listeners that are later started. Listeners that are currently started are unaffected by changes to this parameter.
This parameter is valid only on z/OS.
- LUGROUP(string)
- The generic LU name to be used by the LU 6.2 listener that handles inbound
transmissions for the queue sharing group. The maximum length of this parameter is eight characters.
If this name is blank, the listener cannot be used.
Changes to this parameter take effect for listeners that are later started. Listeners that are currently started are unaffected by changes to this parameter.
This parameter is valid only on z/OS.
- LUNAME(string)
- The name of the LU to use for outbound LU 6.2 transmissions. Set this parameter to be
the same as the name of the LU to be used by the listener for inbound transmissions. The maximum
length of this parameter is eight characters.
If this name is blank, the APPC/MVS default LU name is used. This name is variable, so LUNAME must always be set if we are using LU 6.2
Changes to this parameter take effect when the channel initiator is restarted.
This parameter is valid only on z/OS.
- LU62ARM(string)
- The suffix of the APPCPM member of SYS1.PARMLIB. This suffix nominates the LUADD for
this channel initiator. When automatic restart manager (ARM) restarts the channel initiator, the
z/OS command SET APPC= xx
is issued.
If we do not provide a value for this parameter, no SET APPC= xx command is issued.
The maximum length of this parameter is two characters.
Changes to this parameter take effect when the channel initiator is restarted.
This parameter is valid only on z/OS.
- LU62CHL(integer)
- The maximum number of channels that can be current, or clients that can be connected,
that use the LU 6.2 transmission protocol.
Specify a value 0- 9999 that is not greater than the value of MAXCHL. MAXCHL defines the maximum number of channels available. If you specify zero, the LU 6.2 transmission protocol is not used.
If we change this value, also review the MAXCHL, LU62CHL, and ACTCHL values. Ensure that there is no conflict of values and if necessary, raise the value of MAXCHL and ACTCHL.
If the value of this parameter is reduced, any current channels that exceed the new limit continue to run until they stop.
If the value of LU62CHL is non-zero when the channel initiator starts up, the value can be modified dynamically. If the value of LU62CHL is zero when the channel initiator starts up, a later ALTER command does not take effect. In this case, we should carry out an ALTER command, either before the channel initiator starts, or in CSQINP2 before we issue the START CHINIT command.
This parameter is valid only on z/OS.
- MARKINT(integer)
- The time interval, expressed in milliseconds, for which messages marked as browsed by a call to
MQGET, with the get message option MQGMO_MARK_BROWSE_CO_OP, are
expected to remain mark-browsed.
If messages are marked for more than approximately MARKINT milliseconds, the queue manager might automatically unmark messages. It might unmark messages that are marked as browsed for the cooperating set of handles.
This parameter does not affect the state of any message marked as browse by a call to MQGET with the get message option MQGMO_MARK_BROWSE_HANDLE.
Specify a value up to the maximum of 999,999,999. The default value is 5000.Attention: We should not reduce the value below the default of 5000.The special value NOLIMIT indicates that the queue manager does not automatically unmark messages by this process.
- MAXCHL(integer)
- The maximum number of channels that can be current (including
server-connection channels with connected clients).
Specify a value in the range 1- 9999. If you change this value, also review the TCPCHL, LU62CHL, and ACTCHL values to ensure that there is no conflict of values. If necessary, increase the number of active channels with the ACTCHL value. The values of ACTCHL, LU62CHL, and TCPCHL must not be greater than the maximum number of channels. Suggested settings are:
- Test system: 200
- Production system: 1000
For an explanation of which channel states are considered current; see Channel states.
If the value of this parameter is reduced, any current channels that exceed the new limit continue to run until they stop.
If the value of MAXCHL is reduced to less than its value when the channel initiator was initialized, channels continue to run until they stop. When the number of running channels falls below the value of MAXCHL, more channels can be started. Increasing the value of MAXCHL to more than its value when the channel initiator was initialized does not have immediate effect. The higher value of MAXCHL takes effect at the next channel initiator restart.
Sharing conversations do not contribute to the total for this parameter.
For more information about the relationship between CHIADAPS, CHIDISPS, and MAXCHL, see Tailor the channel initiator parameters.
This parameter is valid only on z/OS.
- MAXHANDS(integer)
- The maximum number
of open handles that any one connection can have at the same time.
This value is a value in the range 0 - 999,999,999.
- MAXMSGL(integer)
- The maximum length of
messages allowed on queues for this queue manager.
This value is in the range 32 KB through 100 MB.
Ensure that you also consider the length of any message properties when deciding the value for the MAXMSGL parameter of a channel.
If you reduce the maximum message length for the queue manager, we must also reduce the maximum message length of the SYSTEM.DEFAULT.LOCAL.QUEUE definition. We must also reduce the maximum message length for all other queues defined on the queue manager. This change ensures that the limit of the queue manager is not less than the limit of any of the queues associated with it. If we do not change these lengths, and applications inquire only the MAXMSGL value of the queue, they might not work correctly.
Note that by adding the digital signature and key to the message, Advanced Message Security increases the length of the message.
- MAXPROPL ( integer )
- The maximum length
of property data in bytes that can be associated with a message.
This value is in the range 0 through 100 MB (104 857 600 bytes).
The special value NOLIMIT indicates that the size of the properties is not restricted, except by the upper limit.
- MAXUMSGS(integer)
- The maximum number of uncommitted messages
within a sync point.
MAXUMSGS is a limit on the number of messages that can be retrieved, plus the number of messages that can be put, within any single sync point. The limit does not apply to messages that are put or retrieved outside sync point.
The number includes any trigger messages and report messages generated within the same unit of recovery.
If existing applications and queue manager processes are putting and getting a larger number of messages in sync point, reducing MAXUMSGS might cause problems.
An example of queue manager processes that might be affected is clustering on z/OS.
Specify a value in the range 1 through 999,999,999. The default value is 10000.
MAXUMSGS has no effect on MQ Telemetry. MQ Telemetry tries to batch requests to subscribe, unsubscribe, send, and receive messages from multiple clients into batches of work within a transaction.
- MONACLS
- Controls the
collection of online monitoring data for auto-defined cluster-sender channels:
- QMGR
- Collection of online monitoring data is inherited from the setting of the
MONCHL parameter of the queue manager.
This is the queue manager's initial default value.
- OFF
- Monitor for the channel is disabled.
- LOW
- Unless MONCHL is NONE, monitoring is enabled with a low rate of data collection with a minimal effect on system performance. The data collected is not likely to be the most current.
- MEDIUM
- Unless MONCHL is NONE, monitoring is enabled with a moderate rate of data collection with limited effect on system performance.
- HIGH
- Unless MONCHL is NONE, monitoring is enabled with a high rate of data collection with a likely effect on system performance. The data collected is the most current available.
A change to this parameter takes effect only on channels started after the change occurs. Any channel started before the change to the parameter continues with the value in force at the time that the channel started.
- MONCHL
- Controls the
collection of online monitoring data for channels. The channels defined with
MONCHL(QMGR) are affected by changing the QMGR
MONCHL attribute.
- OFF
- Online monitoring data collection is turned off for channels specifying a value of
QMGR in their MONCHL parameter.
This is the queue manager's initial default value.
- NONE
- Online monitoring data collection is turned off for channels regardless of the setting of their MONCHL parameter.
- LOW
- Online monitoring data collection is turned on, with a low ratio of data collection, for channels specifying a value of QMGR in their MONCHL parameter.
- MEDIUM
- Online monitoring data collection is turned on, with a moderate ratio of data collection, for channels specifying a value of QMGR in their MONCHL parameter.
- HIGH
- Online monitoring data collection is turned on, with a high ratio of data collection, for channels specifying a value of QMGR in their MONCHL parameter.
A change to this parameter takes effect only on channels started after the change occurs. Any channel started before the change to the parameter continues with the value in force at the time that the channel started.
- MONQ
- Controls the collection
of online monitoring data for queues.
- OFF
- Online monitoring data collection is turned off for queues specifying a value of
QMGR in their MONQ parameter.
This is the queue manager's initial default value.
- NONE
- Online monitoring data collection is turned off for queues regardless of the setting of their MONQ parameter.
- LOW
- Online monitoring data collection is turned on for queues specifying a value of QMGR in their MONQ parameter.
- MEDIUM
- Online monitoring data collection is turned on for queues specifying a value of QMGR in their MONQ parameter.
- HIGH
- Online monitoring data collection is turned on for queues specifying a value of QMGR in their MONQ parameter.
In contrast to MONCHL, there is no distinction between the values LOW, MEDIUM, and HIGH. These values all turn data collection on, but do not affect the rate of collection.
Changes to this parameter are effective only for queues opened after the parameter is changed.
- OPORTMAX(integer)
- The maximum value in the range of port numbers to be used when binding outgoing
channels. When all the port numbers in the specified range are used, outgoing channels bind to any
available port number.
Specify a value in the range 0 - 65535. A value of zero means that all outgoing channels bind to any available port number.
Specify a corresponding value for OPORTMIN to define a range of port numbers. Ensure that the value you specify for OPORTMAX is greater than or equal to the value you specify for OPORTMIN.
Changes to this parameter take effect for channels that are later started. Channels that are currently started are unaffected by changes to this parameter.
This parameter is valid only on z/OS.
- OPORTMIN(integer)
- The minimum value in the range of port numbers to be used when binding outgoing
channels. When all the port numbers in the specified range are used, outgoing channels bind to any
available port number.
Specify a value in the range 0 - 65535.
Specify a corresponding value for OPORTMAX to define a range of port numbers. Ensure that the value you specify for OPORTMIN is less than or equal to the value you specify for OPORTMAX.
Changes to this parameter take effect for channels that are later started. Channels that are currently started are unaffected by changes to this parameter.
This parameter is valid only on z/OS.
- PARENT(parentname)
- The name of the parent
queue manager to which the local queue manager is to connect as its child in a hierarchy.
A blank value indicates that the queue manager has no parent queue manager.
If there is an existing parent queue manager it is disconnected.
IBM MQ hierarchical connections require that the queue manager attribute PSMODE is set to ENABLED.
The value of PARENT can be set to a blank value if PSMODE is set to DISABLED.
Before a queue manager can connect to a queue manager as its child in a hierarchy, channels must exist in both directions. The channels must exist between the parent queue manager and the child queue manager.
If a parent is already defined, the ALTER QMGR PARENT command disconnects from the original parent and sends a connection flow to the new parent queue manager.
Successful completion of the command does not mean that the action completed. To check that this command has completed, see the ALTER QMGR step in Check that async commands for distributed networks have finished.
- PERFMEV
- Specifies whether performance-related events are generated:
- ENABLED
- Performance-related events are generated.
- DISABLED
- Performance-related events are not generated.
This is the queue manager's initial default value.
On IBM MQ for z/OS, all the queue managers in a queue sharing group must have the same setting.
- PSCLUS
- Controls whether this queue manager participates in publish subscribe activity across any clusters in which it is a member. No clustered topic objects can exist in any cluster when modifying from ENABLED to DISABLED.
- For more information about PSCLUS, see Inhibiting clustered publish/subscribe.
- Note: To change a PSCLUS parameter status, the CHIN address space needs to be running.
-
- ENABLED
- This queue manager can define clustered topic objects, publish to subscribers on other queue managers, and register subscriptions that receive publications from other queue managers. All queue managers in the cluster running a version of IBM MQ that supports this option must specify PSCLUS(ENABLED) for the publish/subscribe activity to function as expected. ENABLED is the default value when a queue manager is created.
- DISABLED
- This queue manager cannot define clustered topic objects and ignores their definition on any other queue manager in the cluster.
- Publications are not forwarded to subscribers elsewhere in the cluster, and subscriptions are not registered other than on the local queue manager.
- To ensure that no publish/subscribe activity occurs in the cluster, all queue managers must specify PSCLUS(DISABLED). As a minimum, full repositories must be consistent in enabling or disabling publish/subscribe participation.
- PSMODE
- Controls whether the
publish/subscribe engine and the queued publish/subscribe interface are running. It controls whether
applications can publish or subscribe by using the application programming interface. It also
controls whether the queues that are monitored by the queued publish/subscribe interface, are
monitored. Changing the PSMODE attribute can change the
PSMODE status. Use one of the following commands to determine the current state
of the publish/subscribe engine and the queued publish/subscribe interface:
- DISPLAY PUBSUB
- DSPMQM (on IBM i only)
- COMPAT
- The publish/subscribe engine is running. It is therefore possible to publish or subscribe by
using the application programming interface.
The queued publish/subscribe interface is not running. Any publish/subscribe messages put to the queues that are monitored by the queued publish/subscribe interfaces are not acted upon.
Use this setting for compatibility with IBM Integration Bus (formerly known as WebSphere Message Broker) V6 or earlier versions that use this queue manager.
- DISABLED
- The publish/subscribe engine and the queued publish/subscribe interface are not running. It is
therefore not possible to publish or subscribe by using the application programming interface. Any
publish/subscribe messages put to the queues that are monitored by the queued publish/subscribe
interfaces are not acted upon.
If a queue manager is in a publish/subscribe cluster or hierarchy, it might receive publish/subscribe messages from other queue managers in the cluster or hierarchy. Examples of such messages are publication messages or proxy subscriptions. While PSMODE is set to DISABLED those messages are not processed. For this reason, disable any queue manager in a publish/subscribe cluster or hierarchy only for as long as there is little build-up of messages.
- ENABLED
- The publish/subscribe engine and the queued publish/subscribe interface are running. It is
therefore possible to publish or subscribe by using the application programming interface and the
queues that are being monitored by the queued publish/subscribe interface.
This is the queue manager's initial default value.
Note: If a queue manager is in a publish/subscribe cluster or hierarchy, and we change PSMODE to ENABLED, you might have to run the command REFRESH QMGR TYPE(PROXY). The command ensures that non-durable subscriptions are known across the cluster or hierarchy when PSMODE is set back to ENABLED. The circumstance in which we must run the command is as follows. If PSMODE is changed from ENABLED to DISABLED and back to ENABLED, and one or more non-durable subscriptions exist across all three stages.
- PSNPMSG
- If the queued
publish/subscribe interface cannot process a non-persistent input message it might attempt to write
the input message to the dead-letter queue. Whether it attempts to do so depends on the report
options of the input message. The attempt to write the input message to the dead-letter queue might
fail. In this case, the queued publish/subscribe interface might discard the input message. If
MQRO_DISCARD_MSG is specified on the input message, the input message is discarded.
If MQRO_DISCARD_MSG is not set, setting PSNPMSG to
KEEP prevents the input message from being discarded. The default is to discard the
input message. Note: If you specify a value of IFPER for
PSSYNCPT, we must not specify a value of KEEP for
PSNPMSG.
- DISCARD
- Non-persistent input messages might be discarded if they cannot be processed.
- KEEP
- Non-persistent input messages are not discarded if they cannot be processed. In this situation, the queued publish/subscribe interface continues to try to process this message again at appropriate intervals and does not continue processing subsequent messages.
- PSNPRES
- The
PSNPRES attribute controls whether the queued publish/subscribe interface
writes an undeliverable reply message to the dead-letter queue, or discards the message. The choice
is necessary if the queued publish/subscribe interface cannot deliver a reply message to the
reply-to queue.
For new queue managers, the initial value is NORMAL. If you specify a value of IFPER for PSSYNCPT, we must not specify a value of KEEP or SAFE for PSNPRES.
For migrated queue managers on Multiplatforms, the value depends on DLQNonPersistentResponse and DiscardNonPersistentResponse.
- NORMAL
- Non-persistent responses which cannot be placed on the reply queue are put on the dead-letter queue. If they cannot be placed on the dead-letter queue then they are discarded.
- SAFE
- Non-persistent responses which cannot be placed on the reply queue are put on the dead-letter queue. If the response cannot be sent and cannot be placed on the dead-letter queue, the queued publish/subscribe interface backs out of the current operation. It tries again at appropriate intervals, and does not continue processing subsequent messages.
- DISCARD
- Non-persistent responses which cannot be placed on the reply queue are discarded
- KEEP
-
Non-persistent responses are not placed on the dead-letter queue or discarded. Instead the queued publish/subscribe interface backs out the current operation and then tries it again at appropriate intervals and does not continue processing subsequent messages.
- PSRTYCNT
- If the queued
publish/subscribe interface fails to process a command message under sync point, the unit of work is
backed out. The command tries to process the message a number of times again, before the
publish/subscribe broker processes the command message according to its report options instead. This
situation can arise for a number of reasons. For example, if a publish message cannot be delivered
to a subscriber, and it is not possible to put the publication on the dead letter queue.
The initial value for this parameter on a new queue manager is 5.
Range is 0 - 999,999,999.
- PSSYNCPT
- Controls whether the
queued publish/subscribe interface processes command messages (publishes or delete publication
messages) under sync point.
- YES
- All messages are processed under sync point.
- IFPER
- Only persistent messages are part of the sync point
The initial value of the queue manager is IFPER.
- RCVTIME ( integer )
- The approximate length of time that a TCP/IP channel waits to receive data, including
heartbeats, from its partner before returning to the inactive state. This parameter applies only to
message channels and not to MQI channels. This number can be qualified as follows:
- To specify that this number is a multiplier to apply to the negotiated HBINT value to determine how long a channel is to wait, set RCVTTYPE to MULTIPLY. Specify a RCVTIME value of zero or in the range 2 through 99. If you specify zero, the channel continues to wait indefinitely to receive data from its partner.
- To specify that RCVTIME is the number of seconds to add to the negotiated HBINT value to determine how long a channel is to wait, set RCVTTYPE to ADD. Specify an RCVTIME value in the range 1 through 999999.
- To specify that RCVTIME is a value, in seconds, that the channel is to wait, set RCVTTYPE to EQUAL. Specify an RCVTIME value in the range 0 - 999,999. If you specify zero, the channel continues to wait indefinitely to receive data from its partner.
Changes to this parameter take effect for channels that are later started. Channels that are currently started are unaffected by changes to this parameter.
For more information, see Check that the other end of the channel is still available.
This parameter is valid only on z/OS.
- RCVTMIN(integer)
- The minimum length of time that a TCP/IP channel waits to receive data, including
heartbeats, from its partner before returning to an inactive state. This parameter applies only to
message channels (and not to MQI channels).
The TCP/IP channel wait time can be configured relative to the negotiated value of HBINT. If RCVTTYPE is MULTIPLY or ADD, the resultant value might be less than the value set in RCVTMIN. In this case, the TCP/IP channel wait time is set to RCVTMIN. If RCVTTYPE is EQUAL then RCVTMIN does not apply.
Specify a value, in seconds, between zero and 999999.
Changes to this parameter take effect for channels that are later started. Channels that are currently started are unaffected by changes to this parameter.
For more information, see Check that the other end of the channel is still available.
This parameter is valid only on z/OS.
- RCVTTYPE
- The qualifier to apply to the value in RCVTIME.
- MULTIPLY
- Specifies that RCVTIME is a multiplier to be applied to the negotiated HBINT value to determine how long a channel waits.
- ADD
- Specifies that RCVTIME is a value, in seconds, to be added to the negotiated HBINT value to determine how long a channel waits.
- EQUAL
- Specifies that RCVTIME is a value, in seconds, representing how long the channel waits.
Changes to this parameter take effect for channels that are later started. Channels that are currently started are unaffected by changes to this parameter.
For more information, see Check that the other end of the channel is still available.
This parameter is valid only on z/OS.
- REMOTEEV
- Specifies whether remote error events are generated, caused by an application or the
queue manager not being able to access a remote queue on another queue manager, for example, the
transmission queue not being correctly defined:
- DISABLED
- Remote error events are not generated.
This is the queue manager's initial default value.
- ENABLED
- Remote error events are generated.
If we are using the reduced function form of IBM MQ for z/OS supplied with WebSphere Application Server, only DISABLED is valid.
- REPOS(clustername)
- The name of a cluster for which this queue manager provides a repository manager
service. The maximum length is 48 characters conforming to the rules for naming IBM MQ objects.
We can specify either the REPOS or the REPOSNL parameter, but not both. If both REPOS and REPOSNL are blank, the queue manager does not have a full repository.
If we use the REPOS parameter to create a full repository queue manager, connect it to at least one other full repository queue manager in the cluster. Connect it using a cluster-sender channel. See the information in Components of a cluster for details about using cluster-sender channels with full repository queue managers.
Successful completion of the command does not mean that the action completed. To check for true completion, see the ALTER QMGR step in Check that async commands for distributed networks have finished.
- REPOSNL(nlname)
- The name of a namelist of clusters for which this queue manager provides a repository
manager service.
We can specify either the REPOS or the REPOSNL parameter, but not both.
Both REPOS and REPOSNL might be blank, or REPOS might be blank and the namelist specified by REPOSNL is empty. In these cases, this queue manager does not have a full repository. It might be a client of other repository services that are defined in the cluster.
If we use the REPOSNL parameter to create a full repository queue manager, connect it to other full repository queue managers. Connect it to at least one other full repository queue manager in each cluster specified in the namelist using cluster-sender channels. See the information in Components of a cluster for details about using cluster-sender channels with full repository queue managers.
Successful completion of the command does not mean that the action completed. To check for true completion, see the ALTER QMGR step in Check that async commands for distributed networks have finished.
- REVDNS
- Controls whether
reverse lookup of the host name from a Domain Name Server (DNS) is done for the IP address from
which a channel has connected. This attribute has an effect only on channels using a transport type
(TRPTYPE) of TCP:
- ENABLED
- DNS host names are reverse looked-up for the IP addresses of inbound channels when this
information is required. This setting is required for matching against CHLAUTH rules that contain
host names, and to include the host name in error messages. The IP address is still included in
messages that provide a connection identifier.
This is the initial default value for the queue manager.
- DISABLED
- DNS host names are not reverse looked-up for the IP addresses of inbound channels. With this setting any CHLAUTH rules using host names are not matched.
- ROUTEREC
- Specifies whether
trace-route information is recorded if requested in the message. If this parameter is not set to
DISABLED, it controls whether any reply generated is sent to
SYSTEM.ADMIN.TRACE.ROUTE.QUEUE, or to the destination specified by the message
itself. If ROUTEREC is not DISABLED, messages not yet at the
final destination might have information added to them.
- DISABLED
- Trace-route information is not recorded.
- MSG
- Trace-route information is recorded and sent to the destination specified by the originator of
the message causing the trace route record.
This is the queue manager's initial default value.
- QUEUE
- Trace-route information is recorded and sent to SYSTEM.ADMIN.TRACE.ROUTE.QUEUE.
- SCHINIT
- Specifies whether the
channel initiator starts automatically when the queue manager starts.
- QMGR
- The channel initiator starts automatically when the queue manager starts.
- MANUAL
- The channel initiator does not start automatically.
This parameter is valid only on Multiplatforms.
- SCMDSERV
- Specifies whether
the command server starts automatically when the queue manager starts.
- QMGR
- The command server starts automatically when the queue manager starts.
- MANUAL
- The command server does not start automatically.
This parameter is valid only on Multiplatforms.
- SCYCASE
- Specifies whether the security profiles are uppercase or mixed case.
- UPPER
- The security profiles are uppercase only. However, MXTOPIC and GMXTOPIC are used for topic security, and can contain mixed-case profiles.
- MIXED
- The security profiles are mixed case. MQCMDS and MQCONN are used for command and connection security but they can contain only uppercase profiles.
Changes to SCYCASE become effective after you run the following command:
REFFRESH SECURITY(*) TYPE(CLASSES)
This parameter is valid only on z/OS.
- SQQMNAME
- The SQQMNAME attribute specifies whether a queue manager in a
queue sharing group opens a shared queue in the same group directly. The processing queue manager
calls MQOPEN for a shared queue and sets the ObjectQmgrName
parameter for the queue. If the shared queue is in the same queue sharing group as the processing
queue manager, the queue can be opened directly by the processing queue manager. Set the
SQQMNAME attribute to control if the queue is opened directly, or by the
ObjectQmgrName queue manager. The attribute will also be honored when opening a
QALIAS with copy disposition, if the target queue is a shared queue in the same queue sharing group
as the processing queue manager. In this situation it is important that the QALIAS copy object on
each queue manager in the queue sharing group has the same target queue.
- USE
- The ObjectQmgrName is used, and the appropriate transmission queue is opened.
- IGNORE
- The processing queue manager opens the shared queue directly. Setting the parameter to this value can reduce the traffic in your queue manager network.
This parameter is valid only on z/OS.
- SSLCRLNL ( nlname )
-
The name of a namelist of authentication information objects which are used to provide
certificate revocation locations to allow enhanced TLS certificate checking.Attention: The namelist can reference a maximum of one OCSP type AUTHINFO object only.
From IBM MQ Version 9.2.0, if more than one OCSP type AUTHINFO objects is referenced in the NAMELIST, only the first entry will be used.
If SSLCRLNL is blank, certificate revocation checking is not invoked unless one of the TLS certificates used contains an AuthorityInfoAccess or CrlDistributionPoint X.509 certificate extension.
Changes to SSLCRLNL, or to the names in a previously specified namelist, or to previously referenced authentication information objects become effective as follows:- When a REFRESH SECURITY TYPE(SSL) command is issued.
- On UNIX, Linux, and Windows:
- When a new channel process is started
- For channels that run as threads of the channel initiator, when the channel initiator is restarted
- For channels that run as threads of the listener, when the listener is restarted
- On IBM i:
- When a new channel process is started
- For channels that run as threads of the channel initiator, when the channel initiator is restarted
- For channels that run as threads of the listener, when the listener is restarted
On IBM i queue managers, this parameter is ignored. However, it is used to determine which authentication information objects are written to the AMQCLCHL.TAB file.
- On z/OS, when the channel initiator is restarted.
Only authentication information objects with types of LDAPCRL or OCSP are allowed in the namelist referred to by SSLCRLNL. Any other type results in an error message when the list is processed and is subsequently ignored.
- SSLCRYP(string)
- Sets the name of the parameter string required to configure the cryptographic hardware present
on the system. All supported cryptographic hardware supports the PKCS #11 interface. Specify a
string of the following format:
GSK_PKCS11= the PKCS #11 driver path and file name> ; the PKCS #11 token label> ; the PKCS #11 token password> ; symmetric cipher setting> ;
The PKCS #11 driver path is an absolute path to the shared library providing support for the PKCS #11 card. The PKCS #11 driver file name is the name of the shared library. An example of the value required for the PKCS #11 driver path and file name is /usr/lib/pkcs11/PKCS11_API.so To access symmetric cipher operations through GSKit, specify the symmetric cipher setting parameter. The value of this parameter is either:- SYMMETRIC_CIPHER_OFF
- Do not access symmetric cipher operations.
- SYMMETRIC_CIPHER_ON
- Access symmetric cipher operations.
If the symmetric cipher setting parameter is not specified, it has the same effect as specifying SYMMETRIC_CIPHER_OF F.
The maximum length of the string is 256 characters.
If you specify a string that is not in the format listed, you get an error.
When the SSLCRYP value is changed, the cryptographic hardware parameters specified become the ones used for new TLS connection environments. The new information becomes effective:- When a new channel process is started.
- For channels that run as threads of the channel initiator, when the channel initiator is restarted.
- For channels that run as threads of the listener, when the listener is restarted.
- When a REFRESH SECURITY TYPE(SSL) command is issued.
- SSLEV
- Specifies whether TLS events are generated.
- DISABLED
- TLS events are not generated.
This is the queue manager's initial default value.
- ENABLED
- All TLS events are generated.
- SSLFIPS
- SSLFIPS specifies whether only FIPS-certified algorithms are to be used if
cryptography is carried out in IBM MQ, rather than in
cryptographic hardware. If cryptographic hardware is configured, the cryptographic modules used are
those modules provided by the hardware product. These might, or might not, be FIPS-certified to a
particular level. Whether the modules are FIPS-certified depends on the hardware product in use. For
more information about FIPS, see the Federal Information Processing Standards (FIPS) manual.
- NO
- If you set SSLFIPS to NO, we can use either FIPS
certified or non-FIPS certified CipherSpecs.
If the queue manager runs without using cryptographic hardware, refer to the CipherSpecs listed in Specify CipherSpecs.
This is the queue manager's initial default value.
- YES
- Specifies that only FIPS-certified algorithms are to be used in the CipherSpecs allowed on all
TLS connections from and to this queue manager.
For a listing of appropriate FIPS 140-2 certified CipherSpecs; see Specify CipherSpecs.
Changes to SSLFIPS become effective as follows:
- On UNIX, Linux, and Windows:
- when a REFRESH SECURITY TYPE(SSL) command is issued
- when a new channel process is started
- for channels that run as threads of the channel initiator, when the channel initiator is restarted
- for channels that run as threads of the listener, when the listener is restarted
- for channels that run as threads of a process pooling process, when the process pooling process is started or restarted and first runs a TLS channel. If the process pooling process has already run a TLS channel, and we want the change to become effective immediately, run the MQSC command REFRESH SECURITY TYPE(SSL). The process pooling process is amqrmppa
- On z/OS, when the channel initiator is restarted.
This parameter is valid on z/OS, UNIX, Linux, and Windows.
- SSLKEYR(string)
- The name of the Secure Sockets Layer key repository. The maximum length of the string is 256 characters. The format of the name depends on the environment.
-
On z/OS, the name is the name of a key ring.
On Multiplatforms, the name is in stem format, which means that it includes the full path and the file name without an extension:- On IBM i, the name is of the form
pathname/keyfile, where keyfile is
specified without the suffix .kdb, and identifies a GSKit key database file.
- If you specify *SYSTEM, IBM MQ uses the system certificate store as the key repository for the queue manager. The queue manager is registered as a server application in the Digital Certificate Manager (DCM). We can assign any server/client certificate in the system store to the queue manager, because you registered it as a server application.
- If we change the SSLKEYR parameter to a value other than *SYSTEM, IBM MQ unregisters the queue manager as an application with DCM.
- On UNIX and Linux, the name is of the form pathname/keyfile where keyfile is specified without the suffix .kdb and identifies a GSKit CMS key database file.
- On Windows, the name is of the form pathname\keyfile where keyfile is specified without the suffix .kdb and identifies a GSKit CMS key database file.
On Multiplatforms, the syntax of this parameter is validated to ensure that it contains a valid and absolute directory path.
If SSLKEYR is blank, channels using TLS do not start. If SSLKEYR is set to a value that does not correspond to a key ring or key database file, channels using TLS also do not start.
Changes to SSLKEYR become effective as follows:- When a REFRESH SECURITY TYPE(SSL) command is issued.
- On Multiplatforms:
- When a new channel process is started.
- For channels that run as threads of the channel initiator, when the channel initiator is restarted.
- For channels that run as threads of the listener, when the listener is restarted.
- For channels that run as threads of a process pooling process, amqrmppa, when the process pooling process is started or restarted and first runs a TLS channel. If the process pooling process has already run a TLS channel, and we want the change to become effective immediately, run the MQSC command REFRESH SECURITY TYPE(SSL).
- On z/OS, when the channel initiator is restarted.
- On IBM i, the name is of the form
pathname/keyfile, where keyfile is
specified without the suffix .kdb, and identifies a GSKit key database file.
- SSLRKEYC(integer)
- The number of bytes to be sent and received within an TLS conversation before the secret key is
renegotiated. The number of bytes includes control information.
SSLRKEYC is used only by TLS channels which initiate communication from the queue manager. For example, the sender channel initiates communication in a sender and receiver channel pairing.
If a value greater than zero is specified, the secret key is also renegotiated before message data is sent or received following a channel heartbeat. The count of bytes until the next secret key renegotiation is reset after each successful renegotiation.
Specify a value in the range 0 - 999,999,999. A value of zero means that the secret key is never renegotiated. If you specify an TLS secret key reset count in the range 1 - 32767 bytes (32 KB), TLS channels use a secret key reset count of 32 KB. The larger reset count value avoids the cost of excessive key resets which would occur for small TLS secret key reset values.
Attention: Non-zero values less than 4096 (4 KB) might cause channels to fail to start, or might cause inconsistencies in the values of SSLKEYDA, SSLKEYTI, and SSLRKEYS. - SSLTASKS(integer)
- The number of server subtasks to use for processing TLS calls. To use TLS channels, we must
have at least two of these tasks running.
This value is in the range 0 - 9999. To avoid problems with storage allocation, do not set the SSLTASKS parameter to a value greater than 50.
Changes to this parameter are effective when the channel initiator is restarted.
This parameter is valid only on z/OS.
- STATACLS
- Specifies whether statistics data is to be collected for auto-defined cluster-sender channels:
- QMGR
- Collection of statistics data is inherited from the setting of the STATCHL
parameter of the queue manager.
This is the queue manager's initial default value.
- OFF
- Statistics data collection for the channel is disabled.
- LOW
- Unless STATCHL is NONE, statistics data collection is switched on with a low ratio of data collection with a minimal effect on system performance.
- MEDIUM
- Unless STATCHL is NONE, statistics data collection is switched on with a moderate ratio of data collection.
- HIGH
- Unless STATCHL is NONE, statistics data collection is switched on with a high ratio of data collection.
A change to this parameter takes effect only on channels started after the change occurs. Any channel started before the change to the parameter continues with the value in force at the time that the channel started.
On z/OS systems, enabling this parameter simply turns on statistics data collection, regardless of the value you select. Specifying LOW, MEDIUM, or HIGH makes no difference to your results. This parameter must be enabled in order to collect channel accounting records.
- STATCHL
- Specifies whether statistics data is to be collected for channels:
- NONE
- Statistics data collection is turned off for channels regardless of the setting of their STATCHL parameter.
- OFF
- Statistics data collection is turned off for channels specifying a value of
QMGR in their STATCHL parameter.
This is the queue manager's initial default value.
- LOW
- Statistics data collection is turned on, with a low ratio of data collection, for channels specifying a value of QMGR in their STATCHL parameter.
- MEDIUM
- Statistics data collection is turned on, with a moderate ratio of data collection, for channels specifying a value of QMGR in their STATCHL parameter.
- HIGH
- Statistics data collection is turned on, with a high ratio of data collection, for channels specifying a value of QMGR in their STATCHL parameter.
A change to this parameter takes effect only on channels started after the change occurs. Any channel started before the change to the parameter continues with the value in force at the time that the channel started.
On z/OS systems, enabling this parameter simply turns on statistics data collection, regardless of the value you select. Specifying LOW, MEDIUM, or HIGH makes no difference to your results. This parameter must be enabled in order to collect channel accounting records.
- STATINT(integer)
- The time interval, in
seconds, at which statistics monitoring data is written to the monitoring queue.
Specify a value in the range 1 through 604800.
Changes to this parameter take immediate effect on the collection of monitoring and statistics data.
This parameter is valid only on Multiplatforms.
- STATMQI
- Specifies whether
statistics monitoring data is to be collected for the queue manager:
- OFF
- Data collection for MQI statistics is disabled.
This is the queue manager's initial default value.
- ON
- Data collection for MQI statistics is enabled.
Changes to this parameter take immediate effect on the collection of monitoring and statistics data.
This parameter is valid only on Multiplatforms.
- STATQ
- Specifies whether
statistics data is to be collected for queues:
- NONE
- Statistics data collection is turned off for queues regardless of the setting of their STATQ parameter.
- OFF
- Statistics data collection is turned off for queues specifying a value of QMGR or OFF in their STATQ parameter. OFF is the default value.
- ON
- Statistics data collection is turned on for queues specifying a value of QMGR or ON in their STATQ parameter.
Statistics messages are generated only for queues which are opened after statistics collection is enabled. You do not need to restart the queue manager for the new value of STATQ to take effect.
This parameter is valid only on Multiplatforms.
- STRSTPEV
- Specifies whether
start and stop events are generated:
- ENABLED
- Start and stop events are generated.
This is the queue manager's initial default value.
- DISABLED
- Start and stop events are not generated.
- SUITEB
- Specifies whether
Suite B-compliant cryptography is used and what strength is required.
- NONE
- Suite B is not used. NONE is the default
- 128_BIT
- Suite B 128-bit level security is used.
- 192_BIT
- Suite B 192-bit level security is used
- 128_BIT,192_BIT
- Both Suite B 128-bit and 192-bit level security is used
- TCPCHL(integer)
- The maximum number of channels that can be current, or clients that can be connected,
that use the TCP/IP transmission protocol.
The maximum number of sockets used is the sum of the values in TCPCHL and CHIDISPS. The z/OS UNIX System Services MAXFILEPROC parameter (specified in the BPXPRMxx member of SYS1.PARMLIB ) controls how many sockets each task is allowed, and thus how many channels each dispatcher is allowed. In this case, the number of channels using TCP/IP is limited to the value of MAXFILEPROC multiplied by the value of CHIDISPS.
Specify a value 0-9999. The value must not be greater than the value of MAXCHL. MAXCHL defines the maximum number of channels available. TCP/IP might not support as many as 9999 channels. If so, the value we can specify is limited by the number of channels TCP/IP can support. If you specify zero, the TCP/IP transmission protocol is not used.
If we change this value, also review the MAXCHL, LU62CHL, and ACTCHL values to ensure that there is no conflict of values. If necessary, raise the value of MAXCHL and ACTCHL.
If the value of this parameter is reduced, any current channels that exceed the new limit continue to run until they stop.
Sharing conversations do not contribute to the total for this parameter.
If the value of TCPCHL is non-zero when the channel initiator starts up, the value can be modified dynamically. If the value of TCPCHL is zero when the channel initiator starts up, a later ALTER command does not take effect. In this case, we should carry out an ALTER command, either before the channel initiator starts, or in CSQINP2 before we issue the START CHINIT command.
This parameter is valid only on z/OS.
- TCPKEEP
- Specifies whether the KEEPALIVE facility is to be used to check
that the other end of the connection is still available. If it is unavailable, the channel is closed.
- NO
- The TCP KEEPALIVE facility is not to be used.
This is the queue manager's initial default value.
- YES
- The TCP KEEPALIVE facility is to be used as specified in the TCP profile configuration data set. The interval is specified in the KAINT channel attribute.
Changes to this parameter take effect for channels that are later started. Channels that are currently started are unaffected by changes to this parameter.
This parameter is valid only on z/OS.
Using the TCPKEEP parameter is no longer required for 'modern' queue managers. The replacement is a combination of:- using 'modern' client channels (SHARECNV <> 0)
- using receive timeout for message channels RCVTIME.
For more information, see the technote Set the TCP/IP KeepAlive interval to be used by IBM MQ, at: https://www.ibm.com/support/pages/node/342737
- TCPNAME(string)
- The name of either the only, or preferred, TCP/IP stack to be used, depending on the
value of TCPSTACK. This name is the name of the z/OS
UNIX System Services stack for TCP/IP, as specified
in the SUBFILESYSTYPE NAME parameter in the
BPXPRMxx member of SYS1.PARMLIB.
TCPNAME is only applicable in CINET multiple stack environments. The queue
manager's initial default value is TCPIP.
In INET single stack environments the channel initiator uses the only available TCP/IP stack.
The maximum length of this parameter is eight characters.
Changes to this parameter take effect when the channel initiator is restarted.
This parameter is valid only on z/OS.
- TCPSTACK
- Specifies whether the channel initiator can use only the TCP/IP stack specified in
TCPNAME, or optionally bind to any selected TCP/IP stack defined. This
parameter is only applicable in CINET multiple stack environments.
- SINGLE
- The channel initiator can use only the TCP/IP address space specified in TCPNAME.
- MULTIPLE
- The channel initiator can use any TCP/IP address space available to it.
Changes to this parameter take effect when the channel initiator is restarted.
This parameter is valid only on z/OS.
- TRAXSTR
- Specifies whether the channel initiator trace starts automatically:
- YES
- Channel initiator trace is to start automatically.
- NO
- Channel initiator trace is not to start automatically.
Changes to this parameter take effect when the channel initiator is restarted. If we want to start or stop channel initiator trace without restarting the channel initiator, use the START TRACE or STOP TRACE commands after starting the channel initiator.
This parameter is valid only on z/OS.
- TRAXTBL(integer)
- The size, in megabytes, of the trace data space of the channel initiator.
Specify a value in the range 2 through 2048.
Note:- Changes to this parameter take effect immediately; any existing trace table contents are lost.
- The CHINIT trace is stored in a dataspace called qmidCHIN.CSQXTRDS. When we use large z/OS data spaces, ensure that sufficient auxiliary storage is available on the system to support any related z/OS paging activity. We might also need to increase the size of our SYS1.DUMP data sets.
This parameter is valid only on z/OS.
- TREELIFE ( integer )
- The lifetime, in
seconds of non-administrative topics.
Non-administrative topics are those topics created when an application publishes to, or subscribes on, a topic string that does not exist as an administrative node. When this non-administrative node no longer has any active subscriptions, this parameter determines how long the queue manager waits before removing that node. Only non-administrative topics that are in use by a durable subscription remain after the queue manager is recycled.
Specify a value in the range 0 through 604000. A value of 0 means that non-administrative topics are not removed by the queue manager.
- TRIGINT(integer)
- A time interval expressed in milliseconds.
The TRIGINT parameter is relevant only if the trigger type (TRIGTYPE) is set to FIRST (see DEFINE QLOCAL for details). In this case trigger messages are normally generated only when a suitable message arrives on the queue, and the queue was previously empty. Under certain circumstances, however, an additional trigger message can be generated with FIRST triggering even if the queue was not empty. These additional trigger messages are not generated more often than every TRIGINT milliseconds; see Special case of trigger type FIRST.
Specify a value in the range 0 - 999,999,999.
Parent topic: MQSC commands
Related information