.. _ddos_template_tcp_progression_tracking:

ddos template tcp progression-tracking
======================================

Configure and enable TCP Progression Tracking


progression-tracking Specification
----------------------------------

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

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

	 **Element Name**                      progression-tracking

	 **Element URI**                       /axapi/v3/ddos/template/tcp/{name}/progression-tracking

	 **Element Attributes**                progression-tracking_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`progression-tracking schema <ddos-template-tcp-progression-tracking/ddos-template-tcp-progression-tracking.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/template/tcp/{name}/progression-tracking



.. raw:: html

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


:ref:`1207_progression-tracking_attributes`



.. raw:: html

   </td><td><button id='post_eg' onClick="showExample('post')">example</button> <button id='post_cl' onClick="closeExample('post')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='post_div' style='display:none'>


.. include:: ../artifacts/ddos_template_tcp_progression_tracking_POST.txt
   :literal:




.. raw:: html

   </div></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/template/tcp/{name}/progression-tracking



.. raw:: html

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


:ref:`1207_progression-tracking_attributes`



.. raw:: html

   </td><td><button id='get_eg' onClick="showExample('get')">example</button> <button id='get_cl' onClick="closeExample('get')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='get_div' style='display:none'>


.. include:: ../artifacts/ddos_template_tcp_progression_tracking_GET.txt
   :literal:




.. raw:: html

   </div></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/template/tcp/{name}/progression-tracking



.. raw:: html

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


:ref:`1207_progression-tracking_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/template/tcp/{name}/progression-tracking



.. raw:: html

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


:ref:`1207_progression-tracking_attributes`



.. raw:: html

   </td><td><button id='put_eg' onClick="showExample('put')">example</button> <button id='put_cl' onClick="closeExample('put')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='put_div' style='display:none'>


.. include:: ../artifacts/ddos_template_tcp_progression_tracking_PUT.txt
   :literal:




.. raw:: html

   </div></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/template/tcp/{name}/progression-tracking



.. raw:: html

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


:ref:`1207_progression-tracking_attributes`



.. raw:: html

   </td><td><button id='delete_eg' onClick="showExample('delete')">example</button> <button id='delete_cl' onClick="closeExample('delete')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='delete_div' style='display:none'>


.. include:: ../artifacts/ddos_template_tcp_progression_tracking_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _1207_progression-tracking_attributes:

progression-tracking attributes
-------------------------------

    **connection-tracking**

        **Description:** connection-tracking is a **JSON Block**.  Please see below for :ref:`1207_connection-tracking` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/ddos/template/tcp/{name}/progression-tracking/connection-tracking <ddos_template_tcp>`

    **first-request-max-time**

        **Description** Set the maximum wait time from connection creation until the first data is transmitted over the connection (100 ms)

        **Type:** number

        **Range:** 1-65535

    **profiling-connection-life-model**

        **Description** Enable auto-config progression tracking learning for connection model

        **Type:** boolean

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

        **Default:** 0

    **profiling-request-response-model**

        **Description** Enable auto-config progression tracking learning for request response model

        **Type:** boolean

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

        **Default:** 0

    **profiling-time-window-model**

        **Description** Enable auto-config progression tracking learning for time window model

        **Type:** boolean

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

        **Default:** 0

    **progression-tracking-action**

        **Description** 'drop': Drop packets for progression tracking violation exceed (Default); 'blacklist-src': Blacklist-src for progression tracking violation exceed; 

        **Type:** string

        **Supported Values:** drop, blacklist-src

        **Default:** drop

        **Mutual Exclusion:** progression-tracking-action and progression-tracking-action-list-name are mutually exclusive

    **progression-tracking-action-list-name**

        **Description** Configure action-list to take when progression tracking violation exceed

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

        **Mutual Exclusion:** progression-tracking-action-list-name and progression-tracking-action are mutually exclusive

        **Reference Object:** :doc:`/axapi/v3/ddos/action-list <ddos_action_list>`

    **progression-tracking-enabled**

        **Description** 'enable-check': Enable Progression Tracking Check; 

        **Type:** string

        **Supported Values:** enable-check

    **request-length-max**

        **Description** Set the maximum request length

        **Type:** number

        **Range:** 1-65535

    **request-length-min**

        **Description** Set the minimum request length

        **Type:** number

        **Range:** 1-65535

    **request-response-model**

        **Description** 'enable': Enable Request Response Model; 'disable': Disable Request Response Model; 

        **Type:** string

        **Supported Values:** enable, disable

        **Default:** enable

    **request-to-response-max-time**

        **Description** Set the maximum request to response time (100 ms)

        **Type:** number

        **Range:** 1-65535

    **response-length-max**

        **Description** Set the maximum response length

        **Type:** number

        **Range:** 1-4294967295

    **response-length-min**

        **Description** Set the minimum response length

        **Type:** number

        **Range:** 1-65535

    **response-request-max-ratio**

        **Description** Set the maximum response to request ratio (in unit of 0.1% [1:1000])

        **Type:** number

        **Range:** 1-4294967295

    **response-request-min-ratio**

        **Description** Set the minimum response to request ratio (in unit of 0.1% [1:1000])

        **Type:** number

        **Range:** 1-65535

    **response-to-request-max-time**

        **Description** Set the maximum response to request time (100 ms)

        **Type:** number

        **Range:** 1-65535

    **time-window-tracking**

        **Description:** time-window-tracking is a **JSON Block**.  Please see below for :ref:`1207_time-window-tracking` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/ddos/template/tcp/{name}/progression-tracking/time-window-tracking <ddos_template_tcp>`

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **violation**

        **Description** Set the violation threshold

        **Type:** number

        **Range:** 1-255

