.. _ddos_tunnel:

ddos tunnel
===========

tunnel counters


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

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

	 **Element Name**                      tunnel

	 **Element URI**                       /axapi/v3/ddos/tunnel

	 **Element Attributes**                tunnel_attributes

	 **Statistics Data URI**               /axapi/v3/ddos/tunnel/stats

	 **Schema**                             :download:`tunnel schema <ddos-tunnel/ddos-tunnel.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/ddos/tunnel



.. raw:: html

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


:ref:`251_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/ddos/tunnel



.. raw:: html

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


:ref:`251_tunnel_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/ddos/tunnel



.. raw:: html

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


:ref:`251_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/ddos/tunnel



.. raw:: html

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


:ref:`251_tunnel_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/ddos/tunnel



.. raw:: html

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


:ref:`251_tunnel_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _251_tunnel_attributes:

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

    **sampling-enable**

        **Type:** List

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _251_sampling-enable:

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

	 **Block object keys**             

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

    **counters1**

        **Description** 'all': all; 'ip_tunnel_rcvd': IPv4 Tunnel Received; 'ip_tunnel_rate_limit_inner': IPv4 Tunnel Rate Limit Inner Pkts; 'ip_tunnel_encap': IPv4 Tunnel Encap; 'ip_tunnel_encap_fail': IPv4 Tunnel Encap Failed; 'ip_tunnel_decap': IPv4 Tunnel Decap; 'ip_tunnel_decap_fail': IPv4 Tunnel Decap Failed; 'ip6_tunnel_rcvd': IPv6 Tunnel Received; 'ip6_tunnel_rate_limit_inner': IPv6 Tunnel Rate Limit Inner Pkts; 'ip6_tunnel_encap': IPv6 Tunnel Encap; 'ip6_tunnel_encap_fail': IPv6 Tunnel Encap Failed; 'ip6_tunnel_decap': IPv6 Tunnel Decap; 'ip6_tunnel_decap_fail': IPv6 Tunnel Decap Failed; 'ip_gre_tunnel_rcvd': GRE Tunnel Received; 'ip_gre_tunnel_rate_limit_inner': GRE Tunnel Rate Limit Inner Pkts; 'ip_gre_tunnel_encap': GRE Tunnel Encap; 'ip_gre_tunnel_encap_fail': GRE Tunnel Encap Failed; 'ip_gre_tunnel_decap': GRE Tunnel Decap; 'ip_gre_tunnel_decap_fail': GRE Tunnel Decap Failed; 'ip_gre_tunnel_encap_key': GRE Tunnel Encap W/ Key; 'ip_gre_tunnel_decap_key': GRE Tunnel Decap W/ Key; 'ip_gre_tunnel_decap_drop': GRE Tunnel Decap Key Mismatch Dropped; 'ip6_gre_tunnel_rcvd': GRE V6 Tunnel Received; 'ip6_gre_tunnel_rate_limit_inner': GRE V6 Tunnel Rate Limit Inner Pkts; 'ip6_gre_tunnel_encap': GRE V6 Tunnel Encap; 'ip6_gre_tunnel_encap_fail': GRE V6 Tunnel Encap Received Failed; 'ip6_gre_tunnel_decap': GRE V6 Tunnel Decap; 'ip6_gre_tunnel_decap_fail': GRE V6 Tunnel Decap Failed; 'ip6_gre_tunnel_encap_key': GRE V6 Tunnel Encap W/ Key; 'ip6_gre_tunnel_decap_key': GRE V6 Tunnel Decap W/ Key; 'ip6_gre_tunnel_decap_drop': GRE V6 Tunnel Decap No Key Dropped; 'ip_esp_tunnel_rcvd': ESP Tunnel Received; 'ip_esp_tunnel_inspect': ESP Tunnel Inspect; 'ip_esp_tunnel_inspect_fail': ESP Tunnel Inspect Fail; 'ip6_esp_tunnel_rcvd': ESP V6 Tunnel Received; 'ip6_esp_tunnel_inspect': ESP V6 Tunnel Inspect; 'ip6_esp_tunnel_inspect_fail': ESP V6 Tunnel Inspect Fail; 'ip_vxlan_tunnel_rcvd': IP VxLAN Received; 'ip_vxlan_tunnel_invalid_vni': IP VxLAN Invalid VNI; 'ip_vxlan_tunnel_decap': IP VxLAN Decap; 'ip_vxlan_tunnel_decap_err': IP VxLAN Decap Error; 'ip_gre_tunnel_keepalive_rcvd': GRE Tunnel Keep-Alive Received; 'jumbo_in_tunnel_drop': Jumbo Packet in Tunnel Drop; 

        **Type:** string

        **Supported Values:** all, ip_tunnel_rcvd, ip_tunnel_rate_limit_inner, ip_tunnel_encap, ip_tunnel_encap_fail, ip_tunnel_decap, ip_tunnel_decap_fail, ip6_tunnel_rcvd, ip6_tunnel_rate_limit_inner, ip6_tunnel_encap, ip6_tunnel_encap_fail, ip6_tunnel_decap, ip6_tunnel_decap_fail, ip_gre_tunnel_rcvd, ip_gre_tunnel_rate_limit_inner, ip_gre_tunnel_encap, ip_gre_tunnel_encap_fail, ip_gre_tunnel_decap, ip_gre_tunnel_decap_fail, ip_gre_tunnel_encap_key, ip_gre_tunnel_decap_key, ip_gre_tunnel_decap_drop, ip6_gre_tunnel_rcvd, ip6_gre_tunnel_rate_limit_inner, ip6_gre_tunnel_encap, ip6_gre_tunnel_encap_fail, ip6_gre_tunnel_decap, ip6_gre_tunnel_decap_fail, ip6_gre_tunnel_encap_key, ip6_gre_tunnel_decap_key, ip6_gre_tunnel_decap_drop, ip_esp_tunnel_rcvd, ip_esp_tunnel_inspect, ip_esp_tunnel_inspect_fail, ip6_esp_tunnel_rcvd, ip6_esp_tunnel_inspect, ip6_esp_tunnel_inspect_fail, ip_vxlan_tunnel_rcvd, ip_vxlan_tunnel_invalid_vni, ip_vxlan_tunnel_decap, ip_vxlan_tunnel_decap_err, ip_gre_tunnel_keepalive_rcvd, jumbo_in_tunnel_drop

