Inquire Channel Status (Response)

The response to the Inquire Channel Status (MQCMD_INQUIRE_CHANNEL_STATUS) command consists of the response header followed by several structures.

These structures are

  • The ChannelName structure
  • The ChannelDisposition structure (on z/OS only),
  • The ChannelInstanceType structure
  • The ChannelStatus structure (except on z/OS channels whose ChannelInstanceType parameter has a value of MQOT_SAVED_CHANNEL.
  • The ChannelType structure
  • The ConnectionName structure
  • The RemoteApplTag structure
  • The RemoteQMgrName structure
  • The StopRequested structure
  • The XmitQName structure

which are then followed by the requested combination of status attribute parameter structures. One such message is generated for each channel instance found that matches the criteria specified on the command. On z/OS, if the value for any of these parameters exceeds 999999999, it is returned as 999999999:

  • Batches
  • BuffersReceived
  • BuffersSent
  • BytesReceived
  • BytesSent
  • CompressionTime
  • CurrentMsgs
  • ExitTime
  • Msgs
  • NetTime
  • SSLKeyResets
  • XQTime

    Always returned:
    ChannelDisposition , ChannelInstanceType , ChannelName , ChannelStatus , ChannelType , ConnectionName , RemoteApplTag , RemoteQMgrName , StopRequested , SubState , XmitQName

    Returned if requested:
    Batches, BatchSize, BatchSizeIndicator, BuffersReceived, BuffersSent, BytesReceived, BytesSent, ChannelMonitoring, ChannelStartDate, ChannelStartTime, CompressionRate, CompressionTime, CurrentLUWID, CurrentMsgs, CurrentSequenceNumber, CurrentSharingConversations, ExitTime, HeaderCompression, HeartbeatInterval, InDoubtStatus, KeepAliveInterval, LastLUWID, LastMsgDate, LastMsgTime, LastSequenceNumber, LocalAddress, LongRetriesLeft, MaxMsgLength, MaxSharingConversations, MCAJobName, MCAStatus, MCAUserIdentifier, MessageCompression, Msgs, MsgsAvailable, NetTime, NonPersistentMsgSpeed, QMgrName, RemoteVersion, RemoteProduct, SecurityProtocol, ShortRetriesLeft, SSLCertRemoteIssuerName, SSLCertUserId, SSLKeyResetDate, SSLKeyResets, SSLKeyResetTime, SSLShortPeerName, XQTime


Response data

    Batches (MQCFIN)
    Number of completed batches (parameter identifier: MQIACH_BATCHES).

    BatchSize (MQCFIN)
    Negotiated batch size (parameter identifier: MQIACH_BATCH_SIZE).

    BatchSizeIndicator (MQCFIL)
    Indicator of the number of messages in a batch (parameter identifier: MQIACH_BATCH_SIZE_INDICATOR). Two values are returned:

    • A value based on recent activity over a short period.
    • A value based on activity over a longer period.

    Where no measurement is available, the value MQMON_NOT_AVAILABLE is returned.

    BuffersReceived (MQCFIN)
    Number of buffers received (parameter identifier: MQIACH_BUFFERS_RCVD).

    BuffersSent (MQCFIN)
    Number of buffers sent (parameter identifier: MQIACH_BUFFERS_SENT).

    BytesReceived (MQCFIN)
    Number of bytes received (parameter identifier: MQIACH_BYTES_RCVD).

    BytesSent (MQCFIN)
    Number of bytes sent (parameter identifier: MQIACH_BYTES_SENT).

    ChannelDisposition (MQCFIN)
    Channel disposition (parameter identifier: MQIACH_CHANNEL_DISP). This parameter is valid only on z/OS. The value can be any of the following values:

      MQCHLD_PRIVATE
      Status information for a private channel.

      MQCHLD_SHARED
      Status information for a shared channel.

      MQCHLD_FIXSHARED
      Status information for a shared channel, tied to a specific queue manager.

    ChannelInstanceType (MQCFIN)
    Channel instance type (parameter identifier: MQIACH_CHANNEL_INSTANCE_TYPE). The value can be any of the following values:

    ChannelMonitoring (MQCFIN)
    Current level of monitoring data collection for the channel (parameter identifier: MQIA_MONITORING_CHANNEL). The value can be any of the following values:

      MQMON_OFF
      Monitor for the channel is disabled.

      MQMON_LOW
      Low rate of data collection.

      MQMON_MEDIUM
      Medium rate of data collection.

      MQMON_HIGH
      High rate of data collection.

    ChannelName (MQCFST)
    Channel name (parameter identifier: MQCACH_CHANNEL_NAME).

    The maximum length of the string is MQ_CHANNEL_NAME_LENGTH.

    ChannelStartDate (MQCFST)
    Date channel started, in the form yyyy-mm-dd (parameter identifier: MQCACH_CHANNEL_START_DATE).

    The maximum length of the string is MQ_CHANNEL_DATE_LENGTH.

    ChannelStartTime (MQCFST)
    Time channel started, in the form hh.mm.ss (parameter identifier: MQCACH_CHANNEL_START_TIME).

    The maximum length of the string is MQ_CHANNEL_TIME_LENGTH.

    ChannelStatistics (MQCFIN)
    Specifies whether statistics data is to be collected for channels (parameter identifier: MQIA_STATISTICS_CHANNEL). The value can be:

      MQMON_OFF
      Statistics data collection is turned off.

      MQMON_LOW
      Statistics data collection is turned on, with a low ratio of data collection.

      MQMON_MEDIUM
      Statistics data collection is turned on, with a moderate ratio of data collection.

      MQMON_HIGH
      Statistics data collection is turned on, with a high ratio of data collection.

    On z/OS systems, enabling this parameter simply turns on statistics data collection, regardless of the value you select. Specifying LOW, MEDIUM, or HIGH makes no difference to your results. This parameter must be enabled in order to collect channel accounting records.

    This parameter is valid only on z/OS.

    ChannelStatus (MQCFIN)
    Channel status (parameter identifier: MQIACH_CHANNEL_STATUS). Channel status has the following values defined:

      MQCHS_BINDING
      Channel is negotiating with the partner.

      MQCHS_STARTING
      Channel is waiting to become active.

      MQCHS_RUNNING
      Channel is transferring or waiting for messages.

      MQCHS_PAUSED
      Channel is paused.

      MQCHS_STOPPING
      Channel is in process of stopping.

      MQCHS_RETRYING
      Channel is reattempting to establish connection.

      MQCHS_STOPPED
      Channel is stopped.

      MQCHS_REQUESTING
      Requester channel is requesting connection.

      MQCHS_SWITCHING
      Channel is switching transmission queues.

      MQCHS_INITIALIZING
      Channel is initializing.

    ChannelType (MQCFIN)
    Channel type (parameter identifier: MQIACH_CHANNEL_TYPE). The value can be any of the following values:

      MQCHT_SENDER
      Sender.

      MQCHT_SERVER
      Server.

      MQCHT_RECEIVER
      Receiver.

      MQCHT_REQUESTER
      Requester.

      MQCHT_SVRCONN
      Server-connection (for use by clients).

      MQCHT_CLNTCONN
      Client connection.

      MQCHT_CLUSRCVR
      Cluster-receiver.

      MQCHT_CLUSSDR
      Cluster-sender.

    CompressionRate (MQCFIL)
    The compression rate achieved displayed to the nearest percentage (parameter identifier: MQIACH_COMPRESSION_RATE). Two values are returned:

    • A value based on recent activity over a short period.
    • A value based on activity over a longer period.

    Where no measurement is available, the value MQMON_NOT_AVAILABLE is returned.

    CompressionTime (MQCFIL)
    The amount of time per message, displayed in microseconds, spent during compression or decompression (parameter identifier: MQIACH_COMPRESSION_TIME). Two values are returned:

    • A value based on recent activity over a short period.
    • A value based on activity over a longer period.

    Where no measurement is available, the value MQMON_NOT_AVAILABLE is returned.

    ConnectionName (MQCFST)
    Connection name (parameter identifier: MQCACH_CONNECTION_NAME).

    On Multiplatforms, the maximum length of the string is 264.

    On z/OS, the maximum length of the string is 48.

    CurrentLUWID (MQCFST)
    Logical unit of work identifier for in-doubt batch (parameter identifier: MQCACH_CURRENT_LUWID).

    The logical unit of work identifier associated with the current batch, for a sending or a receiving channel.

    For a sending channel, when the channel is in-doubt it is the LUWID of the in-doubt batch.

    It is updated with the LUWID of the next batch when it is known.

    The maximum length is MQ_LUWID_LENGTH.

    CurrentMsgs (MQCFIN)
    Number of messages in-doubt (parameter identifier: MQIACH_CURRENT_MSGS).

    For a sending channel, this parameter is the number of messages that have been sent in the current batch. It is incremented as each message is sent, and when the channel becomes in-doubt it is the number of messages that are in-doubt.

    For a receiving channel, it is the number of messages that have been received in the current batch. It is incremented as each message is received.

    The value is reset to zero, for both sending and receiving channels, when the batch is committed.

    CurrentSequenceNumber (MQCFIN)
    Sequence number of last message in in-doubt batch (parameter identifier: MQIACH_CURRENT_SEQ_NUMBER).

    For a sending channel, this parameter is the message sequence number of the last message sent. It is updated as each message is sent, and when the channel becomes in-doubt it is the message sequence number of the last message in the in-doubt batch.

    For a receiving channel, it is the message sequence number of the last message that was received. It is updated as each message is received.

    CurrentSharingConversations (MQCFIN)
    Number of conversations currently active on this channel instance (parameter identifier: MQIACH_CURRENT_SHARING_CONVS).

    This parameter is returned only for TCP/IP server-connection channels.

    A value of zero indicates that the channel instance is running in a mode before IBM WebSphere MQ Version 7.0, regarding:

    • Administrator stop-quiesce
    • Heartbeating
    • Read ahead
    • Client asynchronous consumption

    ExitTime (MQCFIL)
    Indicator of the time taken executing user exits per message (parameter identifier: MQIACH_EXIT_TIME_INDICATOR). Amount of time, in microseconds, spent processing user exits per message. Where more than one exit is executed per message, the value is the sum of all the user exit times for a single message. Two values are returned:

    • A value based on recent activity over a short period.
    • A value based on activity over a longer period.

    Where no measurement is available, the value MQMON_NOT_AVAILABLE is returned.

    HeaderCompression (MQCFIL)
    Whether the header data sent by the channel is compressed (parameter identifier: MQIACH_HDR_COMPRESSION). Two values are returned:

    • The default header data compression value negotiated for this channel.
    • The header data compression value used for the last message sent. The header data compression value can be altered in a sending channels message exit. If no message has been sent, the second value is MQCOMPRESS_NOT_AVAILABLE.

    The values can be:

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

      MQCOMPRESS_SYSTEM
      Header data compression is performed.

      MQCOMPRESS_NOT_AVAILABLE
      No message has been sent by the channel.

    HeartbeatInterval (MQCFIN)
    Heartbeat interval (parameter identifier: MQIACH_HB_INTERVAL).

    InDoubtStatus (MQCFIN)
    Whether the channel is currently in doubt (parameter identifier: MQIACH_INDOUBT_STATUS).

    A sending channel is only in doubt while the sending Message Channel Agent is waiting for an acknowledgment that a batch of messages, which it has sent, has been successfully received. It is not in doubt at all other times, including the period during which messages are being sent, but before an acknowledgment has been requested.

    A receiving channel is never in doubt.

    The value can be any of the following values:

      MQCHIDS_NOT_INDOUBT
      Channel is not in-doubt.

      MQCHIDS_INDOUBT
      Channel is in-doubt.

    KeepAliveInterval (MQCFIN)
    KeepAlive interval (parameter identifier: MQIACH_KEEP_ALIVE_INTERVAL). This parameter is valid only on z/OS.

    LastLUWID (MQCFST)
    Logical unit of work identifier for last committed batch (parameter identifier: MQCACH_LAST_LUWID).

    The maximum length is MQ_LUWID_LENGTH.

    LastMsgDate (MQCFST)
    Date last message was sent, or MQI call was handled, in the form yyyy-mm-dd (parameter identifier: MQCACH_LAST_MSG_DATE).

    The maximum length of the string is MQ_CHANNEL_DATE_LENGTH.

    LastMsgTime (MQCFST)
    Time last message was sent, or MQI call was handled, in the form hh.mm.ss (parameter identifier: MQCACH_LAST_MSG_TIME).

    The maximum length of the string is MQ_CHANNEL_TIME_LENGTH.

    LastSequenceNumber (MQCFIN)
    Sequence number of last message in last committed batch (parameter identifier: MQIACH_LAST_SEQ_NUMBER).

    LocalAddress (MQCFST)
    Local communications address for the channel (parameter identifier: MQCACH_LOCAL_ADDRESS).

    The maximum length of the string is MQ_LOCAL_ADDRESS_LENGTH.

    LongRetriesLeft (MQCFIN)
    Number of long retry attempts remaining (parameter identifier: MQIACH_LONG_RETRIES_LEFT).

    MaxMsgLength (MQCFIN)
    Maximum message length (parameter identifier: MQIACH_MAX_MSG_LENGTH). This parameter is valid only on z/OS.

    MaxSharingConversations (MQCFIN)
    Maximum number of conversations permitted on this channel instance. (parameter identifier: MQIACH_MAX_SHARING_CONVS)

    This parameter is returned only for TCP/IP server-connection channels.

    A value of zero indicates that the channel instance is running in a mode before IBM WebSphere MQ Version 7.0, regarding:

    • Administrator stop-quiesce
    • Heartbeating
    • Read ahead
    • Client asynchronous consumption

    MCAJobName (MQCFST)
    Name of MCA job (parameter identifier: MQCACH_MCA_JOB_NAME).

    The maximum length of the string is MQ_MCA_JOB_NAME_LENGTH.

    MCAStatus (MQCFIN)
    MCA status (parameter identifier: MQIACH_MCA_STATUS). The value can be any of the following values:

      MQMCAS_STOPPED
      Message channel agent stopped.

      MQMCAS_RUNNING
      Message channel agent running.

    MCAUserIdentifier (MQCFST)
    The user ID used by the MCA (parameter identifier: MQCACH_MCA_USER_ID).

    This parameter applies only to server-connection, receiver, requester, and cluster-receiver channels.

    The maximum length of the string is MQ_MCA_USER_ID_LENGTH.

    MessageCompression (MQCFIL)
    Whether the message data sent by the channel is compressed (parameter identifier: MQIACH_MSG_COMPRESSION). Two values are returned:

    • The default message data compression value negotiated for this channel.
    • The message data compression value used for the last message sent. The message data compression value can be altered in a sending channels message exit. If no message has been sent, the second value is MQCOMPRESS_NOT_AVAILABLE.

    The values can be:

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

      MQCOMPRESS_RLE
      Message data compression is performed using run-length encoding.

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

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

      MQCOMPRESS_NOT_AVAILABLE
      No message has been sent by the channel.

    Msgs (MQCFIN)
    Number of messages sent or received, or number of MQI calls handled (parameter identifier: MQIACH_MSGS).

    MsgsAvailable (MQCFIN)
    Number of messages available (parameter identifier: MQIACH_XMITQ_MSGS_AVAILABLE). Number of messages queued on the transmission queue available to the channel for MQGETs.

    Where no measurement is available, the value MQMON_NOT_AVAILABLE is returned.

    This parameter applies to cluster sender channels only.

    NetTime (MQCFIL)
    Indicator of the time of a network operation (parameter identifier: MQIACH_NETWORK_TIME_INDICATOR). Amount of time, in microseconds, to send a request to the remote end of the channel and receive a response. This time only measures the network time for such an operation. Two values are returned:

    • A value based on recent activity over a short period.
    • A value based on activity over a longer period.

    Where no measurement is available, the value MQMON_NOT_AVAILABLE is returned.

    NonPersistentMsgSpeed (MQCFIN)
    Speed at which nonpersistent messages are to be sent (parameter identifier: MQIACH_NPM_SPEED). The value can be any of the following values:

      MQNPMS_NORMAL
      Normal speed.

      MQNPMS_FAST
      Fast speed.

    QMgrName (MQCFST)
    Name of the queue manager that owns the channel instance (parameter identifier: MQCA_Q_MGR_NAME). This parameter is valid only on z/OS.

    The maximum length of the string is MQ_Q_MGR_NAME_LENGTH.

    RemoteApplTag (MQCFST)
    The remote partner application name. This parameter is the name of the client application at the remote end of the channel. This parameter applies only to server-connection channels (parameter identifier: MQCACH_REMOTE_APPL_TAG).

    RemoteProduct (MQCFST)
    The remote partner product identifier. This parameter is the product identifier of the IBM MQ code running at the remote end of the channel (parameter identifier: MQCACH_REMOTE_PRODUCT). The possible values are shown in the following table:

    Product Identifier Description
    MQMM Queue Manager (non z/OS Platform)
    MQMV Queue Manager on z/OS
    MQCC IBM MQ C client
    MQNM IBM MQ .NET fully managed client
    MQJB IBM MQ Classes for JAVA
    MQJM IBM MQ Classes for JMS (normal mode)
    MQJN IBM MQ Classes for JMS (migration mode)
    MQJU Common Java interface to the MQI
    MQXC XMS client C/C++ (normal mode)
    MQXD XMS client C/C++ (migration mode)
    MQXN XMS client .NET (normal mode)
    MQXM XMS client .NET (migration mode)
    MQXU IBM MQ .NET XMS client (unmanaged/XA)
    MQNU IBM MQ .NET unmanaged client

    RemoteVersion (MQCFST)
    The remote partner version. This parameter is the version of the IBM MQ code running at the remote end of the channel (parameter identifier: MQCACH_REMOTE_VERSION). The remote version is displayed as VVRRMMFF, where

      VV
      Version

      RR
      Release

      MM
      Maintenance level

      FF
      Fix level

    RemoteQMgrName (MQCFST)
    Name of the remote queue manager, or queue sharing group (parameter identifier: MQCA_REMOTE_Q_MGR_NAME).

    ShortRetriesLeft (MQCFIN)
    Number of short retry attempts remaining (parameter identifier: MQIACH_SHORT_RETRIES_LEFT).

    SecurityProtocol (MQCFIN)
    Defines the security protocol currently in use (parameter identifier: MQIACH_SECURITY_PROTOCOL).
    Does not apply to client-connection channels.
    Set automatically, based on the value you set for SSLCipherSpecification.
    Possible values are:

      MQSECPROT_NONE
      No security protocol

      MQSECPROT_SSLV30
      SSL 3.0
      This protocol is deprecated. See Deprecated CipherSpecs

      MQSECPROT_TLSV10
      TLS 1.0

      MQSECPROT_TLSV12
      TLS 1.2

      MQSECPROT_TLSV13
      TLS 1.3
      From Version 9.2.0, IBM MQ supports the TLS 1.3 security protocol on all platforms. On IBM MQ for z/OS, TLS 1.3 is supported only on z/OS Version 2.4 or later.

    SSLCertRemoteIssuerName (MQCFST)
    The full Distinguished Name of the issuer of the remote certificate. The issuer is the certificate authority that issued the certificate (parameter identifier: MQCACH_SSL_CERT_ISSUER_NAME).

    The maximum length of the string is MQ_SHORT_DNAME_LENGTH.

    SSLCertUserId (MQCFST)
    The local user ID associated with the remote certificate (parameter identifier: MQCACH_SSL_CERT_USER_ID).

    This parameter is valid only on z/OS.

    The maximum length of the string is MQ_USER_ID_LENGTH.

    SSLKeyResetDate (MQCFST)
    Date of the previous successful TLS secret key reset, in the form yyyy-mm-dd (parameter identifier: MQCACH_SSL_KEY_RESET_DATE).

    The maximum length of the string is MQ_DATE_LENGTH.

    SSLKeyResets (MQCFIN)
    TLS secret key resets (parameter identifier: MQIACH_SSL_KEY_RESETS).

    The number of successful TLS secret key resets that have occurred for this channel instance since the channel started. If TLS secret key negotiation is enabled, the count is incremented whenever a secret key reset is performed.

    SSLKeyResetTime (MQCFST)
    Time of the previous successful TLS secret key reset, in the form hh.mm.ss (parameter identifier: MQCACH_SSL_KEY_RESET_TIME).

    The maximum length of the string is MQ_TIME_LENGTH.

    SSLShortPeerName (MQCFST)
    Distinguished Name of the peer queue manager or client at the other end of the channel (parameter identifier: MQCACH_SSL_SHORT_PEER_NAME).

    The maximum length is MQ_SHORT_DNAME_LENGTH, so longer Distinguished Names are truncated.

    StopRequested (MQCFIN)
    Whether user stop request is outstanding (parameter identifier: MQIACH_STOP_REQUESTED). The value can be any of the following values:

      MQCHSR_STOP_NOT_REQUESTED
      User stop request has not been received.

      MQCHSR_STOP_REQUESTED
      User stop request has been received.

    SubState (MQCFIN)
    Current action being performed by the channel (parameter identifier: MQIACH_CHANNEL_SUBSTATE). The value can be any of the following values:

      MQCHSSTATE_CHADEXIT
      Running channel auto-definition exit.

      MQCHSSTATE_COMPRESSING
      Compressing or decompressing data.

      MQCHSSTATE_END_OF_BATCH
      End of batch processing.

      MQCHSSTATE_HANDSHAKING
      TLS handshaking.

      MQCHSSTATE_HEARTBEATING
      Heartbeating with partner.

      MQCHSSTATE_IN_MQGET
      Performing MQGET.

      MQCHSSTATE_IN_MQI_CALL
      Executing an IBM MQ API call, other than an MQPUT or MQGET.

      MQCHSSTATE_IN_MQPUT
      Performing MQPUT.

      MQCHSSTATE_MREXIT
      Running retry exit.

      MQCHSSTATE_MSGEXIT
      Running message exit.

      MQCHSSTATE_NAME_SERVER
      Name server request.

      MQCHSSTATE_NET_CONNECTING
      Network connect.

      MQCHSSTATE_OTHER
      Undefined state.

      MQCHSSTATE_RCVEXIT
      Running receive exit.

      MQCHSSTATE_RECEIVING
      Network receive.

      MQCHSSTATE_RESYNCHING
      Resynching with partner.

      MQCHSSTATE_SCYEXIT
      Running security exit.

      MQCHSSTATE_SENDEXIT
      Running send exit.

      MQCHSSTATE_SENDING
      Network send.

      MQCHSSTATE_SERIALIZING
      Serialized on queue manager access.

    XmitQName (MQCFST)
    Transmission queue name (parameter identifier: MQCACH_XMIT_Q_NAME).

    The maximum length of the string is MQ_Q_NAME_LENGTH.

    XQTime (MQCFIL)
    This parameter applies to only sender, server, and cluster-sender channels.
    Transmission queue time indicator (parameter identifier: MQIACH_XMITQ_TIME_INDICATOR). The time, in microseconds, that messages remained on the transmission queue before being retrieved. The time is measured from when the message is put onto the transmission queue until it is retrieved to be sent on the channel and, therefore, includes any interval caused by a delay in the putting application. Two values are returned:

    • A value based on recent activity over a short period.
    • A value based on activity over a longer period.

    Where no measurement is available, the value MQMON_NOT_AVAILABLE is returned.

Parent topic: Definitions of the Programmable Command Formats


Related reference