.. _ddos_l4_icmp:

ddos l4-icmp
============

l4 icmp counters


l4-icmp Specification
---------------------

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

	 **Element Name**                      l4-icmp

	 **Element URI**                       /axapi/v3/ddos/l4-icmp

	 **Element Attributes**                l4-icmp_attributes

	 **Statistics Data URI**               /axapi/v3/ddos/l4-icmp/stats

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



.. raw:: html

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


:ref:`1287_l4-icmp_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/l4-icmp



.. raw:: html

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


:ref:`1287_l4-icmp_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/l4-icmp



.. raw:: html

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


:ref:`1287_l4-icmp_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/l4-icmp



.. raw:: html

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


:ref:`1287_l4-icmp_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/l4-icmp



.. raw:: html

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


:ref:`1287_l4-icmp_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _1287_l4-icmp_attributes:

l4-icmp attributes
------------------

    **sampling-enable**

        **Type:** List

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1287_sampling-enable:

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

	 **Block object keys**             

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

    **counters1**

        **Description** 'all': all; 'icmp_src_drop': ICMP Src Packets Dropped; 'icmp_dst_drop': ICMP Dst Packets Dropped; 'icmp_exceed_drop_prate_dst': ICMP Dst Packet Rate Drop (deprecated); 'icmp_wildcard_bl': ICMP Type Wildcard Blacklisted; 'src_icmp_bl_user_config': ICMP Src Blacklisted User Packets Dropped; 'icmp_rcvd': ICMP Total Packets Received; 'icmp_echo_rcvd': ICMP Echo Received; 'icmp_other_rcvd': ICMP other Received; 'icmp_exceed_drop_any_dst': ICMP Dst Exceed Drop (deprecated); 'icmp_dst_bl_drop': ICMP Dst Blacklist Drop (deprecated); 'icmp_src_any_exceed_drop': ICMP Src Exceed Drop (deprecated); 'icmp_src_pkt_rate_exceed_drop': ICMP Src Packet Rate Drop (deprecated); 'icmp_drop_black_src': ICMP Src Blacklist Drop (deprecated); 'icmp_src_dst_drop': ICMP SrcDst Packets Dropped; 'icmp_src_dst_any_exceed_drop': ICMP SrcDst Exceed Drop (deprecated); 'icmp_src_dst_pkt_rate_exceed_drop': ICMP SrcDst Packet Rate Drop (deprecated); 'icmp_src_dst_bl_drop': ICMP SrcDst Blacklist Drop (deprecated); 'icmp_src_dst_bl_drop_user_cfg': ICMP SrcDst Blacklisted User Packets Dropped; 'icmp_type_deny_drop': ICMP Type Dropped; 'icmp_v4_rfc_undef_drop': ICMPv4 RFC Undef Type Dropped; 'icmp_v6_rfc_undef_drop': ICMPv6 RFC Undef Type Dropped; 'icmp_wildcard_deny_drop': ICMP Type Wildcard Dropped; 'icmp_rate_exceed0': ICMP Type Rate 1 Exceeded; 'icmp_rate_exceed1': ICMP Type Rate 2 Exceeded; 'icmp_rate_exceed2': ICMP Type Rate 3 Exceeded; 'icmp_exceed_drop_brate_dst': ICMP Dst KiBit Rate Drop (KiBit) (deprecated); 'icmp_exceed_drop_brate_src': ICMP Src KiBit Rate Drop (KiBit) (deprecated); 'icmp_exceed_drop_brate_src_dst': ICMP SrcDst KiBit Rate Drop (KiBit)(deprecated); 'icmp_type': ICMP Type; 'icmp_type_bl': ICMP Type Blacklisted; 'icmp_rate_exceed0_drop': ICMP Type Rate 1 Dropped; 'icmp_rate_exceed0_bl': ICMP Type Rate 1 Blacklisted; 'icmp_rate_exceed1_drop': ICMP Type Rate 2 Dropped; 'icmp_rate_exceed1_bl': ICMP Type Rate 2 Blacklisted; 'icmp_rate_exceed2_drop': ICMP Type Rate 3 Dropped; 'icmp_rate_exceed2_bl': ICMP Type Rate 3 Blacklisted; 'icmp_wildcard': ICMP Type Wildcard; 'icmp_any_exceed': ICMP Exceeded; 'icmp_drop_bl': ICMP Blacklisted Packets Dropped; 'icmp_frag_rcvd': ICMP Fragmented Packets Received; 'icmp_frag_drop': ICMP Fragmented Packets Dropped; 'icmp_total_bytes_rcv': ICMP Total Bytes Received; 'icmp_total_drop': ICMP Total Packets Dropped; 'icmp_total_bytes_drop': ICMP Total Bytes Dropped; 

        **Type:** string

        **Supported Values:** all, icmp_src_drop, icmp_dst_drop, icmp_exceed_drop_prate_dst, icmp_wildcard_bl, src_icmp_bl_user_config, icmp_rcvd, icmp_echo_rcvd, icmp_other_rcvd, icmp_exceed_drop_any_dst, icmp_dst_bl_drop, icmp_src_any_exceed_drop, icmp_src_pkt_rate_exceed_drop, icmp_drop_black_src, icmp_src_dst_drop, icmp_src_dst_any_exceed_drop, icmp_src_dst_pkt_rate_exceed_drop, icmp_src_dst_bl_drop, icmp_src_dst_bl_drop_user_cfg, icmp_type_deny_drop, icmp_v4_rfc_undef_drop, icmp_v6_rfc_undef_drop, icmp_wildcard_deny_drop, icmp_rate_exceed0, icmp_rate_exceed1, icmp_rate_exceed2, icmp_exceed_drop_brate_dst, icmp_exceed_drop_brate_src, icmp_exceed_drop_brate_src_dst, icmp_type, icmp_type_bl, icmp_rate_exceed0_drop, icmp_rate_exceed0_bl, icmp_rate_exceed1_drop, icmp_rate_exceed1_bl, icmp_rate_exceed2_drop, icmp_rate_exceed2_bl, icmp_wildcard, icmp_any_exceed, icmp_drop_bl, icmp_frag_rcvd, icmp_frag_drop, icmp_total_bytes_rcv, icmp_total_drop, icmp_total_bytes_drop

.. _1287_stats_data:

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

   *  - 
      - Counter
      - Size
      - Description

   *  - 
      - 
      - 
      - 

   *  - 
      - icmp_rate_exceed1_drop
      - 8
      - ICMP Type Rate 2 Dropped

   *  - 
      - icmp_wildcard_bl
      - 8
      - ICMP Type Wildcard Blacklisted

   *  - 
      - icmp_rcvd
      - 8
      - ICMP Total Packets Received

   *  - 
      - icmp_src_dst_drop
      - 8
      - ICMP SrcDst Packets Dropped

   *  - 
      - icmp_v4_rfc_undef_drop
      - 8
      - ICMPv4 RFC Undef Type Dropped

   *  - 
      - icmp_type
      - 8
      - ICMP Type

   *  - 
      - icmp_rate_exceed1_bl
      - 8
      - ICMP Type Rate 2 Blacklisted

   *  - 
      - icmp_any_exceed
      - 8
      - ICMP Exceeded

   *  - 
      - icmp_v6_rfc_undef_drop
      - 8
      - ICMPv6 RFC Undef Type Dropped

   *  - 
      - icmp_drop_bl
      - 8
      - ICMP Blacklisted Packets Dropped

   *  - 
      - icmp_total_drop
      - 8
      - ICMP Total Packets Dropped

   *  - 
      - icmp_rate_exceed2_bl
      - 8
      - ICMP Type Rate 3 Blacklisted

   *  - 
      - icmp_other_rcvd
      - 8
      - ICMP other Received

   *  - 
      - icmp_src_dst_bl_drop_user_cfg
      - 8
      - ICMP SrcDst Blacklisted User Packets Dropped

   *  - 
      - icmp_total_bytes_drop
      - 8
      - ICMP Total Bytes Dropped

   *  - 
      - icmp_frag_rcvd
      - 8
      - ICMP Fragmented Packets Received

   *  - 
      - icmp_wildcard
      - 8
      - ICMP Type Wildcard

   *  - 
      - icmp_type_deny_drop
      - 8
      - ICMP Type Dropped

   *  - 
      - icmp_rate_exceed0
      - 8
      - ICMP Type Rate 1 Exceeded

   *  - 
      - icmp_rate_exceed1
      - 8
      - ICMP Type Rate 2 Exceeded

   *  - 
      - icmp_rate_exceed2
      - 8
      - ICMP Type Rate 3 Exceeded

   *  - 
      - icmp_total_bytes_rcv
      - 8
      - ICMP Total Bytes Received

   *  - 
      - icmp_src_drop
      - 8
      - ICMP Src Packets Dropped

   *  - 
      - src_icmp_bl_user_config
      - 8
      - ICMP Src Blacklisted User Packets Dropped

   *  - 
      - icmp_rate_exceed2_drop
      - 8
      - ICMP Type Rate 3 Dropped

   *  - 
      - icmp_wildcard_deny_drop
      - 8
      - ICMP Type Wildcard Dropped

   *  - 
      - icmp_frag_drop
      - 8
      - ICMP Fragmented Packets Dropped

   *  - 
      - icmp_type_bl
      - 8
      - ICMP Type Blacklisted

   *  - 
      - icmp_rate_exceed0_bl
      - 8
      - ICMP Type Rate 1 Blacklisted

   *  - 
      - icmp_rate_exceed0_drop
      - 8
      - ICMP Type Rate 1 Dropped

   *  - 
      - icmp_dst_drop
      - 8
      - ICMP Dst Packets Dropped

   *  - 
      - icmp_echo_rcvd
      - 8
      - ICMP Echo Received