.. _ddos_network_object_ip:

ddos network-object ip
======================

DDOS Network-object IPv4 Subnet


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

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

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

	 **Object Key(s)**                     *subnet-ip-addr*

	 **Collection Name**                   :ref:`1124_ip_list`

	 **Collection URI**                    /axapi/v3/ddos/network-object/{object-name}/ip

	                                       

	 **Element Name**                      ip

	 **Element URI**                       /axapi/v3/ddos/network-object/{object-name}/ip/{subnet-ip-addr}

	 **Element Attributes**                ip_attributes

	 **Partition Visibility**              shared

	 **Statistics Data URI**               /axapi/v3/ddos/network-object/{object-name}/ip/{subnet-ip-addr}/stats

	 **Schema**                             :download:`ip schema <ddos-network-object-ip/ddos-network-object-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/network-object/{object-name}/ip



.. raw:: html

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


:ref:`1124_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/ddos/network-object/{object-name}/ip



.. raw:: html

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


:ref:`1124_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/network-object/{object-name}/ip/{subnet-ip-addr}



.. raw:: html

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


:ref:`1124_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/ddos/network-object/{object-name}/ip



.. raw:: html

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


:ref:`1124_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/network-object/{object-name}/ip/{subnet-ip-addr}



.. raw:: html

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


:ref:`1124_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/network-object/{object-name}/ip/{subnet-ip-addr}



.. raw:: html

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


:ref:`1124_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/ddos/network-object/{object-name}/ip



.. raw:: html

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


:ref:`1124_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/network-object/{object-name}/ip/{subnet-ip-addr}



.. raw:: html

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


:ref:`1124_ip_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _1124_ip_list:

ip-list
-------


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

        ip-list : [

             { :ref:`1124_ip_attributes` },

             { :ref:`1124_ip_attributes` },

             ...

         ]

.. _1124_ip_attributes:

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

    **prefix-anomaly-threshold**

        **Description:** prefix-anomaly-threshold is a **JSON Block**.  Please see below for :ref:`1124_prefix-anomaly-threshold` 

        **Type:** Object

    **sampling-enable**

        **Type:** List

    **subnet-ip-addr**

        **Description** IP Subnet, supported prefix range is from 8 to 31

        **Type:** string

        **Format:** ipv4-cidr

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

.. _1124_prefix-anomaly-threshold:

prefix-anomaly-threshold
^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **prefix-bit-rate**

        **Description** Bit rate of the prefix subnet

        **Type:** number

        **Range:** 800-34359738360

    **prefix-pkt-rate**

        **Description** Packet rate of the prefix subnet

        **Type:** number

        **Range:** 1-2147483647

.. _1124_sampling-enable:

sampling-enable
^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **counters1**

        **Description** 'all': all; 'packet_rate': PPS; 'bit_rate': B(bits)PS; 

        **Type:** string

        **Supported Values:** all, packet_rate, bit_rate