Inquire Channel

The Inquire Channel (MQCMD_INQUIRE_CHANNEL) command inquires about the attributes of IBM MQ channel definitions.


Required parameters

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

    Generic channel names are supported. A generic name is a character string followed by an asterisk (*), for example ABC*, and it selects all channels having names that start with the selected character string. An asterisk on its own matches all possible names.

    The maximum length of the string is MQ_CHANNEL_NAME_LENGTH.


Optional parameters

    ChannelAttrs (MQCFIL)
    Channel attributes (parameter identifier: MQIACF_CHANNEL_ATTRS). The attribute list can specify the following value on its own. This is also the default value used if the parameter is not specified:

      MQIACF_ALL
      All attributes.

    Alternatively, the attribute list can specify a combination of the parameters in the following table:

    Parameter Sender Server Receiver Requester Client conn Server conn Cluster sender Cluster receiver AMQP
    MQCA_ALTERATION_DATE

    Date on which the definition was last altered

    MQCA_ALTERATION_TIME

    Time at which the definition was last altered

    MQCA_CERT_LABEL

    Certificate label

    MQCA_CLUSTER_NAME

    Name of local queue manager

    		             
    MQCA_CLUSTER_NAMELIST

    Name of local queue manager

    		             
    MQCA_Q_MGR_NAME

    Name of local queue manager

    		               
    MQCACH_CHANNEL_NAME

    Channel name. We cannot use this attribute as a filter keyword.

    MQCACH_CONNECTION_NAME

    Connection name

    		     
    MQCACH_DESC

    Description

    MQCACH_LOCAL_ADDRESS

    Local communications address for the channel

    		   
    MQCACH_MCA_NAME

    Message channel agent name

    		         
    MQCACH_MCA_USER_ID

    MCA user identifier

    		 
    MQCACH_MODE_NAME

    Mode name

    		     
    MQCACH_MR_EXIT_NAME

    Message-retry exit name

    		           
    MQCACH_MR_EXIT_USER_DATA

    Message-retry exit name

    		           
    MQCACH_MSG_EXIT_NAME

    Message exit name

    		     
    MQCACH_MSG_EXIT_USER_DATA

    Message exit user data

    		     
    MQCACH_PASSWORD

    Password

    		       
    MQCACH_RCV_EXIT_NAME

    Receive exit name

    		 
    MQCACH_RCV_EXIT_USER_DATA

    Receive exit user data

    		 
    MQCACH_SEC_EXIT_NAME

    Security exit name

    		 
    MQCACH_SEC_EXIT_USER_DATA

    Security exit user data

    		 
    MQCACH_SEND_EXIT_NAME

    Send exit name

    		 
    MQCACH_SEND_EXIT_USER_DATA

    Send exit user data

    		 
    MQCACH_SSL_CIPHER_SPEC

    TLS cipher spec

    MQCACH_SSL_PEER_NAME

    TLS peer name

    MQCACH_TP_NAME

    Transaction program name

    		   
    MQCACH_TP_ROOT

    Topic root for AMQP channel

    		                
    MQCACH_USER_ID

    User identifier

    		       
    MQCACH_XMIT_Q_NAME

    Transmission queue name

    		             
    MQIA_MONITORING_CHANNEL

    Online monitoring data collection

    		   
    MQIA_PROPERTY_CONTROL

    Property control attribute

    		         
    MQIA_STATISTICS_CHANNEL

    Online statistics collection

    		     
    MQIA_USE_DEAD_LETTER_Q

    Determines whether the dead-letter queue is used when messages cannot be delivered by channels.

    		      
    MQIACH_AMQP_KEEP_ALIVE

    AMQP channel keep alive interval

    		                
    MQIACH_BATCH_HB

    Value to use for batch heartbeating

    		         
    MQIACH_BATCH_INTERVAL

    Batch wait interval (seconds)

    		         
    MQIACH_BATCH_DATA_LIMIT

    Batch data limit (kilobytes)

    		         
    MQIACH_BATCH_SIZE

    Batch size

    		     
    MQIACH_CHANNEL_TYPE

    Channel type

    MQIACH_CLIENT_CHANNEL_WEIGHT

    Client Channel Weight

    		               
    MQIACH_CLWL_CHANNEL_ PRIORITY

    Cluster workload channel priority

    		             
    MQIACH_CLWL_CHANNEL_RANK

    Cluster workload channel rank

    		             
    MQIACH_CLWL_CHANNEL_WEIGHT

    Cluster workload channel weight

    		             
    MQIACH_CONNECTION_AFFINITY

    Connection Affinity

    		               
    MQIACH_DATA_CONVERSION

    Whether sender must convert application data

    		         
    MQIACH_DEF_RECONNECT

    Default reconnection option

    		               
    MQIACH_DISC_INTERVAL

    Disconnection interval

    		       
    MQIACH_HB_INTERVAL

    Heartbeat interval (seconds)

    		 
    MQIACH_HDR_COMPRESSION

    List of header data compression techniques supported by the channel

    		 
    MQIACH_KEEP_ALIVE_INTERVAL

    KeepAlive interval

    		 
    MQIACH_LONG_RETRY

    Long retry count

    		         
    MQIACH_LONG_TIMER

    Long timer

    		         
    MQIACH_MAX_INSTANCES

    Maximum number of simultaneous instances of a server-connection channel that can be started.

    		             
    MQIACH_MAX_INSTS_PER_ CLIENT

    Maximum number of simultaneous instances of a server-connection channel that can be started from a single client.

    		               
    MQIACH_MAX_MSG_LENGTH

    Maximum message length

    MQIACH_MCA_TYPE

    MCA type

    		       
    MQIACH_MR_COUNT

    Message retry count

    		           
    MQIACH_MSG_COMPRESSION

    List of message data compression techniques supported by the channel

    		 
    MQIACH_MR_INTERVAL

    Message retry interval (milliseconds)

    		           
    MQIACH_NPM_SPEED

    Speed of nonpersistent messages

    		     
    MQIACH_PORT

    AMQP port number

    		                
    MQIACH_PUT_AUTHORITY

    Put authority

    		         
    MQIACH_RESET_REQUESTED

    Sequence number of outstanding request when a RESET CHANNEL command is used

    		     
    MQIACH_SEQUENCE_NUMBER_ WRAP

    Sequence number wrap

    		     
    MQIACH_SHARING_CONVERSATIONS

    Value of Sharing Conversations

    		               
    MQIACH_SHORT_RETRY

    Short retry count

    		         
    MQIACH_SHORT_TIMER

    Short timer

    		         
    MQIACH_SPL_PROTECTION

    Security policy protection

    		         
    MQIACH_SSL_CLIENT_AUTH

    TLS client authentication

    		   
    MQIACH_USE_CLIENT_ID

    Specify that the client ID is used for authorization checks for an AMQP channel

    		               
    MQIACH_XMIT_PROTOCOL_TYPE

    Transport (transmission protocol) type

    		 
    Note:
    1. Only one of the following parameters can be specified:

      • MQCACH_JAAS_CONFIG
      • MQCACH_MCA_USER_ID
      • MQIACH_USE_CLIENT_ID

    If none of these parameters is specified, no authentication is performed. If MQCACH_JAAS_CONFIG is specified, the client flows a user name and password, in all other cases the flowed user name is ignored.

    ChannelType (MQCFIN)
    Channel type (parameter identifier: MQIACH_CHANNEL_TYPE).

    If this parameter is present, eligible channels are limited to the specified type. Any attribute selector specified in the ChannelAttrs list which is only valid for channels of a different type or types is ignored; no error is raised.

    If this parameter is not present (or if MQCHT_ALL is specified), channels of all types other than MQCHT_MQTT are eligible. Each attribute specified must be a valid channel attribute selector (that is, it must be one from the following list), but it might not be applicable to all (or any) of the channels returned. Channel attribute selectors that are valid but not applicable to the channel are ignored, no error messages occur, and no attribute is returned.

    The value can be:

      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.

      MQCHT_AMQP
      AMQP channel.

      MQCHT_MQTT
      Telemetry channel.

      MQCHT_ALL
      All types other than MQCHT_MQTT.

    The default value if this parameter is not specified is MQCHT_ALL.

    Note: If this parameter is present, it must occur immediately after the ChannelName parameter on platforms other than z/OS otherwise resulting in a MQRCCF_MSG_LENGTH_ERROR error message.

    CommandScope (MQCFST)
    Command scope (parameter identifier: MQCACF_COMMAND_SCOPE). This parameter applies to z/OS only. Specifies how the command is executed when the queue manager is a member of a queue sharing group. We can specify one of the following:

    • blank (or omit the parameter altogether). The command is executed on the queue manager on which it was entered.
    • a queue manager name. The command is executed on the queue manager you specify, providing it is active within the queue sharing group. If you specify a queue manager name other than the queue manager on which it was entered, we must be using a queue sharing group environment, and the command server must be enabled.
    • an asterisk (*). The command is executed on the local queue manager and is also passed to every active queue manager in the queue sharing group.

    The maximum length is MQ_QSG_NAME_LENGTH.

    We cannot use CommandScope as a parameter to filter on.

    IntegerFilterCommand (MQCFIF)
    Integer filter command descriptor. The parameter identifier must be any integer type parameter allowed in ChannelAttrs except MQIACF_ALL. Use this parameter to restrict the output from the command by specifying a filter condition. See MQCFIF - PCF integer filter parameter for information about using this filter condition.

    If you specify an integer filter for channel type, we cannot also specify the ChannelType parameter.

    If you specify an integer filter, we cannot also specify a string filter using the StringFilterCommand parameter.

    QSGDisposition (MQCFIN)
    Disposition of the object within the group (parameter identifier: MQIA_QSG_DISP). This parameter applies to z/OS only. Specifies the disposition of the object for which information is to be returned (that is, where it is defined and how it behaves). The value can be any of the following values:

      MQQSGD_LIVE
      The object is defined as MQQSGD_Q_MGR or MQQSGD_COPY. MQQSGD_LIVE is the default value if the parameter is not specified.

      MQQSGD_ALL
      The object is defined as MQQSGD_Q_MGR or MQQSGD_COPY.

      If there is a shared queue manager environment, and the command is being executed on the queue manager where it was issued, this option also displays information for objects defined with MQQSGD_GROUP.

      If MQQSGD_LIVE is specified or defaulted, or if MQQSGD_ALL is specified in a shared queue manager environment, the command might give duplicated names (with different dispositions).

      MQQSGD_COPY
      The object is defined as MQQSGD_COPY.

      MQQSGD_GROUP
      The object is defined as MQQSGD_GROUP. MQQSGD_GROUP is permitted only in a shared queue environment.

      MQQSGD_Q_MGR
      The object is defined as MQQSGD_Q_MGR.

      MQQSGD_PRIVATE
      The object is defined as either MQQSGD_Q_MGR or MQQSGD_COPY. MQQSGD_PRIVATE returns the same information as MQQSGD_LIVE.

    We cannot use QSGDisposition as a parameter to filter on.

    StringFilterCommand (MQCFSF)
    String filter command descriptor. The parameter identifier must be any string type parameter allowed in ChannelAttrs except MQCACH_CHANNEL_NAME and MQCACH_MCA_NAME. Use this parameter to restrict the output from the command by specifying a filter condition. See MQCFSF - PCF string filter parameter for information about using this filter condition.

    If you specify a string filter, we cannot also specify an integer filter using the IntegerFilterCommand parameter.


Error codes

This command might return the following error codes in the response format header, in addition to the values shown in Error codes applicable to all commands.

    Reason (MQLONG)
    The value can be any of the following values:

      MQRCCF_CHANNEL_NAME_ERROR
      Channel name error.

      MQRCCF_CHANNEL_NOT_FOUND
      Channel not found.

      MQRCCF_CHANNEL_TYPE_ERROR
      Channel type not valid.

Parent topic: Definitions of the Programmable Command Formats