.. _ddos_detection_agent_netflow:

ddos detection agent netflow
============================

Configure DDoS detection agent Netflow settings


netflow Specification
---------------------

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

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

	 **Element Name**                      netflow

	 **Element URI**                       /axapi/v3/ddos/detection/agent/{agent-name}/netflow

	 **Element Attributes**                netflow_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`netflow schema <ddos-detection-agent-netflow/ddos-detection-agent-netflow.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/detection/agent/{agent-name}/netflow



.. raw:: html

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


:ref:`664_netflow_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/detection/agent/{agent-name}/netflow



.. raw:: html

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


:ref:`664_netflow_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/detection/agent/{agent-name}/netflow



.. raw:: html

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


:ref:`664_netflow_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/detection/agent/{agent-name}/netflow



.. raw:: html

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


:ref:`664_netflow_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/detection/agent/{agent-name}/netflow



.. raw:: html

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


:ref:`664_netflow_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _664_netflow_attributes:

netflow attributes
------------------

    **active-timeout**

        **Description** Configure agent's flow active timeout (seconds)

        **Type:** number

        **Range:** 10-600

    **inactive-timeout**

        **Description** Configure agent's flow inactive timeout (seconds)

        **Type:** number

        **Range:** 10-600

    **netflow-samples-collection**

        **Description** 'enable': Enable Netflow flow samples collection(default); 'disable': Disable Netflow flow samples collection; 

        **Type:** string

        **Supported Values:** enable, disable

        **Default:** enable

    **netflow-sampling-rate**

        **Description** Configure agent's netflow sampling rate

        **Type:** number

        **Range:** 1-65535

        **Default:** 1

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters