.. _netflow_monitor:

netflow monitor
===============

Configure NetFlow Monitor


monitor Specification
---------------------

	===================================== ===============================================================
	===================================== ===============================================================
	 **Type**                              *Collection*

	 **Object Key(s)**                     *name*

	 **Collection Name**                   :ref:`1055_monitor_list`

	 **Collection URI**                    /axapi/v3/netflow/monitor

	                                       

	 **Element Name**                      monitor

	 **Element URI**                       /axapi/v3/netflow/monitor/{name}

	 **Element Attributes**                monitor_attributes

	 **Statistics Data URI**               /axapi/v3/netflow/monitor/{name}/stats

	 **Operational Data URI**              /axapi/v3/netflow/monitor/{name}/oper

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



.. raw:: html

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


:ref:`1055_monitor_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_monitor_POST.txt
   :literal:




.. raw:: html

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


.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Create List



.. raw:: html

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


POST



.. raw:: html

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


/axapi/v3/netflow/monitor



.. raw:: html

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


:ref:`1055_monitor_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/netflow/monitor/{name}



.. raw:: html

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


:ref:`1055_monitor_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/netflow_monitor_GET.txt
   :literal:




.. raw:: html

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


.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Get List



.. raw:: html

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


GET



.. raw:: html

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


/axapi/v3/netflow/monitor



.. raw:: html

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


:ref:`1055_monitor_list`



.. 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/monitor/{name}



.. raw:: html

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


:ref:`1055_monitor_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/monitor/{name}



.. raw:: html

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


:ref:`1055_monitor_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/netflow_monitor_PUT.txt
   :literal:




.. raw:: html

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


.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Replace List



.. raw:: html

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


PUT



.. raw:: html

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


/axapi/v3/netflow/monitor



.. raw:: html

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


:ref:`1055_monitor_list`



.. 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/monitor/{name}



.. raw:: html

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


:ref:`1055_monitor_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/netflow_monitor_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _1055_monitor_list:

monitor-list
------------


    monitor-list is **JSON List** of :ref:`1055_monitor_attributes` 

        monitor-list : [

             { :ref:`1055_monitor_attributes` },

             { :ref:`1055_monitor_attributes` },

             ...

         ]

.. _1055_monitor_attributes:

monitor attributes
------------------

    **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:`1055_destination` 

        **Type:** Object

        **Refernce 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:`1055_protocol` 

        **Type:** Object

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

    **record**

        **Description:** record is a **JSON Block**.  Please see below for :ref:`1055_record` 

        **Type:** Object

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

    **resend-template**

        **Description:** resend-template is a **JSON Block**.  Please see below for :ref:`1055_resend-template` 

        **Type:** Object

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

    **sample**

        **Description:** sample is a **JSON Block**.  Please see below for :ref:`1055_sample` 

        **Type:** Object

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

    **source-address**

        **Description:** source-address is a **JSON Block**.  Please see below for :ref:`1055_source-address` 

        **Type:** Object

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

.. _1055_protocol:

protocol
^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **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

.. _1055_source-address:

source-address
^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **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

.. _1055_destination:

destination
^^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *object*

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

    **ip-cfg**

        **Description:** ip-cfg is a **JSON Block**.  Please see below for :ref:`1055_destination_ip-cfg` 

        **Type:** Object

    **ipv6-cfg**

        **Description:** ipv6-cfg is a **JSON Block**.  Please see below for :ref:`1055_destination_ipv6-cfg` 

        **Type:** Object

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1055_destination_ip-cfg:

destination_ip-cfg
^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **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

.. _1055_destination_ipv6-cfg:

destination_ipv6-cfg
^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **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

.. _1055_sample:

sample
^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *object*

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

    **ethernet-list**

        **Type:** List

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

    **ve-list**

        **Type:** List

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

.. _1055_sample_ve-list:

sample_ve-list
^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **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

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

.. _1055_sample_ethernet-list:

sample_ethernet-list
^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **ifindex**

        **Description** Ethernet interface number

        **Type:** number

        **Format:** interface

        **Range:** 2-195

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1055_record:

record
^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **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

.. _1055_resend-template:

resend-template
^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **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

.. _1055_stats_data:

stats data
----------
.. list-table::
   :widths: 10 20 30 80
   :header-rows: 2
   :stub-columns: 1

   *  - 
      - Counter
      - Size
      - Description

   *  - 
      - 
      - 
      - 

   *  - 
      - port-mapping-nat64-records-sent
      - 8
      - Port Mapping Nat64 Event Records Sent

   *  - 
      - netflow-v5-records-sent
      - 8
      - Netflow v5 Records Sent

   *  - 
      - port-mapping-nat44-records-sent-failure
      - 8
      - Port Mapping Nat44 Event Records Failed

   *  - 
      - ddos-http-stat-records-sent-failure
      - 8
      - ddos-http-stat-records-sent-failure

   *  - 
      - session-event-nat64-records-sent
      - 8
      - Nat64 Session Event Records Sent

   *  - 
      - netflow-v5-ext-records-sent-failure
      - 8
      - Netflow v5 Ext Records Failed

   *  - 
      - port-mapping-dslite-records-sent-failure
      - 8
      - Port Mapping Dslite Event Records failed

   *  - 
      - session-event-dslite-records-sent
      - 8
      - Dslite Session Event Records Sent

   *  - 
      - netflow-v5-ext-records-sent
      - 8
      - Netflow v5 Ext Records Sent

   *  - 
      - dslite-records-sent-failure
      - 8
      - Dslite Flow Records Failed

   *  - 
      - session-event-nat44-records-sent
      - 8
      - Nat44 Session Event Records Sent

   *  - 
      - port-mapping-nat64-records-sent-failure
      - 8
      - Port Mapping Nat64 Event Records Failed

   *  - 
      - nat64-records-sent
      - 8
      - NAT64 Flow Records Sent

   *  - 
      - ddos-http-stat-records-sent
      - 8
      - ddos-http-stat-records-sent

   *  - 
      - ddos-general-stat-records-sent
      - 8
      - ddos-general-stat-records-sent

   *  - 
      - port-mapping-dslite-records-sent
      - 8
      - Port Mapping Dslite Event Records Sent

   *  - 
      - bytes-sent
      - 8
      - Sent Bytes Count

   *  - 
      - session-event-dslite-records-sent-failure
      - 8
      - Dslite Session Event Records Failed

   *  - 
      - ddos-general-stat-records-sent-failure
      - 8
      - ddos-general-stat-records-sent-failure

   *  - 
      - nat44-records-sent-failure
      - 8
      - NAT44 Flow Records Failed

   *  - 
      - dslite-records-sent
      - 8
      - Dslite Flow Records Sent

   *  - 
      - port-mapping-nat44-records-sent
      - 8
      - Port Mapping Nat44 Event Records Sent

   *  - 
      - session-event-nat44-records-sent-failure
      - 8
      - Nat44 Session Event Records Failed

   *  - 
      - session-event-nat64-records-sent-failure
      - 8
      - Nat64 Session Event Records Falied

   *  - 
      - nat44-records-sent
      - 8
      - NAT44 Flow Records Sent

   *  - 
      - packets-sent
      - 8
      - Sent Packets Count

   *  - 
      - nat64-records-sent-failure
      - 8
      - NAT64 Flow Records Failed

   *  - 
      - netflow-v5-records-sent-failure
      - 8
      - Netflow v5 Records Failed

.. _1055_oper_data:

operational data
----------------
.. list-table::
   :widths: 10 20 30 80
   :header-rows: 2
   :stub-columns: 1

   *  - 
      - Counter
      - Size
      - Description

   *  - 
      - 
      - 
      - 

   *  - 
      - status
      - string
      - status

   *  - 
      - source-ip-use-mgmt
      - string
      - source-ip-use-mgmt

   *  - 
      - protocol
      - string
      - protocol

   *  - 
      - resend-template-timeout
      - string
      - resend-template-timeout

   *  - 
      - destination
      - string
      - destination

   *  - 
      - counter-polling-interval
      - string
      - counter-polling-interval

   *  - 
      - filter
      - string
      - filter

   *  - 
      - resend-template-per-records
      - string
      - resend-template-per-records

   *  - 
      - flow-timeout
      - string
      - flow-timeout

   *  - 
      - source-ip-addr
      - string
      - source-ip-addr