The parameter descriptions also apply to the ALTER CHANNEL command, with the following exceptions:
Table 2 shows the parameters that are relevant for each type of channel. There is a description of each parameter after the table. Parameters are optional unless the description states that they are required.
Parameter | SDR | SVR | RCVR | RQSTR | CLNT- CONN | SVR- CONN | CLUS- SDR | CLUS- RCVR |
---|---|---|---|---|---|---|---|---|
AUTOSTART | X | X | X | X | ||||
BATCHHB | X | X | X | X | ||||
BATCHINT | X | X | X | X | ||||
BATCHSZ | X | X | X | X | X | X | ||
channel-name | X | X | X | X | X | X | X | X |
CHLTYPE | X | X | X | X | X | X | X | X |
CLUSNL | X | X | ||||||
CLUSTER | X | X | ||||||
CLWLPRTY | X | X | ||||||
CLWLRANK | X | X | ||||||
CLWLWGHT | X | X | ||||||
CMDSCOPE | X | X | X | X | X | X | X | X |
COMPHDR | X | X | X | X | X | X | X | X |
COMPMSG | X | X | X | X | X | X | X | X |
CONNAME | X | X | X | X | X | X | ||
CONVERT | X | X | X | X | ||||
DESCR | X | X | X | X | X | X | X | X |
DISCINT | X | X | X | X | X | |||
HBINT | X | X | X | X | X | X | X | X |
KAINT | X | X | X | X | X | X | X | X |
LIKE | X | X | X | X | X | X | X | X |
LOCLADDR | X | X | X | X | X | X | ||
LONGRTY | X | X | X | X | ||||
LONGTMR | X | X | X | X | ||||
MAXMSGL | X | X | X | X | X | X | X | X |
MCANAME | X | X | X | X | X | |||
MCATYPE | X | X | X | X | X | |||
MCAUSER | X | X | X | X | X | X | X | |
MODENAME | X | X | X | X | X | X | ||
MONCHL | X | X | X | X | X | X | X | |
MRDATA | X | X | X | |||||
MREXIT | X | X | X | |||||
MRRTY | X | X | X | |||||
MRTMR | X | X | X | |||||
MSGDATA | X | X | X | X | X | X | ||
MSGEXIT | X | X | X | X | X | X | ||
NETPRTY | X | |||||||
NPMSPEED | X | X | X | X | X | X | ||
PASSWORD | X | X | X | X | X | |||
PUTAUT | X | X | X | X | ||||
QMNAME | X | |||||||
QSGDISP | X | X | X | X | X | X | X | X |
RCVDATA | X | X | X | X | X | X | X | X |
RCVEXIT | X | X | X | X | X | X | X | X |
REPLACE | X | X | X | X | X | X | X | X |
SCYDATA | X | X | X | X | X | X | X | X |
SCYEXIT | X | X | X | X | X | X | X | X |
SENDDATA | X | X | X | X | X | X | X | X |
SENDEXIT | X | X | X | X | X | X | X | X |
SEQWRAP | X | X | X | X | X | X | ||
SHORTRTY | X | X | X | X | ||||
SHORTTMR | X | X | X | X | ||||
SSLCAUTH | X | X | X | X | X | |||
SSLCIPH | X | X | X | X | X | X | X | X |
SSLPEER | X | X | X | X | X | X | X | X |
STATCHL | X | X | X | X | X | X | ||
TPNAME | X | X | X | X | X | X | X | |
TRPTYPE | X | X | X | X | X | X | X | X |
USERID | X | X | X | X | X | |||
XMITQ | X | X |
Parameters are optional unless the description states that they are required.
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 cluster-sender channels includes the name of the queue manager, you can define a cluster-sender channel using the +QMNAME+ construction. After connection to the matching cluster-receiver channel, WebSphere MQ substitutes the correct repository queue manager name in place of +QMNAME+ in the cluster-sender channel definition. This facility applies to AIX, HP-UX, Linux, i5/OS, Solaris, and Windows only. For a full explanation of this facility, see WebSphere MQ Queue Manager Clusters.
The name must not be the same as any existing channel defined on this queue manager (unless REPLACE or ALTER is specified). On z/OS, client-connection 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 WebSphere MQ objects.
This parameter is valid only for channels with a channel type (CHLTYPE) of RCVR, RQSTR, SVR, and SVRCONN. It is supported only on Compaq NSK.
Batch heartbeats allow a sending channel to verify that the receiving channel is still active just before committing a batch of messages, so that 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 has had a communication from the receiving channel within the batch heartbeat interval, the receiving channel is assumed to be still active, otherwise a 'heartbeat' is sent to the receiving channel to check.
The value must be in the range zero through 999 999. A value of zero indicates that batch heartbeating is not used.
This parameter is valid only for channels with a channel type (CHLTYPE) of SDR, SVR, CLUSSDR and CLUSRCVR.
The batch is terminated by whichever of the following occurs first:
The default value is zero, which means that the batch is terminated as soon as the transmission queue becomes empty (or the BATCHSZ limit is reached).
The value must be in the range zero, through 999 999 999.
This parameter is valid only for channels with a channel type (CHLTYPE) of SDR, SVR, CLUSSDR, or CLUSRCVR. It is valid only on AIX, HP OpenVMS, HP-UX, Linux, i5/OS, Solaris, Windows, and z/OS.
The maximum batch size actually used is the lowest of the following:
The maximum number of uncommitted messages is specified by the MAXUMSGS parameter of the ALTER QMGR command.
This parameter is valid only for channels with a channel type (CHLTYPE) of SDR, SVR, RCVR, RQSTR, CLUSSDR, or CLUSRCVR.
The value must be in the range 1 through 9999.
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.
This parameter is valid only on AIX, HP OpenVMS, HP-UX, Linux i5/OS, Solaris, Windows, and z/OS.
This parameter is valid only for channels with a channel type (CHLTYPE) of CLUSSDR or CLUSRCVR. Only one of the resultant values of CLUSTER or CLUSNL can be nonblank, the other must be blank.
This parameter is valid only on AIX, HP OpenVMS, HP-UX, Linux, i5/OS, Solaris, Windows and z/OS.
This parameter is valid only for channels with a channel type (CHLTYPE) of CLUSSDR or CLUSRCVR.
For more information about this attribute, see WebSphere MQ Queue Manager Clusters.
This parameter is valid only for channels with a channel type (CHLTYPE) of CLUSSDR or CLUSRCVR.
For more information about this attribute, see WebSphere MQ Queue Manager Clusters.
This parameter is valid only for channels with a channel type (CHLTYPE) of CLUSSDR or CLUSRCVR.
For more information about this attribute, see WebSphere MQ Queue Manager Clusters.
CMDSCOPE must be blank, or the local queue manager, if QSGDISP is set to GROUP.
You can specify a queue manager name other than the queue manager on which it was entered, only if you are using a shared queue environment and if the command server is enabled.
The channel's mutually supported compression techniques are passed to the sending channel's message exit where the compression technique used can be altered on a per message basis. Compression alters the data passed to send and receive exits.
The channel's mutually supported compression techniques are passed to the sending channel's message exit where the compression technique used can be altered on a per message basis. Compression will alter the data passed to send and receive exits.
For cluster-receiver channels (when specified) 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.
This parameter 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.
The value you specify depends on the transport type (TRPTYPE) to be used:
CONNAME('node_name(object_name)')
This is valid only on HP OpenVMS.
CONNAME('gateway_node.access_name(tpname)')
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.
The specified or implied LU name can be that of a VTAM(R) generic resources group.
See the information about configuration parameters for an LU 6.2 connection for your platform in the WebSphere MQ Intercommunication manual for more information.
CONNAME('$PPPP.LOCALLU.REMOTELU')
CONNAME('$PPPP.LOCALLU')The name of the local LU can be an asterisk (*), indicating any name.
CONNAME('$PPPP.#OPEN.LOCALLU.REMOTELU')For receiver and non fully qualified server channels, this is the process name of the SNAX/APC process, the ICE open name, and the name of the local LU, for example:
CONNAME('$PPPP.#OPEN.LOCALLU')The name of the local LU can be an asterisk (*), indicating any name.
CONNAME('0a0b0c0d.804abcde23a1(5e86)')
If the socket number is omitted, the WebSphere MQ default value (X'5e86') is assumed.
If the CONNAME is a hostname, the hostname 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 *** for information about how this 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 this for channels with a channel type (CHLTYPE) of CLUSSDR.
On Compaq NonStop Kernel the connection name can take an additional field at the start of the value, specifying the name of a specific Guardian TCP/IP server process to be used for the channel.
On AIX, HP-UX, Linux, i5/OS, Solaris, Windows, and z/OS, when you define a channel with a channel type (CHLTYPE) of CLUSRCVR that is using TCP/IP, you do not need to specify the network address of your queue manager. WebSphere MQ generates a CONNAME for you, assuming the default port and using 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.
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.
It should contain only displayable characters. The maximum length is 64 characters. In a DBCS installation, it can contain DBCS characters (subject to a maximum length of 64 bytes).
The value must be in the range zero through 999 999.
This parameter is valid only for channels with a channel type (CHLTYPE) of SVRCONN (on z/OS only), SDR, SVR, CLUSSDR, CLUSRCVR.
For SVRCONN channels on z/OS using the TCP protocol, this 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 only applies between 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.
The value must be in the range zero through 999 999. A value of zero means that no heartbeat exchange takes place. The value that is used is the larger of the values specified at the sending side and the receiving side.
This parameter is valid only on AIX, HP OpenVMS, HP-UX, Linux, i5/OS, Solaris, Windows and z/OS.
For this attribute to have any effect, TCP/IP keepalive must be enabled both in the queue manager and in TCP/IP. On z/OS, you 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 the KEEPALIVE=YES parameter is specified in the TCP stanza in the distributed queuing configuration file, qm.ini, or through the WebSphere(R) 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 'nettune' 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; there is no functional implementation of the parameter. This is useful in a clustered environment where a value set in a cluster-receiver channel definition on Solaris, for example, flows to (and is implemented by) 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.
This parameter is valid for all channel types. It is ignored for channels with a TRPTYPE other than TCP or SPX.
This parameter applies only to the DEFINE CHANNEL command.
If this field is not filled in, and you do not complete the parameter fields related to the command, the values are taken from one of the following, depending upon the channel type:
This is equivalent to defining the following object:
LIKE(SYSTEM.DEF.SENDER)
for a sender channel, and similarly for other channel types.
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.
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])])
where ip-addr is specified in IPv4 dotted decimal, IPv6 hexadecimal notation, or alphanumeric hostname form, and low-port and high-port are port numbers enclosed in parentheses. All are optional.
Table 3 shows how the LOCLADDR parameter can be used:
LOCLADDR | Meaning |
---|---|
9.20.4.98 | Channel binds to this address locally |
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 to 2000 locally |
(1000) | Channel binds to port 1000 locally |
(1000,2000) | Channel binds to port in range 1000 to 2000 locally |
This parameter is valid only for channels with a channel type (CHLTYPE) of SDR, SVR, RQSTR, CLNTCONN, CLUSSDR, or CLUSRCVR.
On cluster-sender channels, the IP address and port to which the outbound channel binds to is a merger 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.
Even though this parameter is similar in form to CONNAME, it should 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 4 for further details on how the IP stack is determined. For further guidance, see the WebSphere MQ Intercommunication manual.
If the appropriate IP stack for the local address is not installed or configured, the channel fails to start and an error message is generated.
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 hostname3 | 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 hostname | IPv4 address | Channel binds to IPv4 stack | |
Any address4 | IPv6 address | Channel fails to resolve LOCLADDR | |
IPv4 address | IPv4 and 6 hostname | Channel binds to IPv4 stack | |
IPv6 address | IPv4 and 6 hostname | Channel fails to resolve CONNAME | |
IPv4 and 6 hostname | IPv4 and 6 hostname | 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 hostname | 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 hostname | 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 hostname | IPv6 address | Channel binds IPv6 stack | |
IPv4 address | IPv4 and 6 hostname | Channel binds to IPv4 stack | |
IPv6 address | IPv4 and 6 hostname | Channel binds to IPv6 stack | |
IPv4 and 6 hostname | IPv4 and 6 hostname | 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 hostname | 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 hostname | IPv6 address | Channel binds to IPv6 stack | |
IPv4 address | IPv4 and 6 hostname | Channel maps CONNAME to IPv65 | |
IPv6 address | IPv4 and 6 hostname | Channel binds to IPv6 stack | |
IPv4 and 6 hostname | IPv4 and 6 hostname | Channel binds to IPv6 stack | |
Notes:
1. IPv4 address. An IPv4 hostname that only resolves to an IPv4 network address or a specific dotted notation IPv4 address, for example 1.2.3.4. This applies to all occurrences of 'IPv4 address' in this table. 2. IPv6 address. An IPv6 hostname that only resolves to an IPv6 network address or a specific hexadecimal notation IPv6 address, for example 4321:54bc. This applies to all occurrences of 'IPv6 address' in this table. 3. IPv4 and 6 hostname. A hostname that resolves to both IPv4 and IPv6 network addresses. This applies to all occurrences of 'IPv4 and 6 hostname' in this table. 4. Any address. IPv4 address, IPv6 address, or IPv4 and 6 hostname. This applies to all occurrences of 'Any address' in this table. 5. 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 may require protocol translators in order to be used. The use of mapped addresses is not recommended. |
If this count is also exhausted without success, an error is logged to the operator, and the channel is stopped. The channel must subsequently be restarted with a command (it is not started automatically by the channel initiator).
The value must be in the range zero through 999 999 999.
This parameter is valid only for channels with a channel type (CHLTYPE) of SDR, SVR, CLUSSDR, or CLUSRCVR.
The time is approximate; zero means that another connection attempt is made as soon as possible.
The interval between retries might be extended if the channel has to wait to become active.
The value must be in the range zero through 999 999 999.
This parameter is valid only for channels with a channel type (CHLTYPE) of SDR, SVR, CLUSSDR, or CLUSRCVR.
The value zero means the maximum message length for the queue manager.
On AIX, HP OpenVMS, HP-UX, Linux, i5/OS, Solaris, and Windows, specify a value in the range zero through to the maximum message length for the queue manager.
See the MAXMSGL parameter of the ALTER QMGR command for more information.
On z/OS, specify a value in the range zero through 100 MB (104 857 600 bytes).
On other platforms, specify a value in the range zero through 4 MB (4 194 304 bytes).
This is reserved, and if specified must only be set to blanks (maximum length 20 characters).
In situations where a threaded listener is required to service a large number of incoming requests, resources can become strained. In this case, you should 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 OpenVMS, HP-UX, Linux, i5/OS, 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.
If it is nonblank, it is the user identifier that is to be used by the message channel agent for authorization to access WebSphere MQ resources, including (if PUTAUT is DEF) authorization to put the message to the destination queue for receiver or requester 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:
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 CLNTCONN.
This parameter is valid only for channels with a transport type (TRPTYPE) of LU 6.2. If TRPTYPE is not LU 6.2, the data is ignored and no error message is issued.
If specified, this should be set to the SNA mode name unless the CONNAME contains a side-object name, in which case it should be set to blanks. The actual name is then taken from the CPI-C Communications Side Object, or APPC side information data set.
See the information about configuration parameters for an LU 6.2 connection for your platform in the WebSphere MQ Intercommunication manual for more information.
This parameter is not valid for channels with a channel type (CHLTYPE) of RCVR or SVRCONN.
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 cluster-sender channels. For auto-defined cluster-sender channels, the value of this parameter is taken from the queue manager's attribute MONACLS. This value may then be overridden in the channel auto-definition exit.
This 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.
The format and maximum length of the name is the same as for MSGEXIT, however you can only specify one message-retry exit.
This parameter is valid only for channels with a channel type (CHLTYPE) of RCVR, RQSTR, or CLUSRCVR.
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 for the exit's use, but the number of retries performed (if any) is controlled by the exit, and not by this parameter.
The value must be in the range zero through 999 999 999. A value of zero means that no retries are performed.
The default value is 10, except for z/OS channels that you are migrating from an earlier release which take a value of zero as default.
This parameter is valid only for channels with a channel type (CHLTYPE) of RCVR, RQSTR, or CLUSRCVR. .
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 for the exit's use, but the retry interval is controlled by the exit, and not by this parameter.
The value must be in the range zero through 999 999 999. A value of zero means that the retry is performed as soon as possible (provided that the value of MRRTY is greater than zero).
This parameter is valid only for channels with a channel type (CHLTYPE) of RCVR, RQSTR, or CLUSRCVR.
This data is passed to the channel message exit when it is called.
On AIX, HP OpenVMS, 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 i5/OS, 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 8 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.
On Compaq NSK, there is only one channel user exit program. 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. This string is passed to the exit program, but it is not used to determine the program name.
On other platforms, if this name is nonblank, the exit is called at the following times:
The exit is given the entire application message and transmission queue header for modification.
On AIX, HP OpenVMS, 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 i5/OS, 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 8 exit programs by specifying multiple strings separated by commas.
On other platforms you can specify only one message exit name for each channel.
For channels with a channel type (CHLTYPE) of CLNTCONN or SVRCONN, this parameter is accepted but ignored, because message exits are not invoked for such channels.
The format and maximum length of the name depends on the environment:
libraryname(functionname)The maximum length of the string is 128 characters.
dllname(functionname)where dllname is specified without the suffix (".DLL"). The maximum length of the string is 128 characters.
progname libnamewhere program name occupies the first 10 characters and libname the second 10 characters (both padded to the right with blanks if necessary). The maximum length of the string is 20 characters.
This parameter is valid only for CLUSRCVR channels.
This parameter is valid only on AIX, HP OpenVMS, HP-UX, Linux, i5/OS, Solaris, Windows, and z/OS.
This parameter is valid only for channels with a CHLTYPE of SDR, SVR, RCVR, RQSTR, CLUSSDR, or CLUSRCVR. It is valid only on AIX, HP OpenVMS, HP-UX, Linux, i5/OS, Solaris, Windows, and z/OS.
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.
This parameter is valid only for channels with a channel type (CHLTYPE) of RCVR, RQSTR, CLUSRCVR, or, on z/OS only, SVRCONN.
For channels with a channel type (CHLTYPE) of CLNTCONN, this is the name of the queue manager to which an application running in the MQI client environment can request connection.
Specifies the disposition of the object to which you are applying the command (that is, where it is defined and how it behaves).
QSGDISP | ALTER | DEFINE |
---|---|---|
COPY | The object definition resides on the page set of the queue manager that executes the command. The object was defined using a command that had the parameters QSGDISP(COPY). Any object residing in the shared repository, or any object defined using a command that had the parameters QSGDISP(QMGR), is not affected by this command. | The object is defined on the page set of the queue manager that executes the command using the QSGDISP(GROUP) object of the same name as the 'LIKE' object. |
GROUP | The object definition resides in the shared repository. The object
was defined using a command that had the parameters QSGDISP(GROUP). Any object
residing on the page set of the queue manager that executes the command (except
a local copy of the object) is not affected by this command.
If the command is successful, the following command is generated and sent to all active queue managers in the queue-sharing group to attempt to refresh local copies on page set zero: DEFINE CHANNEL(channel-name) CHLTYPE(type) REPLACE QSGDISP(COPY)The ALTER for the group object takes effect regardless of whether the generated command with QSGDISP(COPY) fails. |
The object definition resides in the shared repository.
This is allowed only if the queue manager is in a queue-sharing group.
If the definition is successful, the following command is generated and sent to all active queue managers in the queue-sharing group to attempt to make or refresh local copies on page set zero: DEFINE CHANNEL(channe-name) CHLTYPE(type) REPLACE QSGDISP(COPY)The DEFINE for the group object takes effect regardless of whether the generated command with QSGDISP(COPY) fails. |
PRIVATE | The object resides on the page set of the queue manager
that executes the command, and was defined with QSGDISP(QMGR) or QSGDISP(COPY).
Any object residing in the shared repository is unaffected. |
Not permitted. |
QMGR | The object definition resides on the page set of the queue
manager that executes the command. The object was defined using a command
that had the parameters QSGDISP(QMGR). Any object residing in the shared repository,
or any local copy of such an object, is not affected by this command.
This is the default value. |
The object is defined on the page set of the queue manager
that executes the command.
This is the default value. |
This is passed to the channel receive exit when it is called.
On AIX, HP OpenVMS, 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 i5/OS, 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 8 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.
On platforms other than Compaq NSK, if this name is nonblank, the exit is called at the following times:
The exit is given the complete transmission buffer as received. The contents of the buffer can be modified as required.
On AIX, HP OpenVMS, 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 i5/OS, 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 8 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.
This parameter applies only to the DEFINE CHANNEL command.
This is passed to the channel security exit when it is called.
On platforms other than Compaq NSK, if this name is nonblank, the exit is called at the following times:
Before any messages are transferred, the exit is given the opportunity to instigate security flows to validate connection authorization.
Any security message flows received from the remote processor on the remote queue manager are given to the exit.
The format and maximum length of the name is the same as for MSGEXIT but only one name is allowed.
This is passed to the channel send exit when it is called.
On AIX, HP OpenVMS, 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 i5/OS, 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 8 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.
On platforms other than Compaq NSK, if this name is nonblank, the exit is called at the following times:
The exit is given the complete transmission buffer before it is transmitted. The contents of the buffer can be modified as required.
On AIX, HP OpenVMS, 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 i5/OS, 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 8 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.
This value is nonnegotiable and must match in both the local and remote channel definitions.
The value must be in the range 100 through 999 999 999.
This parameter is valid only for channels with a channel type (CHLTYPE) of SDR, SVR, RCVR, RQSTR, CLUSSDR, or CLUSRCVR.
Retry attempts are made if the channel fails to connect initially (whether it is started automatically by the channel initiator or by an explicit command), and also if the connection fails after the channel has successfully connected. However, if the cause of the failure is such that retry is unlikely to be successful, retries are not attempted.
The value must be in the range zero through 999 999 999.
This parameter is valid only for channels with a channel type (CHLTYPE) of SDR, SVR, CLUSSDR, or CLUSRCVR.
The time is approximate; zero means that another connection attempt is made as soon as possible.
The interval between retries might be extended if the channel has to wait to become active.
The value must be in the range zero through 999 999 999.
This parameter is valid only for channels with a channel type (CHLTYPE) of SDR, SVR, CLUSSDR, or CLUSRCVR.
This parameter is valid only for channels with a channel type (CHLTYPE) of RCVR, SVRCONN, CLUSRCVR, SVR, or RQSTR.
The parameter is used only for channels with SSLCIPH specified. If SSLCIPH is blank, the data is ignored and no error message is issued.
This parameter is valid only for channels with a transport type (TRPTYPE) of TCP. If the TRPTYPE is not TCP, the data is ignored and no error message is issued.
The SSLCIPH values must specify the same CipherSpec on both ends of the channel.
Specify the name of the CipherSpec you are using. The CipherSpecs that can be used with WebSphere MQ SSL support are shown in Table 5.
On i5/OS, installation of AC3 is a prerequisite of the use of SSL.
CipherSpec name | Hash algorithm | Encryption algorithm | Encryption bits | FIPS on Windows and UNIX platforms 1 |
---|---|---|---|---|
NULL_MD5
Note:
Available
on all platforms |
MD5 | None | 0 | No |
NULL_SHA
Note:
Available
on all platforms |
SHA-1 | None | 0 | No |
RC4_MD5_EXPORT
Note:
Available on all platforms |
MD5 | RC4 | 40 | No |
RC4_MD5_US
Note:
Available
on all platforms |
MD5 | RC4 | 128 | No |
RC4_SHA_US
Note:
Available
on all platforms |
SHA-1 | RC4 | 128 | No |
RC2_MD5_EXPORT
Note:
Available on all platforms |
MD5 | RC2 | 40 | No |
DES_SHA_EXPORT
Note:
Available on all platforms |
SHA-1 | DES | 56 | No |
RC4_56_SHA_EXPORT1024
Notes:
|
SHA-1 | RC4 | 56 | No |
DES_SHA_EXPORT1024
Notes:
|
SHA-1 | DES | 56 | No |
TRIPLE_DES_SHA_US
Note:
Not available for i5/OS |
SHA-1 | 3DES | 168 | No |
TLS_RSA_WITH_AES_128_CBC_SHA
Notes:
|
SHA-1 | AES | 128 | Yes |
TLS_RSA_WITH_AES_256_CBC_SHA
Notes:
|
SHA-1 | AES | 256 | Yes |
AES_SHA_US
Note:
Available on i5/OS(TM) only |
SHA-1 | AES | 128 | No |
TLS_RSA_WITH_DES_CBC_SHA
Notes:
|
SHA-1 | DES | 56 | Yes |
TLS_RSA_WITH_3DES_EDE_CBC_SHA
Notes:
|
SHA-1 | 3DES | 168 | Yes |
FIPS_WITH_DES_CBC_SHA
Note:
Available only on Windows and UNIX platforms |
SHA-1 | DES | 56 | Yes |
FIPS_WITH_3DES_EDE_CBC_SHA
Note:
Available only on Windows and UNIX platforms |
SHA-1 | 3DES | 168 | Yes |
Notes:
|
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:
If the SSLCIPH parameter is blank, no attempt is made to use SSL on the channel.
Specifies the filter to use to compare with the Distinguished Name of the certificate from the peer queue manager or client at the other end of the channel. (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
This parameter is optional; if it is not specified, the Distinguished Name of the peer is not checked at channel start up. (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('CN="xxx yyy zzz",O=xxx,C=xxx')
You can use a semi-colon as a separator instead of a comma.
The possible attribute types supported are:
CN | common name |
T | title |
OU | organizational unit name |
O | organization name |
L | locality name |
S, ST, or SP(TM) | state or province name |
C | country |
WebSphere MQ will only accept upper case letters for the attribute types.
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 (depending on which platform you are running on), and the string is deemed not to have matched the flowed certificate's Distinguished Name.
If the flowed certificate's Distinguished Name contains multiple OU (organisational unit) attributes, and SSLPEER specifies these attributes to be compared, they must be defined in descending hierarchical order. For example, if the flowed certificate's Distinguished Name contains the OUs OU=Large Unit, OU=Medium Unit, OU=Small Unit, specifying the following SSLPEER values will work:
('OU=Large Unit,OU=Medium Unit') ('OU=*,OU=Medium Unit,OU=Small Unit') ('OU=*,OU=Medium Unit')
but specifying the following SSLPEER values will fail:
('OU=Medium Unit,OU=Small Unit') ('OU=Large Unit,OU=Small Unit') ('OU=Medium Unit') ('OU=Small Unit, Medium Unit, Large Unit')
Any or all of the attribute values can be generic, either an asterisk (*) on its own, or a stem with initiating or trailing asterisks. This allows the SSLPEER to match any Distinguished Name value, or any value starting with the stem for that attribute.
If an asterisk is specified at the beginning or end of any attribute value in the Distinguished Name on the certificate, you can specify '\*' to check for an exact match in SSLPEER. For example, if you have an attribute of CN='Test*' in the Distinguished Name of the certificate, you can use the following command:
SSLPEER('CN=Test\*')
The maximum length of the parameter is 1024 bytes on Windows, i5/OS, and UNIX platforms, and 256 bytes on z/OS.
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 cluster-sender channels. For auto-defined cluster-sender channels, the value of this parameter is taken from the queue manager's attribute STATACLS. This value may then be overridden in the channel auto-definition exit.
This parameter is valid only on AIX, HP-UX, Linux, i5/OS, Solaris, and Windows.
This parameter is valid only for channels with a transport type (TRPTYPE) of LU 6.2.
On Compaq NSK, this should be set to the local TP name. This can be followed by the name of the TP on the remote machine, for example:
TPNAME('localtp[.remotetp]')
Both names can be up to 16 characters in length.
On other platforms, this should be set to the SNA transaction program name, unless the CONNAME contains a side-object name in which case it should be set to blanks. The actual name is taken instead from the CPI-C Communications Side Object, or the APPC side information data set.
See the information about configuration parameters for an LU 6.2 connection for your platform in the WebSphere MQ Intercommunication manual for more information.
On Windows SNA Server, and in the side object on z/OS, the TPNAME is wrapped to upper case.
This parameter is not valid for channels with a channel type (CHLTYPE) of RCVR.
On AIX, HP-UX, Linux, i5/OS, 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. However, no check is made that the correct transport type has been specified if the channel is initiated from the other end. On z/OS, if the SYSTEM.DEF.channel-type definition does not exist, the default is LU62.
This is required on all other platforms.
This 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 kept in encrypted format and the LU 6.2 software is using a different encryption method, an attempt to start the channel fails with invalid security details. You can avoid this by modifying the receiving SNA configuration to either:
The name of the queue from which messages are retrieved. See Rules for naming 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.
Notices |
Downloads |
Library |
Support |
Feedback
![]() ![]() |
csqzaj1039 |