Stop Channel Listener

The Stop Channel Listener (MQCMD_STOP_CHANNEL_LISTENER) command stops an IBM MQ listener.


Required parameters

    ListenerName (MQCFST)
    Listener name (parameter identifier: MQCACH_LISTENER_NAME). This parameter does not apply to z/OS®.

    The name of the listener definition to be stopped. If this parameter is specified, no other parameters can be specified.

    The maximum length of the string is MQ_LISTENER_NAME_LENGTH.

Optional parameters

    CommandScope (MQCFST)
    Command scope (parameter identifier: MQCACF_COMMAND_SCOPE). Specifies how the command is processed 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 processed on the queue manager on which it was entered.
    • a queue manager name. The command is processed 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, you must be using a queue sharing group environment, and the command server must be enabled.

    This parameter is valid only on z/OS.

    The maximum length is MQ_QSG_NAME_LENGTH.

    InboundDisposition (MQCFIN)
    Inbound transmission disposition (parameter identifier: MQIACH_INBOUND_DISP). Specifies the disposition of the inbound transmissions that the listener handles. The value can be any of the following values:

      MQINBD_Q_MGR
      Handling for transmissions directed to the queue manager. MQINBD_Q_MGR is the default.

      MQINBD_GROUP
      Handling for transmissions directed to the queue sharing group. MQINBD_GROUP is permitted only if there is a shared queue manager environment.

    This parameter is valid only on z/OS.

    IPAddress (MQCFST)
    IP address (parameter identifier: MQCACH_IP_ADDRESS).

    The IP address for TCP/IP specified in dotted decimal or alphanumeric form. This parameter is valid on z/OS only where channels have a TransportType of MQXPT_TCP.

    The maximum length of the string is MQ_IP_ADDRESS_LENGTH.

    Port (MQCFIN)
    Port number for TCP (parameter identifier: MQIACH_PORT_NUMBER).

    The port number for TCP. This parameter is valid only on z/OS where channels have a TransportType of MQXPT_TCP.

    TransportType (MQCFIN)
    Transmission protocol type (parameter identifier: MQIACH_XMIT_PROTOCOL_TYPE). The value can be:

      MQXPT_LU62
      LU 6.2.

      MQXPT_TCP
      TCP.

    This parameter is valid only on z/OS.


Error codes

This command might return the following error code 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_LISTENER_STOPPED
      Listener not running.