[IBM i]

WRKMQMCHST (Work with MQ Channel Status)

Where allowed to run
All environments (*ALL)
Threadsafe
Yes

The Work with MQ Channel Status (WRKMQMCHST) command allows you to work with the status of one or more channel definitions.

Parameters

Table 1. Command parameters
Keyword Description Choices Notes
CHLNAME Channel name Character value, *ALL Optional, Positional 1
CONNAME Connection name Character value, *ALL Optional, Positional 2
TMQNAME Transmission queue name Character value, *ALL Optional, Positional 3
MQMNAME Message Queue Manager name Character value, *DFT Optional, Positional 4
CHLSTS Channel status *ALL, *SAVED, *CURRENT Optional, Positional 5
WHERE Filter command Single values: *NONE Other values: Element list Optional, Positional 6
Element 1: Filter keyword *CHLSTS, *CHLTYPE, *COMPHDR, *COMPMSG, *CONNAME, *INDOUBT, *INDMSGS, *INDSEQNO, *LSTSEQNO, *MONCHL, *RMTMQMNAME, *RMTVERSION, *SHARECNV, *STATUS, *SUBSTATE, *TMQNAME, *XQMSGSA, *LSTMSGDATE, *LSTMSGTIME, *MSGS
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 of the channel definition.

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.

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

Connection name (CONNAME)

Specifies the name of the machine to connect.

The possible values are:

*ALL
All the channels are selected.
generic-connection-name
Specify the generic connection name of the required channels.
connection-name
Specify the connection name of the required channels.

Transmission queue name (TMQNAME)

Specifies the name of the transmission queue.

The possible values are:

*ALL
All the transmission queues are selected.
generic-transmission-queue-name
Specify the generic name of the transmission queues.
transmission-queue-name
Specify the name of the transmission queue. A transmission queue name is required if the channel definition type (CHLTYPE) is *SDR or *SVR.

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 you 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 (CHLSTS)

Specifies the type of channel status to display.

The possible values are:

*SAVED
Saved channel status only is displayed. Status is not saved until a persistent message is transmitted across a channel, or a nonpersistent message is transmitted with a NPMSPEED of NORMAL. Because status is saved at the end of each batch, a channel has no saved status until at least one batch has been transmitted.
*CURRENT
Current channel status only is displayed. This applies to channels that have been started, or on which a client has connected, and that have not finished or disconnected normally. The current status data is updated as messages are sent or received.
*ALL
Both saved and current channel status is displayed.

Filter command (WHERE)

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

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:

*CHLSTS
The type of channel status.

The filter value is one of the following:

*CURRENT
Current status for an active channel.
*SAVED
Saved status for an active or inactive channel.
*CHLTYPE
The type of channel.

The filter value is one of the following:

*SDR
Sender channel.
*SVR
Server channel.
*RCVR
Receiver channel.
*RQSTR
Requester channel.
*CLUSSDR
Cluster-sender channel.
*CLUSRCVR
Cluster-receiver channel.
*SVRCN
Server-connection channel.
*COMPHDR
Whether the channel performs header data compression.

The filter value is one of the following:

*NONE
No header data compression is performed.
*SYSTEM
Header data compression is performed.
*COMPMSG
Whether the channel performs message data 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.
*CONNAME
The connection name of the channel.

The filter value is the connection name string.

*INDOUBT
Whether there are any in-doubt messages in the network.

The filter value is either *NO or *YES.

*INDMSGS
The number of in-doubt messages.

The filter value is the integer number of messages.

*INDSEQNO
The sequence number of the message that is in-doubt.

The filter value is the integer sequence number.

*LSTMSGTIME
The time the last message was sent on the channel.

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

*LSTMSGDATE
The date that the last message was sent on the channel.

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

*LSTSEQNO
The last message sequence number.

The filter value is the integer sequence number.

*MONCHL
The current level of monitoring data collection for the channel.

The filter value is one of the following:

*NONE
No monitoring data is collected.
*LOW
A low ratio of monitoring data is collected.
*MEDIUM
A medium ratio of monitoring data is collected.
*HIGH
A high ratio of monitoring data is collected.
*MSGS
The number of messages that have been sent on the channel.

The filter value is the integer number of messages.

*RMTMQMNAME
The remote message queue manager.

The filter value is the message queue manager name.

*RMTVERSION
The remote partner version.

The filter value is the integer format of the remote partner version.

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

The filter value is the integer number of shared conversations.

*STATUS
The status of the channel.

The filter value is one of the following:

*BINDING
The channel is establishing a session.
*INACTIVE
The channel has ended processing normally or the channel has never started.
*INITIALIZING
The channel initiator is attempting to start the channel.
*PAUSED
The channel is waiting for the message retry interval.
*REQUESTING
The channel has been requested to start.
*RETRYING
A previous attempt to establish a connection has failed. The channel will retry the connection after the specified interval.
*RUNNING
The channel is transferring or is ready to transfer data.
*STARTING
The channel is ready to begin negotiation with the target MCA.
*STOPPED
The channel has been stopped.
*STOPPING
The channel has been requested to stop.
*SWITCHING
The channel is switching transmission queues.
*SUBSTATE
The channel substate.

The filter value is one of the following:

*ENDBATCH
End of batch processing.
*SEND
Sending data.
*RECEIVE
Receiving data.
*SERIALIZE
Serializing with the partner channel.
*RESYNCH
Resynchronizing with the partner channel.
*HEARTBEAT
Heartbeat processing.
*SCYEXIT
Processing a security exit.
*RCVEXIT
Processing a receive exit.
*SENDEXIT
Processing a send exit.
*MSGEXIT
Processing a message exit.
*MREXIT
Processing a message-retry exit.
*CHADEXIT
Processing a channel auto-definition exit.
*NETCONNECT
Connecting to remote machine.
*SSLHANDSHK
Establishing a TLS connection.
*NAMESERVER
Requesting information from a name server.
*MQPUT
MQPUT processing.
*MQGET
MQGET processing.
*MQICALL
Processing an MQI call.
*COMPRESS
Compressing or extracting data.
*TMQNAME
The transmission queue of the channel.

The filter value is the queue name.

*XQMSGSA
The number of messages queued on the transmission queue available for MQGET. This field is valid for cluster-sender channels.

The filter value is the integer number of messages.