+

Search Tips | Advanced Search

Work with MQ Channels (WRKMQMCHL)

    Where allowed to run
    All environments (*ALL)

    Threadsafe
    Yes

The Work with IBM MQ Channels (WRKMQMCHL) command allows you to work with one or more channel definitions. This enables you to create, start, end, change, copy, delete, ping, display and reset channels, and resolve in-doubt units of work.


Parameters

Keyword Description Choices Notes
CHLNAME Channel name Character value, *ALL Optional, Positional 1
CHLTYPE Channel type *RCVR, *SDR, *SVR, *RQSTR, *SVRCN, *CLUSSDR, *CLUSRCVR, *CLTCN, *ALL Optional, Positional 2
MQMNAME Message Queue Manager name Character value, *DFT Optional, Positional 3
STATUS Channel status *ALL, *INACTIVE, *STOPPED, *BINDING, *RETRYING, *RUNNING, *SWITCHING Optional, Positional 4
WHERE Filter command Single values: *NONE Other values: Element list Optional, Positional 5
Element 1: Filter keyword *AFFINITY, *ALTDATE, *ALTTIME, *BATCHHB, *BATCHINT, *BATCHLIM, *BATCHSIZE, *CLNTWGHT, *CLUSNL, *CLUSTER, *CLWLPRTY, *CLWLRANK, *CLWLWGHT, *COMPHDR, *COMPMSG, *CONNAME, *CVTMSG, *DSCITV, *HRTBTINTVL, *KAINT, *LOCLADDR, *LONGRTY, *LONGTMR, *MAXINST, *MAXINSTC, *MAXMSGLEN, *MCANAME, *MCATYPE, *MCAUSRID, *MODENAME, *MONCHL, *MSGEXIT, *MSGRTYDATA, *MSGRTYEXIT, *MSGRTYITV, *MSGRTYNBR, *MSGUSRDATA, *NETPRTY, *NPMSPEED, *PROPCTL, *PUTAUT, *RCVEXIT, *RCVUSRDATA, *SCYEXIT, *SCYUSRDATA, *SEQNUMWRAP, *SHARECNV, *SHORTRTY, *SHORTTMR, *SNDEXIT, *SNDUSRDATA, *SSLCAUTH, *SSLCIPH, *SSLPEER, *STATCHL, *TEXT, *TGTMQMNAME, *TMQNAME, *TPNAME, *TRPTYPE, *USERID
Element 2: Filter operator *GT, *LT, *EQ, *NE, *GE, *LE, *LK, *NL, *CT, *EX, *CTG, *EXG
Element 3: Filter value Character value


Channel name (CHLNAME)

>

Specifies the name or names of the IBM MQ channel definitions to be selected.

The possible values are:

    *ALL
    All channel definitions are selected.

    generic-channel-name
    Specify the generic name of the channel definitions to be selected. A generic name is a character string followed by an asterisk (*). For example ABC*, it selects all channel definitions having names that start with the character string.

    You are recommended to specify the name required within quotation marks. Using this format ensures that your selection is precisely what you entered.

    We cannot select all the uppercase and lowercase versions of a generic name on a single panel, without requesting all the names.

    channel-name
    Specify the name of the channel definition.


Channel type (CHLTYPE)

>

Specifies the type of channel definitions that are to be displayed.

The possible values are:

    *ALL
    All the channel types are selected.


Message Queue Manager name (MQMNAME)

>

Specifies the name of the message queue manager.

The possible values are:

    *DFT
    The default queue manager is used. If we do not have a default queue manager defined on the system, the command fails.

    message-queue-manager-name
    The name of a message queue manager.


Channel status (STATUS)

>

Specifies the status type of the IBM MQ channel definitions to be selected.

The possible values are:

    *ALL
    Channels with any status are selected.

    *BINDING
    Only channels with a binding status are selected.

    *INACTIVE
    Only channels with an inactive status are selected.

    *RETRYING
    Only channels with a retrying status are selected.

    *RUNNING
    Only channels with a running status are selected.

    *STOPPED
    Only channels with a stopped status are selected.

    *SWITCHING
    Only channels with a switching status are selected.


Filter command (WHERE)

>

This parameter can be used to selectively display those channels with particular channel attributes only.

The parameter takes three arguments, a keyword, an operator and a value.

