DEFINE CHANNEL
Use the MQSC command DEFINE CHANNEL to define a new channel, and set its parameters.
UNIX and Linux® | Windows |
---|---|
Synonym: DEF
CHL
Usage notes
For CLUSSDR channels, you can specify the REPLACE option only for manually created channels.Parameter descriptions for DEFINE CHANNEL
- SDR
- Sender channel
- SVR
- Server channel
- RCVR
- Receiver channel
- RQSTR
- Requester channel
- CLNTCONN
- Client-connection channel
- SVRCONN
- Server-connection channel
- CLUSSDR
- Cluster-sender channel
- CLUSRCVR
- Cluster-receiver channel
- MQTT
- DEFINE CHANNEL (MQTT)
Parameter | SDR | SVR | RCVR | RQSTR | CLNTCONN | SVRCONN | CLUSSDR | CLUSRCVR | MQTT |
---|---|---|---|---|---|---|---|---|---|
AFFINITY | |||||||||
BACKLOG | |||||||||
BATCHHB | |||||||||
BATCHINT | |||||||||
BATCHLIM | |||||||||
BATCHSZ | |||||||||
channel-name |
|||||||||
CHLTYPE | |||||||||
CLNTWGHT | |||||||||
CLUSNL | |||||||||
CLUSTER | |||||||||
CLWLPRTY | |||||||||
CLWLRANK | |||||||||
CLWLWGHT | |||||||||
CMDSCOPE | |||||||||
COMPHDR | |||||||||
COMPMSG | |||||||||
CONNAME | |||||||||
CONVERT | |||||||||
DEFCDISP | |||||||||
DEFRECON | |||||||||
DESCR | |||||||||
DISCINT | |||||||||
HBINT | |||||||||
JAASCFG | |||||||||
KAINT | |||||||||
LIKE | |||||||||
LOCLADDR | |||||||||
LONGRTY | |||||||||
LONGTMR | |||||||||
MAXINST | |||||||||
MAXINSTC | |||||||||
MAXMSGL | |||||||||
MCANAME | |||||||||
MCATYPE | |||||||||
MCAUSER | |||||||||
MODENAME | |||||||||
MONCHL | |||||||||
MRDATA | |||||||||
MREXIT | |||||||||
MRRTY | |||||||||
MRTMR | |||||||||
MSGDATA | |||||||||
MSGEXIT | |||||||||
NETPRTY | |||||||||
NPMSPEED | |||||||||
PASSWORD | |||||||||
PORT | |||||||||
PROPCTL | |||||||||
PUTAUT | |||||||||
QMNAME | |||||||||
QSGDISP | |||||||||
RCVDATA | |||||||||
RCVEXIT | |||||||||
REPLACE | |||||||||
SCYDATA | |||||||||
SCYEXIT | |||||||||
SENDDATA | |||||||||
SENDEXIT | |||||||||
SEQWRAP | |||||||||
SHARECNV | |||||||||
SHORTRTY | |||||||||
SHORTTMR | |||||||||
SSLCAUTH | |||||||||
SSLCIPH 1 | 1 | ||||||||
SSLCIPH | |||||||||
SSLKEYR | |||||||||
SSLPEER | |||||||||
STATCHL | |||||||||
TPNAME | |||||||||
TRPTYPE | |||||||||
USECLTID | |||||||||
USEDLQ | |||||||||
USERID | |||||||||
XMITQ |
- If SSLCIPH is used with MQTT channels, it means SSL Cipher Suite. For all other channel types, it means SSL CipherSpec. See SSLCIPH.
- AFFINITY
- Use the channel affinity attribute when client applications connect
multiple times using the same queue manager name. With the attribute,
you can choose whether the client uses the same client channel definition
for each connection. This attribute is intended to be used when multiple
applicable channel definitions are available.
- PREFERRED
- The first connection in a process reading a client channel definition
table (CCDT) creates a list of applicable definitions. The list is
based on the weightings, with any applicable
CLNTWGHT(0)
definitions first and in alphabetic order. Each connection in the process attempts to connect using the first definition in the list. If a connection is unsuccessful the next definition is used. Unsuccessful non-CLNTWGHT(0)
definitions are moved to the end of the list.CLNTWGHT(0)
definitions remain at the start of the list and are selected first for each connection. For C, C++ and .NET (including fully managed .NET) clients the list is updated if the CCDT was modified since the list was created. Each client process with the same host name creates the same list. - NONE
- The first connection in a process reading a CCDT creates a list
of applicable definitions. All connections in a process select an
applicable definition based on the weighting with any applicable
CLNTWGHT(0)
definitions selected first in alphabetic order. For C, C++ and .NET (including fully managed .NET) clients the list is updated if the CCDT was modified since the list was created.
For example, suppose that we had the following definitions in the CCDT:CHLNAME(A) QMNAME(QM1) CLNTWGHT(3) CHLNAME(B) QMNAME(QM1) CLNTWGHT(4) CHLNAME(C) QMNAME(QM1) CLNTWGHT(4)
The first connection in a process creates its own ordered list based on the weightings. So it might, for example, create the ordered list
CHLNAME(B), CHLNAME(A), CHLNAME(C)
.For
AFFINITY(PREFFERED)
, each connection in the process attempts to connect usingCHLNAME(B)
. If a connection is unsuccessful the definition is moved to the end of the list which now becomesCHLNAME(A), CHLNAME(C), CHLNAME(B)
. Each connection in the process then attempts to connect usingCHLNAME(A)
.For
AFFINITY(NONE)
, each connection in the process attempts to connect using one of the three definitions selected at random based on the weightings.If sharing conversations is enabled with a non-zero channel weighting and
AFFINITY(NONE)
, multiple connections do not have to share an existing channel instance. They can connect to the same queue manager name using different applicable definitions rather than sharing an existing channel instance. - BACKLOG
(integer)
- The number of outstanding connection requests that the telemetry
channel can support at any one time. When the backlog limit is reached,
any further clients trying to connect are refused connection until
the current backlog is processed.
The value is in the range hyphen 0 - 999999999.
The default value is 4096.
- BATCHHB
(integer)
- Specifies
whether batch heartbeats are to be used. The value is the length of
the heartbeat in milliseconds.
Batch heartbeats allow a sending channel to verify that the receiving channel is still active just before committing a batch of messages. If the receiving channel is not active, the batch can be backed out rather than becoming in-doubt, as would otherwise be the case. By backing out the batch, the messages remain available for processing so they could, for example, be redirected to another channel.
If the sending channel received a communication from the receiving channel within the batch heartbeat interval, the receiving channel is assumed to be still active. If not, a 'heartbeat' is sent to the receiving channel to check.
The value must be in the range 0 - 999999. A value of zero indicates that batch heart beats are not used.
This parameter is valid for channels with a channel type (CHLTYPE) of only
SDR
,SVR
,CLUSSDR
, andCLUSRCVR
. - BATCHINT
(integer)
- The
minimum amount of time, in milliseconds, that a channel keeps a batch
open. The batch is terminated when one of the following conditions is met:
- BATCHSZ messages are sent.
- BATCHLIM kilobytes are sent.
- The transmission queue is empty and BATCHINT is exceeded.
The value must be in the range 0 - 999999999. Zero means that the batch is terminated as soon as the transmission queue becomes empty (or the
BATCHSZ
limit is reached).This parameter is valid for channels with a channel type (CHLTYPE) of only
SDR
,SVR
,CLUSSDR
, andCLUSRCVR
. - BATCHLIM
(integer)
The limit, in kilobytes, of the amount of data that can be sent through a channel before taking a sync point. A sync point is taken after the message that caused the limit to be reached flows across the channel. A value of zero in this attribute means that no data limit is applied to batches over this channel.
The batch is terminated when one of the following conditions is met:- BATCHSZ messages are sent.
- BATCHLIM kilobytes are sent.
- The transmission queue is empty and BATCHINT is exceeded.
This parameter is valid for channels with a channel type (CHLTYPE) of only
SDR
,SVR
,CLUSSDR
, andCLUSRCVR
.The value must be in the range 0 - 999999. The default value is 5000.
This parameter is supported on all platforms.
- BATCHSZ
( integer )
- The maximum
number of messages that can be sent through a channel before taking a sync point. The maximum batch size used is the lowest of the following values:
- The BATCHSZ of the sending channel.
- The BATCHSZ of the receiving channel.
- On distributed platforms, the maximum number of uncommitted messages allowed at the sending queue manager (or one if this value is zero or less).
- On distributed platforms, the maximum number of uncommitted messages allowed at the receiving queue manager (or one if this value is zero or less).
While non-persistent messages sent over an NPMSPEED (FAST) channel are delivered to a queue immediately (without waiting for a complete batch), the messages still contribute to the batch size for a channel and, therefore, cause confirm flows to occur when BATCHSZ messages have flowed.
If the batch flows are causing a performance impact when moving only non-persistent messages, and NPMSPEED is set to FAST, you should consider setting the BATCHSZ to the maximum permissible value of 9999, and BATCHLIM to zero.
Additionally, setting BATCHINT to a high value, for example, 999999999 keeps each batch "open" for longer, even if there are no new messages waiting on the transmission queue.
The above settings minimize the frequency of confirm flows, but be aware that if any persistent messages are moved over a channel with these settings, there will be significant delays in the delivery of those persistent messages only.
The maximum number of uncommitted messages is specified by the MAXUMSGS parameter of the
This parameter is valid only for channels with a channel type ( CHLTYPE ) of SDR, SVR, RCVR, RQSTR, CLUSSDR, or CLUSRCVR.ALTER QMGR
command.The value must be in the range 1 - 9999.
- (channel-name)
- The
name of the new channel definition.
This parameter is required on all types of channel. On CLUSSDR channels, it can take a different form to the other channel types. If your convention for naming CLUSSDR channels includes the name of the queue manager, you can define a CLUSSDR channel using the
+QMNAME+
construction. After connection to the matching CLUSRCVR channel, WebSphere® MQ substitutes the correct repository queue manager name in place of+QMNAME+
in the CLUSSDR channel definition. This facility applies to AIX®, HP-UX, IBM® i, Linux, Solaris, and Windows only; see Components of a clusterThe name must not be the same as any existing channel defined on this queue manager (unless REPLACE or ALTER is specified). On z/OS®, CLNTCONN channel names can duplicate others.
The maximum length of the string is 20 characters, and the string must contain only valid characters; see Rules for naming IBM WebSphere MQ objects.
- CHLTYPE
- Channel type. This parameter is required.
It must follow immediately after the (channel-name) parameter
on all platforms except z/OS.
- SDR
- Sender channel
- SVR
- Server channel
- RCVR
- Receiver channel
- RQSTR
- Requester channel
- CLNTCONN
- Client-connection channel
- SVRCONN
- Server-connection channel
- CLUSSDR
- CLUSSDR channel.
- CLUSRCVR
- Cluster-receiver channel.
- MQTT
- Telemetry channel
Note: If you are using the REPLACE option, you cannot change the channel type. - CLNTWGHT
- Set the client channel weighting attribute to select a client
channel definition at random based on its weighting when more than
one suitable definition is available. Specify a value in the range
0 - 99.
The special value 0 indicates that no random load balancing is performed and applicable definitions are selected in alphabetic order. To enable random load balancing the value can be in the range 1 - 99, where 1 is the lowest weighting and 99 is the highest.
If a client application issues MQCONN with a queue manager name of
*name
a client channel definition can be selected at random. The chosen definition is randomly selected based on the weighting. Any applicableCLNTWGHT(0)
definitions selected are selected first in alphabetic order. Randomness in the selection of client connection definitions is not guaranteed.For example, suppose that we had the following two definitions in the CCDT:CHLNAME(TO.QM1) CHLTYPE(CLNTCONN) QMNAME(GRP1) CONNAME(address1) CLNTWGHT(2) CHLNAME(TO.QM2) CHLTYPE(CLNTCONN) QMNAME(GRP1) CONNAME(address2) CLNTWGHT(4)
A client MQCONN with queue manager name
*GRP1
would choose one of the two definitions based on the weighting of the channel definition. (A random integer 1 - 6 would be generated. If the integer was in the range 1 through 2,address1
would be used otherwiseaddress2
would be used). If this connection was unsuccessful the client would then use the other definition.The CCDT might contain applicable definitions with both zero and non-zero weighting. In this situation, the definitions with zero weighting are chosen first and in alphabetic order. If these connections are unsuccessful the definitions with non-zero weighting are chosen based on their weighting.
For example, suppose that we had the following four definitions in the CCDT:CHLNAME(TO.QM1) CHLTYPE(CLNTCONN) QMNAME(GRP1) CONNAME(address1) CLNTWGHT(1) CHLNAME(TO.QM2) CHLTYPE(CLNTCONN) QMNAME(GRP1) CONNAME(address2) CLNTWGHT(2) CHLNAME(TO.QM3) CHLTYPE(CLNTCONN) QMNAME(GRP1) CONNAME(address3) CLNTWGHT(0) CHLNAME(TO.QM4) CHLTYPE(CLNTCONN) QMNAME(GRP1) CONNAME(address4) CLNTWGHT(0)
A client MQCONN with queue manager name
*GRP1
would first choose definitionTO.QM3
. If this connection was unsuccessful the client would then choose definitionTO.QM4
. If this connection was also unsuccessful the client would then randomly choose one of the remaining two definitions based on their weighting.CLNTWGHT is supported for all transport protocols.
- CLUSNL
(nlname)
- The name of the namelist that specifies
a list of clusters to which the channel belongs.
This parameter is valid only for channels with a channel type (CHLTYPE) of CLUSSDR and CLUSRCVR channels. Only one of the resultant values of CLUSTER or CLUSNL can be nonblank, the other must be blank.
- CLUSTER
(clustername)
- The name of the cluster to which the
channel belongs. The maximum length is 48 characters conforming to
the rules for naming IBM WebSphere MQ
objects.
This parameter is valid only for channels with a channel type (CHLTYPE) of CLUSSDR and CLUSRCVR channels. Only one of the resultant values of CLUSTER or CLUSNL can be nonblank, the other must be blank.
- CLWLPRTY
(integer)
- Specifies the priority of the channel
for the purposes of cluster workload distribution. The value must
be in the range 0 - 9 where 0 is the lowest priority and 9 is the
highest.
This parameter is valid only for channels with a channel type (CHLTYPE) of CLUSSDR and CLUSRCVR channels.
For more information about this attribute, see CLWLPRTY channel attribute.
- CLWLRANK
(integer)
- Specifies the rank of the channel
for the purposes of cluster workload distribution. The value must
be in the range 0 - 9 where 0 is the lowest rank and 9 is the highest.
This parameter is valid only for channels with a channel type (CHLTYPE) of CLUSSDR and CLUSRCVR channels.
For more information about this attribute, see CLWLRANK channel attribute.
- CLWLWGHT
(integer)
- Specifies the weighting to be applied
to a channel so that the proportion of messages sent down the channel
can be controlled by workload management. The value must be in the
range 1 - 99 where 1 is the lowest rank and 99 is the highest.
This parameter is valid only for channels with a channel type (CHLTYPE) of CLUSSDR and CLUSRCVR channels.
For more information about this attribute, see CLWLWGHT channel attribute.
- CMDSCOPE
- This parameter applies to z/OS only
and specifies how the command is executed when the queue manager is
a member of a queue-sharing group. CMDSCOPE must either be left blank, or if QSGDISP is set to GROUP, the local queue manager name.
- ' '
- The command is executed on the queue manager on which it was entered.
QmgrName
- The command is executed on the queue manager you specify, providing
the queue manager is active within the queue-sharing group.
You can specify a queue manager name other than the queue manager on which the command was entered. To do so, you must be using a shared queue environment, and the command server must be enabled.
- *
- The command is executed on the local queue manager and is also
passed to every active queue manager in the queue-sharing group. The
effect of
*
is the same as entering the command on every queue manager in the queue-sharing group.
- COMPHDR
- The list of header data compression techniques supported by the channel.
- COMPMSG
- The list of message data compression techniques supported by the channel.
- CONNAME
(string)
- Connection name.
For CLUSRCVR channels, CONNAME relates to the local queue manager, and for other channels it relates to the target queue manager.
The maximum length of the string is 48 characters on z/OS, and 264 characters on other platforms.
A workaround to the 48 character limit might be one of the following suggestions:- Set up your DNS servers so that you use, for example, host name of myserver instead of myserver.location.company.com, ensuring you can use the short host name.
- Use IP addresses.
Specify CONNAME as a comma-separated list of names of machines for the stated TRPTYPE. Typically only one machine name is required. You can provide multiple machine names to configure multiple connections with the same properties. The connections are usually tried in the order they are specified in the connection list until a connection is successfully established. The order is modified for clients if the CLNTWGHT attribute is provided. If no connection is successful, the channel attempts the connection again, as determined by the attributes of the channel. With client channels, a connection-list provides an alternative to using queue manager groups to configure multiple connections. With message channels, a connection list is used to configure connections to the alternative addresses of a multi-instance queue manager.
CONNAME is required for channels with a channel type (CHLTYPE) of SDR, RQSTR, CLNTCONN, and CLUSSDR. It is optional for SVR channels, and for CLUSRCVR channels of
TRPTYPE(TCP)
, and is not valid for RCVR or SVRCONN channels.Providing multiple connection names in a list was first supported in IBM WebSphere MQ Version 7.0.1. It changes the syntax of the CONNAME parameter. Earlier clients and queue managers connect using the first connection name in the list, and do not read the rest of the connection names in the list. In order for the earlier clients and queue managers to parse the new syntax, you must specify a port number on the first connection name in the list. Specifying a port number avoids problems when connecting to the channel from a client or queue manager that is running at a level earlier than IBM WebSphere MQ Version 7.0.1.
On AIX, HP-UX, IBM i, Linux, Solaris, and Windows platforms, the TCP/IP connection name parameter of a cluster-receiver channel is optional. If you leave the connection name blank, IBM WebSphere MQ generates a connection name for you, assuming the default port and using the current IP address of the system. You can override the default port number, but still use the current IP address of the system. For each connection name leave the IP name blank, and provide the port number in parentheses; for example:
The generated CONNAME is always in the dotted decimal (IPv4) or hexadecimal (IPv6) form, rather than in the form of an alphanumeric DNS host name.(1415)
Tip: If you are using any of the special characters in your connection name (for example, parentheses) you must enclose the string in single quotation marks.The value you specify depends on the transport type (TRPTYPE) to be used:- LU62
-
- On z/OS, there are two
forms in which to specify the value:
- Logical unit name
- The logical unit information for the queue manager, comprising
the logical unit name, TP name, and optional mode name. Logical unit
name can be specified in one of three forms:
Form Example luname IGY12355 luname/TPname IGY12345/APING luname/TPname/modename IGY12345/APINGD/#INTER For the first form, the TP name and mode name must be specified for the TPNAME and MODENAME parameters; otherwise these parameters must be blank.
Note: For CLNTCONN channels, only the first form is allowed. - Symbolic name
- The symbolic destination name for the logical unit information
for the queue manager, as defined in the side information data set.
The TPNAME and MODENAME parameters
must be blank. Note: For CLUSRCVR channels, the side information is on the other queue managers in the cluster. Alternatively, it can be a name that a channel auto-definition exit can resolve into the appropriate logical unit information for the local queue manager.
The specified or implied LU name can be that of a VTAM® generic resources group.
- On AIX, HP-UX, IBM i, Linux, Solaris, and Windows, CONNAME is the name of the CPI-C communications side object. Alternatively, if the TPNAME is not blank, CONNAME is the fully qualified name of the partner logical unit.
- On z/OS, there are two
forms in which to specify the value:
- NetBIOS
- A unique NetBIOS name (limited to 16 characters).
- SPX
- The 4-byte network address, the 6-byte node address, and the 2-byte
socket number. These values must be entered in hexadecimal, with
a period separating the network and node addresses. The socket number
must be enclosed in brackets, for example:
CONNAME('0a0b0c0d.804abcde23a1(5e86)')
- TCP
- Either the host name, or the network address of the remote machine
(or the local machine for CLUSRCVR channels). This
address can be followed by an optional port number, enclosed in parentheses.
If the CONNAME is a host name, the host name is resolved to an IP address.
The IP stack used for communication depends on the value specified for CONNAME and the value specified for LOCLADDR. See LOCLADDR for information about how this value is resolved.
On z/OS, the connection name can include the IP_name of an z/OS dynamic DNS group or a Network Dispatcher input port. Do not include the IP_name or input port for channels with a channel type (CHLTYPE) of CLUSSDR.
On AIX, HP-UX, Linux, IBM i, Solaris, Windows, and z/OS, you do not always need to specify the network address of your queue manager. If you define a channel with a channel type (CHLTYPE) of CLUSRCVR that is using TCP/IP, WebSphere MQ generates a CONNAME for you. It assumes the default port and uses the current IPv4 address of the system. If the system does not have an IPv4 address, the current IPv6 address of the system is used.
Note: If you are using clustering between IPv6-only and IPv4-only queue managers, do not specify an IPv6 network address as the CONNAME for CLUSRCVR channels. A queue manager that is capable only of IPv4 communication is unable to start a CLUSSDR channel definition that specifies the CONNAME in IPv6 hexadecimal form. Consider, instead, using host names in a heterogeneous IP environment.
- CONVERT
- Specifies whether the sending message
channel agent attempts conversion of the application message data,
if the receiving message channel agent cannot perform this conversion.
- NO
- No conversion by sender
- YES
- Conversion by sender
On z/OS, N and Y are accepted as synonyms of NO and YES.
This parameter is valid only for channels with a channel type (CHLTYPE) of SDR, SVR, CLUSSDR, or CLUSRCVR.
- DEFCDISP
- Specifies the default channel disposition
of the channel.
- PRIVATE
- The intended disposition of the channel is as a private channel.
- FIXSHARED
- The intended disposition of the channel is as a shared channel associated with a specific queue manager.
- SHARED
- The intended disposition of the channel is as a shared channel.
This parameter does not apply to channels with a channel type (CHLTYPE) of CLNTCONN, CLUSSDR, or CLUSRCVR.
- DEFRECON
- Specifies whether
a client connection automatically reconnects a client application
if its connection breaks.
- NO
- Unless overridden by MQCONNX, the client is not reconnected automatically.
- YES
- Unless overridden by MQCONNX, the client reconnects automatically.
- QMGR
- Unless overridden by MQCONNX, the client reconnects
automatically, but only to the same queue manager. The QMGR option has the same
effect as
MQCNO_RECONNECT_Q_MGR
. - DISABLED
- Reconnection is disabled, even if requested by the client program using the MQCONNX MQI call.
Table 2. Automatic reconnection depends on the values set in the application and in the channel definition DEFRECON Reconnection options set in the application MQCNO_RECONNECT
MQCNO_RECONNECT_Q_MGR
MQCNO_RECONNECT_AS_DEF
MQCNO_RECONNECT_DISABLED
NO YES QMGR NO NO YES YES QMGR YES NO QMGR YES QMGR QMGR NO DISABLED NO NO NO NO - DESCR
(string)
- Plain-text comment. It provides descriptive
information about the channel when an operator issues the DISPLAY
CHANNEL command.
It must contain only displayable characters. The maximum length is 64 characters. In a DBCS installation, it can contain DBCS characters (subject to a maximum length of 64 bytes).
Note: If the information is sent to another queue manager they might be translated incorrectly. The characters must be in the coded character set identifier (CCSID) of the local queue manager. - DISCINT
(integer)
- The minimum time in seconds for which
the channel waits for a message to arrive on the transmission queue.
The waiting period starts after a batch ends. After the end of the
waiting period, if there are no more messages, the channel is ended.
A value of zero causes the message channel agent to wait indefinitely.
The value must be in the range 0 - 999 999.
This parameter is valid only for channels with a channel type (CHLTYPE) of SVRCONN, SDR, SVR, CLUSSDR, CLUSRCVR.
For SVRCONN channels using the TCP protocol, DISCINT has a different interpretation. It is the minimum time in seconds for which the SVRCONN instance remains active without any communication from its partner client. A value of zero disables this disconnect processing. The SVRCONN inactivity interval applies only between IBM WebSphere MQ API calls from a client, so no client is disconnected during an extended MQGET with wait call. This attribute is ignored for SVRCONN channels using protocols other than TCP.
- HBINT
(integer)
HBINT specifies the approximate time between heartbeat flows sent by a message channel agent (MCA). The flows are sent when there are no messages on the transmission queue.
Heartbeat flows unblock the receiving MCA, which is waiting for messages to arrive or for the disconnect interval to expire. When the receiving MCA is unblocked, it can disconnect the channel without waiting for the disconnect interval to expire. Heartbeat flows also free any storage buffers that are allocated for large messages. They also close any queues that are left open at the receiving end of the channel.
The value is in seconds and must be in the range 0 - 999999. A value of zero means that no heartbeat flows are to be sent. The default value is 300. To be most useful, the value needs to be less than the disconnect interval value.
For SVRCONN and CLNTCONN channels, heartbeats can flow from both the server side as well as the client side independently. If no data is transferred across the channel during the heartbeat interval, the CLNTCONN MQI agent sends a heartbeat flow. The SVRCONN MQI agent responds to it with another heartbeat flow. The flows happen irrespective of the state of the channel. For example, irrespective of whether it is inactive while making an API call, or is inactive waiting for client user input. The SVRCONN MQI agent is also capable of initiating a heartbeat to the client, again irrespective of the state of the channel. The SVRCONN and CLNTCONN MQI agents are prevented from heart beating to each other at the same time. The server heartbeat is flowed if no data is transferred across the channel for the heartbeat interval plus 5 seconds.
For server-connection and client-connection channels working in the channel mode before IBM WebSphere MQ Version 7.0, heartbeats flow only when a server MCA is waiting for an MQGET command with the WAIT option specified, which it has issued on behalf of a client application.
For more information, see Heartbeat interval (HBINT).
- JAASCFG
(string)
- The name of a stanza in the JAAS configuration file.
- KAINT
(integer)
- The value passed to the communications
stack for keepalive timing for this channel.
For this attribute to be effective, TCP/IP keepalive must be enabled both in the queue manager and in TCP/IP. On z/OS, enable TCP/IP keepalive in the queue manager by issuing the
ALTER QMGR TCPKEEP(YES)
command. If the TCPKEEP queue manager parameter is NO, the value is ignored, and the keepalive facility is not used. On other platforms, TCP/IP keepalive is enabled when theKEEPALIVE=YES
parameter is specified in the TCP stanza. Modify the TCP stanza in the distributed queuing configuration file, qm.ini, or through the IBM WebSphere MQ Explorer.Keepalive must also be switched on within TCP/IP itself. Refer to your TCP/IP documentation for information about configuring keepalive. On AIX, use the no command. On HP-UX, use the ndd command. On Windows, edit the registry. On z/OS, update your TCP/IP PROFILE data set and add or change the INTERVAL parameter in the TCPCONFIG section.
Although this parameter is available on all platforms, its setting is implemented only on z/OS. On platforms other than z/OS, you can access and modify the parameter, but it is only stored and forwarded. It is not implemented, but it is still useful, for instance in a clustered environment. For example, a value set in a CLUSRCVR channel definition on Solaris flows to z/OS queue managers that are in, or join, the cluster.
On platforms other than z/OS, if you need the functionality provided by the KAINT parameter, use the Heartbeat Interval (HBINT) parameter, as described in HBINT.
(integer)
- The KeepAlive interval to be used, in seconds, in the range 1 through 99999.
- 0
- The value used is that specified by the INTERVAL statement in the TCP profile configuration data set.
- AUTO
- The KeepAlive interval is calculated based upon the negotiated
heartbeat value as follows:
- If the negotiated HBINT is greater than zero, keepalive interval is set to that value plus 60 seconds.
- If the negotiated HBINT is zero, the keepalive value used is that specified by the INTERVAL statement in the TCP/IP PROFILE configuration data set.
If AUTO is specified for KAINT, and it is a server-connection channel, the TCP INTERVAL value is used instead for the keepalive interval.
In this case, KAINT is zero in DISPLAY CHSTATUS; it would be non-zero if an integer had been coded instead of AUTO.
This parameter is valid for all channel types. It is ignored for channels with a TRPTYPE other than TCP or SPX.
- LIKE
(channel-name)
- The
name of a channel. The parameters of this channel are used to model
this definition. If you do not set LIKE, and do not set a parameter field related to the command, its value is taken from one of the default channels. The default values depend upon the channel type:
SYSTEM.DEF.SENDER
- Sender channel
SYSTEM.DEF.SERVER
- Server channel
SYSTEM.DEF.RECEIVER
- Receiver channel
SYSTEM.DEF.REQUESTER
- Requester channel
SYSTEM.DEF.SVRCONN
- Server-connection channel
SYSTEM.DEF.CLNTCONN
- Client-connection channel
SYSTEM.DEF.CLUSSDR
- CLUSSDR channel
SYSTEM.DEF.CLUSRCVR
- Cluster-receiver channel
SYSTEM.DEF.MQTT
- Telemetry channel
This parameter is equivalent to defining the following object:
for a SDR channel, and similarly for other channel types.LIKE(SYSTEM.DEF.SENDER)
These default channel definitions can be altered by the installation to the default values required.
On z/OS, the queue manager searches page set zero for an object with the name you specify and a disposition of QMGR or COPY. The disposition of the LIKE object is not copied to the object and channel type you are defining.Note:QSGDISP(GROUP)
objects are not searched.- LIKE is ignored if
QSGDISP(COPY)
is specified. However, the group object defined is used as a LIKE object.
- LOCLADDR
(string)
- LOCLADDR is the
local communications address for the channel. Use this parameter if
you want a channel to use a particular IP address, port, or port range
for outbound communications. LOCLADDR might be
useful in recovery scenarios where a channel is restarted on a different
TCP/IP stack. LOCLADDR is also useful to force
a channel to use an IPv4 or IPv6 stack on a
dual-stack system. You can also use LOCLADDR to
force a channel to use a dual-mode stack on a single-stack system.
This parameter is valid only for channels with a transport type (TRPTYPE) of TCP. If TRPTYPE is not TCP, the data is ignored and no error message is issued.
The value is the optional IP address, and optional port or port range used for outbound TCP/IP communications. The format for this information is as follows:LOCLADDR([ip-addr][(low-port[,high-port])][,[ip-addr][(low-port[,high-port])]])
The maximum length of LOCLADDR, including multiple addresses, is
MQ_LOCAL_ADDRESS_LENGTH
.If you omit LOCLADDR, a local address is automatically allocated.
Note, that you can set LOCLADDR for a C client using the Client Channel Definition Table (CCDT).
All the parameters are optional. Omitting the
ip-addr
part of the address is useful to enable the configuration of a fixed port number for an IP firewall. Omitting the port number is useful to select a particular network adapter without having the identify a unique local port number. The TCP/IP stack generates a unique port number.Specify
[,[ip-addr][(low-port[,high-port])]]
multiple times for each additional local address. Use multiple local addresses if you want to specify a specific subset of local network adapters. You can also use[,[ip-addr][(low-port[,high-port])]]
to represent a particular local network address on different servers that are part of a multi-instance queue manager configuration.ip-addr
ip-addr
is specified in one of three forms:- IPv4 dotted decimal
- For example
192.0.2.1
- IPv6 hexadecimal notation
- For example
2001:DB8:0:0:0:0:0:0
- Alphanumeric host name form
- For example
WWW.EXAMPLE.COM
low-port and high-port
low-port
andhigh-port
are port numbers enclosed in parentheses.
Table 3. Examples of how the LOCLADDR parameter can be used LOCLADDR Meaning 9.20.4.98 Channel binds to this address locally 9.20.4.98, 9.20.4.99 Channel binds to either IP address. The address might be two network adapters on one server, or a different network adapter on two different servers in a multi-instance configuration. 9.20.4.98(1000) Channel binds to this address and port 1000 locally 9.20.4.98(1000,2000) Channel binds to this address and uses a port in the range 1000 - 2000 locally (1000) Channel binds to port 1000 locally (1000,2000) Channel binds to port in range 1000 - 2000 locally This parameter is valid only for channels with a channel type (CHLTYPE) of SDR, SVR, RQSTR, CLNTCONN, CLUSSDR, CLUSRCVR, or MQTT.
On CLUSSDR channels, the IP address and port to which the outbound channel binds, is a combination of fields. It is a concatenation of the IP address, as defined in the LOCLADDR parameter, and the port range from the cluster cache. If there is no port range in the cache, the port range defined in the LOCLADDR parameter is used. This port range does not apply to z/OS.
Even though this parameter is similar in form to CONNAME, it must not be confused with it. The LOCLADDR parameter specifies the characteristics of the local communications, whereas the CONNAME parameter specifies how to reach a remote queue manager.
When a channel is started, the values specified for CONNAME and LOCLADDR determine the IP stack to be used for communication; see Table 3 and Local Address (LOCLADDR) .
If the TCP/IP stack for the local address is not installed or configured, the channel does not start and an exception message is generated. The message indicates that the connect() request specifies an interface address that is not known on the default IP stack. To direct the connect() request to the alternative stack, specify the LOCLADDR parameter in the channel definition as either an interface on the alternative stack, or a DNS host name. The same specification also works for listeners that might not use the default stack. To find the value to code for LOCLADDR, run the NETSTAT HOME command on the IP stacks that you want to use as alternatives.
For channels with a channel type (CHLTYPE) of MQTT the usage of this parameter is slightly different. Specifically, a telemetry channel (MQTT) LOCLADDR parameter expects only an IPv4 or IPv6 IP address, or a valid host name as a string. This string must not contain a port number or port range. If an IP address is entered, only the address format is validated. The IP address itself is not validated.
Table 4. How the IP stack to be used for communication is determined Protocols supported CONNAME LOCLADDR Action of channel IPv4 only IPv4 address1 Channel binds to IPv4 stack IPv6 address2 Channel fails to resolve CONNAME IPv4 and 6 host name3 Channel binds to IPv4 stack IPv4 address IPv4 address Channel binds to IPv4 stack IPv6 address IPv4 address Channel fails to resolve CONNAME IPv4 and 6 host name IPv4 address Channel binds to IPv4 stack Any address4 IPv6 address Channel fails to resolve LOCLADDR IPv4 address IPv4 and 6 host name Channel binds to IPv4 stack IPv6 address IPv4 and 6 host name Channel fails to resolve CONNAME IPv4 and 6 host name IPv4 and 6 host name Channel binds to IPv4 stack IPv4 and IPv6 IPv4 address Channel binds to IPv4 stack IPv6 address Channel binds to IPv6 stack IPv4 and 6 host name Channel binds to stack determined by IPADDRV IPv4 address IPv4 address Channel binds to IPv4 stack IPv6 address IPv4 address Channel fails to resolve CONNAME IPv4 and 6 host name IPv4 address Channel binds to IPv4 stack IPv4 address IPv6 address Channel maps CONNAME to IPv65 IPv6 address IPv6 address Channel binds IPv6 stack IPv4 and 6 host name IPv6 address Channel binds IPv6 stack IPv4 address IPv4 and 6 host name Channel binds to IPv4 stack IPv6 address IPv4 and 6 host name Channel binds to IPv6 stack IPv4 and 6 host name IPv4 and 6 host name Channel binds to stack determined by IPADDRV IPv6 only IPv4 address Channel maps CONNAME to IPv65 IPv6 address Channel binds to IPv6 stack IPv4 and 6 host name Channel binds to IPv6 stack Any address IPv4 address Channel fails to resolve LOCLADDR IPv4 address IPv6 address Channel maps CONNAME to IPv65 IPv6 address IPv6 address Channel binds to IPv6 stack IPv4 and 6 host name IPv6 address Channel binds to IPv6 stack IPv4 address IPv4 and 6 host name Channel maps CONNAME to IPv65 IPv6 address IPv4 and 6 host name Channel binds to IPv6 stack IPv4 and 6 host name IPv4 and 6 host name Channel binds to IPv6 stack Notes:- IPv4 address.
An IPv4 host
name that resolves only to an IPv4 network address
or a specific dotted notation IPv4 address, for
example
1.2.3.4
. This note applies to all occurrences of 'IPv4 address' in this table. - IPv6 address.
An IPv6 host
name that resolves only to an IPv6 network address
or a specific hexadecimal notation IPv6 address, for
example
4321:54bc
. This note applies to all occurrences of 'IPv6 address' in this table. - IPv4 and 6 host name. A host name that resolves to both IPv4 and IPv6 network addresses. This note applies to all occurrences of 'IPv4 and 6 host name' in this table.
- Any address. IPv4 address, IPv6 address, or IPv4 and 6 host name. This note applies to all occurrences of 'Any address' in this table.
- Maps IPv4 CONNAME to IPv4 mapped IPv6 address. IPv6 stack implementations that do not support IPv4 mapped IPv6 addressing fail to resolve the CONNAME. Mapped addresses might require protocol translators in order to be used. The use of mapped addresses is not recommended.
- LONGRTY
(integer)
- The LONGRTY parameter
specifies the maximum number of further attempts that are made by
a SDR, SVR, or CLUSSDR channel
to connect to a remote queue manager. The interval between attempts
is specified by LONGTMR. The LONGRTY parameter
takes effect if the count specified by SHORTRTY is
exhausted.
If this count is exhausted without success, an error is logged to the operator, and the channel stops. In this circumstance, the channel must be restarted with a command. It is not started automatically by the channel initiator.
The LONGRTY value must be in the range 0 - 9999999.
This parameter is valid only for channels with a channel type (CHLTYPE) of SDR, SVR, CLUSSDR, or CLUSRCVR.
A channel attempts to reconnect if it fails to connect initially, whether it is started automatically by the channel initiator or by an explicit command. It also tries to connect again if the connection fails after the channel successfully connecting. If the cause of the failure is such that more attempts are unlikely to be successful, they are not attempted.
- LONGTMR
(integer)
- For LONGRTY, LONGTMR is
the maximum number of seconds to wait before reattempting connection
to the remote queue manager.
The time is approximate; zero means that another connection attempt is made as soon as possible.
The interval between attempting to reconnect might be extended if the channel has to wait to become active.
The LONGTMR value must be in the range 0 - 9999999.
Note: For implementation reasons, the maximum LONGTMR value is 999,999; values exceeding this maximum are treated as 999,999. Similarly, the minimum interval between attempting to reconnect is 2 seconds. Values less than this minimum are treated as 2 seconds.This parameter is valid only for channels with a channel type (CHLTYPE) of SDR, SVR, CLUSSDR, or CLUSRCVR.
- MAXINST
(integer)
- The maximum number of simultaneous
instances of an individual SVRCONN channel that can
be started.
The value must be in the range 0 - 999999999.
A value of zero prevents all client access on this channel.
New instances cannot start if the number of running instances equals or exceeds the value of this parameter. If MAXINST is changed to less than the number of instances of the SVRCONN channel that are currently running, the number of running instances is not affected.
On z/OS, without the client attachment feature installed, a maximum of five instances are allowed on the SYSTEM.ADMIN.SVRCONN channel. If MAXINST is set to a larger number than five, it is interpreted as zero without the CAF installed.
This parameter is valid only for channels with a channel type (CHLTYPE) of SVRCONN.
- MAXINSTC
(integer)
- The maximum number of simultaneous
individual SVRCONN channels that can be started from
a single client. In this context, connections that originate from
the same remote network address are regarded as coming from the same
client.
The value must be in the range 0 - 999999999.
A value of zero prevents all client access on this channel.
If you reduce the value of MAXINSTC to less than the number of instances of the SVRCONN channel that is currently running from an individual client, the running instances are not affected. New SVRCONN instances from that client cannot start until the client is running fewer instances than the value of MAXINSTC.
On z/OS, without the client attachment feature installed, only a maximum of five instances are allowed on the channel named
SYSTEM.ADMIN.SVRCONN
.This parameter is valid only for channels with a channel type (CHLTYPE) of SVRCONN.
- MAXMSGL
(integer)
- Specifies the maximum message length
that can be transmitted on the channel. This parameter is compared
with the value for the partner and the actual maximum used is the
lower of the two values. The value is ineffective if the MQCB function
is being executed and the channel type (CHLTYPE)
is SVRCONN.
The value zero means the maximum message length for the queue manager; see ALTER QMGR MAXMSGL.
On AIX, HP-UX, IBM i, Linux, Solaris, and Windows, specify a value in the range zero to the maximum message length for the queue manager.
On z/OS, specify a value in the range 0 - 104857600 bytes (100 MB).
Note that by adding the digital signature and key to the message, IBM WebSphere MQ Advanced Message Security increases the length of the message.
- MCANAME
(string)
- Message channel agent name.
This parameter is reserved, and if specified must be set to blanks (maximum length 20 characters).
- MCATYPE
- Specifies whether the message-channel-agent
program on an outbound message channel runs as a thread or a process.
- PROCESS
- The message channel agent runs as a separate process.
- THREAD
- The message channel agent runs as a separate thread
In situations where a threaded listener is required to service many incoming requests, resources can become strained. In this case, use multiple listener processes and target incoming requests at specific listeners though the port number specified on the listener.
This parameter is valid only for channels with a channel type (CHLTYPE) of SDR, SVR, RQSTR, CLUSSDR, or CLUSRCVR. It is supported only on AIX, HP-UX, IBM i, Linux, Solaris, and Windows.
On z/OS, it is supported only for channels with a channel type of CLUSRCVR. When specified in a CLUSRCVR definition, MCATYPE is used by a remote machine to determine the corresponding CLUSSDR definition.
- MCAUSER
(string)
- Message channel agent user identifier.
Note: An alternative way of providing a user ID for a channel to run under is to use channel authentication records. With channel authentication records, different connections can use the same channel while using different credentials. If both MCAUSER on the channel is set and channel authentication records are used to apply to the same channel, the channel authentication records take precedence. The MCAUSER on the channel definition is only used if the channel authentication record uses
USERSRC(CHANNEL)
. For more details, see Channel authentication recordsThis parameter interacts with PUTAUT; see PUTAUT.
If MCAUSER is nonblank, a user identifier is used by the message channel agent for authorization to access IBM WebSphere MQ resources. If PUTAUT is DEF, authorization includes authorization to put the message to the destination queue for RCVR or RQSTR channels.
If it is blank, the message channel agent uses its default user identifier.
The default user identifier is derived from the user ID that started the receiving channel. The possible values are:- z/OS,
- The user ID assigned to the channel-initiator started task by the z/OS started-procedures table.
- TCP/IP, other than z/OS
- The user ID from the inetd.conf entry, or the user that started the listener.
- SNA, other than z/OS
- The user ID from the SNA server entry. In the absence of the user ID from the SNA server entry, the user from the incoming attach request, or the user that started the listener.
- NetBIOS or SPX
- The user ID that started the listener.
The maximum length of the string is 64 characters on Windows and 12 characters on other platforms. On Windows, you can optionally qualify a user identifier with the domain name in the format
user@domain
.This parameter is not valid for channels with a channel type (CHLTYPE) of SDR, SVR, CLNTCONN, CLUSSDR.
- MODENAME
(string)
- LU 6.2 mode name (maximum length 8
characters).
This parameter is valid only for channels with a transport type (TRPTYPE) of LU62. If TRPTYPE is not LU62, the data is ignored and no error message is issued.
If specified, this parameter must be set to the SNA mode name unless the CONNAME contains a side-object name. If CONNAME is a a side-object name it must be set to blanks. The actual name is then taken from the CPI-C Communications Side Object, or APPC side information data set.
This parameter is not valid for channels with a channel type (CHLTYPE) of RCVR or SVRCONN.
- MONCHL
- Controls the collection of online
monitoring data for channels:
- QMGR
- Collect monitoring data according to the setting of the queue manager parameter MONCHL.
- OFF
- Monitoring data collection is turned off for this channel.
- LOW
- If the value of the queue manager MONCHL parameter is not NONE, online monitoring data is turned on. Data us collected at a low rate for this channel.
- MEDIUM
- If the value of the queue manager MONCHL parameter is not NONE, online monitoring data is turned on. Data us collected at a medium rate for this channel.
- HIGH
- If the value of the queue manager MONCHL parameter is not NONE, online monitoring data is turned on. Data us collected at a high rate for this channel.
Changes to this parameter take effect only on channels started after the change occurs.
For cluster channels, the value of this parameter is not replicated in the repository and, therefore, not used in the auto-definition of CLUSSDR channels. For auto-defined CLUSSDR channels, the value of this parameter is taken from the queue manager attribute MONACLS. This value might then be overridden in the channel auto-definition exit.
- MRDATA
(string)
- Channel message-retry exit user data.
The maximum length is 32 characters.
This parameter is passed to the channel message-retry exit when it is called.
This parameter is valid only for channels with a channel type (CHLTYPE) of RCVR, RQSTR, or CLUSRCVR.
- MREXIT
(string)
- Channel message-retry exit name.
The format and maximum length of the name is the same as for MSGEXIT, however you can specify only one message-retry exit.
This parameter is valid only for channels with a channel type (CHLTYPE) of RCVR, RQSTR, or CLUSRCVR.
- MRRTY
(integer)
- The number of times the channel tries
again before it decides it cannot deliver the message.
This parameter controls the action of the MCA only if the message-retry exit name is blank. If the exit name is not blank, the value of MRRTY is passed to the exit to use. The number of attempts to redeliver the message is controlled by the exit, and not by this parameter.
The value must be in the range 0 - 999999999. A value of zero means that no attempts to redeliver the message are tried.
This parameter is valid only for channels with a channel type (CHLTYPE) of RCVR, RQSTR, or CLUSRCVR.
- MRTMR
(integer)
- The minimum interval of time that
must pass before the channel can try the MQPUT operation again. The
time interval is in milliseconds.
This parameter controls the action of the MCA only if the message-retry exit name is blank. If the exit name is not blank, the value of MRTMR is passed to the exit to use. The number of attempts to redeliver the message is controlled by the exit, and not by this parameter.
The value must be in the range 0 - 999999999. A value of zero means that if the value of MRRTY is greater than zero, the channel reattempts delivery as soon as possible.
This parameter is valid only for channels with a channel type (CHLTYPE) of RCVR, RQSTR, or CLUSRCVR.
- MSGDATA
(string)
- User data for the channel message
exit. The maximum length is 32 characters.
This data is passed to the channel message exit when it is called.
On AIX, HP-UX, Linux, Solaris, and Windows, you can specify data for more than one exit program by specifying multiple strings separated by commas. The total length of the field must not exceed 999 characters.
On IBM i, you can specify up to 10 strings, each of length 32 characters. The first string of data is passed to the first message exit specified, the second string to the second exit, and so on.
On z/OS, you can specify up to eight strings, each of length 32 characters. The first string of data is passed to the first message exit specified, the second string to the second exit, and so on.
On other platforms, you can specify only one string of message exit data for each channel.
Note: This parameter is accepted but ignored for SVRCONN and CLNTCONN channels. - MSGEXIT
(string)
- Channel message exit name. If MSGEXIT is nonblank the exit is called at the following times:
- Immediately after a SDR or SVR channel retrieves a message from the transmission queue.
- Immediately before a RQSTR channel puts a message on destination queue.
- When the channel is initialized or ended.
MSGEXIT is accepted and ignored by CLNTCONN and SVRCONN channels. CLNTCONN or SVRCONN channels do not call message exits.
The format and maximum length of the exit name depends on the platform; see Table 5.
If the MSGEXIT, MREXIT, SCYEXIT, SENDEXIT, and RCVEXIT parameters are all left blank, the channel user exit is not invoked. If any of these parameters is nonblank, the channel exit program is called. You can enter text string for these parameters. The maximum length of the string is 128 characters.Table 5. Message exit format and length Platform Exit name format Maximum length Comment AIX, HP-UX, Linux, and Solaris libraryname(functionname)
128 You can specify the name of more than one exit program. Specify multiple strings separated by commas. However, the total number of characters specified must not exceed 999. Windows dllname(functionname)
128 - You can specify the name of more than one exit program. Specify multiple strings separated by commas. However, the total number of characters specified must not exceed 999.
dllname
is specified without the suffix (.DLL).
IBM i progname libname
20 - You can specify the names of up to 10 exit programs by specifying multiple strings separated by commas.
program name
occupies the first 10 characters andlibname
the second 10 characters. If necessary, both fields are padded to the right with blanks.
z/OS loadModuleName
8 - You can specify the names of up to eight exit programs by specifying multiple strings separated by commas.
- 128 characters are allowed for exit names for CLNTCONN channels, subject to a maximum total length including commas of 999.
- On systems, it is of the form:
- NETPRTY
(integer)
- The priority for the network connection.
Distributed queuing chooses the path with the highest priority if
there are multiple paths available. The value must be in the range
0 - 9; 0 is the lowest priority.
This parameter is valid only for CLUSRCVR channels.
- NPMSPEED
- The class of service for nonpersistent
messages on this channel:
- FAST
- Fast delivery for nonpersistent messages; messages might be lost
if the channel is lost. Messages are retrieved using
MQGMO_SYNCPOINT_IF_PERSISTENT
and so are not included in the batch unit of work. - NORMAL
- Normal delivery for nonpersistent messages.
This parameter is valid only for channels with a CHLTYPE of SDR, SVR, RCVR, RQSTR, CLUSSDR, or CLUSRCVR.
- PASSWORD
(string)
- Password used by the message channel
agent when attempting to initiate a secure LU 6.2 session with a remote
message channel agent. The maximum length is 12 characters.
This parameter is valid only for channels with a channel type (CHLTYPE) of SDR, SVR, RQSTR, CLNTCONN, or CLUSSDR. On z/OS, it is supported only for channels with a channel type (CHLTYPE) of CLNTCONN.
Although the maximum length of the parameter is 12 characters, only the first 10 characters are used.
- PORT
(integer)
- The port number for TCP/IP. This parameter is the port number on which the listener is to stop listening. It is valid only if the transmission protocol is TCP/IP.
- PROPCTL
- Property control attribute; see PROPCTL channel
options.
PROPCTL specifies what happens to message properties when a message is sent to another queue manager; see
This parameter is applicable to SDR, SVR, CLUSSDR, and CLUSRCVR channels.
This parameter is optional.
Permitted values are:- COMPAT
- COMPAT allows applications which expect JMS-related
properties to be in an MQRFH2 header in the message
data to continue to work unmodified.
Message properties Result The message contains a property with a prefix of mcd., jms., usr. or mqext. If the Support value is MQPD_SUPPORT_OPTIONAL
, all optional message properties are placed in one or more MQRFH2 headers. This rule does not apply to properties in the message descriptor or extension, which remain in the same place. Optional message properties are moved into the message data before the message it sent to the remote queue manager.The message does not contain a property with a prefix of mcd., jms., usr. or mqext. All message properties, except properties in the message descriptor or extension, are removed from the message before the message is sent to the remote queue manager. The message contains a property where the Support field of the property descriptor is not set to MQPD_SUPPORT_OPTIONAL
The message is rejected with reason MQRC_UNSUPPORTED_PROPERTY
and treated in accordance with its report options.The message contains one or more properties where the Support field of the property descriptor is set to MQPD_SUPPORT_OPTIONAL
. Other fields of the property descriptor are set to non-default values.The properties with non-default values are removed from the message before the message is sent to the remote queue manager. The MQRFH2 folder that would contain the message property needs to be assigned with the content='properties'
attributeThe properties are removed to prevent MQRFH2 headers with unsupported syntax flowing to a Version 6.0 or prior queue manager. - NONE
- All properties of the message, except properties in the message descriptor or extension, are removed from the message. The properties are removed before the message is sent to the remote queue manager.
- ALL
- All properties of the message are included with the message when it is sent to the remote queue manager. The properties, except properties in the message descriptor (or extension), are placed in one or more MQRFH2 headers in the message data.
- PUTAUT
- PUTAUT specifies
which user identifiers are used to establish authority for a channel.
It specifies the user identifier to put messages to the destination
queue using a message channel, or to run an MQI call using an MQI
channel.
- DEF
- The default user ID is used. On z/OS, DEF might involve using both the user ID received from the network and that derived from MCAUSER.
- CTX
- The user ID from the
UserIdentifier
field of the message descriptor is used. On z/OS, CTX might involve also using the user ID received from the network or that derived from MCAUSER, or both. - ONLYMCA
- The default user ID is used. Any user ID received from the network is not used. This value is supported only on z/OS.
- ALTMCA
- The user ID from the
UserIdentifier
field of the message descriptor is used. Any user ID received from the network is not used. This value is supported only on z/OS.
On z/OS, the user IDs that are checked, and how many user IDs are checked, depends on the setting of the MQADMIN RACF® class hlq.RESLEVEL profile. Depending on the level of access the user ID of the channel initiator has to hlq.RESLEVEL, zero, one, or two user IDs are checked.
This parameter is valid only for channels with a channel type (CHLTYPE) of RCVR, RQSTR, CLUSRCVR, or, on z/OS only, SVRCONN. CTX and ALTMCA are not valid for SVRCONN channels.
- QMNAME
(string)
- Queue manager name.
For CLNTCONN channels, QMNAME is the name of a queue manager to which a IBM WebSphere MQ MQI client application can request connection. QMNAME is not necessarily the same as the name of the queue manager on which the channel is defined; see Queue manager groups in the CCDT.
For channels of other types, the QMNAME parameter is not valid.
- QSGDISP
- This parameter applies to z/OS only.
Specifies the disposition of the object to which you are applying the command (that is, where it is defined and how it behaves).
QSGDISP DEFINE COPY The object is defined on the page set of the queue manager that executes the command using the QSGDISP(GROUP)
object of the same name as the LIKE object.GROUP The object definition resides in the shared repository but only if the queue manager is in a queue-sharing group. If the definition is successful, the following command is generated. The command is sent to all active queue managers in the queue-sharing group to make or refresh local copies on page set zero:
The DEFINE command for the group object takes effect regardless of whether the generated command withDEFINE CHANNEL(channe-name) CHLTYPE(type) REPLACE QSGDISP(COPY)
QSGDISP(COPY)
fails.PRIVATE Not permitted. QMGR The object is defined on the page set of the queue manager that executes the command. - RCVDATA
(string)
- Channel receive exit user data (maximum
length 32 characters).
This parameter is passed to the channel receive exit when it is called.
On AIX, HP-UX, Linux, Solaris, and Windows, you can specify data for more than one exit program by specifying multiple strings separated by commas. The total length of the field must not exceed 999 characters.
On IBM i, you can specify up to 10 strings, each of length 32 characters. The first string of data is passed to the first receive exit specified, the second string to the second exit, and so on.
On z/OS, you can specify up to eight strings, each of length 32 characters. The first string of data is passed to the first receive exit specified, the second string to the second exit, and so on.
On other platforms, you can specify only one string of receive exit data for each channel.
- RCVEXIT
(string)
- Channel receive exit name. If this name is nonblank, the exit is called at the following times:
- Immediately before the received network data is processed.
The exit is given the complete transmission buffer as received. The contents of the buffer can be modified as required.
- At initialization and termination of the channel.
On AIX, HP-UX, Linux, Solaris, and Windows, you can specify the name of more than one exit program by specifying multiple strings separated by commas. However, the total number of characters specified must not exceed 999.
On IBM i, you can specify the names of up to 10 exit programs by specifying multiple strings separated by commas.
On z/OS, you can specify the names of up to eight exit programs by specifying multiple strings separated by commas.
On other platforms, you can specify only one receive exit name for each channel.
The format and maximum length of the name is the same as for MSGEXIT.
- Immediately before the received network data is processed.
- REPLACE and NOREPLACE
- Replace the
existing definition with this one, or not. This parameter is optional.
On z/OS it must have the same
disposition. Any object with a different disposition is not changed.
- REPLACE
- The definition replaces any existing definition of the same name. If a definition does not exist, one is created. REPLACE does not alter the channel status.
- NOREPLACE
- The definition does not replace any existing definition of the same name.
- SCYDATA
(string)
- Channel security exit user data (maximum
length 32 characters).
This parameter is passed to the channel security exit when it is called.
- SCYEXIT
(string)
- Channel security exit name. If this name is nonblank, the exit is called at the following times:
- Immediately after establishing a channel.
Before any messages are transferred, the exit is able to instigate security flows to validate connection authorization.
- Upon receipt of a response to a security message flow.
Any security message flows received from the remote processor on the remote queue manager are given to the exit.
- At initialization and termination of the channel.
The format and maximum length of the name is the same as for MSGEXIT but only one name is allowed.
- Immediately after establishing a channel.
- SENDDATA
(string)
- Channel send exit user data. The maximum
length is 32 characters.
This parameter is passed to the channel send exit when it is called.
On AIX, HP-UX, Linux, Solaris, and Windows, you can specify data for more than one exit program by specifying multiple strings separated by commas. The total length of the field must not exceed 999 characters.
On IBM i, you can specify up to 10 strings, each of length 32 characters. The first string of data is passed to the first send exit specified, the second string to the second exit, and so on.
On z/OS, you can specify up to eight strings, each of length 32 characters. The first string of data is passed to the first send exit specified, the second string to the second exit, and so on.
On other platforms, you can specify only one string of send exit data for each channel.
- SENDEXIT
(string)
- Channel send exit name. If this name is nonblank, the exit is called at the following times:
- Immediately before data is sent out on the network.
The exit is given the complete transmission buffer before it is transmitted. The contents of the buffer can be modified as required.
- At initialization and termination of the channel.
On AIX, HP-UX, Linux, Solaris, and Windows, you can specify the name of more than one exit program by specifying multiple strings separated by commas. However, the total number of characters specified must not exceed 999.
On IBM i, you can specify the names of up to 10 exit programs by specifying multiple strings separated by commas.
On z/OS, you can specify the names of up to eight exit programs by specifying multiple strings separated by commas.
On other platforms, you can specify only one send exit name for each channel.
The format and maximum length of the name is the same as for MSGEXIT.
- Immediately before data is sent out on the network.
- SEQWRAP
(integer)
- When this value is reached, sequence
numbers wrap to start again at 1.
This value is nonnegotiable and must match in both the local and remote channel definitions.
The value must be in the range 100 - 999999999.
This parameter is valid only for channels with a channel type (CHLTYPE) of SDR, SVR, RCVR, RQSTR, CLUSSDR, or CLUSRCVR.
- Specifies the maximum number of conversations
that can be sharing each TCP/IP channel instance. A SHARECNV value
of:
1
- Specifies no sharing of conversations over a TCP/IP channel instance. Client heart beating is available whether in an MQGET call or not. Read ahead and client asynchronous consumption are also available, and channel quiescing is more controllable.
0
- Specifies no sharing of conversations over a TCP/IP channel instance.
The channel instance runs in a mode that is compatible with WebSphere MQ earlier than
version 7.0, regarding:
- Administrator stop-quiesce
- Heart beating
- Read ahead
- Client asynchronous consumption
The value must be in the range zero through 999999999.
This parameter is valid only for channels with a channel type (CHLTYPE) of CLNTCONN or SVRCONN. If the CLNTCONN SHARECNV value does not match the SVRCONN SHARECNV value, the lower of the two values is used. This parameter is ignored for channels with a transport type (TRPTYPE) other than TCP.
All the conversations on a socket are received by the same thread.
High SHARECNV limits have the advantage of reducing queue manager thread usage. If many conversations sharing a socket are all busy, there is a possibility of delays. The conversations contend with one another to use the receiving thread. In this situation, a lower SHARECNV value is better.
The number of shared conversations does not contribute to the MAXINST or MAXINSTC totals.
Note: You should restart the client for this change to take effect. - SHORTRTY
(integer)
- SHORTRTY specifies
the maximum number of attempts that are made by a SDR, SVR,
or CLUSSDR channel to connect to the remote queue
manager, at intervals specified by SHORTTMR. After
the number of attempts is exhausted, the channel tries to reconnect
using to the schedule defined by LONGRTY.
The value must be in the range 0 - 999999999.
This parameter is valid only for channels with a channel type (CHLTYPE) of SDR, SVR, CLUSSDR, or CLUSRCVR.
A channel attempts to reconnect if it fails to connect initially, whether it is started automatically by the channel initiator or by an explicit command. It also tries to connect again if the connection fails after the channel successfully connecting. If the cause of the failure is such that more attempts are unlikely to be successful, they are not attempted.
- SHORTTMR
(integer)
- For SHORTRTY, SHORTTMR is the
maximum number of seconds to wait before reattempting connection to the remote queue manager.
The time is approximate.
The interval between attempting to reconnect might be extended if the channel has to wait to become active.
The value must be in the range 0 - 999999999.
Note: For implementation reasons, the maximum SHORTTMR value is 999,999; values exceeding this maximum are treated as 999,999. The minimum interval between attempting to connect is 10 seconds with SHORTTMR(0) and 2 seconds with SHORTTMR(1).This parameter is valid only for channels with a channel type (CHLTYPE) of SDR, SVR, CLUSSDR, or CLUSRCVR.
- SSLCAUTH
- SSLCAUTH defines
whether IBM WebSphere MQ requires
a certificate from the SSL client. The SSL client is the initiating
end of the channel. SSLCAUTH is applied to the
SSL server, to determine the behavior required of the client. The
SSL server is the end of the channel that receives the initiation
flow.
This parameter is valid only for channels with a channel type (CHLTYPE) of RCVR, SVRCONN, CLUSRCVR, SVR, RQSTR, or MQTT.
The parameter is used only for channels with SSLCIPH specified. If SSLCIPH is blank, the data is ignored and no error message is issued.
- REQUIRED
- IBM WebSphere MQ requires and validates a certificate from the SSL client.
- OPTIONAL
- The peer SSL client system might still send a certificate. If it does, the contents of this certificate are validated as normal.
- SSLCIPH
(string)
- SSLCIPH specifies the CipherSpec that is used on the channel. The maximum length is 32 characters. This parameter is valid on all channel types which use transport type
TRPTYPE(TCP)
. If the SSLCIPH parameter is blank, no attempt is made to use SSL on the channel.Note: When SSLCIPH is used with a telemetry channel, it meansSSL Cipher Suite
. See the SSLCIPH description inDEFINE CHANNEL (MQTT)
.Specify the name of the CipherSpec you are using. The CipherSpecs that can be used with IBM WebSphere MQ SSL support are shown in the following table. The SSLCIPH values must specify the same CipherSpec on both ends of the channel.
A table describing the CipherSpecs you can use with WebSphere MQ SSL and TLS support.
CipherSpec name Protocol used Data integrity Encryption algorithm Encryption bits FIPS1 Suite B 128 bit Suite B 192 bit NULL_MD5
aSSL 3.0 MD5 None 0 No No No NULL_SHA
aSSL 3.0 SHA-1 None 0 No No No RC4_MD5_EXPORT
2 aSSL 3.0 MD5 RC4 40 No No No RC4_MD5_US
aSSL 3.0 MD5 RC4 128 No No No RC4_SHA_US
aSSL 3.0 SHA-1 RC4 128 No No No RC2_MD5_EXPORT
2 aSSL 3.0 MD5 RC2 40 No No No DES_SHA_EXPORT
2 aSSL 3.0 SHA-1 DES 56 No No No RC4_56_SHA_EXPORT1024
3 bSSL 3.0 SHA-1 RC4 56 No No No DES_SHA_EXPORT1024
3 bSSL 3.0 SHA-1 DES 56 No No No TLS_RSA_WITH_AES_128_CBC_SHA
aTLS 1.0 SHA-1 AES 128 Yes No No TLS_RSA_WITH_AES_256_CBC_SHA
4 aTLS 1.0 SHA-1 AES 256 Yes No No TLS_RSA_WITH_DES_CBC_SHA
aTLS 1.0 SHA-1 DES 56 No5 No No FIPS_WITH_DES_CBC_SHA
bSSL 3.0 SHA-1 DES 56 No6 No No TLS_RSA_WITH_AES_128_GCM_SHA256
bTLS 1.2 AEAD AES-128 GCM AES 128 Yes No No TLS_RSA_WITH_AES_256_GCM_SHA384
bTLS 1.2 AEAD AES-256 GCM AES 256 Yes No No TLS_RSA_WITH_AES_128_CBC_SHA256
bTLS 1.2 SHA-256 AES 128 Yes No No TLS_RSA_WITH_AES_256_CBC_SHA256
bTLS 1.2 SHA-256 AES 256 Yes No No ECDHE_ECDSA_RC4_128_SHA256
bTLS 1.2 SHA-1 RC4 128 No No No ECDHE_RSA_RC4_128_SHA256
bTLS 1.2 SHA_1 RC4 128 No No No ECDHE_ECDSA_AES_128_CBC_SHA256
bTLS 1.2 SHA-256 AES 128 Yes No No ECDHE_ECDSA_AES_256_CBC_SHA384
bTLS 1.2 SHA-384 AES 256 Yes No No ECDHE_RSA_AES_128_CBC_SHA256
bTLS 1.2 SHA-256 AES 128 Yes No No ECDHE_RSA_AES_256_CBC_SHA384
bTLS 1.2 SHA-384 AES 256 Yes No No ECDHE_ECDSA_AES_128_GCM_SHA256
bTLS 1.2 AEAD AES-128 GCM AES 128 Yes Yes No ECDHE_ECDSA_AES_256_GCM_SHA384
bTLS 1.2 AEAD AES-256 GCM AES 256 Yes No Yes ECDHE_RSA_AES_128_GCM_SHA256
bTLS 1.2 AEAD AES-128 GCM AES 128 Yes No No ECDHE_RSA_AES_256_GCM_SHA384
bTLS 1.2 AEAD AES-256 GCM AES 256 Yes No No TLS_RSA_WITH_NULL_SHA256
bTLS 1.2 SHA-256 None 0 No No No ECDHE_RSA_NULL_SHA256
bTLS 1.2 SHA-1 None 0 No No No ECDHE_ECDSA_NULL_SHA256
bTLS 1.2 SHA-1 None 0 No No No TLS_RSA_WITH_NULL_NULL
bTLS 1.2 None None 0 No No No TLS_RSA_WITH_RC4_128_SHA256
bTLS 1.2 SHA-1 RC4 128 No No No Notes:- Specifies whether the CipherSpec is FIPS-certified on a FIPS-certified platform. See Federal Information Processing Standards (FIPS) for an explanation of FIPS.
- The maximum handshake key size is 512 bits. If either of the certificates exchanged during the SSL handshake has a key size greater than 512 bits, a temporary 512-bit key is generated for use during the handshake.
- The handshake key size is 1024 bits.
- This CipherSpec cannot be used to secure a connection from the WebSphere MQ Explorer to a queue manager unless the appropriate unrestricted policy files are applied to the JRE used by the Explorer.
- This CipherSpec was FIPS 140-2 certified before 19 May 2007.
- This CipherSpec was FIPS 140-2 certified before 19 May 2007. The name
FIPS_WITH_DES_CBC_SHA
is historical and reflects the fact that this CipherSpec was previously (but is no longer) FIPS-compliant. This CipherSpec is deprecated and its use is not recommended. - This CipherSpec can be used to transfer up to 32 GB of data before the connection is terminated with error AMQ9288. To avoid this error, either avoid using triple DES, or enable secret key reset when using this CipherSpec.
Platform support:a
Available on all supported platforms.b
Available only on UNIX, Linux, and Windows platforms.
When you request a personal certificate, you specify a key size for the public and private key pair. The key size that is used during the SSL handshake can depend on the size stored in the certificate and on the CipherSpec:- On z/OS, Windows, UNIX and Linux systems, when
a CipherSpec name includes
_EXPORT
, the maximum handshake key size is 512 bits. If either of the certificates exchanged during the SSL handshake has a key size greater than 512 bits, a temporary 512-bit key is generated for use during the handshake. - On Windows, UNIX and Linux systems, when
a CipherSpec name includes
_EXPORT1024
, the handshake key size is 1024 bits. - Otherwise the handshake key size is the size stored in the certificate.
- SSLKEYP
(string)
- The store for digital certificates and their associated private keys. If you do not specify a key file, SSL is not used.
- SSLKEYR
(string)
- The password for the key repository. If no passphrase is entered, then unencrypted connections must be used.
- SSLPEER(string)
-
Specifies the certificate filter used by the peer queue manager or client at the other end of the channel. The filter is used to compare with the distinguished name of the certificate. A
distinguished name
is the identifier of the SSL certificate. If the distinguished name in the certificate received from the peer does not match the SSLPEER filter, the channel does not start.Note: An alternative way of restricting connections into channels by matching against the SSL or TLS Subject distinguished name, is to use channel authentication records. With channel authentication records, different SSL or TLS subject distinguished name patterns can be applied to the same channel. Both SSLPEER and a channel authentication record can be applied to the same channel. If so, the inbound certificate must match both patterns in order to connect. For more information, see Channel authentication records.SSLPEER is optional. If it is not specified, the distinguished name of the peer is not checked at channel startup. The distinguished name from the certificate is still written into the SSLPEER definition held in memory, and passed to the security exit. If SSLCIPH is blank, the data is ignored and no error message is issued.
This parameter is valid for all channel types.
The SSLPEER value is specified in the standard form used to specify a distinguished name. For example:SSLPEER('SERIALNUMBER=4C:D0:49:D5:02:5F:38,CN="H1_C_FR1",O=IBM,C=GB')
You can use a semi-colon as a separator instead of a comma.
The possible attribute types supported are:IBM WebSphere MQ accepts only uppercase letters for the attribute types.Table 6. Attribute types supported by SSLPEER. A two column table describing the attributes supported by the SSLPEER parameter
Attribute Description SERIALNUMBER Certificate serial number MAIL Email address E Email address (Deprecated in preference to MAIL) UID or USERID User identifier CN Common Name T Title OU Organizational Unit name DC Domain component O Organization name STREET Street / First line of address L Locality name ST (or SP or S) State or Province name PC Postal code / zipcode C Country UNSTRUCTUREDNAME Host name UNSTRUCTUREDADDRESS IP address DNQ Distinguished name qualifier If any of the unsupported attribute types are specified in the SSLPEER string, an error is output either when the attribute is defined, or at run time. When the error is output depends on which platform you are running on. An error implies that the SSLPEER string does not match the distinguished name of the flowed certificate.
If the distinguished name of the flowed certificate contains multiple organizational unit (OU) attributes, and SSLPEER specifies that these attributes are to be compared, they must be defined in descending hierarchical order. For example, if the distinguished name of the flowed certificate contains the OUsOU=Large Unit, OU=Medium Unit, OU=Small Unit
, specifying the following SSLPEER values works:
but specifying the following SSLPEER values fails:('OU=Large Unit,OU=Medium Unit') ('OU=*,OU=Medium Unit,OU=Small Unit') ('OU=*,OU=Medium Unit')
As indicated in these examples, attributes at the low end of the hierarchy can be omitted. For example,('OU=Medium Unit,OU=Small Unit') ('OU=Large Unit,OU=Small Unit') ('OU=Medium Unit') ('OU=Small Unit, Medium Unit, Large Unit')
('OU=Large Unit,OU=Medium Unit')
is equivalent to('OU=Large Unit,OU=Medium Unit,OU=*')
If two DNs are equal in all respects except for their domain component (DC)) values, almost the same matching rules apply as for OUs. The exception is that with DC values, the left-most DC is the lowest-level and most specific, and the comparison ordering differs accordingly.
Any or all the attribute values can be generic, either an asterisk*
on its own, or a stem with initiating or trailing asterisks. Asterisks allow the SSLPEER to match any distinguished name value, or any value starting with the stem for that attribute. You can specify an asterisk at the beginning or end of any attribute value in the DN on the certificate. If you do so, you can still check for an exact match with SSLPEER. Specify\*
to check for an exact match. For example, if you have an attribute ofCN='Test*'
in the DN of the certificate, you use the following command to check for an exact match:SSLPEER('CN=Test\*')
The maximum length of the parameter is 1024 bytes on AIX, HP-UX, IBM i, Linux, Solaris, and Windows platforms, and 256 bytes on z/OS.
- STATCHL
- Controls the collection of statistics
data for channels:
- QMGR
- The value of the STATCHL parameter of the queue manager is inherited by the channel.
- OFF
- Statistics data collection is turned off for this channel.
- LOW
- If the value of the STATCHL parameter of the queue manager is not NONE, statistics data collection is turned on. Data is collected at a low rate for this channel.
- MEDIUM
- If the value of the STATCHL parameter of the queue manager is not NONE, statistics data collection is turned on. Data is collected at a medium rate for this channel.
- HIGH
- If the value of the STATCHL parameter of the queue manager is not NONE, statistics data collection is turned on. Data is collected at a high rate for this channel.
Changes to this parameter take effect only on channels started after the change occurs.
For cluster channels, the value of this parameter is not replicated in the repository and used in the auto-definition of CLUSSDR channels. For auto-defined CLUSSDR channels, the value of this parameter is taken from the attribute STATACLS of the queue manager. This value might then be overridden in the channel auto-definition exit.
This parameter is valid only on AIX, HP-UX, IBM i, Linux, Solaris, and Windows.
- TPNAME
(string)
- LU 6.2 transaction program name (maximum
length 64 characters).
This parameter is valid only for channels with a transport type (TRPTYPE) of LU62.
Set this parameter to the SNA transaction program name, unless the CONNAME contains a side-object name in which case set it to blanks. The actual name is taken instead from the CPI-C Communications Side Object, or the APPC side information data set.
On Windows SNA Server, and in the side object on z/OS, the TPNAME is wrapped to uppercase.
This parameter is not valid for channels with a channel type (CHLTYPE) of RCVR.
- TRPTYPE
- Transport
type to be used.
On AIX, HP-UX, Linux, IBM i, Solaris, Windows, and z/OS, this parameter is optional because, if you do not enter a value, the value specified in the
SYSTEM.DEF.channel-type
definition is used. If the channel is initiated from the other end, no check is made that the correct transport type is specified. On z/OS, if theSYSTEM.DEF.channel-type
definition does not exist, the default is LU62.This parameter is required on all other platforms.- LU62
- SNA LU 6.2
- NETBIOS
- NetBIOS (supported only on Windows, and DOS; it also applies to z/OS for defining CLNTCONN channels that connect to servers on the platforms supporting NetBIOS)
- SPX
- Sequenced packet exchange (supported only on Windows, and DOS; it also applies to z/OS for defining CLNTCONN channels that connect to servers on the platforms supporting SPX)
- TCP
- Transmission Control Protocol - part of the TCP/IP protocol suite
- USECLTID
- Decide whether you want to use the IBM WebSphere MQ Telemetry client ID for the new connection as the IBM WebSphere MQ user ID for that connection. If this property is specified, the user name supplied by the client is ignored.
- USEDLQ
- Determines whether the dead-letter queue is used when messages
cannot be delivered by channels.
- NO
- Messages that cannot be delivered by a channel are treated as a failure. The channel either discards the message, or the channel ends, in accordance with the NPMSPEED setting.
- YES
- When the DEADQ queue manager attribute provides the name of a dead-letter queue, then it is used, else the behavior is as for NO. YES is the default value.
- USERID
(string)
- Task user identifier. The maximum
length is 12 characters.
This parameter is used by the message channel agent when attempting to initiate a secure LU 6.2 session with a remote message channel agent.
This parameter is valid only for channels with a channel type (CHLTYPE) of SDR, SVR, RQSTR, CLNTCONN, or CLUSSDR. On z/OS, it is supported only for CLNTCONN channels.
Although the maximum length of the parameter is 12 characters, only the first 10 characters are used.
On the receiving end, if passwords are encrypted and the LU 6.2 software is using a different encryption method, the channel fails to start. The error is diagnosed as invalid security details. You can avoid invalid security details by modifying the receiving SNA configuration to either:- Turn off password substitution, or
- Define a security user ID and password.
- XMITQ
(string)
- Transmission queue name.
The name of the queue from which messages are retrieved. See Rules for naming IBM WebSphere MQ objects .
This parameter is valid only for channels with a channel type (CHLTYPE) of SDR or SVR. For these channel types, this parameter is required.