.. _1207_connection-tracking:

connection-tracking
^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **conn-duration-max**

        **Description** Set the maximum duration time (in unit of 100ms, up to 24 hours)

        **Type:** number

        **Range:** 1-864000

    **conn-duration-min**

        **Description** Set the minimum duration time (in unit of 100ms, up to 24 hours)

        **Type:** number

        **Range:** 1-864000

    **conn-rcvd-max**

        **Description** Set the maximum total received byte

        **Type:** number

        **Range:** 1-65535

    **conn-rcvd-min**

        **Description** Set the minimum total received byte

        **Type:** number

        **Range:** 1-65535

    **conn-rcvd-sent-ratio-max**

        **Description** Set the maximum received to sent ratio (in unit of 0.1% [1:1000])

        **Type:** number

        **Range:** 1-65535

    **conn-rcvd-sent-ratio-min**

        **Description** Set the minimum received to sent ratio (in unit of 0.1% [1:1000])

        **Type:** number

        **Range:** 1-65535

    **conn-sent-max**

        **Description** Set the maximum total sent byte

        **Type:** number

        **Range:** 1-65535

    **conn-sent-min**

        **Description** Set the minimum total sent byte

        **Type:** number

        **Range:** 1-65535

    **conn-violation**

        **Description** Set the violation threshold

        **Type:** number

        **Range:** 1-255

    **progression-tracking-conn-action**

        **Description** 'drop': Drop packets for progression tracking violation exceed (Default); 'blacklist-src': Blacklist-src for progression tracking violation exceed; 

        **Type:** string

        **Supported Values:** drop, blacklist-src

        **Default:** drop

        **Mutual Exclusion:** progression-tracking-conn-action and progression-tracking-conn-action-list-name are mutually exclusive

    **progression-tracking-conn-action-list-name**

        **Description** Configure action-list to take when progression tracking violation exceed

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

        **Mutual Exclusion:** progression-tracking-conn-action-list-name and progression-tracking-conn-action are mutually exclusive

        **Reference Object:** :doc:`/axapi/v3/ddos/action-list <ddos_action_list>`

    **progression-tracking-conn-enabled**

        **Description** 'enable-check': Enable General Progression Tracking per Connection; 

        **Type:** string

        **Supported Values:** enable-check

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1207_time-window-tracking:

time-window-tracking
^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **progression-tracking-win-enabled**

        **Description** 'enable-check': Enable Progression Tracking per Time Window; 

        **Type:** string

        **Supported Values:** enable-check

    **progression-tracking-windows-action**

        **Description** 'drop': Drop packets for progression tracking violation exceed (Default); 'blacklist-src': Blacklist-src for progression tracking violation exceed; 

        **Type:** string

        **Supported Values:** drop, blacklist-src

        **Default:** drop

        **Mutual Exclusion:** progression-tracking-windows-action and progression-tracking-windows-action-list-name are mutually exclusive

    **progression-tracking-windows-action-list-name**

        **Description** Configure action-list to take when progression tracking violation exceed

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

        **Mutual Exclusion:** progression-tracking-windows-action-list-name and progression-tracking-windows-action are mutually exclusive

        **Reference Object:** :doc:`/axapi/v3/ddos/action-list <ddos_action_list>`

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **window-rcvd-max**

        **Description** Set the maximum total received byte

        **Type:** number

        **Range:** 1-65535

    **window-rcvd-min**

        **Description** Set the minimum total received byte

        **Type:** number

        **Range:** 1-65535

    **window-rcvd-sent-ratio-max**

        **Description** Set the maximum received to sent ratio (in unit of 0.1% [1:1000])

        **Type:** number

        **Range:** 1-65535

    **window-rcvd-sent-ratio-min**

        **Description** Set the minimum received to sent ratio (in unit of 0.1% [1:1000])

        **Type:** number

        **Range:** 1-65535

    **window-sent-max**

        **Description** Set the maximum total sent byte

        **Type:** number

        **Range:** 1-65535

    **window-sent-min**

        **Description** Set the minimum total sent byte

        **Type:** number

        **Range:** 1-65535

    **window-violation**

        **Description** Set the violation threshold

        **Type:** number

        **Range:** 1-255