.. _slb_mqtt:

slb mqtt
========

Show MQTT Statistics


mqtt Specification
------------------

	===================================== =================================================
	 **Parameter**                         **Value** 

	===================================== =================================================
	 **Type**                              *Configuration Resource*

	 **Element Name**                      mqtt

	 **Element URI**                       /axapi/v3/slb/mqtt

	 **Element Attributes**                mqtt_attributes

	 **Partition Visibility**              shared

	 **Statistics Data URI**               /axapi/v3/slb/mqtt/stats

	 **Operational Data URI**              /axapi/v3/slb/mqtt/oper

	 **Schema**                             :download:`mqtt schema <slb-mqtt/slb-mqtt.txt>`
	===================================== =================================================





	**Operations Allowed:**




.. raw:: html

   <script type="text/javascript">
 function showExample(a,b) { document.getElementById(a+'_div').style.display = 'block'; document.getElementById(a+'_cl').style.display = 'block'; document.getElementById(a+'_eg').style.display = 'none';}
   function closeExample(a,b) { document.getElementById(a+'_div').style.display = 'none'; document.getElementById(a+'_cl').style.display = 'none'; document.getElementById(a+'_eg').style.display = 'block';}
 </script>
   <table width='90%' style='margin-left:5%'>



.. raw:: html

   <tr style='border-bottom: thin solid; border-top: thin solid'><th width=15%>Operation</th><th width=10%>Method</th><th>URI</th><th width=15%>Payload</th><th width=10%></th></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Create Object



.. raw:: html

   </td><td valign = 'top'>


POST



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/slb/mqtt



.. raw:: html

   </td><td valign = 'top'>


:ref:`2828_mqtt_attributes`



.. raw:: html

   </td><td><button id='post_eg' onClick="showExample('post')">example</button> <button id='post_cl' onClick="closeExample('post')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='post_div' style='display:none'>


.. include:: ../artifacts/slb_mqtt_POST.txt
   :literal:




.. raw:: html

   </div></td></tr>


.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Get Object



.. raw:: html

   </td><td valign = 'top'>


GET



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/slb/mqtt



.. raw:: html

   </td><td valign = 'top'>


:ref:`2828_mqtt_attributes`



.. raw:: html

   </td><td><button id='get_eg' onClick="showExample('get')">example</button> <button id='get_cl' onClick="closeExample('get')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='get_div' style='display:none'>


.. include:: ../artifacts/slb_mqtt_GET.txt
   :literal:




.. raw:: html

   </div></td></tr>


.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Modify Object



.. raw:: html

   </td><td valign = 'top'>


POST



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/slb/mqtt



.. raw:: html

   </td><td valign = 'top'>


:ref:`2828_mqtt_attributes`



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Replace Object



.. raw:: html

   </td><td valign = 'top'>


PUT



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/slb/mqtt



.. raw:: html

   </td><td valign = 'top'>


:ref:`2828_mqtt_attributes`



.. raw:: html

   </td><td><button id='put_eg' onClick="showExample('put')">example</button> <button id='put_cl' onClick="closeExample('put')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='put_div' style='display:none'>


.. include:: ../artifacts/slb_mqtt_PUT.txt
   :literal:




.. raw:: html

   </div></td></tr>


.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Delete Object



.. raw:: html

   </td><td valign = 'top'>


DELETE



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/slb/mqtt



.. raw:: html

   </td><td valign = 'top'>


:ref:`2828_mqtt_attributes`



.. raw:: html

   </td><td><button id='delete_eg' onClick="showExample('delete')">example</button> <button id='delete_cl' onClick="closeExample('delete')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='delete_div' style='display:none'>


.. include:: ../artifacts/slb_mqtt_DELETE.txt
   :literal:




.. raw:: html

   </div></td></tr>


.. raw:: html

   </table>

.. _2828_mqtt_attributes:

mqtt attributes
---------------

    **sampling-enable**

        **Type:** List

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2828_sampling-enable:

sampling-enable
^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

	=============================== ===================================================

    **counters1**

        **Description** 'all': all; 'recv_mqtt_connect': MQTT Connect; 'recv_mqtt_connack': MQTT Connack; 'recv_mqtt_publish': MQTT Publish; 'recv_mqtt_puback': MQTT Puback; 'recv_mqtt_pubrec': MQTT Pubrec; 'recv_mqtt_pubrel': MQTT Pubrel; 'recv_mqtt_pubcomp': MQTT Pubcomp; 'recv_mqtt_subscribe': MQTT Subscribe; 'recv_mqtt_suback': MQTT Suback; 'recv_mqtt_unsubscribe': MQTT Unsubscribe; 'recv_mqtt_unsuback': MQTT Unsuback; 'recv_mqtt_pingreq': MQTT Pingreq; 'recv_mqtt_pingresp': MQTT Pingresp; 'recv_mqtt_disconnect': MQTT Disconnect; 'recv_mqtt_auth': MQTT Auth; 'recv_mqtt_other': MQTT Unknown; 'curr_proxy': Current proxy conns; 'total_proxy': Total proxy conns; 'request': Total MQTT Commands; 'parse_connect_fail': Parse connect failure; 'parse_publish_fail': Parse publish failure; 'parse_subscribe_fail': Parse subscribe failure; 'parse_unsubscribe_fail': Parse unsubscribe failure; 'tuple_not_linked': tuple-not-linked failure; 'tuple_already_linked': tuple-already-linked failure; 'conn_null': Null conn; 'client_id_null': Null client id; 'session_exist': Session already exist; 'insertion_failed': Insertion failure; 'insertion_successful': Insertion successful; 

        **Type:** string

        **Supported Values:** all, recv_mqtt_connect, recv_mqtt_connack, recv_mqtt_publish, recv_mqtt_puback, recv_mqtt_pubrec, recv_mqtt_pubrel, recv_mqtt_pubcomp, recv_mqtt_subscribe, recv_mqtt_suback, recv_mqtt_unsubscribe, recv_mqtt_unsuback, recv_mqtt_pingreq, recv_mqtt_pingresp, recv_mqtt_disconnect, recv_mqtt_auth, recv_mqtt_other, curr_proxy, total_proxy, request, parse_connect_fail, parse_publish_fail, parse_subscribe_fail, parse_unsubscribe_fail, tuple_not_linked, tuple_already_linked, conn_null, client_id_null, session_exist, insertion_failed, insertion_successful