ltm rule command MQTT protocol nameΒΆ

iRule(1)					  BIG-IP TMSH Manual					     iRule(1)

MQTT::protocol_name
       Get or set protocol-name of MQTT CONNECT message

SYNOPSIS
       MQTT::protocol_name (PROTOCOL)?

DESCRIPTION
       This command can be used to get or set protocol name of MQTT message.  This command is valid only for
       following MQTT message types:

	   CONNECT

       Syntax

       MQTT::protocol_name [  ]

       MQTT::protocol_name
	   * Get the protocol name of MQTT CONNECT message.

       MQTT::protocol_name 
	   * Set the protocol name of MQTT CONNECT message.
	     To set to MQTT 3.1.1 use 'MQTT'.
	     To set to MQTT 3.1 use 'MQIsdp', capitalized as shown.

RETURN VALUE
       When called without an argument, this command returns the protocol name of MQTT CONNECT message

VALID DURING
       MQTT_CLIENT_INGRESS MQTT_SERVER_INGRESS MQTT_CLIENT_DATA MQTT_SERVER_DATA MQTT_CLIENT_EGRESS
       MQTT_SERVER_EGRESS

EXAMPLES
	# Upgrade protocol from 3.1 to 3.1.1
	when MQTT_CLIENT_INGRESS {
	   set type [MQTT::type]
	   switch $type {
	       "CONNECT" {
		  if {[MQTT::protocol_version] == 3 } {
		     MQTT::protocol_version 4
		     MQTT::protocol_name "MQTT"
		  }
	       }
	   }
	}

HINTS
SEE ALSO
CHANGE LOG
       @BIGIP-13.0.0 --First introduced the command.

BIG-IP						      2020-06-23					     iRule(1)