DEFINE CHANNEL
Use DEFINE CHANNEL to define a new channel, and set its parameters.
Note that for cluster-sender channels, you can only specify the REPLACE option for channels that have been created manually.
Synonym: DEF CHL
There is a separate syntax diagram for each type of channel:
- Sender channel
- Server channel
- Receiver channel
- Requester channel
- Client-connection channel
- Server-connection channel
- Cluster-sender channel
- Cluster-receiver channel
Sender channel
DEFINE CHANNEL >>-DEFINE CHANNEL(channel-name)--CHLTYPE(SDR)-------------------> (3) (4) >--CONNAME(string)--TRPTYPE-----(-+-DECNET-------+-)------------> +-LU62---------+ | (5) | +-NETBIOS------+ | (5) | +-SPX----------+ +-TCP----------+ | (6) | '-UDP----------' (7) .-BATCHHB(0)-------. >--XMITQ(string)--+------------------+--------------------------> 'BATCHHB(integer)--' (7) (7) .-BATCHINT(0)-------. (8) .-BATCHSZ(50)------. >--+-------------------+-------+------------------+-------------> '-BATCHINT(integer)-' '-BATCHSZ(integer)-' (7) .-CONVERT(NO)------. >--+---------------------------+-------+------------------+-----> | (14) | '-CONVERT(YES)-----' +-CMDSCOPE(qmgr-name)-------+ | (14) | '-CMDSCOPE(*)---------------' (7) (7) .-DESCR(' ')------. .-DISCINT(6000)------. >--+-----------------+--+--------------------+------------------> '-DESCR(string)---' '-DISCINT(integer)---' (7) (7) .-HBINT(300)------. (8) .-KAINT(AUTO)------. >--+-----------------+-------+------------------+---------------> '-HBINT(integer)--' (7) .-LOCLADDR(' ')------. >--+--------------------+--+--------------------+---------------> '-LIKE(channel-name)-' 'LOCLADDR(string)----' (7) (7) .-LONGRTY(999 999 999)------. .-LONGTMR(1200)------. >--+---------------------------+--+--------------------+--------> '-LONGRTY(integer)----------' '-LONGTMR(integer)---' (7) .-MAXMSGL(4 194 304)------. >--+-------------------------+--+--------------+----------------> '-MAXMSGL(integer)--------' '-MCANAME(' ')-' (7) (10) (7) .-MCATYPE(PROCESS)-----------. .-MCAUSER(' ')------. >--+----------------------------+--+-------------------+--------> | (10) | '-MCAUSER(string)---' '-MCATYPE(THREAD)------------' (7) (11) .-MODENAME(' ')-----------. >--+-------------------------+----------------------------------> | (11) | '-MODENAME(string)--------' (7) .-MSGDATA(' ')----------------. >--+-----------------------------+------------------------------> | .-+---+--------. | | | '-,-' | | | V (12) | | '-MSGDATA(---------string-+-)-' (7) .-MSGEXIT(' ')----------------. >--+-----------------------------+------------------------------> | .-+---+--------. | | | '-,-' | | | V (12) | | '-MSGEXIT(---------string-+-)-' (7) (8) .-NPMSPEED(FAST)----------. >--+-------------------------+----------------------------------> | (8) | '-NPMSPEED(NORMAL)--------' (7) (11) (13) .-PASSWORD(' ')----------------. >--+------------------------------+-----------------------------> | (11) (13) | '-PASSWORD(string)-------------' >--+----------------------+-------------------------------------> | (14) | +-QSGDISP(COPY)--------+ | (14) | '-QSGDISP(GROUP)-------' (7) .-RCVDATA(' ')----------------. >--+-----------------------------+------------------------------> | .-+---+--------. | | | '-,-' | | | V (12) | | '-RCVDATA(---------string-+-)-' (7) .-RCVEXIT(' ')----------------. .-NOREPLACE-. >--+-----------------------------+--+-----------+---------------> | .-+---+--------. | '-REPLACE---' | | '-,-' | | | V (12) | | '-RCVEXIT(---------string-+-)-' (7) (7) .-SCYDATA(' ')------. .-SCYEXIT(' ')------. >--+-------------------+--+-------------------+-----------------> '-SCYDATA(string)---' '-SCYEXIT(string)---' (7) .-SENDDATA(' ')----------------. >--+------------------------------+-----------------------------> | .-+---+--------. | | | '-,-' | | | V (12) | | '-SENDDATA(---------string-+-)-' (7) .-SENDEXIT(' ')----------------. >--+------------------------------+-----------------------------> | .-+---+--------. | | | '-,-' | | | V (12) | | '-SENDEXIT(---------string-+-)-' (7) (7) .-SEQWRAP(999 999 999)------. .-SHORTRTY(10)------. >--+---------------------------+--+-------------------+---------> '-SEQWRAP(integer)----------' '-SHORTRTY(integer)-' (7) (7) .-SHORTTMR(60)------. .-SSLCIPH(' ')------. (9) >--+-------------------+--+-------------------+-----------------> '-SHORTTMR(integer)-' '-SSLCIPH(string)---' (7) (7) (11) .-SSLPEER(' ')------. (9) .-TPNAME(' ')-----------. >--+-------------------+-------+-----------------------+--------> '-SSLPEER(string)---' | (11) | '-TPNAME(string)--------' (7) (11) (13) .-USERID(' ')----------------. >--+----------------------------+------------------------------>< | (11) (13) | '-USERID(string)-------------'
Notes:
- This parameter must follow immediately after the channel name except on z/OS.
- Valid only on z/OS.
- This is not mandatory on AIX, Compaq OpenVMS, HP-UX, Linux, OS/2 Warp, OS/400, Solaris, Windows, and z/OS.
- Valid only on Compaq OpenVMS.
- Valid only on OS/2 Warp and Windows.
- Valid only on AIX.
- This is the default supplied with WebSphere MQ, but your installation might have changed it.
- Valid only on AIX, Compaq OpenVMS, HP-UX, Linux, OS/400, Solaris, Windows, and z/OS.
- Valid only on AIX, HP-UX, Linux, OS/400, Solaris, Windows, and z/OS.
- Valid only on AIX, Compaq OpenVMS, HP-UX, Linux, OS/2 Warp, OS/400, Solaris, and Windows.
- Valid only if TRPTYPE is LU62.
- You can specify more than one value only on AIX, Compaq OpenVMS, HP-UX, Linux, OS/2 Warp, OS/400, z/OS, Solaris, and Windows.
- Not valid on z/OS.
- Valid only on full function WebSphere MQ for z/OS when the queue manager is a member of a queue-sharing group.
Server channel
DEFINE CHANNEL >>-DEFINE CHANNEL(channel-name)--CHLTYPE(SVR)-------------------> (3) (5) >--TRPTYPE-----(-+-DECNET-------+-)--XMITQ(string)--------------> +-LU62---------+ | (6) | +-NETBIOS------+ | (6) | +-SPX----------+ +-TCP----------+ | (7) | '-UDP----------' (9) .-AUTOSTART(DISABLED)-. (8) .-BATCHHB(0)-------. >--+---------------------+-------+------------------+-----------> '-AUTOSTART(ENABLED)--' 'BATCHHB(integer)--' (9) (9) .-BATCHINT(0)-------. (10) .-BATCHSZ(50)------. >--+-------------------+--------+------------------+------------> '-BATCHINT(integer)-' '-BATCHSZ(integer)-' (9) .-CONNAME(' ')------. >--+---------------------------+-------+-------------------+----> | (15) | '-CONNAME(string)---' +-CMDSCOPE(qmgr-name)-------+ | (15) | '-CMDSCOPE(*)---------------' (9) (9) .-CONVERT(NO)------. .-DESCR(' ')------. >--+------------------+--+-----------------+--------------------> '-CONVERT(YES)-----' '-DESCR(string)---' (9) (9) .-DISCINT(6000)------. .-HBINT(300)------. (10) >--+--------------------+--+-----------------+------------------> '-DISCINT(integer)---' '-HBINT(integer)--' (9) >--+------------------+-------+--------------------+------------> 'KAINT(integer)----' '-LIKE(channel-name)-' (9) (9) .-LOCLADDR(' ')------. .-LONGRTY(999 999 999)------. >--+--------------------+--+---------------------------+--------> 'LOCLADDR(string)----' '-LONGRTY(integer)----------' (9) (9) .-LONGTMR(1200)------. .-MAXMSGL(4 194 304)------. >--+--------------------+--+-------------------------+----------> '-LONGTMR(integer)---' '-MAXMSGL(integer)--------' (9) .-MCATYPE(PROCESS)------. (11) >--+--------------+--+-----------------------+------------------> '-MCANAME(' ')-' '-MCATYPE(THREAD)-------' (9) (9) .-MCAUSER(' ')------. .-MODENAME(' ')------. (12) >--+-------------------+--+--------------------+----------------> '-MCAUSER(string)---' '-MODENAME(string)---' (9) .-MSGDATA(' ')----------------. >--+-----------------------------+------------------------------> | .-+---+--------. | | | '-,-' | | | V (13) | | '-MSGDATA(---------string-+-)-' (9) .-MSGEXIT(' ')----------------. >--+-----------------------------+------------------------------> | .-+---+--------. | | | '-,-' | | | V (13) | | '-MSGEXIT(---------string-+-)-' (9) .-NPMSPEED(FAST)------. (10) >--+---------------------+--------------------------------------> '-NPMSPEED(NORMAL)----' (9) .-PASSWORD(' ')------. (12) (14) >--+--------------------+---------------------------------------> '-PASSWORD(string)---' >--+----------------------+-------------------------------------> | (15) | +-QSGDISP(COPY)--------+ | (15) | '-QSGDISP(GROUP)-------' (9) .-RCVDATA(' ')----------------. >--+-----------------------------+------------------------------> | .-+---+--------. | | | '-,-' | | | V (13) | | '-RCVDATA(---------string-+-)-' (9) .-RCVEXIT(' ')----------------. .-NOREPLACE-. >--+-----------------------------+--+-----------+---------------> | .-+---+--------. | '-REPLACE---' | | '-,-' | | | V (13) | | '-RCVEXIT(---------string-+-)-' (9) (9) .-SCYDATA(' ')------. .-SCYEXIT(' ')------. >--+-------------------+--+-------------------+-----------------> '-SCYDATA(string)---' '-SCYEXIT(string)---' (9) .-SENDDATA(' ')----------------. >--+------------------------------+-----------------------------> | .-+---+--------. | | | '-,-' | | | V (13) | | '-SENDDATA(---------string-+-)-' (9) .-SENDEXIT(' ')----------------. >--+------------------------------+-----------------------------> | .-+---+--------. | | | '-,-' | | | V (13) | | '-SENDEXIT(---------string-+-)-' (9) (9) .-SEQWRAP(999 999 999)------. .-SHORTRTY(10)------. >--+---------------------------+--+-------------------+---------> '-SEQWRAP(integer)----------' '-SHORTRTY(integer)-' (9) (9) .-SHORTTMR(60)------. .-SSLCAUTH(REQUIRED)------. (4) >--+-------------------+--+-------------------------+-----------> '-SHORTTMR(integer)-' '-SSLCAUTH(OPTIONAL)------' (9) (9) .-SSLCIPH(' ')------. (4) .-SSLPEER(' ')------. (4) >--+-------------------+-------+-------------------+------------> '-SSLCIPH(string)---' '-SSLPEER(string)---' (9) .-TPNAME(' ')------. (12) >--+------------------+-----------------------------------------> '-TPNAME(string)---' (9) .-USERID(' ')------. (12) (14) >--+------------------+---------------------------------------->< '-USERID(string)---'
Notes:
- This parameter must follow immediately after the channel name except on z/OS.
- Valid only on z/OS.
- This is not mandatory on AIX, Compaq OpenVMS, HP-UX, Linux, OS/2 Warp, OS/400, Solaris, Windows, and z/OS.
- Valid only on AIX, HP-UX, Linux, OS/400, Solaris, Windows, and z/OS.
- Valid only on Compaq OpenVMS.
- Valid only on OS/2 Warp and Windows.
- Valid only on AIX.
- Valid only on Compaq NSK.
- This is the default supplied with WebSphere MQ, but your installation might have changed it.
- Valid only on AIX, Compaq OpenVMS, HP-UX, Linux, OS/2 Warp, OS/400, Solaris, Windows, and z/OS.
- Valid only on AIX, Compaq OpenVMS, HP-UX, Linux, OS/2 Warp, OS/400, Solaris, and Windows.
- Valid only if TRPTYPE is LU62.
- You can specify more than one value only on AIX, Compaq OpenVMS, HP-UX, Linux, OS/2 Warp, OS/400, Solaris, Windows, and z/OS.
- Not valid on z/OS.
- Valid only on full function WebSphere MQ for z/OS when the queue manager is a member of a queue-sharing group.
Receiver channel
DEFINE CHANNEL >>-DEFINE CHANNEL(channel-name)--CHLTYPE(RCVR)------------------> >--TRPTYPE-----(-+-DECNET-------+-)-----------------------------> +-LU62---------+ | (5) | +-NETBIOS------+ | (5) | +-SPX----------+ +-TCP----------+ | (6) | '-UDP----------' (8) .-AUTOSTART(DISABLED)-. (7) .-BATCHSZ(50)------. >--+---------------------+-------+------------------+-----------> '-AUTOSTART(ENABLED)--' '-BATCHSZ(integer)-' (8) .-CMDSCOPE(' ')-------------. (12) .-DESCR(' ')------. >--+---------------------------+--------+-----------------+-----> | (13) | '-DESCR(string)---' +-CMDSCOPE(qmgr-name)-------+ | (13) | '-CMDSCOPE(*)---------------' (8) (8) .-HBINT(300)------. (9) .-KAINT(AUTO)------. (12) >--+-----------------+-------+------------------+---------------> '-HBINT(integer)--' 'KAINT(integer)----' (8) .-MAXMSGL(4 194 304)------. >--+--------------------+--+-------------------------+----------> '-LIKE(channel-name)-' '-MAXMSGL(integer)--------' (8) (8) .-MCAUSER(' ')------. .-MRDATA(' ')------. (10) >--+-------------------+--+------------------+------------------> '-MCAUSER(string)---' '-MRDATA(string)---' (8) (8) .-MREXIT(' ')------. (10) .-MRRTY(10)------. (10) >--+------------------+--------+----------------+---------------> '-MREXIT(string)---' '-MRRTY(integer)-' (8) .-MRTMR(1000)------. (10) >--+------------------+-----------------------------------------> '-MRTMR(integer)---' (8) .-MSGDATA(' ')----------------. >--+-----------------------------+------------------------------> | .-+---+--------. | | | '-,-' | | | V (11) | | '-MSGDATA(---------string-+-)-' (8) .-MSGEXIT(' ')----------------. >--+-----------------------------+------------------------------> | .-+---+--------. | | | '-,-' | | | V (11) | | '-MSGEXIT(---------string-+-)-' (8) (8) .-NPMSPEED(FAST)------. (9) .-PUTAUT(DEF)-----------. >--+---------------------+-------+-----------------------+------> '-NPMSPEED(NORMAL)----' +-PUTAUT(CTX)-----------+ | (12) | +-PUTAUT(ONLYMCA)-------+ | (12) | '-PUTAUT(ALTMCA)--------' .-QSGDISP(QMGR)--------. (12) >--+----------------------+-------------------------------------> | (13) | +-QSGDISP(COPY)--------+ | (13) | '-QSGDISP(GROUP)-------' (8) .-RCVDATA(' ')----------------. >--+-----------------------------+------------------------------> | .-+---+--------. | | | '-,-' | | | V (11) | | '-RCVDATA(---------string-+-)-' (8) .-RCVEXIT(' ')----------------. .-NOREPLACE-. >--+-----------------------------+--+-----------+---------------> | .-+---+--------. | '-REPLACE---' | | '-,-' | | | V (11) | | '-RCVEXIT(---------string-+-)-' (8) (8) .-SCYDATA(' ')------. .-SCYEXIT(' ')------. >--+-------------------+--+-------------------+-----------------> '-SCYDATA(string)---' '-SCYEXIT(string)---' (8) .-SENDDATA(' ')----------------. >--+------------------------------+-----------------------------> | .-+---+--------. | | | '-,-' | | | V (11) | | '-SENDDATA(---------string-+-)-' (8) .-SENDEXIT(' ')----------------. >--+------------------------------+-----------------------------> | .-+---+--------. | | | '-,-' | | | V (11) | | '-SENDEXIT(---------string-+-)-' (8) .-SEQWRAP(999 999 999)------. >--+---------------------------+--------------------------------> '-SEQWRAP(integer)----------' (8) .-SSLCAUTH(REQUIRED)------. (3) >--+-------------------------+----------------------------------> '-SSLCAUTH(OPTIONAL)------' (8) (8) .-SSLCIPH(' ')------. (3) .-SSLPEER(' ')------. (3) >--+-------------------+-------+-------------------+----------->< '-SSLCIPH(string)---' '-SSLPEER(string)---'
Notes:
- This parameter must follow immediately after the channel name except on z/OS.
- This is not mandatory on AIX, Compaq OpenVMS, HP-UX, Linux, OS/2 Warp, OS/400, Solaris, Windows, and z/OS.
- Valid only on AIX, HP-UX, Linux, OS/400, Solaris, Windows, and z/OS.
- Valid only on Compaq OpenVMS.
- Valid only on OS/2 Warp or Windows.
- Valid only on AIX.
- Valid only on Compaq NSK.
- This is the default supplied with WebSphere MQ, but your installation might have changed it.
- Valid only on AIX, Compaq OpenVMS, HP-UX, Linux, OS/2 Warp, OS/400, Solaris, Windows, and z/OS.
- Not valid on z/OS.
- You can specify more than one value only on AIX, Compaq OpenVMS, HP-UX, Linux, OS/2 Warp, OS/400, Solaris, Windows, and z/OS.
- Valid only on z/OS.
- Valid only on full function WebSphere MQ for z/OS when the queue manager is a member of a queue-sharing group.
Requester channel
DEFINE CHANNEL >>-DEFINE CHANNEL(channel-name)--CHLTYPE(RQSTR)-----------------> >--CONNAME(string)--TRPTYPE-----(-+-DECNET-------+-)------------> +-LU62---------+ | (4) | +-NETBIOS------+ | (4) | +-SPX----------+ +-TCP----------+ | (5) | '-UDP----------' (7) .-AUTOSTART(DISABLED)-. (6) .-BATCHSZ(50)------. >--+---------------------+-------+------------------+-----------> '-AUTOSTART(ENABLED)--' '-BATCHSZ(integer)-' (7) .-CMDSCOPE(' ')-------------. (14) .-DESCR(' ')------. >--+---------------------------+--------+-----------------+-----> | (15) | '-DESCR(string)---' +-CMDSCOPE(qmgr-name)-------+ | (15) | '-CMDSCOPE(*)---------------' (7) (7) .-HBINT(300)------. (8) .-KAINT(AUTO)------. (14) >--+-----------------+-------+------------------+---------------> '-HBINT(integer)--' 'KAINT(integer)----' (7) .-LOCLADDR(' ')------. >--+--------------------+--+--------------------+---------------> '-LIKE(channel-name)-' 'LOCLADDR(string)----' (7) .-MAXMSGL(4 194 304)------. >--+-------------------------+--+--------------+----------------> '-MAXMSGL(integer)--------' '-MCANAME(' ')-' (7) (7) .-MCATYPE(PROCESS)------. (9) .-MCAUSER(' ')------. >--+-----------------------+-------+-------------------+--------> '-MCATYPE(THREAD)-------' '-MCAUSER(string)---' (7) (7) .-MODENAME(' ')------. (11) .-MRDATA(' ')------. (12) >--+--------------------+--------+------------------+-----------> '-MODENAME(string)---' '-MRDATA(string)---' (7) (7) .-MREXIT(' ')------. (12) .-MRRTY(10)------. (12) >--+------------------+--------+----------------+---------------> '-MREXIT(string)---' '-MRRTY(integer)-' (7) .-MRTMR(1000)------. (12) >--+------------------+-----------------------------------------> '-MRTMR(integer)---' (7) .-MSGDATA(' ')----------------. >--+-----------------------------+------------------------------> | .-+---+--------. | | | '-,-' | | | V (13) | | '-MSGDATA(---------string-+-)-' (7) .-MSGEXIT(' ')----------------. >--+-----------------------------+------------------------------> | .-+---+--------. | | | '-,-' | | | V (13) | | '-MSGEXIT(---------string-+-)-' (7) .-NPMSPEED(FAST)------. (8) >--+---------------------+--------------------------------------> '-NPMSPEED(NORMAL)----' (7) .-PASSWORD(' ')------. (11) (12) >--+--------------------+---------------------------------------> '-PASSWORD(string)---' (7) .-PUTAUT(DEF)-----------. .-QSGDISP(QMGR)--------. (14) >--+-----------------------+--+----------------------+----------> +-PUTAUT(CTX)-----------+ | (15) | | (14) | +-QSGDISP(COPY)--------+ +-PUTAUT(ONLYMCA)-------+ | (15) | | (14) | '-QSGDISP(GROUP)-------' '-PUTAUT(ALTMCA)--------' (7) .-RCVDATA(' ')----------------. >--+-----------------------------+------------------------------> | .-+---+--------. | | | '-,-' | | | V (13) | | '-RCVDATA(---------string-+-)-' (7) .-RCVEXIT(' ')----------------. .-NOREPLACE-. >--+-----------------------------+--+-----------+---------------> | .-+---+--------. | '-REPLACE---' | | '-,-' | | | V (13) | | '-RCVEXIT(---------string-+-)-' (7) (7) .-SCYDATA(' ')------. .-SCYEXIT(' ')------. >--+-------------------+--+-------------------+-----------------> '-SCYDATA(string)---' '-SCYEXIT(string)---' (7) .-SENDDATA(' ')----------------. >--+------------------------------+-----------------------------> | .-+---+--------. | | | '-,-' | | | V (13) | | '-SENDDATA(---------string-+-)-' (7) .-SENDEXIT(' ')----------------. >--+------------------------------+-----------------------------> | .-+---+--------. | | | '-,-' | | | V (13) | | '-SENDEXIT(---------string-+-)-' (7) .-SEQWRAP(999 999 999)------. >--+---------------------------+--------------------------------> '-SEQWRAP(integer)----------' (7) .-SSLCAUTH(REQUIRED)------. (10) >--+-------------------------+----------------------------------> '-SSLCAUTH(OPTIONAL)------' (7) (7) .-SSLCIPH(' ')------. (10) .-SSLPEER(' ')------. (10) >--+-------------------+--------+-------------------+-----------> '-SSLCIPH(string)---' '-SSLPEER(string)---' (7) .-TPNAME(' ')------. (11) >--+------------------+-----------------------------------------> '-TPNAME(string)---' (7) .-USERID(' ')------. (11) (12) >--+------------------+---------------------------------------->< '-USERID(string)---'
Notes:
- This parameter must follow immediately after the channel name except on z/OS.
- This is not mandatory on AIX, Compaq OpenVMS, HP-UX, Linux, OS/2 Warp, OS/400, Solaris, Windows, and z/OS.
- Valid only on Compaq OpenVMS.
- Valid only on OS/2 Warp and Windows.
- Valid only on AIX.
- Valid only on Compaq NSK.
- This is the default supplied with WebSphere MQ, but your installation might have changed it.
- Valid only on AIX, Compaq OpenVMS, HP-UX, Linux, OS/2 Warp, OS/400, Solaris, Windows, and z/OS.
- Valid only on AIX, Compaq OpenVMS, HP-UX, Linux, OS/2 Warp, OS/400, Solaris, and Windows.
- Valid only on AIX, HP-UX, Linux, OS/400, Solaris, Windows, and z/OS.
- Valid only if TRPTYPE is LU62.
- Not valid on z/OS.
- You can specify more than one value only on AIX, Compaq OpenVMS, HP-UX, Linux, OS/2 Warp, OS/400, Solaris, Windows, and z/OS.
- Valid only on z/OS.
- Valid only on full function WebSphere MQ for z/OS when the queue manager is a member of a queue-sharing group.
Client-connection channel
DEFINE CHANNEL >>-DEFINE CHANNEL(channel-name)--CHLTYPE-----(CLNTCONN)---------> (3) (4) >--CONNAME(string)--TRPTYPE-----(-+-DECNET-------+-)------------> +-LU62---------+ | (5) | +-NETBIOS------+ | (5) | +-SPX----------+ '-TCP----------' (6) .-DESCR(' ')------. >--+---------------------------+-------+-----------------+------> | (11) | '-DESCR(string)---' +-CMDSCOPE(qmgr-name)-------+ | (11) | '-CMDSCOPE(*)---------------' (6) .-HBINT(300)------. (7) >--+-----------------+-------+------------------+---------------> '-HBINT(integer)--' 'KAINT(integer)----' (6) .-LOCLADDR(' ')------. >--+--------------------+--+--------------------+---------------> '-LIKE(channel-name)-' 'LOCLADDR(string)----' (6) (6) .-MAXMSGL(4 194 304)------. .-MODENAME(' ')------. (8) >--+-------------------------+--+--------------------+----------> '-MAXMSGL(integer)--------' '-MODENAME(string)---' (6) (6) .-PASSWORD(' ')------. (8) .-QMNAME(' ')------. >--+--------------------+-------+------------------+------------> '-PASSWORD(string)---' '-QMNAME(string)---' >--+----------------------+-------------------------------------> | (11) | +-QSGDISP(COPY)--------+ | (11) | '-QSGDISP(GROUP)-------' (6) .-RCVDATA(' ')---------------. >--+----------------------------+-------------------------------> | .-+---+-------. | | | '-,-' | | | V (9) | | '-RCVDATA(--------string-+-)-' (6) .-RCVEXIT(' ')---------------. .-NOREPLACE-. >--+----------------------------+--+-----------+----------------> | .-+---+-------. | '-REPLACE---' | | '-,-' | | | V (9) | | '-RCVEXIT(--------string-+-)-' (6) (6) .-SCYDATA(' ')------. .-SCYEXIT(' ')------. >--+-------------------+--+-------------------+-----------------> '-SCYDATA(string)---' '-SCYEXIT(string)---' (6) .-SENDDATA(' ')---------------. >--+-----------------------------+------------------------------> | .-+---+-------. | | | '-,-' | | | V (9) | | '-SENDDATA(--------string-+-)-' (6) .-SENDEXIT(' ')---------------. >--+-----------------------------+------------------------------> | .-+---+-------. | | | '-,-' | | | V (9) | | '-SENDEXIT(--------string-+-)-' (6) (6) .-SSLCIPH(' ')--------. (10) .-SSLPEER(' ')------. (10) >--+---------------------+--------+-------------------+---------> '-+-----------------+-' '-SSLPEER(string)---' '-SSLCIPH(string)-' (6) (6) .-TPNAME(' ')------. (8) .-USERID(' ')------. (8) >--+------------------+-------+------------------+------------->< '-TPNAME(string)---' '-USERID(string)---'
Notes:
- This parameter must follow immediately after the channel name except on z/OS.
- Valid only on z/OS.
- This is not mandatory on AIX, Compaq OpenVMS, HP-UX, Linux, OS/2 Warp, OS/400, Solaris, Windows, and z/OS.
- Valid only on Compaq OpenVMS.
- Valid only for clients to be run on DOS, OS/2 Warp, or Windows.
- This is the default supplied with WebSphere MQ, but your installation might have changed it.
- Valid only on AIX, Compaq OpenVMS, HP-UX, Linux, OS/2 Warp, OS/400, Solaris, and Windows.
- Valid only if TRPTYPE is LU62.
- You can specify more than one value only on AIX, Compaq OpenVMS, HP-UX, Linux, OS/2 Warp, OS/400, Solaris, Windows, and z/OS.
- Valid only on AIX, HP-UX, Linux, OS/400, Solaris, Windows, and z/OS.
- Valid only on full function WebSphere MQ for z/OS when the queue manager is a member of a queue-sharing group.
Server-connection channel
DEFINE CHANNEL >>-DEFINE CHANNEL(channel-name)--CHLTYPE(SVRCONN)---------------> >--TRPTYPE-----(-+-DECNET-------+-)-----------------------------> +-LU62---------+ | (4) | +-NETBIOS------+ | (4) | +-SPX----------+ '-TCP----------' .-AUTOSTART(DISABLED)-. (5) >--+---------------------+--------------------------------------> '-AUTOSTART(ENABLED)--' (6) .-CMDSCOPE(' ')-------------. (9) .-DESCR(' ')------. >--+---------------------------+-------+-----------------+------> | (11) | '-DESCR(string)---' +-CMDSCOPE(qmgr-name)-------+ | (11) | '-CMDSCOPE(*)---------------' (6) (6) .-HBINT(300)------. (7) .-KAINT(AUTO)------. (9) >--+-----------------+-------+------------------+---------------> '-HBINT(integer)--' 'KAINT(integer)----' (6) .-MAXMSGL(4 194 304)------. >--+--------------------+--+-------------------------+----------> '-LIKE(channel-name)-' '-MAXMSGL(integer)--------' (6) (6) .-MCAUSER(' ')------. .-PUTAUT(DEF)------. (9) >--+-------------------+--+------------------+------------------> '-MCAUSER(string)---' '-PUTAUT(ONLYMCA)--' .-QSGDISP(QMGR)--------. (9) >--+----------------------+-------------------------------------> | (11) | +-QSGDISP(COPY)--------+ | (11) | '-QSGDISP(GROUP)-------' (6) .-RCVDATA(' ')----------------. >--+-----------------------------+------------------------------> | .-+---+--------. | | | '-,-' | | | V (10) | | '-RCVDATA(---------string-+-)-' (6) .-RCVEXIT(' ')----------------. .-NOREPLACE-. >--+-----------------------------+--+-----------+---------------> | .-+---+--------. | '-REPLACE---' | | '-,-' | | | V (10) | | '-RCVEXIT(---------string-+-)-' (6) (6) .-SCYDATA(' ')------. .-SCYEXIT(' ')------. >--+-------------------+--+-------------------+-----------------> '-SCYDATA(string)---' '-SCYEXIT(string)---' (6) .-SENDDATA(' ')----------------. >--+------------------------------+-----------------------------> | .-+---+--------. | | | '-,-' | | | V (10) | | '-SENDDATA(---------string-+-)-' (6) .-SENDEXIT(' ')----------------. >--+------------------------------+-----------------------------> | .-+---+--------. | | | '-,-' | | | V (10) | | '-SENDEXIT(---------string-+-)-' (6) .-SSLCAUTH(REQUIRED)------. (8) >--+-------------------------+----------------------------------> '-SSLCAUTH(OPTIONAL)------' (6) (6) .-SSLCIPH(' ')------. (8) .-SSLPEER(' ')------. (8) >--+-------------------+-------+-------------------+----------->< '-SSLCIPH(string)---' '-SSLPEER(string)---'
Notes:
- This parameter must follow immediately after the channel name except on z/OS.
- This is not mandatory on AIX, Compaq OpenVMS, HP-UX, Linux, OS/2 Warp, OS/400, Solaris, Windows, and z/OS.
- Valid only on Compaq OpenVMS.
- Valid only for clients to be run on DOS, OS/2 Warp, or Windows.
- Valid only on Compaq NSK.
- This is the default supplied with WebSphere MQ, but your installation might have changed it.
- Valid only on AIX, Compaq OpenVMS, HP-UX, Linux, OS/2 Warp, OS/400, Solaris, and Windows.
- Valid only on AIX, HP-UX, Linux, OS/400, Solaris, Windows, and z/OS.
- Valid only on z/OS.
- You can specify more than one value only on AIX, Compaq OpenVMS, HP-UX, Linux, OS/2 Warp, OS/400, Solaris, Windows, and z/OS.
- Valid only on full function WebSphere MQ for z/OS when the queue manager is a member of a queue-sharing group.
Cluster-sender channel
DEFINE CHANNEL >>-DEFINE CHANNEL-+-(channel-name)---------+--------------------> +-(string+QMNAME+)-------+ '-(string+QMNAME+string)-' (3) >--CHLTYPE(CLUSSDR)-----------CONNAME(string)-------------------> (4) (4) .-BATCHHB(0)-------. .-BATCHINT(0)-------. >--+------------------+--+-------------------+------------------> 'BATCHHB(integer)--' '-BATCHINT(integer)-' (4) (4) .-BATCHSZ(50)------. .-CLUSNL(' ')------. >--+------------------+--+------------------+-------------------> '-BATCHSZ(integer)-' '-CLUSNL(nlname)---' (4) .-CLUSTER(' ')---------. >--+----------------------+-------------------------------------> '-CLUSTER(clustername)-' (4) .-CONVERT(NO)------. >--+---------------------------+-------+------------------+-----> | (11) | '-CONVERT(YES)-----' +-CMDSCOPE(qmgr-name)-------+ | (11) | '-CMDSCOPE(*)---------------' (4) (4) .-DESCR(' ')------. .-DISCINT(6000)------. >--+-----------------+--+--------------------+------------------> '-DESCR(string)---' '-DISCINT(integer)---' (4) (4) .-HBINT(300)------. >--+-----------------+--+------------------+--------------------> '-HBINT(integer)--' 'KAINT(integer)----' (4) .-LOCLADDR(' ')------. >--+--------------------+--+--------------------+---------------> '-LIKE(channel-name)-' 'LOCLADDR(string)----' (4) (4) .-LONGRTY(999 999 999)------. .-LONGTMR(1200)------. >--+---------------------------+--+--------------------+--------> '-LONGRTY(integer)----------' '-LONGTMR(integer)---' (4) .-MAXMSGL(4 194 304)------. >--+-------------------------+--+--------------+----------------> '-MAXMSGL(integer)--------' '-MCANAME(' ')-' (4) (4) .-MCATYPE(THREAD)------. (5) .-MCAUSER(' ')------. >--+----------------------+-------+-------------------+---------> '-MCATYPE(PROCESS)-----' '-MCAUSER(string)---' (4) (4) .-MODENAME(' ')------. (7) .-MSGDATA(' ')----------. >--+--------------------+-------+-----------------------+-------> '-MODENAME(string)---' | .-+---+--. | | | '-,-' | | | V | | '-MSGDATA(---string-+-)-' (4) (4) .-MSGEXIT(' ')----------. .-NPMSPEED(FAST)------. >--+-----------------------+--+---------------------+-----------> | .-+---+--. | '-NPMSPEED(NORMAL)----' | | '-,-' | | | V | | '-MSGEXIT(---string-+-)-' (4) .-PASSWORD(' ')------. (7) (8) >--+--------------------+---------------------------------------> '-PASSWORD(string)---' >--+----------------------+-------+-----------------------+-----> | (11) | | .-+---+--. | +-QSGDISP(COPY)--------+ | | '-,-' | | | (11) | | V | | '-QSGDISP(GROUP)-------' '-RCVDATA(---string-+-)-' .-NOREPLACE-. >--+-----------------------+--+-----------+---------------------> | .-+---+--. | '-REPLACE---' | | '-,-' | | | V | | '-RCVEXIT(---string-+-)-' >--+-------------------+--+-------------------+-----------------> '-SCYDATA(string)---' '-SCYEXIT(string)---' >--+------------------------+--+------------------------+-------> | .-+---+--. | | .-+---+--. | | | '-,-' | | | | '-,-' | | | V | | | V | | '-SENDDATA(---string-+-)-' '-SENDEXIT(---string-+-)-' >--+---------------------------+--+-------------------+---------> '-SEQWRAP(integer)----------' '-SHORTRTY(integer)-' >--+-------------------+--+-------------------+-----------------> '-SHORTTMR(integer)-' '-SSLCIPH(string)---' >--+-------------------+-------+------------------+-------------> '-SSLPEER(string)---' '-TPNAME(string)---' >--+-----------------------------+------------------------------> '-TRPTYPE(-+-LU62---------+-)-' | (9) | +-NETBIOS------+ | (9) | +-SPX----------+ +-TCP----------+ | (10) | '-UDP----------' >--+------------------+---------------------------------------->< '-USERID(string)---'
Notes:
- Valid only on AIX, Compaq OpenVMS, HP-UX, Linux, OS/2 Warp, OS/400, Solaris, Windows, and z/OS.
- Valid only on z/OS.
- This parameter must follow immediately after the channel name except on z/OS.
- This is the default supplied with WebSphere MQ, but your installation might have changed it.
- Valid only on AIX, Compaq OpenVMS, HP-UX, Linux, OS/2 Warp, OS/400, Solaris, and Windows.
- Valid only on AIX, HP-UX, Linux, OS/400, Solaris, Windows, and z/OS.
- Valid only if TRPTYPE is LU62.
- Not valid on z/OS.
- Valid only on OS/2 Warp and Windows.
- Valid only on AIX.
- Valid only on full function WebSphere MQ for z/OS when the queue manager is a member of a queue-sharing group.
Cluster-receiver channel
DEFINE CHANNEL (3) >>-DEFINE CHANNEL(channel-name)--CHLTYPE(CLUSRCVR)--------------> >--CONNAME(string)-----------+------------------+---------------> 'BATCHHB(integer)--' >--+-------------------+--+------------------+------------------> '-BATCHINT(integer)-' '-BATCHSZ(integer)-' >--+------------------+--+----------------------+---------------> '-CLUSNL(nlname)---' '-CLUSTER(clustername)-' >--+------------------+--+---------------------------+----------> '-CONVERT(YES)-----' | (11) | +-CMDSCOPE(qmgr-name)-------+ | (11) | '-CMDSCOPE(*)---------------' >--+-----------------+--+--------------------+------------------> '-DESCR(string)---' '-DISCINT(integer)---' >--+-----------------+--+------------------+--------------------> '-HBINT(integer)--' 'KAINT(integer)----' >--+--------------------+--+--------------------+---------------> '-LIKE(channel-name)-' 'LOCLADDR(string)----' >--+---------------------------+--+--------------------+--------> '-LONGRTY(integer)----------' '-LONGTMR(integer)---' >--+-------------------------+--+----------------------+--------> '-MAXMSGL(integer)--------' '-MCATYPE(PROCESS)-----' >--+-------------------+--+--------------------+----------------> '-MCAUSER(string)---' '-MODENAME(string)---' >--+------------------+-------+------------------+--------------> '-MRDATA(string)---' '-MREXIT(string)---' >--+----------------+-------+------------------+----------------> '-MRRTY(integer)-' '-MRTMR(integer)---' >--+-----------------------+--+-----------------------+---------> | .-+---+--. | | .-+---+--. | | | '-,-' | | | | '-,-' | | | V | | | V | | '-MSGDATA(---string-+-)-' '-MSGEXIT(---string-+-)-' >--+------------------+--+---------------------+----------------> '-NETPRTY(integer)-' '-NPMSPEED(NORMAL)----' >--+----------------------+--+----------------------+-----------> +-PUTAUT(CTX)----------+ | (11) | | (8) | +-QSGDISP(COPY)--------+ +-PUTAUT(ONLYMCA)------+ | (11) | | (8) | '-QSGDISP(GROUP)-------' '-PUTAUT(ALTMCA)-------' >--+-----------------------+--+-----------------------+---------> | .-+---+--. | | .-+---+--. | | | '-,-' | | | | '-,-' | | | V | | | V | | '-RCVDATA(---string-+-)-' '-RCVEXIT(---string-+-)-' >--+-----------+--+-------------------+-------------------------> '-REPLACE---' '-SCYDATA(string)---' >--+-------------------+--+------------------------+------------> '-SCYEXIT(string)---' | .-+---+--. | | | '-,-' | | | V | | '-SENDDATA(---string-+-)-' >--+------------------------+--+---------------------------+----> | .-+---+--. | '-SEQWRAP(integer)----------' | | '-,-' | | | V | | '-SENDEXIT(---string-+-)-' >--+-------------------+--+-------------------+-----------------> '-SHORTRTY(integer)-' '-SHORTTMR(integer)-' >--+-------------------------+----------------------------------> >--+------------------+-------+-----------------------------+-->< '-TPNAME(string)---' '-TRPTYPE(-+-LU62---------+-)-' | (9) | +-NETBIOS------+ | (9) | +-SPX----------+ +-TCP----------+ | (10) | '-UDP----------'
Notes:
- Valid only on AIX, Compaq OpenVMS, HP-UX, Linux, OS/2 Warp, OS/400, Solaris, Windows, and z/OS.
- Valid only on AIX, HP-UX, Linux, OS/400, Solaris, Windows, and z/OS.
- This parameter must follow immediately after the channel name except on z/OS.
- This is the default supplied with WebSphere MQ, but your installation might have changed it.
- Not valid on z/OS.
- Valid only if TRPTYPE is LU62.
- This parameter is optional if TRPTYPE is TCP.
- Valid only on z/OS.
- Valid only on OS/2 Warp and Windows.
- Valid only on AIX.
- Valid only on full function WebSphere MQ for z/OS when the queue manager is a member of a queue-sharing group.
Parameter descriptions
The parameter descriptions also apply to the ALTER CHANNEL command, with the following exceptions:
- The LIKE parameter applies only to the DEFINE CHANNEL command.
- The REPLACE and NOREPLACE parameter applies only to the DEFINE CHANNEL command.
- The variations in the CMDSCOPE and QSGDISP parameters between the ALTER CHANNEL and DEFINE CHANNEL commands are described.
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, 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, OS/400, 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:
- BATCHSZ messages have been sent, or
- The transmission queue is empty and BATCHINT is exceeded
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, Compaq OpenVMS, HP-UX, Linux, OS/2 Warp, OS/400, Solaris, Windows, and z/OS.
- BATCHSZ(integer)
- The maximum number of messages that can be sent through a channel before taking a checkpoint.
The maximum batch size actually used is the lowest of the following:
- The BATCHSZ of the sending channel
- The BATCHSZ of the receiving channel
- Three less than the maximum number of uncommitted messages allowed at the sending queue manager (or one if this value is zero or less)
- Three less than 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, Compaq OpenVMS, HP-UX, Linux, OS/2 Warp, OS/400, Solaris, Windows, and z/OS)
- CLUSRCVR
- Cluster-receiver channel (valid only on AIX, Compaq OpenVMS, HP-UX, Linux, OS/2 Warp, OS/400, Solaris, Windows, and z/OS)
Notes:
- Only SVRCONN is available on the reduced function form of WebSphere MQ for z/OS supplied with WebSphere Application Server.
- If you are using the REPLACE option, you 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, Compaq OpenVMS, HP-UX, Linux, OS/2 Warp, OS/400, 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 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, Compaq OpenVMS, HP-UX, Linux, OS/2 Warp, OS/400, Solaris, Windows and z/OS.
- 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.
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 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.
- 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.
- Note:
- 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 Compaq OpenVMS.
- LU 6.2
- On Compaq 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.
- Note:
- 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.
- Note:
- 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(R) generic resources group.
- On OS/2 Warp it is the fully-qualified name of the partner LU, or an LU alias.
- On Compaq OpenVMS, OS/400, 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 Intercommunication 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.
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, OS/400, Solaris, and Windows, 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 IP address of the system.
- UDP
- Either the host name, or the network address of the remote MQSeries for Windows V2.0 machine. This can be followed by an optional port number, enclosed in parentheses.
- 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).
- Note:
- 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 SDR, SVR, CLUSSDR, or CLUSRCVR.
- 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.
This type of heartbeat is valid only on AIX, Compaq OpenVMS, HP-UX, Linux, OS/2 Warp, OS/400, Solaris, Windows, and z/OS.
- Note:
- 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. This type of heartbeat is valid only for AIX, Compaq OpenVMS, HP-UX, Linux, OS/2 Warp, OS/400, Solaris, and Windows.
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.
- KAINT(integer)
- This parameter is valid on z/OS only. It specifies the value passed to the communications stack for KeepAlive timing for this channel. The value is applicable for the TCP/IP and SPX communications protocols, though not all implementations support this parameter.
If the TCPKEEP channel initiator parameter (set by CSQ6CHIP) is NO, the value is ignored and the KeepAlive facility is not used.
- (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 KEEPALIVEOPTIONS statement in the TCP profile configuration data set.
- AUTO
- The KeepAlive interval is calculated based upon the negotiated heartbeat value as follows:
The default value is AUTO.
This parameter is valid for all channel types. It is ignored for channels with a TRPTYPE other than TCP or SPX.
This parameter is valid only on z/OS.
- 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 WebSphere MQ for z/OS, the queue manager searches page set zero for an object with the name you specify. The disposition of the LIKE object is not copied to the object you are defining.
Notes:
- 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.
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 dotted decimal or alphanumeric 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:
Table 2. 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.
- Note:
- 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.
- 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.
- Note:
- 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, Compaq OpenVMS, HP-UX, Linux, OS/2 Warp, OS/400, 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.
On other platforms, specify a value in the range zero through 4 194 304 bytes (4 MB).
- 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 should run as a thread or a process.
- PROCESS
- The message channel agent runs as a separate process
- THREAD
- The message channel agent runs as a separate thread
In situations where a threaded listener is required to service a large number of incoming requests, resources can become strained. In this case, use multiple listener processes and target incoming requests at specific listeners though the port number specified on the listener.
This parameter is valid only for channels with a channel type (CHLTYPE) of SDR, SVR, RQSTR, CLUSSDR, or CLUSRCVR. It is supported only on AIX, Compaq OpenVMS, HP-UX, Linux, OS/2 Warp, OS/400, 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, 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.
- 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 Intercommunication manual for more information.
This parameter is not valid for channels with a channel type (CHLTYPE) of RCVR or SVRCONN.
- MRDATA(string)
- Channel message-retry exit user data. The maximum lengthis 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. It is not supported on z/OS.
- MREXIT(string)
- Channel message-retry exit name.
The format and maximum length of the name is the same as for MSGEXIT.
This parameter is valid only for channels with a channel type (CHLTYPE) of RCVR, RQSTR, or CLUSRCVR. It is not supported on z/OS.
- 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.
This parameter is valid only for channels with a channel type (CHLTYPE) of RCVR, RQSTR, or CLUSRCVR. It is not supported on z/OS.
- 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. It is not supported on z/OS.
- 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, Compaq OpenVMS, HP-UX, Linux, OS/2 Warp, 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 OS/400, 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.
- 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. 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:
- 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, Compaq OpenVMS, HP-UX, Linux, OS/2 Warp, 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 OS/400, 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 not relevant, because message exits are not invoked for such channels.
The format and maximum length of the name depends on the environment:
- On Compaq OpenVMS and UNIX systems, it is of the form:
libraryname(functionname)The maximum length of the string is 128 characters.
- On OS/2 Warp and 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 OS/400, it is of the form:
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.
- 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, Compaq OpenVMS, HP-UX, Linux, OS/2 Warp, OS/400, 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, Compaq OpenVMS, HP-UX, Linux, OS/2 Warp, OS/400, 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 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 refresh local copies on page set zero:DEFINE CHANNEL(channel-name) CHLTYPE(type) REPLACE QSGDISP(COPY)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 make or refresh local copies on page set zero:DEFINE CHANNEL(channe-name) CHLTYPE(type) REPLACE QSGDISP(COPY)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, Compaq OpenVMS, HP-UX, Linux, OS/2 Warp, 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 OS/400, 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.
- 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, Compaq OpenVMS, HP-UX, Linux, OS/2 Warp, 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 OS/400, 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.
- REPLACE and NOREPLACE
- Whether the existing definition 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.
- 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, Compaq OpenVMS, HP-UX, Linux, OS/2 Warp, 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 OS/400, 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.
- 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, Compaq OpenVMS, HP-UX, Linux, OS/2 Warp, 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 OS/400, 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.
- 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.
- Note:
- 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 supported only on AIX, HP-UX, Linux, OS/400, Solaris, Windows, and z/OS.
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 supported only on AIX, HP-UX, Linux, OS/400, Solaris, Windows, and z/OS.
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 3.
Table 3. CipherSpecs that can be used with WebSphere MQ SSL support
CipherSpec name Hash algorithm Encryption algorithm Encryption bits NULL_MD51 MD5 None 0 NULL_SHA1 SHA None 0 RC4_MD5_EXPORT1 MD5 RC4 40 RC4_MD5_US2 MD5 RC4 128 RC4_SHA_US2 SHA RC4 128 RC2_MD5_EXPORT1 MD5 RC2 40 DES_SHA_EXPORT1 SHA DES 56 RC4_56_SHA_EXPORT10243,4,5 SHA RC4 56 DES_SHA_EXPORT10243,4,5,6 SHA DES 56 TRIPLE_DES_SHA_US4 SHA 3DES 168 TLS_RSA_WITH_AES_128_CBC_SHA7 SHA AES 128 TLS_RSA_WITH_AES_256_CBC_SHA7 SHA AES 256 AES_SHA_US8 SHA AES 128 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:
- On UNIX 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 systems, when a CipherSpec name includes _EXPORT1024, the handshake key size is 1024 bits. Refer to note (CS1NOTE1024) in Table 3.
- 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 supported only on AIX, HP-UX, Linux, OS/400, Solaris, Windows, and z/OS.
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 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 match in the order they are found in the certificate's Distinguished Name, and must start with the first OU, or an asterisk. For example, if the flowed certificate's Distinguished Name contains the OUs OU=One,OU=Two,OU=Three, specifying the following SSLPEER values will work:
('OU=One,OU=Two') ('OU=*,OU=Two,OU=Three') ('OU=*,OU=Two')but specifying the following SSLPEER values will fail:
('OU=Two,OU=Three') ('OU=One,OU=Three') ('OU=Two')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, OS/400, and UNIX platforms, and 256 bytes on z/OS.
- 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.
The name can also be nonblank for client connection channels to be used with OS/2 Warp.
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.
- TRPTYPE
- Transport type to be used.
On AIX, HP-UX, Linux, OS/2 Warp, OS/400, 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 Compaq OpenVMS)
- LU62
- SNA LU 6.2
- NETBIOS
- NetBIOS (supported only on OS/2 Warp, 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 OS/2 Warp, 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
- UDP
- User Datagram Protocol - part of the TCP/IP protocol suite (supported only on AIX); this option is available only for connection to MQSeries for Windows, V2.0, with CSD02
- 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. You 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.
WebSphere is a trademark of the IBM Corporation in the United States, other countries, or both.
IBM is a trademark of the IBM Corporation in the United States, other countries, or both.
AIX is a trademark of the IBM Corporation in the United States, other countries, or both.