Home

 

Parameter descriptions

 

The parameter descriptions also apply to the ALTER CHANNEL command, with the following exceptions:

Table 1 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.

DEFINE and ALTER CHANNEL parameters
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.

(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 cluster-sender channels includes the name of the queue manager, we 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.

AUTOSTART

Specifies whether an LU 6.2 responder process for the channel will be started at queue manager startup.

ENABLED

The responder is started.

DISABLED

The responder is not started (this is the default).

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.

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, 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.

BATCHINT(integer)

The minimum amount of time, in milliseconds, that a channel keeps a batch open.

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.

BATCHSZ(integer)

The maximum number of messages that can be sent through a channel before taking a syncpoint.

The maximum batch size actually used is the lowest of the following:

  • The BATCHSZ of the sending channel

  • The BATCHSZ of the receiving channel

  • On z/OS, three less than the maximum number of uncommitted messages allowed at the sending queue manager (or one if this value is zero or less). On platforms other than z/OS, the maximum number of uncommitted messages allowed at the sending queue manager (or one if this value is zero or less).

  • On z/OS, three less than the maximum number of uncommitted messages allowed at the receiving queue manager (or one if this value is zero or less). On platforms other than z/OS, the maximum number of uncommitted messages allowed at the receiving queue manager (or one if this value is zero or less).

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.

CHLTYPE

Channel type. This 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

Cluster-sender channel (valid only on AIX, HP OpenVMS, HP-UX, Linux, i5/OS, Solaris, Windows, and z/OS)

CLUSRCVR

Cluster-receiver channel (valid only on AIX, HP OpenVMS, HP-UX, Linux, i5/OS, Solaris, Windows, and z/OS)

If you are using the REPLACE option, we cannot change the channel type.

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.

This parameter is valid only on AIX, HP OpenVMS, HP-UX, Linux i5/OS, Solaris, Windows, and z/OS.

CLUSTER(clustername)

The name of the cluster to which the channel belongs. The maximum length is 48 characters conforming to the rules for naming WebSphere MQ objects.

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.

CLWLPRTY(integer)

Specifies the priority of the channel for the purposes of cluster workload distribution. The value must be in the range zero through 9 where zero is the lowest priority and 9 is the highest. The default value is zero.

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.

CLWLRANK(integer)

Specifies the rank of the channel for the purposes of cluster workload distribution. The value must be in the range zero through 9 where zero is the lowest rank and 9 is the highest. The default value is zero.

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.

CLWLWGHT(integer)

Specifies the weighting to be applied to the channel for the purposes of cluster workload distribution so that the proportion of messages sent down the channel can be controlled. The value must be in the range 1 through 99 where 1 is the lowest rank and 99 is the highest. The default value is 50.

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

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 be blank, or the local queue manager, if QSGDISP is set to GROUP.

‘ ’

The command is executed on the queue manager on which it was entered. This is the default value.

qmgr-name

The command is executed on the queue manager you specify, providing the queue manager is active within the queue-sharing group.

We 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 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 this 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. For sender, server, cluster-sender, cluster-receiver, and client-connection channels, the values specified are in order of preference with the first compression technique supported by the remote end of the channel being used.

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.

NONE

No header data compression is performed. This is the default value.

SYSTEM

Header data compression is performed.

COMPMSG

The list of message data compression techniques supported by the channel. For sender, server, cluster-sender, cluster-receiver, and client-connection channels, the values specified are in order of preference with the first compression technique supported by the remote end of the channel being used.

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.

NONE

No message data compression is performed. This is the default value.

RLE

Message data compression is performed using run-length encoding.

ZLIBFAST

Message data compression is performed using ZLIB encoding with speed prioritized.

ZLIBHIGH

Message data compression is performed using ZLIB encoding with compression prioritized.

ANY

Any compression technique supported by the queue manager can be used. This is only valid for receiver, requester, and server-connection channels.

CONNAME(string)

Connection name.

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.

If you are using any of the special characters in your connection name (for example, parentheses) enclose the string in single quotes.

The value you specify depends on the transport type (TRPTYPE) to be used:

DECnet

The DECnet node name and the DECnet object name, in the form: 
CONNAME('node_name(object_name)')

This is valid only on HP OpenVMS.

LU 6.2

  • On HP OpenVMS this is the SNA gateway node name, access name, and the tpname that is used by SNA to invoke the remote program. The format of this information is as follows: 
    CONNAME('gateway_node.access_name(tpname)')

  • 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. This can be specified in one of 3 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.

    For client-connection 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.

    For cluster-receiver channels, the side information is on the other queue managers in the cluster. Alternatively, in this case 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 HP OpenVMS, i5/OS, UNIX systems, and Windows, this is the name of the CPI-C communications side object or, if the TPNAME is not blank, this is the fully-qualified name of the partner logical unit.

    See the information about configuration parameters for an LU 6.2 connection for your platform in the WebSphere MQ Intercommunications manual for more information.

  • On Compaq NSK, the value of this depends on whether SNAX or ICE is used as the communications protocol:

    • If SNAX is used:

      • For sender, requester, and fully qualified server channels, this is the process name of the SNAX/APC process, the name of the local LU, and the name of the partner LU on the remote machine, for example: 
        CONNAME('$PPPP.LOCALLU.REMOTELU')

      • For receiver and non fully qualified server channels, this is the process name of the SNAX/APC process and the name of the local LU, for example: 
        CONNAME('$PPPP.LOCALLU')
        The name of the local LU can be an asterisk (*), indicating any name.

    • If ICE is used:

      • For sender, requester, and fully qualified server channels, this is the process name of the ICE process, the ICE open name, the name of the local LU, and the name of the partner LU on the remote machine, for example: 
          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.

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)')

