.. _netflow_monitor_destination:

netflow monitor destination
===========================

Configure destination where netflow records will be sent


destination Specification
-------------------------

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

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

	 **Element Name**                      destination

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

	 **Element Attributes**                destination_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


:ref:`2295_destination_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_destination_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/monitor/{name}/destination



.. raw:: html

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


:ref:`2295_destination_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_destination_GET.txt
   :literal:




.. raw:: html

   </div></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}/destination



.. raw:: html

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


:ref:`2295_destination_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}/destination



.. raw:: html

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


:ref:`2295_destination_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_destination_PUT.txt
   :literal:




.. raw:: html

   </div></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}/destination



.. raw:: html

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


:ref:`2295_destination_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_destination_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _2295_destination_attributes:

destination attributes
----------------------

    **ip-cfg**

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

        **Type:** Object

    **ipv6-cfg**

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

        **Type:** Object

    **service-group**

        **Description** Service-group for load balancing between multiple collector servers

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

        **Mutual Exclusion:** service-group, ip, and ipv6 are mutually exclusive

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2295_ip-cfg:

ip-cfg
^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **ip**

        **Description** IP address of netflow collector

        **Type:** string

        **Format:** ipv4-address

        **Mutual Exclusion:** ip, service-group, and ipv6 are mutually exclusive

    **port4**

        **Description** Port number, default is 9996

        **Type:** number

        **Range:** 1-65535

        **Default:** 9996

.. _2295_ipv6-cfg:

ipv6-cfg
^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **ipv6**

        **Description** IPv6 address of netflow collector

        **Type:** string

        **Format:** ipv6-address

        **Mutual Exclusion:** ipv6, service-group, and ip are mutually exclusive

    **port6**

        **Description** Port number, default is 9996

        **Type:** number

        **Range:** 1-65535

        **Default:** 9996