.. _ddos_pattern_recognition:

ddos pattern-recognition
========================

Pattern Recognition


pattern-recognition Specification
---------------------------------

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

	 **Element Name**                      pattern-recognition

	 **Element URI**                       /axapi/v3/ddos/pattern-recognition

	 **Element Attributes**                pattern-recognition_attributes

	 **Statistics Data URI**               /axapi/v3/ddos/pattern-recognition/stats

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



.. raw:: html

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


:ref:`460_pattern-recognition_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/pattern-recognition



.. raw:: html

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


:ref:`460_pattern-recognition_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/pattern-recognition



.. raw:: html

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


:ref:`460_pattern-recognition_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/pattern-recognition



.. raw:: html

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


:ref:`460_pattern-recognition_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/pattern-recognition



.. raw:: html

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


:ref:`460_pattern-recognition_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _460_pattern-recognition_attributes:

pattern-recognition attributes
------------------------------

    **cpu**

        **Description:** cpu is a **JSON Block**.  Please see below for :ref:`460_cpu` 

        **Type:** Object

        **Refernce Object:** :doc:`/axapi/v3/ddos/pattern-recognition/cpu <ddos_pattern_recognition_cpu>`

    **dedicated-cpus**

        **Description** Configure the number of dedicated cores for Pattern Recognition

        **Type:** number

        **Range:** 0-6

    **hardware-filter**

        **Description** 'enable': Enable Pattern Recognition hardware filter; 'disable': Disable Pattern Recognition harware filter; 

        **Type:** string

        **Supported Values:** enable, disable

        **Default:** disable

    **sflow-event-periodic-interval**

        **Description** Configure the interval in minutes of periodic event (Default: 5 minutes, 0: No periodic updates)

        **Type:** number

        **Range:** 0-120

        **Default:** 5

    **toggle**

        **Description** 'enable': Enable Pattern Recognition; 'disable': Disable Pattern Recognition; 

        **Type:** string

        **Supported Values:** enable, disable

        **Default:** disable

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _460_cpu:

cpu
^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *object*

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

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _460_stats_data:

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

   *  - 
      - Counter
      - Size
      - Description

   *  - 
      - 
      - 
      - 

   *  - 
      - filter_match
      - 8
      - Extracted Filter Match

   *  - 
      - not_found
      - 8
      - Pattern Recognition: Pattern Not Found

   *  - 
      - proceeded
      - 8
      - Pattern Recognition: Engine Started

   *  - 
      - generic_error
      - 8
      - Pattern Recognition: Exceptions

   *  - 
      - filter_drop
      - 8
      - Extracted Filter Drop