.. _ddos_ipproto_icmp:

ddos ipproto-icmp
=================

ddos dst zone ipproto-icmp counters


ipproto-icmp Specification
--------------------------

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

	 **Object Key(s)**                     *sampling-enable*

	 **Collection Name**                   :ref:`307_ipproto-icmp_list`

	 **Collection URI**                    /axapi/v3/ddos/ipproto-icmp

	                                       

	 **Element Name**                      ipproto-icmp

	 **Element URI**                       /axapi/v3/ddos/ipproto-icmp/{sampling-enable}

	 **Element Attributes**                ipproto-icmp_attributes

	 **Statistics Data URI**               /axapi/v3/ddos/ipproto-icmp/{sampling-enable}/stats

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



.. raw:: html

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


:ref:`307_ipproto-icmp_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/ddos/ipproto-icmp



.. raw:: html

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


:ref:`307_ipproto-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/ipproto-icmp/{sampling-enable}



.. raw:: html

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


:ref:`307_ipproto-icmp_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/ddos/ipproto-icmp



.. raw:: html

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


:ref:`307_ipproto-icmp_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/ddos/ipproto-icmp/{sampling-enable}



.. raw:: html

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


:ref:`307_ipproto-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/ipproto-icmp/{sampling-enable}



.. raw:: html

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


:ref:`307_ipproto-icmp_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/ddos/ipproto-icmp



.. raw:: html

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


:ref:`307_ipproto-icmp_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/ddos/ipproto-icmp/{sampling-enable}



.. raw:: html

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


:ref:`307_ipproto-icmp_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _307_ipproto-icmp_list:

ipproto-icmp-list
-----------------


    ipproto-icmp-list is **JSON List** of :ref:`307_ipproto-icmp_attributes` 

        ipproto-icmp-list : [

             { :ref:`307_ipproto-icmp_attributes` },

             { :ref:`307_ipproto-icmp_attributes` },

             ...

         ]

.. _307_ipproto-icmp_attributes:

ipproto-icmp attributes
-----------------------

    **sampling-enable**

        **Type:** List

