.. _ddos_pattern_recognition:

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

Pattern Recognition


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

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

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

	 **Element Name**                      pattern-recognition

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

	 **Element Attributes**                pattern-recognition_attributes

	 **Partition Visibility**              shared

	 **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:`1119_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:`1119_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:`1119_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:`1119_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:`1119_pattern-recognition_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _1119_pattern-recognition_attributes:

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

    **capture-backup**

        **Description** Capture Backup

        **Type:** boolean

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

        **Default:** 0

    **capturing-timeout**

        **Description** Capturing state timeout in seconds

        **Type:** number

        **Range:** 10-60000

    **cpu**

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

        **Type:** Object

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

    **cpu-limit**

        **Description** CPU Limit

        **Type:** number

        **Range:** 1-100

    **dedicated-cpus**

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

        **Type:** number

        **Range:** 0-6

    **disable-app-payload-all**

        **Description** Disable application payload processing for all ports

        **Type:** boolean

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

        **Default:** 0

    **error-timeout**

        **Description** Error state timeout in seconds

        **Type:** number

        **Range:** 10-60000

    **extracting-timeout**

        **Description** Extracting state timeout in seconds

        **Type:** number

        **Range:** 10-60000

    **hardware-filter**

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

        **Type:** string

        **Supported Values:** enable, disable

        **Default:** disable

    **sample-size**

        **Description** Sample Size

        **Type:** number

        **Range:** 1-50000

    **scheduling-timeout**

        **Description** Scheduling state timeout in seconds

        **Type:** number

        **Range:** 10-60000

    **sensitivity**

        **Description** 'high': High Sensitivity; 'medium': Medium Sensitivity; 'low': Low Sensitivity; 

        **Type:** string

        **Supported Values:** high, medium, low

    **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

.. _1119_cpu:

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

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

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters