.. _ddos_network_object:

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

Configure DDoS a static Monitor Network Object


network-object Specification
----------------------------

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

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

	 **Object Key(s)**                     *object-name*

	 **Collection Name**                   :ref:`1102_network-object_list`

	 **Collection URI**                    /axapi/v3/ddos/network-object

	                                       

	 **Element Name**                      network-object

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

	 **Element Attributes**                network-object_attributes

	 **Partition Visibility**              shared

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

	 **Operational Data URI**              /axapi/v3/ddos/network-object/{object-name}/oper

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



.. raw:: html

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


:ref:`1102_network-object_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



.. raw:: html

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


:ref:`1102_network-object_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}



.. raw:: html

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


:ref:`1102_network-object_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



.. raw:: html

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


:ref:`1102_network-object_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}



.. raw:: html

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


:ref:`1102_network-object_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}



.. raw:: html

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


:ref:`1102_network-object_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



.. raw:: html

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


:ref:`1102_network-object_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}



.. raw:: html

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


:ref:`1102_network-object_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _1102_network-object_list:

network-object-list
-------------------


    network-object-list is **JSON List** of :ref:`1102_network-object_attributes` 

        network-object-list : [

             { :ref:`1102_network-object_attributes` },

             { :ref:`1102_network-object_attributes` },

             ...

         ]

.. _1102_network-object_attributes:

network-object attributes
-------------------------

    **anomaly-detection-trigger**

        **Description** 'all': Use both learned and static thresholds (static thresholds take precedence); 'static-threshold-only': Use static thresholds only; 

        **Type:** string

        **Supported Values:** all, static-threshold-only

        **Default:** all

    **histogram-enable**

        **Description** Enable histogram statistics (Default: Disabled)

        **Type:** boolean

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

        **Default:** 0

    **host-anomaly-threshold**

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

        **Type:** Object

    **ip**

        **Type:** List

    **ipv6**

        **Type:** List

    **network-object-anomaly-threshold**

        **Description:** network-object-anomaly-threshold is a **JSON Block**.  Please see below for :ref:`1102_network-object-anomaly-threshold` 

        **Type:** Object

    **notification**

        **Description:** notification is a **JSON Block**.  Please see below for :ref:`1102_notification` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/ddos/network-object/{object-name}/notification <ddos_network_object>`

    **object-name**

        **Description** 

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **operational-mode**

        **Description** 'monitor': Monitor mode; 'learning': Learning mode; 

        **Type:** string

        **Supported Values:** monitor, learning

        **Default:** learning

    **relative-auto-break-down-threshold**

        **Description:** relative-auto-break-down-threshold is a **JSON Block**.  Please see below for :ref:`1102_relative-auto-break-down-threshold` 

        **Type:** Object

    **sampling-enable**

        **Type:** List

    **service-break-down-threshold-local**

        **Description:** service-break-down-threshold-local is a **JSON Block**.  Please see below for :ref:`1102_service-break-down-threshold-local` 

        **Type:** Object

    **service-discovery**

        **Description** 'disable': Disable service discovery for hosts (default: enabled); 

        **Type:** string

        **Supported Values:** disable

    **static-auto-break-down-threshold**

        **Description:** static-auto-break-down-threshold is a **JSON Block**.  Please see below for :ref:`1102_static-auto-break-down-threshold` 

        **Type:** Object

    **sub-network-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/ddos/network-object/{object-name}/sub-network/{subnet-ip-addr} <ddos_network_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

.. _1102_network-object-anomaly-threshold:

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

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

    **network-object-byte-rate**

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

        **Type:** number

        **Range:** 100-10995116277760

    **network-object-pkt-rate**

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

        **Type:** number

        **Range:** 1-10995116277760

.. _1102_ip:

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

	 **Block object keys**             

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

    **subnet-ip-addr**

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

        **Type:** string

        **Format:** ipv4-cidr

.. _1102_service-break-down-threshold-local:

service-break-down-threshold-local
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **svc-percentage**

        **Description** percentage of parent ip node

        **Type:** number

        **Range:** 5-99

.. _1102_relative-auto-break-down-threshold:

relative-auto-break-down-threshold
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **network-percentage**

        **Description** percentage of parent node

        **Type:** number

        **Range:** 1-99

    **permil**

        **Description** permil of root node

        **Type:** number

        **Range:** 1-999

.. _1102_sampling-enable:

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

	 **Block object keys**             

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

    **counters1**

        **Description** 'all': all; 'subnet_learned': Subnet Entry Learned; 'subnet_aged': Subnet Entry Aged; 'ip_learned': IP Entry Learned; 'ip_aged': IP Entry Aged; 'service_learned': Service Entry Learned; 'service_aged': Service Entry Aged; 

        **Type:** string

        **Supported Values:** all, subnet_learned, subnet_aged, subnet_create_fail, ip_learned, ip_aged, ip_create_fail, service_learned, service_aged, service_create_fail

.. _1102_ipv6:

ipv6
^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **subnet-ipv6-addr**

        **Description** IPV6 Subnet, supported prefix range is from 40 to 63

        **Type:** string

        **Format:** ipv6-address-plen

.. _1102_sub-network-list:

sub-network-list
^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **host-anomaly-threshold**

        **Description:** host-anomaly-threshold is a **JSON Block**.  Please see below for :ref:`1102_sub-network-list_host-anomaly-threshold` 

        **Type:** Object

    **sub-network-anomaly-threshold**

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

        **Type:** Object

    **subnet-ip-addr**

        **Description** IPv4 Subnet/host, 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

.. _1102_sub-network-list_sub-network-anomaly-threshold:

sub-network-list_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

.. _1102_sub-network-list_host-anomaly-threshold:

sub-network-list_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

.. _1102_notification:

notification
^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **configuration**

        **Description** 'configuration': configuration; 

        **Type:** string

        **Supported Values:** configuration

    **notification**

        **Type:** List

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1102_notification_notification:

notification_notification
^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **notification-template-name**

        **Description** Specify the notification template name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/ddos/notification-template <ddos_notification_template>`

.. _1102_host-anomaly-threshold:

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

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

    **host-byte-rate**

        **Description** Byte rate of per host

        **Type:** number

        **Range:** 100-4294967295

    **host-pkt-rate**

        **Description** Packet rate of per host

        **Type:** number

        **Range:** 1-2147483647

.. _1102_static-auto-break-down-threshold:

static-auto-break-down-threshold
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **network-pkt-rate**

        **Description** packet rate of current node

        **Type:** number

        **Range:** 100-2000000