.. _307_sampling-enable:

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

	 **Block object keys**             

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

    **counters1**

        **Description** 'all': all; 'rate_type0_exceed': ICMP Type Dst Rate 1 Exceeded; 'rate_type1_exceed': ICMP Type Dst Rate 2 Exceeded; 'rate_type2_exceed': ICMP Type Dst Rate 3 Exceeded; 'type_deny_drop': ICMP Type Dropped; 'icmpv4_rfc_undef_drop': ICMPv4 RFC Undef Type Dropped; 'icmpv6_rfc_undef_drop': ICMPv6 RFC Undef Type Dropped; 'wildcard_deny_drop': ICMP Type Wildcard Dropped; 'port_rcvd': Inbound Packets Received; 'port_drop': Inbound Packets Dropped; 'port_pkt_sent': Inbound Packets Forwarded; 'type': ICMP Type; 'type_bl': ICMP Type Blacklisted; 'wildcard': ICMP Type Wildcard; 'wildcard_bl': ICMP Type Wildcard Blacklisted; 'rate_type0_exceed_drop': ICMP Type Dst Rate 1 Dropped; 'rate_type0_exceed_bl': ICMP Type Dst Rate 1 Blacklisted; 'rate_type1_exceed_drop': ICMP Type Dst Rate 2 Dropped; 'rate_type1_exceed_bl': ICMP Type Dst Rate 2 Blacklisted; 'rate_type2_exceed_drop': ICMP Type Dst Rate 3 Dropped; 'rate_type2_exceed_bl': ICMP Type Dst Rate 3 Blacklisted; 'port_bytes': Inbound Bytes Received; 'outbound_port_bytes': Outbound Bytes Received; 'outbound_port_rcvd': Outbound Packets Received; 'outbound_port_pkt_sent': Outbound Packets Forwarded; 'port_bytes_sent': Inbound Bytes Forwarded; 'port_bytes_drop': Inbound Bytes Dropped; 'port_src_bl': Src Blacklisted; 'port_src_escalation': Src Escalation; 'current_es_level': Current Escalation Level; 'port_pkt_rate_exceed': Packet Rate Exceeded; 'port_kbit_rate_exceed': KiBit Rate Exceeded; 'exceed_drop_prate_src': Src Pkt Rate Exceeded; 'exceed_drop_brate_src': Src KiBit Rate Exceeded; 'outbound_port_bytes_sent': Outbound Bytes Forwarded; 'outbound_port_drop': Outbound Packets Dropped; 'outbound_port_bytes_drop': Outbound Bytes Dropped; 'src_rate_type0_exceed': ICMP Type Src Rate 1 Exceeded; 'src_rate_type0_exceed_drop': ICMP Type Src Rate 1 Dropped; 'src_rate_type0_exceed_bl': ICMP Type Src Rate 1 Blacklisted; 'src_rate_type1_exceed': ICMP Type Src Rate 2 Exceeded; 'src_rate_type1_exceed_drop': ICMP Type Src Rate 2 Dropped; 'src_rate_type1_exceed_bl': ICMP Type Src Rate 2 Blacklisted; 'src_rate_type2_exceed': ICMP Type Src Rate 3 Exceeded; 'src_rate_type2_exceed_drop': ICMP Type Src Rate 3 Dropped; 'src_rate_type2_exceed_bl': ICMP Type Src Rate 3 Blacklisted; 'exceed_drop_brate_src_pkt': Src KiBit Rate Exceeded Count; 'port_kbit_rate_exceed_pkt': KiBit Rate Exceeded Count; 'bl': Dst Blacklisted; 'src_drop': Src Packets Dropped; 'frag_rcvd': Fragmented Packets Received; 'frag_drop': Fragmented Packets Dropped; 'secondary_port_pkt_rate_exceed': Per Addr-Port Packet Rate Exceeded; 'secondary_port_kbit_rate_exceed': Per Addr-Port KiBit Rate Exceeded; 'secondary_port_kbit_rate_exceed_pkt': Per Addr-Port KiBit Rate Exceeded Count; 'no_policy_class_list_match': No Policy Class-list Match; 'frag_timeout': Fragmented Packets Timeout; 'src_frag_drop': Src Fragmented Packets Dropped; 'sflow_internal_samples_packed': Sflow Internal Samples Packed; 'sflow_external_samples_packed': Sflow External Samples Packed; 'sflow_internal_packets_sent': Sflow Internal Packets Sent; 'sflow_external_packets_sent': Sflow External Packets Sent; 'exceed_action_tunnel': Exceed Action: Tunnel; 'dst_hw_drop': Dst Hardware Packets Dropped; 'secondary_port_hit': Per Addr-Port Hit; 

        **Type:** string

        **Supported Values:** all, rate_type0_exceed, rate_type1_exceed, rate_type2_exceed, type_deny_drop, icmpv4_rfc_undef_drop, icmpv6_rfc_undef_drop, wildcard_deny_drop, port_rcvd, port_drop, port_pkt_sent, type, type_bl, wildcard, wildcard_bl, rate_type0_exceed_drop, rate_type0_exceed_bl, rate_type1_exceed_drop, rate_type1_exceed_bl, rate_type2_exceed_drop, rate_type2_exceed_bl, port_bytes, outbound_port_bytes, outbound_port_rcvd, outbound_port_pkt_sent, port_bytes_sent, port_bytes_drop, port_src_bl, port_src_escalation, current_es_level, port_pkt_rate_exceed, port_kbit_rate_exceed, exceed_drop_prate_src, exceed_drop_brate_src, outbound_port_bytes_sent, outbound_port_drop, outbound_port_bytes_drop, src_rate_type0_exceed, src_rate_type0_exceed_drop, src_rate_type0_exceed_bl, src_rate_type1_exceed, src_rate_type1_exceed_drop, src_rate_type1_exceed_bl, src_rate_type2_exceed, src_rate_type2_exceed_drop, src_rate_type2_exceed_bl, exceed_drop_brate_src_pkt, port_kbit_rate_exceed_pkt, bl, src_drop, frag_rcvd, frag_drop, secondary_port_pkt_rate_exceed, secondary_port_kbit_rate_exceed, secondary_port_kbit_rate_exceed_pkt, no_policy_class_list_match, frag_timeout, src_frag_drop, sflow_internal_samples_packed, sflow_external_samples_packed, sflow_internal_packets_sent, sflow_external_packets_sent, exceed_action_tunnel, dst_hw_drop, secondary_port_hit

