.. _ip_mgmt_traffic:

ip mgmt-traffic
===============

Management traffic IP parameters


mgmt-traffic Specification
--------------------------

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

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

	 **Object Key(s)**                     *traffic-type*

	 **Collection Name**                   :ref:`2102_mgmt-traffic_list`

	 **Collection URI**                    /axapi/v3/ip/mgmt-traffic

	                                       

	 **Element Name**                      mgmt-traffic

	 **Element URI**                       /axapi/v3/ip/mgmt-traffic/{traffic-type}

	 **Element Attributes**                mgmt-traffic_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`mgmt-traffic schema <ip-mgmt-traffic/ip-mgmt-traffic.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/ip/mgmt-traffic



.. raw:: html

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


:ref:`2102_mgmt-traffic_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/ip_mgmt_traffic_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/ip/mgmt-traffic



.. raw:: html

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


:ref:`2102_mgmt-traffic_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/ip/mgmt-traffic/{traffic-type}



.. raw:: html

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


:ref:`2102_mgmt-traffic_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/ip_mgmt_traffic_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/ip/mgmt-traffic



.. raw:: html

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


:ref:`2102_mgmt-traffic_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/ip/mgmt-traffic/{traffic-type}



.. raw:: html

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


:ref:`2102_mgmt-traffic_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/ip/mgmt-traffic/{traffic-type}



.. raw:: html

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


:ref:`2102_mgmt-traffic_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/ip_mgmt_traffic_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/ip/mgmt-traffic



.. raw:: html

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


:ref:`2102_mgmt-traffic_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/ip/mgmt-traffic/{traffic-type}



.. raw:: html

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


:ref:`2102_mgmt-traffic_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _2102_mgmt-traffic_list:

mgmt-traffic-list
-----------------


    mgmt-traffic-list is **JSON List** of :ref:`2102_mgmt-traffic_attributes` 

        mgmt-traffic-list : [

             { :ref:`2102_mgmt-traffic_attributes` },

             { :ref:`2102_mgmt-traffic_attributes` },

             ...

         ]

.. _2102_mgmt-traffic_attributes:

mgmt-traffic attributes
-----------------------

    **source-interface**

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

        **Type:** Object

    **traffic-type**

        **Description** 'all': All; 'ftp': FTP; 'ntp': NTP; 'snmp-trap': SNMP Trap; 'ssh': SSH and SCP; 'syslog': SYSLOG; 'telnet': Telnet; 'tftp': TFTP; 'web': Web - HTTP and HTTPS; 

        **Type:** string

        **Supported Values:** all, ftp, ntp, snmp-trap, ssh, syslog, telnet, tftp, web

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2102_source-interface:

source-interface
^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **ethernet**

        **Description** Ethernet interface (Port number)

        **Type:** number

        **Format:** interface

    **lif**

        **Description** Logical interface (Lif interface number)

        **Type:** number

        **Range:** 1-128

    **loopback**

        **Description** Loopback interface (Port number)

        **Type:** number

        **Format:** interface

    **trunk**

        **Description** Trunk interface (Trunk interface number)

        **Type:** number

        **Format:** interface

    **tunnel**

        **Description** Tunnel interface (Tunnel interface number)

        **Type:** number

        **Range:** 1-128

    **ve**

        **Description** Virtual ethernet interface (Virtual ethernet interface number)

        **Type:** number

        **Format:** interface