.. _netflow_common:

netflow common
==============

NetFlow/IPFIX common settings


common Specification
--------------------

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

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

	 **Element Name**                      common

	 **Element URI**                       /axapi/v3/netflow/common

	 **Element Attributes**                common_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`common schema <netflow-common/netflow-common.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/netflow/common



.. raw:: html

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


:ref:`2293_common_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/netflow_common_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/netflow/common



.. raw:: html

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


:ref:`2293_common_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/netflow/common



.. raw:: html

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


:ref:`2293_common_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/netflow/common



.. raw:: html

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


:ref:`2293_common_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/netflow/common



.. raw:: html

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


:ref:`2293_common_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _2293_common_attributes:

common attributes
-----------------

    **max-packet-queue-time**

        **Description** Configure netflow packet queue time (Max packet queue time(*20ms). Default:50( *20ms = 1s)))

        **Type:** number

        **Range:** 0-50

        **Default:** 50

    **nat44_tpl_1001**

        **Description** 

        **Type:** boolean

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

        **Default:** 0

    **reset-time-on-flow-record**

        **Description** Reset session start time to current time on each flow timeout export for long-lasting session (default: disabled).

        **Type:** boolean

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

        **Default:** 0

    **selector-algorithm-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/netflow/common/selector-algorithm/{algorithm-name} <netflow_common_selector_algorithm>`

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2293_selector-algorithm-list:

selector-algorithm-list
^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **algorithm-name**

        **Description** 'random': random; 

        **Type:** string

        **Supported Values:** random

    **sampling-population**

        **Description** Configure sampling population for random algorithm

        **Type:** number

        **Range:** 1-1000000

        **Default:** 1

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