.. _slb_mqtt:

slb mqtt
========

Show MQTT Statistics


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

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

	 **Element Name**                      mqtt

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

	 **Element Attributes**                mqtt_attributes

	 **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:`1693_mqtt_attributes`



.. raw:: html

   </td><td></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:`1693_mqtt_attributes`



.. raw:: html

   </td><td></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:`1693_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:`1693_mqtt_attributes`



.. raw:: html

   </td><td></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:`1693_mqtt_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _1693_mqtt_attributes:

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

    **sampling-enable**

        **Type:** List

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1693_sampling-enable:

sampling-enable
^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **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

.. _1693_stats_data:

stats data
----------
.. list-table::
   :widths: 10 20 30 80
   :header-rows: 2
   :stub-columns: 1

   *  - 
      - Counter
      - Size
      - Description

   *  - 
      - 
      - 
      - 

   *  - 
      - recv_mqtt_unsuback
      - 8
      - MQTT Unsuback

   *  - 
      - total_proxy
      - 8
      - Total proxy conns

   *  - 
      - recv_mqtt_pubcomp
      - 8
      - MQTT Pubcomp

   *  - 
      - client_id_null
      - 8
      - Null client id

   *  - 
      - recv_mqtt_unsubscribe
      - 8
      - MQTT Unsubscribe

   *  - 
      - recv_mqtt_pubrec
      - 8
      - MQTT Pubrec

   *  - 
      - parse_publish_fail
      - 8
      - Parse publish failure

   *  - 
      - parse_unsubscribe_fail
      - 8
      - Parse unsubscribe failure

   *  - 
      - recv_mqtt_pingreq
      - 8
      - MQTT Pingreq

   *  - 
      - insertion_successful
      - 8
      - Insertion successful

   *  - 
      - recv_mqtt_pubrel
      - 8
      - MQTT Pubrel

   *  - 
      - recv_mqtt_connack
      - 8
      - MQTT Connack

   *  - 
      - session_exist
      - 8
      - Session already exist

   *  - 
      - conn_null
      - 8
      - Null conn

   *  - 
      - recv_mqtt_pingresp
      - 8
      - MQTT Pingresp

   *  - 
      - curr_proxy
      - 8
      - Current proxy conns

   *  - 
      - recv_mqtt_other
      - 8
      - MQTT Unknown

   *  - 
      - recv_mqtt_subscribe
      - 8
      - MQTT Subscribe

   *  - 
      - tuple_already_linked
      - 8
      - tuple-already-linked failure

   *  - 
      - parse_subscribe_fail
      - 8
      - Parse subscribe failure

   *  - 
      - insertion_failed
      - 8
      - Insertion failure

   *  - 
      - recv_mqtt_publish
      - 8
      - MQTT Publish

   *  - 
      - recv_mqtt_disconnect
      - 8
      - MQTT Disconnect

   *  - 
      - recv_mqtt_connect
      - 8
      - MQTT Connect

   *  - 
      - tuple_not_linked
      - 8
      - tuple-not-linked failure

   *  - 
      - recv_mqtt_suback
      - 8
      - MQTT Suback

   *  - 
      - recv_mqtt_puback
      - 8
      - MQTT Puback

   *  - 
      - request
      - 8
      - Total MQTT Commands

   *  - 
      - recv_mqtt_auth
      - 8
      - MQTT Auth

   *  - 
      - parse_connect_fail
      - 8
      - Parse connect failure

.. _1693_oper_data:

operational data
----------------
.. list-table::
   :widths: 10 20 30 80
   :header-rows: 2
   :stub-columns: 1

   *  - 
      - Counter
      - Size
      - Description

   *  - 
      - 
      - 
      - 

   *  - 
      - mqtt-cpu-list
      - 
      - mqtt-cpu-list

   *  - 
      - cpu-count
      - number
      - cpu-count