If the socket number is omitted, the WebSphere MQ default value (X'5e86') is assumed.

TCP

Either the host name, or the network address of the remote machine (or the local machine for cluster-receiver channels). This can be followed by an optional port number, enclosed in parentheses.

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 LOCLADDR 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.

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 cluster sender channel definition that specifies the CONNAME in IPv6 hexadecimal form. Consider, instead, using hostnames in a heterogeneous IP environment.

CONVERT

Specifies whether the sending message channel agent should attempt 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.

DESCR(string)

Plain-text comment. It provides descriptive information about the channel when an operator issues the DISPLAY CHANNEL command.

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).

If characters are used that are not in the coded character set identifier (CCSID) for this queue manager, they might be translated incorrectly if the information is sent to another queue manager.

DISCINT(integer)

The minimum time in seconds for which the channel waits for a message to arrive on the transmission queue, after a batch ends, before terminating the channel. A value of zero causes the message channel agent to wait indefinitely.

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.

HBINT(integer)

This parameter has a different interpretation depending upon the channel type, as follows:

  • For channels with a channel type (CHLTYPE) of SDR, SVR, RCVR, RQSTR, CLUSSDR, or CLUSRCVR, this is the time, in seconds, between heartbeat flows passed from the sending MCA when there are no messages on the transmission queue. The heartbeat exchange gives the receiving MCA the opportunity to quiesce the channel.

    You should set this value to be significantly less than the value of DISCINT. WebSphere MQ checks only that it is within the permitted range however.

  • For channels with a channel type (CHLTYPE) of SVRCONN or CLNTCONN, this is the time, in seconds, between heartbeat flows passed from the server MCA when that MCA has issued an MQGET with WAIT on behalf of a client application. This allows the server to handle situations where the client connection fails during an MQGET with WAIT.

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.

KAINT(integer)

The value passed to the communications stack for KeepAlive timing for this channel.

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 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, we 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 we 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 99 999.

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 value used is that specified by the INTERVAL statement in the TCP profile configuration data set.

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, whose parameters are used to model this definition.

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:

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

Cluster-sender channel

SYSTEM.DEF.CLUSRCVR

Cluster-receiver channel

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.

  1. QSGDISP (GROUP) objects are not searched.

  2. LIKE is ignored if QSGDISP(COPY) is specified. However, the group object defined is used as a LIKE object.

