.. _sys_ut_event_action_l3_ip:

sys-ut event action l3 ip
=========================

IP address


ip Specification
----------------

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

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

	 **Object Key(s)**                     *src-dst*

	 **Collection Name**                   :ref:`3140_ip_list`

	 **Collection URI**                    /axapi/v3/sys-ut/event/{event-number}/action/{direction}/l3/ip

	                                       

	 **Element Name**                      ip

	 **Element URI**                       /axapi/v3/sys-ut/event/{event-number}/action/{direction}/l3/ip/{src-dst}

	 **Element Attributes**                ip_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`ip schema <sys-ut-event-action-l3-ip/sys-ut-event-action-l3-ip.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/sys-ut/event/{event-number}/action/{direction}/l3/ip



.. raw:: html

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


:ref:`3140_ip_attributes`



.. raw:: html

   </td><td></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/sys-ut/event/{event-number}/action/{direction}/l3/ip



.. raw:: html

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


:ref:`3140_ip_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/sys-ut/event/{event-number}/action/{direction}/l3/ip/{src-dst}



.. raw:: html

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


:ref:`3140_ip_attributes`



.. raw:: html

   </td><td></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/sys-ut/event/{event-number}/action/{direction}/l3/ip



.. raw:: html

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


:ref:`3140_ip_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/sys-ut/event/{event-number}/action/{direction}/l3/ip/{src-dst}



.. raw:: html

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


:ref:`3140_ip_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/sys-ut/event/{event-number}/action/{direction}/l3/ip/{src-dst}



.. raw:: html

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


:ref:`3140_ip_attributes`



.. raw:: html

   </td><td></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/sys-ut/event/{event-number}/action/{direction}/l3/ip



.. raw:: html

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


:ref:`3140_ip_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/sys-ut/event/{event-number}/action/{direction}/l3/ip/{src-dst}



.. raw:: html

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


:ref:`3140_ip_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _3140_ip_list:

ip-list
-------


    ip-list is **JSON List** of :ref:`3140_ip_attributes` 

        ip-list : [

             { :ref:`3140_ip_attributes` },

             { :ref:`3140_ip_attributes` },

             ...

         ]

.. _3140_ip_attributes:

ip attributes
-------------

    **ethernet**

        **Description** Ethernet interface

        **Type:** number

        **Format:** interface

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

    **ipv4-address**

        **Description** IP address

        **Type:** string

        **Format:** ipv4-address

    **ipv6-address**

        **Description** Ipv6 address

        **Type:** string

        **Format:** ipv6-address

    **nat-pool**

        **Description** Nat pool

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **src-dst**

        **Description** 'dest': dest; 'src': src; 

        **Type:** string

        **Supported Values:** dest, src

    **trunk**

        **Description** Trunk number

        **Type:** number

        **Format:** interface

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **ve**

        **Description** Virtual Ethernet interface

        **Type:** number

        **Format:** interface

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

    **virtual-server**

        **Description** vip

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/slb/virtual-server <slb_virtual_server>`