.. _netflow_monitor_sample:

netflow monitor sample
======================

Configure filters for monitoring traffic (All traffic is monitored if no filters configured)


sample Specification
--------------------

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

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

	 **Element Name**                      sample

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

	 **Element Attributes**                sample_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


sample_attributes



.. raw:: html

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




.. raw:: html

   </table>

.. _2305_sample_attributes:

sample attributes
-----------------

    **ethernet-list**

        **Type:** List

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

    **nat-pool-list**

        **Type:** List

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

    **ve-list**

        **Type:** List

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

.. _2305_ve-list:

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

.. _2305_nat-pool-list:

nat-pool-list
^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **pool-name**

        **Description** Name of nat pool

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2305_ethernet-list:

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

	 **Block object keys**             

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

    **ifindex**

        **Description** Ethernet interface number

        **Type:** number

        **Format:** interface

        **Reference Object:** :doc:`/axapi/v3/interface/ethernet <interface_ethernet>`

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters