.. _netflow:

netflow
=======

Configure NetFlow/IPFIX


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

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

	===================================== ================================================
	 **Type**                              *Intermediate Resource*

	 **Element Name**                      netflow

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

	 **Element Attributes**                netflow_attributes

	 **Partition Visibility**              None

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


Get Object



.. raw:: html

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


GET



.. raw:: html

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


/axapi/v3/netflow



.. raw:: html

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


netflow_attributes



.. raw:: html

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




.. raw:: html

   </table>

.. _940_netflow_attributes:

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

    **collector**

        **Description:** collector is a **JSON Block**.  Please see below for :ref:`940_collector` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/netflow/collector <netflow_collector>`

    **common**

        **Description:** common is a **JSON Block**.  Please see below for :ref:`940_common` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/netflow/common <netflow_common>`

    **monitor-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/netflow/monitor/{name} <netflow_monitor>`

.. _940_monitor-list:

monitor-list
^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **counter-polling-interval**

        **Description** Configure the interval to export global counters (Number of seconds: default is 60)

        **Type:** number

        **Range:** 1-3600

        **Default:** 60

    **destination**

        **Description:** destination is a **JSON Block**.  Please see below for :ref:`940_monitor-list_destination` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/netflow/monitor/{name}/destination <netflow_monitor>`

    **disable**

        **Description** Disable this netflow monitor

        **Type:** boolean

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

        **Default:** 0

    **flow-timeout**

        **Description** Configure timeout value to export flow records periodically for long-live session ( Number of minutes: default is 10, 0 means only send flow record when session is deleted)

        **Type:** number

        **Range:** 0-1440

        **Default:** 10

    **name**

        **Description** Name of netflow monitor

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **protocol**

        **Description:** protocol is a **JSON Block**.  Please see below for :ref:`940_monitor-list_protocol` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/netflow/monitor/{name}/protocol <netflow_monitor>`

    **record**

        **Description:** record is a **JSON Block**.  Please see below for :ref:`940_monitor-list_record` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/netflow/monitor/{name}/record <netflow_monitor>`

    **resend-template**

        **Description:** resend-template is a **JSON Block**.  Please see below for :ref:`940_monitor-list_resend-template` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/netflow/monitor/{name}/resend-template <netflow_monitor>`

    **sample**

        **Description:** sample is a **JSON Block**.  Please see below for :ref:`940_monitor-list_sample` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/netflow/monitor/{name}/sample <netflow_monitor>`

    **source-address**

        **Description:** source-address is a **JSON Block**.  Please see below for :ref:`940_monitor-list_source-address` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/netflow/monitor/{name}/source-address <netflow_monitor>`

    **source-ip-use-mgmt**

        **Description** Use management interface's IP address for source ip of netflow packets

        **Type:** boolean

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

        **Default:** 0

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

.. _940_monitor-list_protocol:

monitor-list_protocol
^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **version**

        **Description** 'v9': Netflow version 9; 'v10': Netflow version 10 (IPFIX); 

        **Type:** string

        **Supported Values:** v9, v10

        **Default:** v9

.. _940_monitor-list_source-address:

monitor-list_source-address
^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **ip**

        **Description** Specify source IP address

        **Type:** string

        **Format:** ipv4-address

    **ipv6**

        **Description** Specify source IPv6 address

        **Type:** string

        **Format:** ipv6-address

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _940_monitor-list_destination:

monitor-list_destination
^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **ip-cfg**

        **Description:** ip-cfg is a **JSON Block**.  Please see below for :ref:`940_monitor-list_destination_ip-cfg` 

        **Type:** Object

    **ipv6-cfg**

        **Description:** ipv6-cfg is a **JSON Block**.  Please see below for :ref:`940_monitor-list_destination_ipv6-cfg` 

        **Type:** Object

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _940_monitor-list_destination_ip-cfg:

monitor-list_destination_ip-cfg
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **ip**

        **Description** IP address of netflow collector

        **Type:** string

        **Format:** ipv4-address

        **Mutual Exclusion:** ip and ipv6 are mutually exclusive

    **port4**

        **Description** Port number, default is 9996

        **Type:** number

        **Range:** 1-65535

        **Default:** 9996

.. _940_monitor-list_destination_ipv6-cfg:

monitor-list_destination_ipv6-cfg
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **ipv6**

        **Description** IPv6 address of netflow collector

        **Type:** string

        **Format:** ipv6-address

        **Mutual Exclusion:** ipv6 and ip are mutually exclusive

    **port6**

        **Description** Port number, default is 9996

        **Type:** number

        **Range:** 1-65535

        **Default:** 9996

.. _940_monitor-list_sample:

monitor-list_sample
^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **ethernet-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/netflow/monitor/{name}/sample/ethernet/{ifindex} <netflow_monitor>`

    **ve-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/netflow/monitor/{name}/sample/ve/{ve-num} <netflow_monitor>`

.. _940_monitor-list_sample_ve-list:

monitor-list_sample_ve-list
^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **ve-num**

        **Description** VE interface number

        **Type:** number

        **Range:** 2-4094

        **Reference Object:** :doc:`/axapi/v3/interface/ve <interface_ve>`

.. _940_monitor-list_sample_ethernet-list:

monitor-list_sample_ethernet-list
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **ifindex**

        **Description** Ethernet interface number

        **Type:** number

        **Format:** interface

        **Range:** 1-131

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _940_monitor-list_record:

monitor-list_record
^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **ddos-general-stat**

        **Description** General DDOS statistics

        **Type:** boolean

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

        **Default:** 0

    **ddos-http-stat**

        **Description** HTTP DDOS statistics

        **Type:** boolean

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

        **Default:** 0

    **netflow-v5**

        **Description** NetFlow V5 Flow Record Template

        **Type:** boolean

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

        **Default:** 0

    **netflow-v5-ext**

        **Description** Extended NetFlow V5 Flow Record Template, supports ipv6

        **Type:** boolean

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

        **Default:** 0

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _940_monitor-list_resend-template:

monitor-list_resend-template
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **records**

        **Description** To resend template once for each number of records (Number of records: default is 1000, 0 means never resend template)

        **Type:** number

        **Range:** 0-1000000

        **Default:** 1000

    **timeout**

        **Description** To set time interval to resend template (number of seconds: default is 1800, 0 means never resend template)

        **Type:** number

        **Range:** 0-86400

        **Default:** 1800

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _940_collector:

collector
^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **template**

        **Description:** template is a **JSON Block**.  Please see below for :ref:`940_collector_template` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/netflow/collector/template <netflow_collector_template>`

    **template-detail**

        **Description:** template-detail is a **JSON Block**.  Please see below for :ref:`940_collector_template-detail` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/netflow/collector/template-detail <netflow_collector_template_detail>`

.. _940_collector_template-detail:

collector_template-detail
^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _940_collector_template:

collector_template
^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _940_common:

common
^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

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

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

.. _940_common_selector-algorithm-list:

common_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