.. _ddos_dst_interface_ip:

ddos dst interface-ip
=====================

Configure protections on local interface IPs


interface-ip Specification
--------------------------

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

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

	 **Object Key(s)**                     *addr*

	 **Collection Name**                   :ref:`827_interface-ip_list`

	 **Collection URI**                    /axapi/v3/ddos/dst/interface-ip

	                                       

	 **Element Name**                      interface-ip

	 **Element URI**                       /axapi/v3/ddos/dst/interface-ip/{addr}

	 **Element Attributes**                interface-ip_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`interface-ip schema <ddos-dst-interface-ip/ddos-dst-interface-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/ddos/dst/interface-ip



.. raw:: html

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


:ref:`827_interface-ip_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/ddos_dst_interface_ip_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/ddos/dst/interface-ip



.. raw:: html

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


:ref:`827_interface-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/ddos/dst/interface-ip/{addr}



.. raw:: html

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


:ref:`827_interface-ip_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/ddos_dst_interface_ip_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/ddos/dst/interface-ip



.. raw:: html

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


:ref:`827_interface-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/ddos/dst/interface-ip/{addr}



.. raw:: html

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


:ref:`827_interface-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/ddos/dst/interface-ip/{addr}



.. raw:: html

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


:ref:`827_interface-ip_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/ddos_dst_interface_ip_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/ddos/dst/interface-ip



.. raw:: html

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


:ref:`827_interface-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/ddos/dst/interface-ip/{addr}



.. raw:: html

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


:ref:`827_interface-ip_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/ddos_dst_interface_ip_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _827_interface-ip_list:

interface-ip-list
-----------------


    interface-ip-list is **JSON List** of :ref:`827_interface-ip_attributes` 

        interface-ip-list : [

             { :ref:`827_interface-ip_attributes` },

             { :ref:`827_interface-ip_attributes` },

             ...

         ]

.. _827_interface-ip_attributes:

interface-ip attributes
-----------------------

    **addr**

        **Description** IP address of interface

        **Type:** string

        **Format:** ipv4-address

    **ip-proto-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/ddos/dst/interface-ip/{addr}/ip-proto/{port-num} <ddos_dst_interface_ip>`

    **l4-type-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/ddos/dst/interface-ip/{addr}/l4-type/{protocol} <ddos_dst_interface_ip>`

    **log-enable**

        **Description** Enable logging of limit exceed drops

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **log-periodic**

        **Description** Enable periodic log while event is continuing

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **port-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/ddos/dst/interface-ip/{addr}/port/{port-num}+{protocol} <ddos_dst_interface_ip>`

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

.. _827_port-list:

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

	 **Block object keys**             

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

    **deny**

        **Description** Blacklist and Drop all incoming packets for protocol

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **glid**

        **Description** Global limit ID

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/glid <glid>`

    **port-num**

        **Description** Port Number

        **Type:** number

        **Range:** 1-65535

    **protocol**

        **Description** 'tcp': tcp; 'udp': udp; 'http-probe': http port for interface health check; 

        **Type:** string

        **Supported Values:** tcp, udp, http-probe

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

.. _827_ip-proto-list:

ip-proto-list
^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **deny**

        **Description** Blacklist and Drop all incoming packets for protocol

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **glid**

        **Description** Global limit ID

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/glid <glid>`

    **port-num**

        **Description** IP protocol number

        **Type:** number

        **Range:** 0-255

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

.. _827_l4-type-list:

l4-type-list
^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **deny**

        **Description** Blacklist and Drop all incoming packets for protocol

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **drop-frag-pkt**

        **Description** Drop fragmented packets

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **glid**

        **Description** Global limit ID

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/glid <glid>`

    **protocol**

        **Description** 'tcp': tcp; 'udp': udp; 'icmp': icmp; 'other': other; 

        **Type:** string

        **Supported Values:** tcp, udp, icmp, other

    **tunnel-decap**

        **Description:** tunnel-decap is a **JSON Block**.  Please see below for :ref:`827_l4-type-list_tunnel-decap` 

        **Type:** Object

    **tunnel-rate-limit**

        **Description:** tunnel-rate-limit is a **JSON Block**.  Please see below for :ref:`827_l4-type-list_tunnel-rate-limit` 

        **Type:** Object

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

.. _827_l4-type-list_tunnel-decap:

l4-type-list_tunnel-decap
^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **gre-decap**

        **Description** Enable GRE Tunnel decapsulation

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **ip-decap**

        **Description** Enable IP Tunnel decapsulation

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **key-cfg**

        **Type:** List

.. _827_l4-type-list_tunnel-decap_key-cfg:

l4-type-list_tunnel-decap_key-cfg
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **key**

        **Description** Only decapsulate GRE packet with this key (Hexadecimal 0x0-0xFFFFFFFF,decimal 0-4294967295)

        **Type:** string

        **Maximum Length:** 10 characters

        **Maximum Length:** 1 characters

.. _827_l4-type-list_tunnel-rate-limit:

l4-type-list_tunnel-rate-limit
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **gre-rate-limit**

        **Description** Enable inner IP rate limiting on GRE traffic

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **ip-rate-limit**

        **Description** Enable inner IP rate limiting on IPinIP traffic

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0