.. _ddos_network_object_sub_network:

ddos network-object sub-network
===============================

Configure sub-network in a DDos Network Object


sub-network Specification
-------------------------

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

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

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

	 **Collection Name**                   :ref:`1101_sub-network_list`

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

	                                       

	 **Element Name**                      sub-network

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

	 **Element Attributes**                sub-network_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`sub-network schema <ddos-network-object-sub-network/ddos-network-object-sub-network.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}/sub-network



.. raw:: html

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


:ref:`1101_sub-network_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}/sub-network



.. raw:: html

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


:ref:`1101_sub-network_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}/sub-network/{subnet-ip-addr}



.. raw:: html

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


:ref:`1101_sub-network_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}/sub-network



.. raw:: html

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


:ref:`1101_sub-network_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}/sub-network/{subnet-ip-addr}



.. raw:: html

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


:ref:`1101_sub-network_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}/sub-network/{subnet-ip-addr}



.. raw:: html

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


:ref:`1101_sub-network_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}/sub-network



.. raw:: html

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


:ref:`1101_sub-network_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}/sub-network/{subnet-ip-addr}



.. raw:: html

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


:ref:`1101_sub-network_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _1101_sub-network_list:

sub-network-list
----------------


    sub-network-list is **JSON List** of :ref:`1101_sub-network_attributes` 

        sub-network-list : [

             { :ref:`1101_sub-network_attributes` },

             { :ref:`1101_sub-network_attributes` },

             ...

         ]

.. _1101_sub-network_attributes:

sub-network attributes
----------------------

    **host-anomaly-threshold**

        **Description:** host-anomaly-threshold is a **JSON Block**.  Please see below for :ref:`1101_host-anomaly-threshold` 

        **Type:** Object

    **sub-network-anomaly-threshold**

        **Description:** sub-network-anomaly-threshold is a **JSON Block**.  Please see below for :ref:`1101_sub-network-anomaly-threshold` 

        **Type:** Object

    **subnet-ip-addr**

        **Description** IPv4 Subnet, supported prefix range is from 24 to 32

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

.. _1101_sub-network-anomaly-threshold:

sub-network-anomaly-threshold
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **static-sub-network-byte-rate**

        **Description** Byte rate of the sub-network

        **Type:** number

        **Range:** 100-4294967295

    **static-sub-network-pkt-rate**

        **Description** Packet rate of the sub-network

        **Type:** number

        **Range:** 1-2147483647

.. _1101_host-anomaly-threshold:

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

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

    **static-byte-rate-threshold**

        **Description** Byte rate of per host

        **Type:** number

        **Range:** 100-4294967295

    **static-pkt-rate-threshold**

        **Description** Packet rate of per host

        **Type:** number

        **Range:** 1-2147483647