PURGE CHANNEL

Use the MQSC command PURGE CHANNEL to stop and purge a telemetry or AMQP channel. Purging a telemetry or AMQP channel disconnects all the MQTT or AMQP clients connected to it, cleans up the state of the MQTT or AMQP clients, and stops the telemetry or AMQP channel. Cleaning the state of a client deletes all the pending publications, including any last will and testament message required by the client, and removes all the subscriptions from the client.


Use MQSC commands

For information on how we use MQSC commands, see Performing local administration tasks using MQSC commands.

Synonym: None

PURGE CHANNEL

PURGE CHANNEL ( channel-name ) CHLTYPE ( MQTTAMQP ) CLIENTID(clientid)


Parameter descriptions for PURGE CHANNEL

    (channel name)
    The name of the telemetry or AMQP channel to be stopped and purged. This parameter is required.

    CHLTYPE (MQTT)
    Channel type. This parameter is required. It must follow immediately after the (channel-name) parameter on all platforms except z/OS®,
    On Multiplatforms, the value must be either MQTT or AMQP
    On z/OS, the value must be MQTT

    CLIENTID (string)
    Client identifier. The client identifier is a 23 byte string that identifies an MQ Telemetry Transport or AMQP client. When the PURGE CHANNEL command specifies a CLIENTID, only the connection for the specified client identifier is purged. If the CLIENTID is not specified, all the connections on the channel are purged.