.. _ddos_src_default:

ddos src default
================

Configure IP/IPv6 default entry


default Specification
---------------------

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

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

	 **Object Key(s)**                     *default-address-type*

	 **Collection Name**                   :ref:`1106_default_list`

	 **Collection URI**                    /axapi/v3/ddos/src/default

	                                       

	 **Element Name**                      default

	 **Element URI**                       /axapi/v3/ddos/src/default/{default-address-type}

	 **Element Attributes**                default_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


:ref:`1106_default_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_src_default_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/src/default



.. raw:: html

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


:ref:`1106_default_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/src/default/{default-address-type}



.. raw:: html

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


:ref:`1106_default_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_src_default_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/src/default



.. raw:: html

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


:ref:`1106_default_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/src/default/{default-address-type}



.. raw:: html

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


:ref:`1106_default_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/src/default/{default-address-type}



.. raw:: html

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


:ref:`1106_default_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_src_default_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/src/default



.. raw:: html

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


:ref:`1106_default_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/src/default/{default-address-type}



.. raw:: html

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


:ref:`1106_default_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_src_default_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _1106_default_list:

default-list
------------


    default-list is **JSON List** of :ref:`1106_default_attributes` 

        default-list : [

             { :ref:`1106_default_attributes` },

             { :ref:`1106_default_attributes` },

             ...

         ]

.. _1106_default_attributes:

default attributes
------------------

    **age**

        **Description** Idle age for ip entry

        **Type:** number

        **Range:** 2-1023

        **Default:** 5

    **app-type-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/ddos/src/default/{default-address-type}/app-type/{protocol} <ddos_src_default>`

    **apply-policy-on-overflow**

        **Description** Enable this flag to apply overflow policy when dynamic entry count overflows

        **Type:** boolean

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

        **Default:** 0

    **default-address-type**

        **Description** 'ip': ip; 'ipv6': ipv6; 

        **Type:** string

        **Supported Values:** ip, ipv6

    **disable**

        **Description** Disable

        **Type:** boolean

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

        **Default:** 0

    **exceed-log-cfg**

        **Description:** exceed-log-cfg is a **JSON Block**.  Please see below for :ref:`1106_exceed-log-cfg` 

        **Type:** Object

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

    **l4-type-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/ddos/src/default/{default-address-type}/l4-type/{protocol} <ddos_src_default>`

    **log-periodic**

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

        **Type:** boolean

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

        **Default:** 0

    **max-dynamic-entry-count**

        **Description** Maximum count for dynamic src entry

        **Type:** number

        **Range:** 0-2147483647

    **template**

        **Description:** template is a **JSON Block**.  Please see below for :ref:`1106_template` 

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

.. _1106_app-type-list:

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

	 **Block object keys**             

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

    **protocol**

        **Description** 'dns': dns; 'http': http; 'ssl-l4': ssl-l4; 'sip': sip; 

        **Type:** string

        **Supported Values:** dns, http, ssl-l4, sip

    **template**

        **Description:** template is a **JSON Block**.  Please see below for :ref:`1106_app-type-list_template` 

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

.. _1106_app-type-list_template:

app-type-list_template
^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **dns**

        **Description** DDOS dns template

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **http**

        **Description** DDOS http template

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **sip**

        **Description** DDOS sip template

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **ssl-l4**

        **Description** DDOS SSL-L4 template

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

.. _1106_template:

template
^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **logging**

        **Description** DDOS logging template

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

.. _1106_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

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

    **template**

        **Description:** template is a **JSON Block**.  Please see below for :ref:`1106_l4-type-list_template` 

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

.. _1106_l4-type-list_template:

l4-type-list_template
^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **other**

        **Description** DDOS OTHER template

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **tcp**

        **Description** DDOS TCP template

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **template-icmp-v4**

        **Description** DDOS icmp-v4 template

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **template-icmp-v6**

        **Description** DDOS icmp-v6 template

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **udp**

        **Description** DDOS UDP template

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

.. _1106_exceed-log-cfg:

exceed-log-cfg
^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **log-enable**

        **Description** Enable logging of limit exceed drop's

        **Type:** boolean

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

        **Default:** 0