.. _251_stats_data:

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

   *  - 
      - Counter
      - Size
      - Description

   *  - 
      - 
      - 
      - 

   *  - 
      - ip_gre_tunnel_keepalive_rcvd
      - 8
      - GRE Tunnel Keep-Alive Received

   *  - 
      - ip6_gre_tunnel_decap_drop
      - 8
      - GRE V6 Tunnel Decap No Key Dropped

   *  - 
      - ip6_tunnel_decap
      - 8
      - IPv6 Tunnel Decap

   *  - 
      - ip_gre_tunnel_encap_key
      - 8
      - GRE Tunnel Encap W/ Key

   *  - 
      - ip_vxlan_tunnel_invalid_vni
      - 8
      - IP VxLAN Invalid VNI

   *  - 
      - ip_tunnel_decap
      - 8
      - IPv4 Tunnel Decap

   *  - 
      - ip_tunnel_rcvd
      - 8
      - IPv4 Tunnel Received

   *  - 
      - ip_gre_tunnel_decap
      - 8
      - GRE Tunnel Decap

   *  - 
      - ip6_gre_tunnel_rate_limit_inner
      - 8
      - GRE V6 Tunnel Rate Limit Inner Pkts

   *  - 
      - ip6_gre_tunnel_decap_fail
      - 8
      - GRE V6 Tunnel Decap Failed

   *  - 
      - ip_gre_tunnel_rate_limit_inner
      - 8
      - GRE Tunnel Rate Limit Inner Pkts

   *  - 
      - ip6_esp_tunnel_rcvd
      - 8
      - ESP V6 Tunnel Received

   *  - 
      - ip6_gre_tunnel_rcvd
      - 8
      - GRE V6 Tunnel Received

   *  - 
      - ip6_tunnel_encap
      - 8
      - IPv6 Tunnel Encap

   *  - 
      - ip_tunnel_encap_fail
      - 8
      - IPv4 Tunnel Encap Failed

   *  - 
      - ip_gre_tunnel_encap
      - 8
      - GRE Tunnel Encap

   *  - 
      - jumbo_in_tunnel_drop
      - 8
      - Jumbo Packet in Tunnel Drop

   *  - 
      - ip6_tunnel_rate_limit_inner
      - 8
      - IPv6 Tunnel Rate Limit Inner Pkts

   *  - 
      - ip_tunnel_rate_limit_inner
      - 8
      - IPv4 Tunnel Rate Limit Inner Pkts

   *  - 
      - ip_esp_tunnel_inspect
      - 8
      - ESP Tunnel Inspect

   *  - 
      - ip6_esp_tunnel_inspect
      - 8
      - ESP V6 Tunnel Inspect

   *  - 
      - ip_tunnel_encap
      - 8
      - IPv4 Tunnel Encap

   *  - 
      - ip_tunnel_decap_fail
      - 8
      - IPv4 Tunnel Decap Failed

   *  - 
      - ip_esp_tunnel_inspect_fail
      - 8
      - ESP Tunnel Inspect Fail

   *  - 
      - ip6_tunnel_decap_fail
      - 8
      - IPv6 Tunnel Decap Failed

   *  - 
      - ip6_esp_tunnel_inspect_fail
      - 8
      - ESP V6 Tunnel Inspect Fail

   *  - 
      - ip_vxlan_tunnel_decap_err
      - 8
      - IP VxLAN Decap Error

   *  - 
      - ip6_gre_tunnel_encap
      - 8
      - GRE V6 Tunnel Encap

   *  - 
      - ip_esp_tunnel_rcvd
      - 8
      - ESP Tunnel Received

   *  - 
      - ip_vxlan_tunnel_rcvd
      - 8
      - IP VxLAN Received

   *  - 
      - ip6_gre_tunnel_encap_key
      - 8
      - GRE V6 Tunnel Encap W/ Key

   *  - 
      - ip6_gre_tunnel_encap_fail
      - 8
      - GRE V6 Tunnel Encap Received Failed

   *  - 
      - ip6_gre_tunnel_decap
      - 8
      - GRE V6 Tunnel Decap

   *  - 
      - ip6_tunnel_rcvd
      - 8
      - IPv6 Tunnel Received

   *  - 
      - ip_gre_tunnel_decap_drop
      - 8
      - GRE Tunnel Decap Key Mismatch Dropped

   *  - 
      - ip6_tunnel_encap_fail
      - 8
      - IPv6 Tunnel Encap Failed

   *  - 
      - ip_gre_tunnel_encap_fail
      - 8
      - GRE Tunnel Encap Failed

   *  - 
      - ip_vxlan_tunnel_decap
      - 8
      - IP VxLAN Decap

   *  - 
      - ip_gre_tunnel_decap_key
      - 8
      - GRE Tunnel Decap W/ Key

   *  - 
      - ip_gre_tunnel_decap_fail
      - 8
      - GRE Tunnel Decap Failed

   *  - 
      - ip6_gre_tunnel_decap_key
      - 8
      - GRE V6 Tunnel Decap W/ Key

   *  - 
      - ip_gre_tunnel_rcvd
      - 8
      - GRE Tunnel Received