Inquire Channel Listener on Multiplatforms

The Inquire Channel Listener (MQCMD_INQUIRE_LISTENER) command inquires about the attributes of existing IBM MQ listeners.


Required parameters

    ListenerName (MQCFST)
    Listener name (parameter identifier: MQCACH_LISTENER_NAME).

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

    The listener name is always returned regardless of the attributes requested.

    The maximum length of the string is MQ_LISTENER_NAME_LENGTH.


Optional parameters

    IntegerFilterCommand (MQCFIF)
    Integer filter command descriptor. The parameter identifier must be any integer type parameter allowed in ListenerAttrs 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, we cannot also specify a string filter using the StringFilterCommand parameter.

    ListenerAttrs (MQCFIL)
    Listener attributes (parameter identifier: MQIACF_LISTENER_ATTRS). The attribute list might specify the following value on its own- default value if the parameter is not specified:

      MQIACF_ALL
      All attributes.

    or a combination of the following:

      MQCA_ALTERATION_DATE
      Date on which the definition was last altered.

      MQCA_ALTERATION_TIME
      Time at which the definition was last altered.

      MQCACH_IP_ADDRESS
      IP address for the listener.

      MQCACH_LISTENER_DESC
      Description of listener definition.

      MQCACH_LISTENER_NAME
      Name of listener definition.

      MQCACH_LOCAL_NAME
      NetBIOS local name that the listener uses. MQCACH_LOCAL_NAME is valid only on Windows.

      MQCACH_TP_NAME
      The LU 6.2 transaction program name. MQCACH_TP_NAME is valid only on Windows.

      MQIACH_ADAPTER
      Adapter number on which NetBIOS listens. MQIACH_ADAPTER is valid only on Windows.

      MQIACH_BACKLOG
      Number of concurrent connection requests that the listener supports.

      MQIACH_COMMAND_COUNT
      Number of commands that the listener can use. MQIACH_COMMAND_COUNT is valid only on Windows.

      MQIACH_LISTENER_CONTROL
      Specifies when the queue manager starts and stops the listener.

      MQIACH_NAME_COUNT
      Number of names that the listener can use. MQIACH_NAME_COUNT is valid only on Windows.

      MQIACH_PORT
      Port number.

      MQIACH_SESSION_COUNT
      Number of sessions that the listener can use. MQIACH_SESSION_COUNT is valid only on Windows.

      MQIACH_SOCKET
      SPX socket on which to listen. MQIACH_SOCKET is valid only on Windows.

    StringFilterCommand (MQCFSF)
    String filter command descriptor. The parameter identifier must be any string type parameter allowed in ListenerAttrs except MQCACH_LISTENER_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.

    TransportType (MQCFIN)
    Transport protocol type (parameter identifier: MQIACH_XMIT_PROTOCOL_TYPE).

    If you specify this parameter, information is returned relating only to those listeners defined with the specified transport protocol type. If you specify an attribute in the ListenerAttrs list which is valid only for listeners of a different transport protocol type, it is ignored and no error is raised. If you specify this parameter, it must occur immediately after the ListenerName parameter.

    If we do not specify this parameter, or if we specify it with a value of MQXPT_ALL, information about all listeners is returned. Valid attributes in the ListenerAttrs list which are not applicable to the listener are ignored, and no error messages are issued. The value can be any of the following values:

      MQXPT_ALL
      All transport types.

      MQXPT_LU62
      SNA LU 6.2. MQXPT_LU62 is valid only on Windows.

      MQXPT_NETBIOS
      NetBIOS. MQXPT_NETBIOS is valid only on Windows.

      MQXPT_SPX
      SPX. MQXPT_SPX is valid only on Windows.

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

Parent topic: Definitions of the Programmable Command Formats