.. _ddos_system_default:

ddos system-default
===================

Configure system default values for DDOS


system-default Specification
----------------------------

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

	===================================== ============================================================
	 **Type**                              *Configuration Resource*

	 **Element Name**                      system-default

	 **Element URI**                       /axapi/v3/ddos/system-default

	 **Element Attributes**                system-default_attributes

	 **Partition Visibility**              shared

	 **Operational Data URI**              /axapi/v3/ddos/system-default/oper

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



.. raw:: html

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


:ref:`1179_system-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_system_default_POST.txt
   :literal:




.. raw:: html

   </div></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/system-default



.. raw:: html

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


:ref:`1179_system-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_system_default_GET.txt
   :literal:




.. raw:: html

   </div></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/system-default



.. raw:: html

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


:ref:`1179_system-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/system-default



.. raw:: html

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


:ref:`1179_system-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_system_default_PUT.txt
   :literal:




.. raw:: html

   </div></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/system-default



.. raw:: html

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


:ref:`1179_system-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_system_default_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _1179_system-default_attributes:

system-default attributes
-------------------------

    **limit-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/ddos/system-default/limit/{limit-type} <ddos_system_default_limit>`

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1179_limit-list:

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

	 **Block object keys**             

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

    **default-bit-rate-limit**

        **Description** Configure Default Kibit (kibibit / 1024-bit) rate limit

        **Type:** number

        **Range:** 1-16000000

    **default-conn-limit**

        **Description** Configure Default Connection limit

        **Type:** number

        **Range:** 1-16000000

    **default-conn-rate-limit**

        **Description** Configure Default Connection rate limit

        **Type:** number

        **Range:** 1-16000000

    **default-frag-pkt-rate-limit**

        **Description** Configure Default Fragmented packet rate limit

        **Type:** number

        **Range:** 1-16000000

    **default-over-limit-action**

        **Description:** default-over-limit-action is a **JSON Block**.  Please see below for :ref:`1179_limit-list_default-over-limit-action` 

        **Type:** Object

    **default-pkt-rate-limit**

        **Description** Configure Default Packet rate limit

        **Type:** number

        **Range:** 1-16000000

    **limit-type**

        **Description** 'dst-entry': dst-entry; 'dst-icmp': dst-icmp; 'dst-other': dst-other; 'dst-tcp': dst-tcp; 'dst-udp': dst-udp; 'src-entry': src-entry; 'src-icmp': src-icmp; 'src-other': src-other; 'src-tcp': src-tcp; 'src-udp': src-udp; 

        **Type:** string

        **Supported Values:** dst-entry, dst-icmp, dst-other, dst-tcp, dst-udp, src-entry, src-icmp, src-other, src-tcp, src-udp

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

.. _1179_limit-list_default-over-limit-action:

limit-list_default-over-limit-action
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **drop**

        **Description** Silently Drop the new connection / new packet when it exceeds limit

        **Type:** boolean

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

        **Default:** 0