MQTT support for responder
The Responder feature supports the MQTT protocol. You can configure responder policies to take an action based on the parameters in the incoming MQTT message.
The action responds with any of the following to a new connection:
-
DROP
-
RESET
-
NOOP
-
A responder action to initiate a new MQTT CONNACK response.
Related information
Configuring responder policies for MQTT
After enabling the responder feature, you must configure one or more actions for handling MQTT requests. Then, configure a responder policy. You can bind the responder policies globally, or to a specific load balancing virtual server or content switching virtual server.
The following bind points are available to bind the responder policies globally:
-
MQTT_REQ_DEFAULT
-
MQTT_REQ_OVERRIDE
-
MQTT_JUMBO_REQ_DEFAULT
-
MQTT_JUMBO_REQ_OVERRIDE
The following bind points are available to bind the responder policies to a content switching or load balancing virtual server:
-
REQUEST
-
MQTT_JUMBO_REQ (this bind point is used only for Jumbo packets)
To configure the responder to respond to an MQTT request by using CLI
At the command prompt, type the following commands:
Configure a responder action.
add responder action <actName> <actType>
-
For
actname, substitute a name for your new action. The name can be 1–127 characters in length, and can contain letters, numbers, hyphen (-), and underscore (_) symbols. -
For
actType, substitute a responder action type, respondwith.
Example:
add responder action mqtt_connack_unsup_ver respondwith MQTT.NEW_CONNACK(132)
Configure a responder policy. The NetScaler appliance responds to the MQTT requests that are selected by this responder policy.
add responder policy <polName> <rule> <actname>
-
For
polname, substitute a name for your new policy. -
For
actname, substitute the name of the action that you created.
Example:
add responder policy reject_lower_version "MQTT.HEADER.COMMAND.EQ(CONNECT) && MQTT.VERSION.LT(3)" mqtt_connack_unsup_ver
Bind the responder policy to a specific load balancing virtual server or content switching virtual server. The policy applies only to the MQTT requests whose destination IP address is the VIP of that virtual server.
bind lb vserver <name> -policyName <policy_name> -priority <priority>
bind cs vserver <name> -policyName <policy_name> -priority <priority>
-
For
policy_name, substitute the name of the policy that you have created. -
For
priority, specify the priority of the policy.
Example:
bind lb vserver lb1 -policyName reject_lower_version -priority 50
bind cs vserver mqtt_frontend_cs -policyName reject_lower_version -priority 5
Use case1: Filter clients based on the user name or client ID
The administrator can configure an MQTT responder policy to reject the connection based on the user name or client ID in the MQTT CONNECT message.
Sample configuration for filtering clients based on the client ID
add policy patset filter_clients
bind policy patset filter_clients client1
add responder action mqtt_connack_invalid_client respondwith MQTT.NEW_CONNACK(2)
add responder policy reject_clients "MQTT.HEADER.COMMAND.EQ(CONNECT) && mqtt.connect.clientid.equals_any(\"filter_clients\")" mqtt_connack_invalid_client
bind cs vserver mqtt_frontend_cs -policyName reject_clients -priority 5
Use case2: Limit the maximum message length of MQTT messages to handle jumbo packets
The administrator can configure an MQTT responder policy to drop the client connection if the length of the message exceeds a certain threshold, or take necessary action based on the requirement.
To handle jumbo packets, the responder policies with any of the following rule patterns are bound to the jumbo bind point:
-
MQTT.MESSAGE_LENGTH
-
MQTT.COMMAND
-
MQTT.FROM_CLIENT
-
MQTT.FROM_SERVER
Policies bound to jumbo bind points are evaluated only for jumbo packets.
Sample configuration for limiting the maximum message length of MQTT messages
set lb parameter -dropmqttjumbomessage no
add responder policy drop_large_message MQTT.MESSAGE_LENGTH.GT(100000) reset
bind cs vserver mqtt_frontend_cs -policyName drop_large_message -priority 10
In this example, the
dropmqttjumbomessage parameter is set to NO. Therefore, the ADC appliance processes the messages with length greater than 64,000 bytes and less than 1,00,000 bytes. The messages with length greater than 1,00,000 bytes are reset.