LOCLADDR(string)

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. This might be useful in recovery scenarios where a channel is restarted on a different TCP/IP stack or if you want to force a channel to use an IPv4 or IPv6 stack on a dual–stack system, or 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])])

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 2 shows how the LOCLADDR parameter can be used:

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(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 3 for further details on how the IP stack is determined. For further guidance, see the WebSphere MQ Intercommunications 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.

How the IP stack to be used for communication is determined
Protocols supported CONNAME LOCLADDR Action of channel
IPv4 only IPv4 address¹   Channel binds to IPv4 stack
IPv6 address²   Channel fails to resolve CONNAME
IPv4 and 6 hostname³   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 address⁴ 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 IPv6⁵
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 IPv6⁵
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 IPv6⁵
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 IPv6⁵
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.

LONGRTY(integer)

When a sender, server, or cluster-sender channel is attempting to connect to the remote queue manager, and the count specified by SHORTRTY has been exhausted, this specifies the maximum number of further attempts that are made to connect to the remote queue manager, at intervals specified by LONGTMR.

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.

LONGTMR(integer)

For long retry attempts, this 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 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.

For implementation reasons, the maximum retry interval that can be used is 999 999; values exceeding this are treated as 999 999.

This parameter is valid only for channels with a channel type (CHLTYPE) of SDR, SVR, CLUSSDR, or CLUSRCVR.

MAXMSGL(integer)

Specifies the maximum message length that can be transmitted on the channel. This is compared with the value for the partner and the actual maximum used is the lower of the two values.

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).

MCANAME(string)

Message channel agent name.

This is reserved, and if specified must only be set to blanks (maximum length 20 characters).

MCATYPE

Specifies whether the message-channel-agent program on an outbound MCA channel should run as a thread or a process.

PROCESS

The message channel agent runs as a separate process. This is the default value.

THREAD

The message channel agent runs as a separate thread

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.

MCAUSER(string)

Message channel agent user identifier.

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:

  • On z/OS, the user ID assigned to the channel-initiator started task by the z/OS started-procedures table.

  • For TCP/IP, other than z/OS, the user ID from the inetd.conf entry, or the user that started the listener.

  • For SNA, other than z/OS, the user ID from the SNA server entry or, in the absence of this the incoming attach request, or the user that started the listener.

  • For 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, we 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.

MODENAME(string)

LU 6.2 mode name (maximum length 8 characters).

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 Intercommunications manual for more information.

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. This is the default value.

OFF

Monitoring data collection is turned off for this channel.

LOW

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

MEDIUM

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

HIGH

If the value of the queue manager's MONCHL parameter is not NONE, online monitoring data collection is turned on, with a high rate of data collection, 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 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.

MRDATA(string)

Channel message-retry exit user data. The maximum length is 32 characters.

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.

MREXIT(string)

Channel message-retry exit name.

The format and maximum length of the name is the same as for MSGEXIT, however we can only specify 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 retries 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 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. .

MRTMR(integer)

The minimum interval of time that must pass before the channel can retry the MQPUT operation. This 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 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.

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 OpenVMS, HP-UX, Linux, Solaris, and Windows, we 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, we 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, we 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 we can specify only one string of message exit data for each channel.

This parameter is accepted but ignored for server-connection and client-connection channels.

MSGEXIT(string)

Channel message exit name.

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. We 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:

  • Immediately after a message has been retrieved from the transmission queue (sender or server), or immediately before a message is put to a destination queue (receiver or requester).

    The exit is given the entire application message and transmission queue header for modification.

  • At initialization and termination of the channel.

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, we can specify the names of up to 10 exit programs by specifying multiple strings separated by commas.

On z/OS, we can specify the names of up to 8 exit programs by specifying multiple strings separated by commas.

