.. _ddos_event_filter:

ddos event-filter
=================

Configure DDOS debug event filter


event-filter Specification
--------------------------

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

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

	 **Object Key(s)**                     *filter-name*

	 **Collection Name**                   :ref:`1053_event-filter_list`

	 **Collection URI**                    /axapi/v3/ddos/event-filter

	                                       

	 **Element Name**                      event-filter

	 **Element URI**                       /axapi/v3/ddos/event-filter/{filter-name}

	 **Element Attributes**                event-filter_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


:ref:`1053_event-filter_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/event-filter



.. raw:: html

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


:ref:`1053_event-filter_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/event-filter/{filter-name}



.. raw:: html

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


:ref:`1053_event-filter_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/event-filter



.. raw:: html

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


:ref:`1053_event-filter_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/event-filter/{filter-name}



.. raw:: html

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


:ref:`1053_event-filter_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/event-filter/{filter-name}



.. raw:: html

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


:ref:`1053_event-filter_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/event-filter



.. raw:: html

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


:ref:`1053_event-filter_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/event-filter/{filter-name}



.. raw:: html

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


:ref:`1053_event-filter_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _1053_event-filter_list:

event-filter-list
-----------------


    event-filter-list is **JSON List** of :ref:`1053_event-filter_attributes` 

        event-filter-list : [

             { :ref:`1053_event-filter_attributes` },

             { :ref:`1053_event-filter_attributes` },

             ...

         ]

.. _1053_event-filter_attributes:

event-filter attributes
-----------------------

    **black-list**

        **Description:** black-list is a **JSON Block**.  Please see below for :ref:`1053_black-list` 

        **Type:** Object

    **drop**

        **Description:** drop is a **JSON Block**.  Please see below for :ref:`1053_drop` 

        **Type:** Object

    **filter-name**

        **Description** 

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **l4-type-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/ddos/event-filter/{filter-name}/l4-type/{protocol} <ddos_event_filter>`

    **user-tag**

        **Description** Customized tag

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **white-list**

        **Description:** white-list is a **JSON Block**.  Please see below for :ref:`1053_white-list` 

        **Type:** Object

.. _1053_black-list:

black-list
^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **black-list-dst**

        **Description** Dst entry/port is black-listed

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **black-list-src**

        **Description** Src entry/port is black-listed

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

.. _1053_drop:

drop
^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **drop-black-list**

        **Description** Packet is dropped because of black-list

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **drop-dst**

        **Description** Packet is dropped because of dst

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **drop-src**

        **Description** Packet is dropped because of src

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

.. _1053_white-list:

white-list
^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **white-list-dst**

        **Description** Dst entry/port is white-listed

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **white-list-src**

        **Description** Src entry/port is white-listed

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

.. _1053_l4-type-list:

l4-type-list
^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **out-of-seq**

        **Description** TCP out-of-seq pkts

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **protocol**

        **Description** 'tcp': tcp; 'udp': udp; 

        **Type:** string

        **Supported Values:** tcp, udp

    **retrans-syn-cfg**

        **Description:** retrans-syn-cfg is a **JSON Block**.  Please see below for :ref:`1053_l4-type-list_retrans-syn-cfg` 

        **Type:** Object

    **tcp-auth**

        **Description:** tcp-auth is a **JSON Block**.  Please see below for :ref:`1053_l4-type-list_tcp-auth` 

        **Type:** Object

    **udp-auth**

        **Description:** udp-auth is a **JSON Block**.  Please see below for :ref:`1053_l4-type-list_udp-auth` 

        **Type:** Object

    **user-tag**

        **Description** Customized tag

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **zero-window**

        **Description** TCP zero window pkts

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

.. _1053_l4-type-list_tcp-auth:

l4-type-list_tcp-auth
^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **tcp-auth-fail**

        **Description** Packet that fails syn-auth/action-on-ack

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **tcp-auth-init**

        **Description** Packet that inits syn-auth/action-on-ack

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **tcp-auth-pass**

        **Description** Packet that passes syn-auth/action-on-ack

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

.. _1053_l4-type-list_udp-auth:

l4-type-list_udp-auth
^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **udp-auth-init**

        **Description** Packet that inits spoof-detect

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **udp-auth-pass**

        **Description** Packet that passes spoof-detect

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

.. _1053_l4-type-list_retrans-syn-cfg:

l4-type-list_retrans-syn-cfg
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **retrans-syn**

        **Description** TCP SYN retransmission

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **retrans-syn-exceed**

        **Description** TCP SYN retransmission exceed

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0