Generic strings are allowed for values which are names.

The operator can take one of the following values:

    *GT
    Greater than.

    Applicable to integer and non-generic string values.

    *LT
    Less than.

    Applicable to integer and non-generic string values

    *EQ
    Equal to.

    Applicable to integer and non-generic string values.

    *NE
    Not equal to.

    Applicable to integer and non-generic string values.

    *GE
    Greater than or equal to.

    Applicable to integer and non-generic string values.

    *LE
    Less than or equal to.

    Applicable to integer and non-generic string values.

    *LK
    Like.

    Applicable to generic string values.

    *NL
    Not like.

    Applicable to generic string values.

    *CT
    Contains.

    Applicable to non-generic list values.

    *EX
    Excludes.

    Applicable to non-generic list values.

    *CTG
    Contains generic.

    Applicable to generic list values.

    *EXG
    Excludes generic.

    Applicable to generic list values.

The keyword can take one of the following values:

    *AFFINITY
    Connection Affinity.

    The filter value is one of the following:

      *PREFERRED
      Preferred connection affinity.

      *NONE
      No connection affinity.

    *ALTDATE
    The date on which the definition or information was last altered.

    The filter value is the data in the form yyyy-mm-dd.

    *ALTTIME
    The time at which the definition or information was last altered.

    The filter value is the time in the form hh:mm:ss.

    *BATCHHB
    Batch heartbeat interval in milliseconds.

    The filter value is the integer interval time.

    *BATCHINT
    Batch interval in milliseconds.

    The filter value is the integer interval time.

    *BATCHLIM
    Batch data limit in kilobytes.

    The limit of the amount of data that can be sent through a channel.

    *BATCHSIZE
    Batch size.

    The filter value is the integer batch size.

    *CLNTWGHT
    Client channel weight.

    The filter value is the integer client channel weight.

    *CLUSNL
    Cluster namelist.

    The filter value is the list of cluster names.

    *CLUSTER
    The cluster to which the channel belongs.

    The filter value is the name of the cluster.

    *CLWLRANK
    Cluster workload rank.

    The filter value is the integer rank.

    *CLWLPRTY
    Cluster workload priority.

    The filter value is the integer priority.

    *CLWLWGHT
    Cluster workload weight.

    The filter value is the integer weight.

    *COMPHDR
    Header compression.

    The filter value is one of the following:

      *NONE
      No header data compression is performed.

      *SYSTEM
      Header data compression is performed.

    *COMPMSG
    Message compression.

    The filter value is one of the following:

      *NONE
      No message data compression is performed.

      *RLE
      Message data compression is performed using RLE.

      *ZLIBHIGH
      Message data compression is performed using ZLIB compression. A high level of compression is preferred.

      *ZLIBFAST
      Message data compression is performed using ZLIB compression. A fast compression time is preferred.

      *ANY
      Any compression technique supported by the queue manager can be used.

    *CONNAME
    Remote connection name.

    The filter value is the connection name string.

    *CVTMSG
    Whether the message is converted before transmission.

    The filter value is one of the following:

      *YES
      The application data in the message is converted before sending.

      *NO
      The application data in the message is not converted before sending.

    *DSCITV
    Disconnect interval in seconds.

    The filter value is the integer interval time.

    *HRTBTINTVL
    Heartbeat interval in seconds.

    The filter value is the integer interval time.

    *KAINT
    Keep alive interval in seconds.

    The filter value is the integer interval time.

    *LOCLADDR
    Local connection name.

    The filter value is the connection name string.

    *LONGRTY
    Long retry count.

    The filter value is the integer count.

    *LONGTMR
    Long retry interval in seconds.

    The filter value is the integer interval time.

    *MAXINST
    Maximum instances of an individual server-connection channel.

    The filter value is the integer number of instances.

    *MAXINSTC
    Maximum instances of an individual server-connection channel from a single client.

    The filter value is the integer number of instances.

    *MAXMSGLEN
    Maximum message length.

    The filter value is the integer length.

    *MCANAME
    Message channel agent name.

    The filter value is the agent name.

    *MCATYPE
    Whether the message channel agent program should run as a thread or process.

    The filter value is one of the following:

    *MCAUSRID
    Message channel agent user identifier.

    The filter value is the user identifier string.

    *MODENAME
    SNA mode name.

    The filter value is the mode name string.

    *MONCHL
    Channel Monitoring.

    The filter value is one of the following:

      *QMGR
      The collection of Online Monitoring Data is inherited from the setting of the queue manager attribute MONCHL.

      *OFF
      Online Monitoring Data collection for this channel is disabled.

      *LOW
      Monitor data collection is turned on with a low ratio of data collection.

      *MEDIUM
      Monitor data collection is turned on with a moderate ratio of data collection.

      *HIGH
      Monitor data collection is turned on with a high ratio of data collection.

    *MSGEXIT
    Message exit name.

    The filter value is the exit name.

    *MSGRTYDATA
    Message retry exit user data.

    The filter value is the user data string.

    *MSGRTYEXIT
    Message retry exit name.

    The filter value is the exit name.

    *MSGRTYITV
    Message retry interval interval in seconds.

    The filter value is the integer interval time.

    *MSGRTYNBR
    Number of message retries.

    The filter value is the integer number of retries.

    *MSGUSRDATA
    Message exit user data.

    The filter value is the user data string.

    *NETPRTY
    Network connection priority ranging from 0 through 9.

    The filter value is the integer priority value.

    *NPMSPEED
    Whether the channel supports fast nonpersistent messages.

    The filter value is one of the following:

      *FAST
      The channel supports fast nonpersistent messages.

      *NORMAL
      The channel does not support fast nonpersistent messages.

    *PROPCTL
    Message Property Control.

    The filter value is one of the following:

    *PUTAUT
    Whether the user identifier in the context information is used.

    The filter value is one of the following:

      *DFT
      No authority check is made before the message is put on the destination queue.

      *CTX
      The user identifier in the message context information is used to establish authority to put the message.

    *RCVEXIT
    Receive exit name.

    The filter value is the exit name.

    *RCVUSRDATA
    Receive exit user data.

    The filter value is the user data string.

    *SCYEXIT
    Security exit name.

    The filter value is the exit name.

    *SCYUSRDATA
    Security exit user data.

    The filter value is the user data string.

    *SEQNUMWRAP
    Maximum message sequence number.

    The filter value is the integer sequence number.

    *SHARECNV
    The number of shared conversations over a TCP/IP socket.

    The filter value is the integer number of shared conversations.

    *SHORTRTY
    Short retry count.

    The filter value is the integer count.

    *SHORTTMR
    Short retry interval in seconds.

    The filter value is the integer interval time.

    *SNDEXIT
    Send exit name.

    The filter value is the exit name.

    *SNDUSRDATA
    Send exit user data.

    The filter value is the user data string.

    *SSLCAUTH
    Whether the channel should carry out client authentication over TLS.

    The filter value is one of the following:

      *REQUIRED
      Client authentication is required.

      *OPTIONAL
      Client authentication is optional.

    *SSLCIPH
    The CipherSpec using in TLS channel negotiation.

    The filter value is the name of the CipherSpec.

    *SSLPEER
    The X500 peer name used in TLS channel negotiation.

    The filter value is the peer name.

    *STATCHL
    Channel Statistics.

    The filter value is one of the following:

      *QMGR
      The collection of statistics data is inherited from the setting of the queue manager attribute STATCHL.

      *OFF
      Statistics data collection for this channel is disabled.

      *LOW
      Statistics data collection is turned on with a low ratio of data collection.

      *MEDIUM
      Statistics data collection is turned on with a moderate ratio of data collection.

      *HIGH
      Statistics data collection is turned on with a high ratio of data collection.

    *TEXT
    Descriptive comment.

    The filter value is the text description of the channel.

    *TGTMQMNAME
    Target queue manager name.

    The filter value is the target queue manager of the channel.

    *TMQNAME
    Transmission queue name.

    The filter value is the name of the queue.

    *TPNAME
    The SNA transaction program name.

    The filter value is the program name string.

    *TRPTYPE
    Transport type.

    The filter value is one of the following:

      *TCP
      Transmission Control Protocol / Internet Protocol (TCP/IP).

      *LU62
      SNA LU 6.2.

    *USERID
    Task user identifier.

    The filter value is the user identifier string.


Examples

>

None


Error messages

>

Unknown

Parent topic: CL commands reference for IBM i

Last updated: 2020-10-04