Summary of qm.ini file stanzas and attributes

A summary of the attributes of the stanzas of the queue manager configuration file, qmi.ini, with links to more information.

Table 1. Stanzas of the qm.ini file

Stanza and attributes	Description of attributes
AccessMode stanza
access group 1	A Windows security group, members of which will be granted full access to all queue manager data files.
ApiExitLocal stanza
Name	The descriptive name of the API exit passed to it in the ExitInfoName field of the MQAXP structure.
Function	The name of the function entry point into the module containing the API exit code.
Module	The module containing the API exit code.
Data	Data to be passed to the API exit in the ExitData field of the MQAXP structure.
Sequence	The sequence in which this API exit is called relative to other API exits.
AuthToken stanza
KeyStore	File path for the keystore that contains the trusted issuer's public key certificates or symmetric keys.
KeyStorePwdFile	File path for the file that contains the encrypted password for the keystore.
CertLabel	The certificate label for a public key certificate or symmetric key in the keystore that is used to validate authentication tokens.
UserClaim	Claim within the token that contains user identity information that the queue manager can adopt for authorization checks.
AllowOSGroups	This attribute determines whether the group membership for the adopted user is checked or not.
AutoCluster stanza
Type	The type of automatic cluster. The only valid option is Uniform, which represents a uniform cluster.
ClusterName	The name of the automatic cluster.
RepositoryName1	The queue manager name for the first full repository in the automatic cluster.
Repository1Conname	The connection name (CONNAME) value for how members of the automatic cluster should connect to the queue manager.
RepositoryName2	The queue manager name for the second full repository in the automatic cluster.
Repository2Conname	The connection name (CONNAME) value for how members of the automatic cluster should connect to the queue manager.
AutoConfig stanza
MQSCConfig	Either a full file path, or path to a directory, where all *.mqsc files are applied to the queue manager on every queue manager start.
IniConfig	Either a full file path, or path to a directory, where all *.ini file are applied to the qm.ini file on every queue manager start.
Channels stanza
MaxChannels	The maximum number of current channels allowed.
MaxActiveChannels	The maximum number of channels allowed to be active at any time.
MaxInitiators	The maximum number of initiators.
MQIBindType	The binding for applications.
ThreadedListener	Whether to start RUNMQLSR or AMQCLMAA as a listener.
PipeLineLength	The maximum number of concurrent threads a channel will use.
AdoptNewMCA	Which types of channels can have the existing channel instance stopped so that a new channel instance can start when IBM® MQ receives a request to start a channel, but finds that an instance of the channel is already running.
AdoptNewMCATimeout	The amount of time, in seconds, that the new channel instance waits for the old channel instance to end.
AdoptNewMCACheck	The type of checking required when enabling the AdoptNewMCA attribute.
ChlauthEarlyAdopt	The order in which connection authentication and channel authentication rules are processed.
PasswordProtection	Whether credentials specified by an application must be protected with MQCSP password protection, if the channel does not use TLS encryption.
IgnoreSeqNumberMismatch	Controls how the queue manager handles a sequence number mismatch during channel startup.
Connection stanza
DefaultBindType	Whether applications and the queue manager, which run in separate processes, share some resources or no resources between them.
DiagnosticMessages stanza
name	Name of a stanza.
Service	A service that is being enabled by this stanza.
ExcludeMessage	Messages that are not to be written to the queue manager error log.
SuppressMessage	Messages that are to be written to the queue manager error log once only in a specified time interval.
SuppressInterval	The time interval, in seconds, in which messages specified in SuppressMessage are written to the queue manager error log once only.
Severities	A comma separated list of severity levels.
FilePath	The path to where the log files are written. (Only supported when the Service attribute is set to File.)
FilePrefix	The prefix of the log files. (Only supported when the Service attribute is set to File.)
FileSize	The size at which the log rolls over. (Only supported when the Service attribute is set to File.)
Format	The format of the file. (Only supported when the Service attribute is set to File.)
Syslog	The Syslog service that sends any unfiltered messages to syslog using the JSON format diagnostic messages specification.
Ident	The ident value associated with the syslog entries. (Only supported when the Service attribute is set to Syslog.)
ExitPath stanza
ExitsDefaultPath	The path for user exit programs on the queue manager system (32-bit).
ExitsDefaultPath64	The path for user exit programs on the queue manager system (64-bit).
ExitPropertiesLocal stanza
CLWLMode	Whether the cluster workloac (CLWL) exit exit runs either in FAST mode or SAFE mode.
Filesystem stanza
ValidateAuth	Allow users who are not members of the mqm group to access error directories and files.
Log stanza
LogPrimaryFiles	The log files allocated when the queue manager is created.
LogSecondaryFiles	The log files allocated when the primary files are exhausted.
LogFilePages	The number of log file pages. (The log file size is specified in units of 4 KB pages.)
LogType	The type of logging to be used by the queue manager (circular or linear).
LogBufferPages	The amount of memory allocated to buffer records for writing, specifying the size of the buffers in units of 4 KB pages.
LogPath	The directory in which the log files for a queue manager reside.
LogWriteIntegrity	The method the logger uses to reliably write log records.
LogManagement	The method used to manage log extents, either manually or by the queue manager.
LU62 stanza
TPName	The TP name to start on the remote site.
Library1	The name of the APPC DLL.
Library2	The same as Library1, used if the code is stored in two separate libraries.
NativeHAInstance stanza
Name	The instance name that was used when the queue manager instance was created.
ReplicationAddress	The hostname, IPv4 dotted decimal, or IPv6 hexadecimal format address of the instance.
NativeHALocalInstance stanza
LocalName	The name of the NativeHALocalInstance stanza, taken from the log replica instance name specified when the Native HA queue manager is created.
KeyRepository	The location of the key repository that holds the digital certificate to use for protection of log replication traffic.
CertificateLabel	The certificate label identifying the digital certificate to use for protection of log replication traffic.
CipherSpec	The MQ CipherSpec to use to protect log replication traffic.
LocalAddress	The local network interface address that accepts log replication traffic.
HeartbeatInterval	The heartbeat interval defines how often in milliseconds an active instance of a Native HA queue manager sends a network heartbeat.
HeartbeatTimeout	The heartbeat timeout defines how long a replica instance of a Native HA queue manager waits before it decides that the active instance is unresponsive.
RetryInterval	The retry interval defines how often in milliseconds a Native HA queue manager should retry a failed replication link.
NETBIOS stanza
LocalName	The name by which this machine is known on the LAN.
AdapterNum	The number of the LAN adapter.
NumSess	The number of sessions to allocate.
NumCmds	The number of commands to allocate.
NumNames	The number of names to allocate.
Library1	The name of the NetBIOS DLL.
QMErrorLog stanza
ErrorLogSize	Specifies the size of the queue manager error log which it is copied to the backup.
ExcludeMessage	Specifies messages that are not to be written to the queue manager error log.
SuppressMessage	Specifies messages that are written to the queue manager error log once only in a specified time interval.
SuppressInterval	Specifies the time interval, in seconds, in which messages specified in SuppressMessage are written to the queue manager error log once only.
Restricted Mode stanza 2
ApplicationGroup	The name of the local transmission queue where remote messages are put if a transmission queue is not explicitly defined for their destination.
Security stanza
ClusterQueueAccessControl	Check the access control of cluster queues or fully qualified queues hosted on cluster queue managers.
GroupModel	Whether the Object Authority Manager (OAM) checks global groups when determining the group membership of a user on Windows.
Service stanza
Name	The name of the required service.
EntryPoints	The number of entry points defined for the service.
SecurityPolicy	On Windows, the security policy for each queue manager
SecurityPolicy	On AIX and Linux, whether the queue manager uses user-based or group-based authorization. From IBM MQ 9.3.0, you can also create a non-operating system user name.
SharedBindingsUserId	For shared bindings only, whether the UserIdentifier field in the IdentityContext structure, from the MQZ_AUTHENTICATE_USER function, is the effective user ID or the real user ID.
FastpathBindingsUserId	For fastpath bindings only, whether the UserIdentifier field in the IdentityContext structure, from the MQZ_AUTHENTICATE_USER function, is the effective user ID or the real user ID.
IsolatedBindingsUserId	For isolated bindings only, whether the UserIdentifier field in the IdentityContext structure, from the MQZ_AUTHENTICATE_USER function, is the effective user ID or the real user ID.
ServiceComponent stanza
Service	The name of the required service.
Name	The descriptive name of the service component.
Module	The name of the module to contain the code for this component.
ComponentDataSize	The size, in bytes, of the component data area passed to the component on each call.
SPX stanza
Socket	The SPX socket number in hexadecimal notation.
BoardNum	The LAN adapter number.
KeepAlive	Switch the KeepAlive function on or off.
Library1	The name of the SPX DLL.
Library2	The same as LibraryName1, used if the code is stored in two separate libraries.
ListenerBacklog	Override the default number of outstanding requests for the SPX listener.
SSL stanza
OutboundSNI	Specifies whether SNI capable clients will set SNI to the target IBM MQ channel name to the remote system when initiating a TLS connection or to the hostname.
AllowOutboundSNI	Specifies whether SNI capable clients will set SNI to the target IBM MQ channel name to the remote system when initiating a TLS connection. Attention: From IBM MQ 9.3.0 this property is deprecated. Use OutboundSNI instead.
AllowedCipherSpecs	Specifies a custom list of CipherSpecs that are ordered and enabled for use with IBM MQ channels on Multiplatforms.
AllowTLSV13	Whether a queue manager is able to use the TLS 1.3 CipherSpecs.
CDPCheckExtensions	Whether TLS channels on this queue manager try to check CDP servers that are named in CrlDistributionPoint certificate extensions.
MinimumRSAKeySize	Specifies the minimum keysize that RSA certificates must have in order to be accepted.
OCSPAuthentication	The action to be taken when a revocation status cannot be determined from an OCSP server.
OCSPCheckExtensions	Whether TLS channels on this queue manager try to check OCSP servers that are named in AuthorityInfoAccess certificate extensions.
OCSPTimeout	The number of seconds to wait for an OCSP responder when performing a revocation check.
PeerCertChainValidation	The IBM Global Security Kit (GSKit) certificate validation setting.
SSLHTTPProxyName	Either the host name or network address of the HTTP Proxy server that is to be used by GSKit for OCSP checks.
SSLHTTPConnectTimeout	The number of seconds to wait for a network connection to be successfully established to a HTTP server when performing a revocation check.
Subpool stanza 3	This stanza is created by IBM MQ. Do not change it .
ShortSubpoolName 3	A name corresponding to a directory and symbolic link created inside the /var/mqm/sockets directory, which IBM MQ uses for internal communications between its running processes.
TCP stanza
Port	The default port number, in decimal notation, for TCP/IP sessions.
Library1	The name of the TCP/IP sockets DLL.
SecureCommsOnly	Specifies whether plain text communication is allowed, the default value, or not allowed.
KeepAlive	Switch the KeepAlive function on or off.
ListenerBacklog	Override the default number of outstanding requests for the TCP/IP listener.
Connect_Timeout	The number of seconds before an attempt to connect the socket times out.
SndBuffSize	The size in bytes of the TCP/IP send buffer used by the sending end of channels.
RcvBuffSize	The size in bytes of the TCP/IP receive buffer used by the receiving end of channels.
RcvSndBuffSize	The size in bytes of the TCP/IP send buffer used by the sender end of a receiver channel.
RcvRcvBuffSize	The size in bytes of the TCP/IP receive buffer used by the receiving end of a receiver channel.
SvrSndBuffSize	The size in bytes of the TCP/IP send buffer used by the server end of a client-connection server-connection channel.
SvrRcvBuffSize	The size in bytes of the TCP/IP receive buffer used by the server end of a client-connection server-connection channel.
DNSResolutionOrder	The order in which IBM MQ looks up host names in mixed IPv6 and IPv4 environments.
Tuning parameters stanza
SuppressDspAuthFail	Whether the queue manager suppresses generation of authorization events and the writing of AMQ8077 error messages to the error log when an authorization check fails, if the connection lacks +dsp authority to an object.
ImplSyncOpenOutput	The minimum number of applications that have the queue open for put, before an implicit syncpoint might be enabled for a persistent put, outside of syncpoint.
UniformClusterName	The name of the IBM MQ cluster you are using as a uniform cluster.
OAMLdapConnectTimeout	The maximum time, in seconds, that the LDAP client will wait to establish a TCP connection to the server.
OAMLdapQueryTimeLimit	The maximum time, in seconds, that the LDAP client will wait to receive a response to an LDAP request from the server.
OAMLdapResponseWarningTime	If a connection to an LDAP server took longer than the threshold number of seconds specified by the OAMLdapResponseWarningTime parameter, then an AMQ5544W message will be written to the error log.
ExpiryInterval	Indicates the frequency with which the queue manager scans the queues looking for expired messages that have not already been cleaned up by other queue activities. It is a time interval in seconds.
LivenessHeartBeatLen	Configures the frequency with which the queue manager checks that writes to the log are being made at a reasonable rate.
ECHeartBeatLen	Configures the frequency of the queue manager general health checks.
FileLockHeartBeatLen	Changes the default value for the file lock checks for a multi-instance queue manager that the execution controller periodically performs to make sure that it still holds the exclusive lock on the primary multi-instance file.
Variables stanza
attribute=value	A name and associated value for use as an insert during MQSC definitions.
XAResourceManager stanza
Name	The resource manager instance.
SwitchFile	The fully-qualified name of the load file containing the resource manager's XA switch structure.
XAOpenString	The string of data to be passed to the resource manager's xa_open entry point.
XACloseString	The string of data to be passed to the resource manager's xa_close entry point.
ThreadOfControl	The value that the queue manager uses for serialization when it needs to call the resource manager from one of its own multithreaded processes. Mandatory for Windows.

Notes:

1. The AccessMode stanza is set by the -a [r] option on the crtmqm command. Do not change the AccessMode stanza after the queue manager has been created.
2. The RestrictedMode stanza is set by the -g option on the crtmqm command. Do not change this stanza after the queue manager has been created. If you do not use the -g option, the stanza is not created in the qm.ini file.
3. The Subpool stanza, and the attribute ShortSubpoolName within that stanza, are written automatically by IBM MQ when you create a queue manager. IBM MQ chooses a value for ShortSubpoolName. Do not alter this value.