On other platforms we 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:

  • On HP OpenVMS and UNIX systems, it is of the form: 
          libraryname(functionname)
    The maximum length of the string is 128 characters.

  • On Windows, it is of the form: 
          dllname(functionname)
    where dllname is specified without the suffix (".DLL"). The maximum length of the string is 128 characters.

  • On i5/OS, it is of the form: 
          progname libname
    where 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.

  • On z/OS, it is a load module name, maximum length 8 characters (128 characters are allowed for exit names for client-connection channels, subject to a maximum total length including commas of 999).

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 zero through 9; zero is the lowest priority.

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.

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. This is the default. 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.
If the sending side and the receiving side do not agree about this parameter, or one does not support it, NORMAL is used.

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.

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.

PUTAUT

Specifies which user identifiers should be used to establish authority to put messages to the destination queue (for messages channels) or to execute an MQI call (for MQI channels).

DEF

The default user ID is used. On z/OS this 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 this 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.

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 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.

For channels of other types this 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 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.

RCVDATA(string)

Channel receive exit user data (maximum length 32 characters).

This is passed to the channel receive exit when it is called.

On AIX, HP OpenVMS, HP-UX, Linux, Solaris, and Windows, we 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, we 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 we can specify only one string of receive exit data for each channel.

RCVEXIT(string)

Channel receive exit name.

On platforms other than Compaq NSK, 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 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, we can specify the names of up to 10 exit programs by specifying multiple strings separated by commas.

On z/OS, we can specify the names of up to 8 exit programs by specifying multiple strings separated by commas.

On other platforms we can specify only one receive exit name for each channel.

The format and maximum length of the name is the same as for MSGEXIT.

REPLACE and NOREPLACE

Whether the existing definition (and on z/OS, with the same disposition) is to be replaced with this one. This is optional. The default is NOREPLACE. Any object with a different disposition is not changed.

This parameter applies only to the DEFINE CHANNEL command.

REPLACE

The definition should replace any existing definition of the same name. If a definition does not exist, one is created. Note that REPLACE does not alter the channel status.

NOREPLACE

The definition should not replace any existing definition of the same name.

SCYDATA(string)

Channel security exit user data (maximum length 32 characters).

This is passed to the channel security exit when it is called.

SCYEXIT(string)

Channel security exit name.

On platforms other than Compaq NSK, 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 given the opportunity 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.

SENDDATA(string)

Channel send exit user data. The maximum length is 32 characters.

This is passed to the channel send exit when it is called.

On AIX, HP OpenVMS, HP-UX, Linux, Solaris, and Windows, we 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, we 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, we 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 we can specify only one string of send exit data for each channel.

SENDEXIT(string)

Channel send exit name.

On platforms other than Compaq NSK, 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 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, we can specify the names of up to 10 exit programs by specifying multiple strings separated by commas.

On z/OS, we can specify the names of up to 8 exit programs by specifying multiple strings separated by commas.

On other platforms we can specify only one send exit name for each channel.

The format and maximum length of the name is the same as for MSGEXIT.

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 through 999 999 999.

This parameter is valid only for channels with a channel type (CHLTYPE) of SDR, SVR, RCVR, RQSTR, CLUSSDR, or CLUSRCVR.

SHORTRTY(integer)

The maximum number of attempts that are made by a sender, server, or cluster-sender channel to connect to the remote queue manager, at intervals specified by SHORTTMR, before the (normally longer) LONGRTY and LONGTMR are used.

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.

SHORTTMR(integer)

For short retry attempts, this 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 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.

For implementation reasons, the maximum retry interval that can be used is 999 999; values exceeding this are treated as 999 999.

This parameter is valid only for channels with a channel type (CHLTYPE) of SDR, SVR, CLUSSDR, or CLUSRCVR.

SSLCAUTH

Defines whether WebSphere MQ requires a certificate from the SSL client or not. The initiating end of the channel acts as the SSL client, so this applies to the end of the channel that receives the initiation flow, which acts as the SSL server.

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.

REQUIRED

WebSphere MQ requires and validates a certificate from the SSL client. This is the default.

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)

CipherSpec used on the channel. The maximum length is 32 characters. This parameter is valid on all channel types.

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 4.

On WebSphere MQ for z/OS and for iSeries, we can also specify the 2-digit hexadecimal code of a CipherSpec, whether or not it appears in Table 4.