.. _307_stats_data:

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

   *  - 
      - Counter
      - Size
      - Description

   *  - 
      - 
      - 
      - 

   *  - 
      - secondary_port_kbit_rate_exceed_pkt
      - 8
      - Per Addr-Port KiBit Rate Exceeded Count

   *  - 
      - port_src_bl
      - 8
      - Src Blacklisted

   *  - 
      - src_zone_service_entry_aged
      - 8
      - SrcZoneService Entry Aged

   *  - 
      - outbound_port_drop
      - 8
      - Outbound Packets Dropped

   *  - 
      - secondary_port_pkt_rate_exceed
      - 8
      - Per Addr-Port Packet Rate Exceeded

   *  - 
      - rate_type2_exceed_drop
      - 8
      - ICMP Type Dst Rate 3 Dropped

   *  - 
      - src_rate_type0_exceed_drop
      - 8
      - ICMP Type Src Rate 1 Dropped

   *  - 
      - port_bytes_drop
      - 8
      - Inbound Bytes Dropped

   *  - 
      - rate_type2_exceed_bl
      - 8
      - ICMP Type Dst Rate 3 Blacklisted

   *  - 
      - outbound_port_bytes_sent
      - 8
      - Outbound Bytes Forwarded

   *  - 
      - dst_hw_drop
      - 8
      - Dst Hardware Packets Dropped

   *  - 
      - src_hw_drop_removed
      - 8
      - Src Hardware Drop Rules Removed

   *  - 
      - port_pkt_rate_exceed
      - 8
      - Packet Rate Exceeded

   *  - 
      - src_rate_type0_exceed
      - 8
      - ICMP Type Src Rate 1 Exceeded

   *  - 
      - src_rate_type2_exceed
      - 8
      - ICMP Type Src Rate 3 Exceeded

   *  - 
      - port_kbit_rate_exceed_pkt
      - 8
      - KiBit Rate Exceeded Count

   *  - 
      - no_policy_class_list_match
      - 8
      - No Policy Class-list Match

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

   *  - 
      - rate_type1_exceed
      - 8
      - ICMP Type Dst Rate 2 Exceeded

   *  - 
      - dst_hw_drop_inserted
      - 8
      - Dst Hardware Drop Rules Inserted

   *  - 
      - src_zone_service_entry_learned
      - 8
      - SrcZoneService Entry Learned

   *  - 
      - port_pkt_sent
      - 8
      - Inbound Packets Forwarded

   *  - 
      - port_bytes_sent
      - 8
      - Inbound Bytes Forwarded

   *  - 
      - exceed_drop_brate_src
      - 8
      - Src KiBit Rate Exceeded

   *  - 
      - rate_type0_exceed_drop
      - 8
      - ICMP Type Dst Rate 1 Dropped

   *  - 
      - src_hw_drop_inserted
      - 8
      - Src Hardware Drop Rules Inserted

   *  - 
      - rate_type1_exceed_bl
      - 8
      - ICMP Type Dst Rate 2 Blacklisted

   *  - 
      - rate_type2_exceed
      - 8
      - ICMP Type Dst Rate 3 Exceeded

   *  - 
      - src_frag_drop
      - 8
      - Src Fragmented Packets Dropped

   *  - 
      - port_kbit_rate_exceed
      - 8
      - KiBit Rate Exceeded

   *  - 
      - src_rate_type2_exceed_drop
      - 8
      - ICMP Type Src Rate 3 Dropped

   *  - 
      - sflow_internal_samples_packed
      - 8
      - Sflow Internal Samples Packed

   *  - 
      - rate_type0_exceed
      - 8
      - ICMP Type Dst Rate 1 Exceeded

   *  - 
      - type
      - 8
      - ICMP Type

   *  - 
      - frag_rcvd
      - 8
      - Fragmented Packets Received

   *  - 
      - wildcard_bl
      - 8
      - ICMP Type Wildcard Blacklisted

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

   *  - 
      - outbound_port_bytes_drop
      - 8
      - Outbound Bytes Dropped

   *  - 
      - secondary_port_hit
      - 8
      - Per Addr-Port Hit

   *  - 
      - outbound_port_pkt_sent
      - 8
      - Outbound Packets Forwarded

   *  - 
      - sflow_external_packets_sent
      - 8
      - Sflow External Packets Sent

   *  - 
      - bl
      - 8
      - Dst Blacklisted

   *  - 
      - current_es_level
      - 8
      - Current Escalation Level

   *  - 
      - rate_type1_exceed_drop
      - 8
      - ICMP Type Dst Rate 2 Dropped

   *  - 
      - exceed_action_tunnel
      - 8
      - Exceed Action: Tunnel

   *  - 
      - exceed_drop_brate_src_pkt
      - 8
      - Src KiBit Rate Exceeded Count

   *  - 
      - type_deny_drop
      - 8
      - ICMP Type Dropped

   *  - 
      - wildcard_deny_drop
      - 8
      - ICMP Type Wildcard Dropped

   *  - 
      - outbound_port_rcvd
      - 8
      - Outbound Packets Received

   *  - 
      - src_rate_type1_exceed_bl
      - 8
      - ICMP Type Src Rate 2 Blacklisted

   *  - 
      - outbound_port_bytes
      - 8
      - Outbound Bytes Received

   *  - 
      - exceed_drop_prate_src
      - 8
      - Src Pkt Rate Exceeded

   *  - 
      - secondary_port_kbit_rate_exceed
      - 8
      - Per Addr-Port KiBit Rate Exceeded

   *  - 
      - port_rcvd
      - 8
      - Inbound Packets Received

   *  - 
      - sflow_external_samples_packed
      - 8
      - Sflow External Samples Packed

   *  - 
      - port_src_escalation
      - 8
      - Src Escalation

   *  - 
      - src_drop
      - 8
      - Src Packets Dropped

   *  - 
      - port_bytes
      - 8
      - Inbound Bytes Received

   *  - 
      - src_rate_type1_exceed_drop
      - 8
      - ICMP Type Src Rate 2 Dropped

   *  - 
      - sflow_internal_packets_sent
      - 8
      - Sflow Internal Packets Sent

   *  - 
      - src_rate_type1_exceed
      - 8
      - ICMP Type Src Rate 2 Exceeded

   *  - 
      - frag_timeout
      - 8
      - Fragmented Packets Timeout

   *  - 
      - wildcard
      - 8
      - ICMP Type Wildcard

   *  - 
      - src_rate_type2_exceed_bl
      - 8
      - ICMP Type Src Rate 3 Blacklisted

   *  - 
      - frag_drop
      - 8
      - Fragmented Packets Dropped

   *  - 
      - port_drop
      - 8
      - Inbound Packets Dropped

   *  - 
      - rate_type0_exceed_bl
      - 8
      - ICMP Type Dst Rate 1 Blacklisted

   *  - 
      - src_rate_type0_exceed_bl
      - 8
      - ICMP Type Src Rate 1 Blacklisted

   *  - 
      - type_bl
      - 8
      - ICMP Type Blacklisted

   *  - 
      - dst_hw_drop_removed
      - 8
      - Dst Hardware Drop Rules Removed