.. _interface_tunnel_stats:

interface tunnel stats
======================

Statistics for the object tunnel


tunnel Specification
--------------------

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

	===================================== =======================================================================
	 **Type**                              *Collection*

	 **Collection Name**                   :ref:`2021_tunnel_list`

	 **Collection URI**                    /axapi/v3/interface/tunnel/{ifnum}

	                                       

	 **Element Name**                      tunnel

	 **Element URI**                       /axapi/v3/interface/tunnel/{ifnum}/stats

	 **Element Attributes**                tunnel_attributes

	 **Partition Visibility**              None

	 **Schema**                             :download:`tunnel schema <interface-tunnel-stats/interface-tunnel-stats.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/interface/tunnel/{ifnum}



.. raw:: html

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


:ref:`2021_tunnel_attributes`



.. raw:: html

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




.. raw:: html

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


Create List



.. raw:: html

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


POST



.. raw:: html

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


/axapi/v3/interface/tunnel/{ifnum}



.. raw:: html

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


:ref:`2021_tunnel_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/interface/tunnel/{ifnum}/stats



.. raw:: html

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


:ref:`2021_tunnel_attributes`



.. raw:: html

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




.. raw:: html

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


Get List



.. raw:: html

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


GET



.. raw:: html

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


/axapi/v3/interface/tunnel/{ifnum}



.. raw:: html

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


:ref:`2021_tunnel_list`



.. 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/interface/tunnel/{ifnum}/stats



.. raw:: html

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


:ref:`2021_tunnel_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/interface/tunnel/{ifnum}/stats



.. raw:: html

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


:ref:`2021_tunnel_attributes`



.. raw:: html

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




.. raw:: html

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


Replace List



.. raw:: html

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


PUT



.. raw:: html

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


/axapi/v3/interface/tunnel/{ifnum}



.. raw:: html

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


:ref:`2021_tunnel_list`



.. 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/interface/tunnel/{ifnum}/stats



.. raw:: html

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


:ref:`2021_tunnel_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _2021_tunnel_list:

tunnel-list
-----------


    tunnel-list is **JSON List** of :ref:`2021_tunnel_attributes` 

        tunnel-list : [

             { :ref:`2021_tunnel_attributes` },

             { :ref:`2021_tunnel_attributes` },

             ...

         ]

.. _2021_tunnel_attributes:

tunnel attributes
-----------------

    **ifnum**

        **Description** Tunnel interface number

        **Type:** number

        **Range:** 1-128

    **stats**

        **Description:** stats is a **JSON Block**.  Please see below for :ref:`2021_stats` 

        **Type:** Object

.. _2021_stats:

stats
^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **num-rx-err-pkts**

        **Description** received error packets

        **Type:** number

        **Format:** counter

    **num-rx-pkts**

        **Description** received packets

        **Type:** number

        **Format:** counter

    **num-total-rx-bytes**

        **Description** received bytes

        **Type:** number

        **Format:** counter

    **num-total-tx-bytes**

        **Description** sent bytes

        **Type:** number

        **Format:** counter

    **num-tx-err-pkts**

        **Description** sent error packets

        **Type:** number

        **Format:** counter

    **num-tx-pkts**

        **Description** sent packets

        **Type:** number

        **Format:** counter

    **rate_byte_rcvd**

        **Description** Byte received rate bits/sec

        **Type:** number

        **Format:** counter

    **rate_byte_sent**

        **Description** Byte sent rate bits/sec

        **Type:** number

        **Format:** counter

    **rate_pkt_rcvd**

        **Description** Packet received rate packets/sec

        **Type:** number

        **Format:** counter

    **rate_pkt_sent**

        **Description** Packet sent rate packets/sec

        **Type:** number

        **Format:** counter