On i5/OS, installation of AC3 is a prerequisite of the use of SSL.

CipherSpecs that can be used with WebSphere MQ SSL support
CipherSpec name Hash algorithm Encryption algorithm Encryption bits FIPS on Windows and UNIX platforms 1
NULL_MD5

Available on all platforms

MD5 None 0 No
NULL_SHA

Available on all platforms

SHA-1 None 0 No
RC4_MD5_EXPORT

Available on all platforms

MD5 RC4 40 No
RC4_MD5_US

Available on all platforms

MD5 RC4 128 No
RC4_SHA_US

Available on all platforms

SHA-1 RC4 128 No
RC2_MD5_EXPORT

Available on all platforms

MD5 RC2 40 No
DES_SHA_EXPORT

Available on all platforms

SHA-1 DES 56 No
RC4_56_SHA_EXPORT1024

  1. Not available for z/OS or i5/OS

  2. Specifies a 1024–bit handshake key size

SHA-1 RC4 56 No
DES_SHA_EXPORT1024

  1. Not available for z/OS or i5/OS

  2. Specifies a 1024–bit handshake key size

SHA-1 DES 56 No
TRIPLE_DES_SHA_US

Not available for i5/OS

SHA-1 3DES 168 No
TLS_RSA_WITH_AES_128_CBC_SHA

  1. Not available for i5/OS

  2. The protocol used is TLS rather than SSL

SHA-1 AES 128 Yes
TLS_RSA_WITH_AES_256_CBC_SHA

  1. Not available for i5/OS

  2. The protocol used is TLS rather than SSL

SHA-1 AES 256 Yes
AES_SHA_US

Available on i5/OS™ only

SHA-1 AES 128 No
TLS_RSA_WITH_DES_CBC_SHA

  1. Not available for z/OS or i5/OS

  2. The protocol used is TLS rather than SSL

SHA-1 DES 56 Yes
TLS_RSA_WITH_3DES_EDE_CBC_SHA

  1. Not available for z/OS or i5/OS

  2. The protocol used is TLS rather than SSL

SHA-1 3DES 168 Yes
FIPS_WITH_DES_CBC_SHA

Available only on Windows and UNIX platforms

SHA-1 DES 56 Yes
FIPS_WITH_3DES_EDE_CBC_SHA

Available only on Windows and UNIX platforms

SHA-1 3DES 168 Yes

  1. Is the CipherSpec FIPS-certified on a FIPS-certified platform? See “CipherSuites and CipherSpecs” in the WebSphere MQ: Security manual for an explanation of FIPS.

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 UNIX systems, Windows systems, and z/OS, 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 UNIX and Windows 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.

If the SSLCIPH parameter is blank, no attempt is made to use SSL on the channel.

SSLPEER(string)

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')

We 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™ 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, we 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, we 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.

STATCHL

Controls the collection of statistics data for channels:

QMGR

The value of the queue manager's STATCHL parameter is inherited by the channel. This is the default value.

OFF

Statistics data collection is turned off for this channel.

LOW

If the value of the queue manager's STATCHL parameter is not NONE, statistics data collection is turned on, with a low rate of data collection, for this channel.

MEDIUM

If the value of the queue manager's STATCHL parameter is not NONE, statistics data collection is turned on, with a moderate rate of data collection, for this channel.

HIGH

If the value of the queue manager's STATCHL parameter is not NONE, statistics data collection is turned on, with a high rate of data collection, 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 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.

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 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 Intercommunications 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.

TRPTYPE

Transport type to be used.

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.

DECNET

DECnet (supported only on HP OpenVMS)

LU62

SNA LU 6.2

NETBIOS

NetBIOS (supported only on Windows, and DOS; it also applies to z/OS for defining client-connection 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 client-connection channels that connect to servers on the platforms supporting SPX)

TCP

Transmission Control Protocol - part of the TCP/IP protocol suite

USERID(string)

Task user identifier. The maximum length is 12 characters.

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. We can avoid this 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 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.

 

Parent topic:

DEFINE CHANNEL


sc11040_


 

Home