.. _ddos_ip_proto:

ddos ip-proto
=============

global ddos port counters


ip-proto Specification
----------------------

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

	 **Element Name**                      ip-proto

	 **Element URI**                       /axapi/v3/ddos/ip-proto

	 **Element Attributes**                ip-proto_attributes

	 **Statistics Data URI**               /axapi/v3/ddos/ip-proto/stats

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



.. raw:: html

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


:ref:`505_ip-proto_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/ip-proto



.. raw:: html

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


:ref:`505_ip-proto_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/ip-proto



.. raw:: html

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


:ref:`505_ip-proto_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/ip-proto



.. raw:: html

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


:ref:`505_ip-proto_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/ip-proto



.. raw:: html

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


:ref:`505_ip-proto_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _505_ip-proto_attributes:

ip-proto attributes
-------------------

    **sampling-enable**

        **Type:** List

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _505_sampling-enable:

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

	 **Block object keys**             

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

    **counters1**

        **Description** 'all': all; 'dst_ipproto_rcvd': Dst IP-Proto Total Packets Received; 'dst_ipproto_drop': Dst IP-Proto Total Packets Dropped; 'dst_ipproto_bl': Dst IP-Proto Blacklist Packets Dropped; 'dst_ipproto_exceed_drop_any': Dst IP-Proto Exceed Dropped; 'dst_ipproto_pkt_rate_exceed': Dst IP-Proto Pkt Rate Exceeded; 'dst_ipproto_kbit_rate_exceed': Dst IP-Proto KiBit Rate Exceeded (KiBit); 'dst_ipproto_frag_rate_exceed': Dst IP-Proto Frag Pkt Rate Exceeded; 

        **Type:** string

        **Supported Values:** all, dst_ipproto_rcvd, dst_ipproto_drop, dst_ipproto_bl, dst_ipproto_exceed_drop_any, dst_ipproto_pkt_rate_exceed, dst_ipproto_kbit_rate_exceed, dst_ipproto_frag_rate_exceed

.. _505_stats_data:

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

   *  - 
      - Counter
      - Size
      - Description

   *  - 
      - 
      - 
      - 

   *  - 
      - dst_ipproto_bl
      - 8
      - Dst IP-Proto Blacklist Packets Dropped

   *  - 
      - dst_ipproto_kbit_rate_exceed
      - 8
      - Dst IP-Proto KiBit Rate Exceeded (KiBit)

   *  - 
      - dst_ipproto_exceed_drop_any
      - 8
      - Dst IP-Proto Exceed Dropped

   *  - 
      - dst_ipproto_drop
      - 8
      - Dst IP-Proto Total Packets Dropped

   *  - 
      - dst_ipproto_frag_rate_exceed
      - 8
      - Dst IP-Proto Frag Pkt Rate Exceeded

   *  - 
      - dst_ipproto_rcvd
      - 8
      - Dst IP-Proto Total Packets Received

   *  - 
      - dst_ipproto_pkt_rate_exceed
      - 8
      - Dst IP-Proto Pkt Rate Exceeded