.. _ddos_zone_src_port_template_udp:

ddos zone-src-port-template udp
===============================

UDP template configuration


udp Specification
-----------------

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

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

	 **Object Key(s)**                     *name*

	 **Collection Name**                   :ref:`1243_udp_list`

	 **Collection URI**                    /axapi/v3/ddos/zone-src-port-template/udp

	                                       

	 **Element Name**                      udp

	 **Element URI**                       /axapi/v3/ddos/zone-src-port-template/udp/{name}

	 **Element Attributes**                udp_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`udp schema <ddos-zone-src-port-template-udp/ddos-zone-src-port-template-udp.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/zone-src-port-template/udp



.. raw:: html

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


:ref:`1243_udp_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_zone_src_port_template_udp_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/zone-src-port-template/udp



.. raw:: html

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


:ref:`1243_udp_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/zone-src-port-template/udp/{name}



.. raw:: html

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


:ref:`1243_udp_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_zone_src_port_template_udp_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/zone-src-port-template/udp



.. raw:: html

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


:ref:`1243_udp_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/zone-src-port-template/udp/{name}



.. raw:: html

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


:ref:`1243_udp_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/zone-src-port-template/udp/{name}



.. raw:: html

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


:ref:`1243_udp_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_zone_src_port_template_udp_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/zone-src-port-template/udp



.. raw:: html

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


:ref:`1243_udp_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/zone-src-port-template/udp/{name}



.. raw:: html

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


:ref:`1243_udp_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_zone_src_port_template_udp_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _1243_udp_list:

udp-list
--------


    udp-list is **JSON List** of :ref:`1243_udp_attributes` 

        udp-list : [

             { :ref:`1243_udp_attributes` },

             { :ref:`1243_udp_attributes` },

             ...

         ]

.. _1243_udp_attributes:

udp attributes
--------------

    **filter-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/ddos/zone-src-port-template/udp/{name}/filter/{udp-filter-name} <ddos_zone_src_port_template_udp>`

    **filter-match-type**

        **Description** 'default': Stop matching on drop/blacklist action; 'stop-on-first-match': Stop matching on first match; 

        **Type:** string

        **Supported Values:** default, stop-on-first-match

        **Default:** default

    **max-payload-size-cfg**

        **Description:** max-payload-size-cfg is a **JSON Block**.  Please see below for :ref:`1243_max-payload-size-cfg` 

        **Type:** Object

    **min-payload-size-cfg**

        **Description:** min-payload-size-cfg is a **JSON Block**.  Please see below for :ref:`1243_min-payload-size-cfg` 

        **Type:** Object

    **name**

        **Description** DDOS UDP Template Name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **ntp-monlist-cfg**

        **Description:** ntp-monlist-cfg is a **JSON Block**.  Please see below for :ref:`1243_ntp-monlist-cfg` 

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

.. _1243_ntp-monlist-cfg:

ntp-monlist-cfg
^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **ntp-monlist**

        **Description** Take action for ntp monlist request/response

        **Type:** boolean

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

        **Default:** 0

    **ntp-monlist-action**

        **Description** 'drop': Drop packets for ntp-monlist (Default); 'blacklist-src': Blacklist-src for ntp-monlist; 'ignore': Ignore ntp-monlist; 

        **Type:** string

        **Supported Values:** drop, blacklist-src, ignore

        **Mutual Exclusion:** ntp-monlist-action and ntp-monlist-action-list-name are mutually exclusive

    **ntp-monlist-action-list-name**

        **Description** Configure action-list to take for ntp-monlist

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

        **Mutual Exclusion:** ntp-monlist-action-list-name and ntp-monlist-action are mutually exclusive

        **Reference Object:** :doc:`/axapi/v3/ddos/action-list <ddos_action_list>`

.. _1243_max-payload-size-cfg:

max-payload-size-cfg
^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **max-payload-size**

        **Description** Maximum UDP payload size for each single packet

        **Type:** number

        **Range:** 1-1470

    **max-payload-size-action**

        **Description** 'drop': Drop packets for max-payload-size exceed (Default); 'blacklist-src': Blacklist-src for max-payload-size exceed; 'ignore': Do nothing for max-payload-size exceed; 

        **Type:** string

        **Supported Values:** drop, blacklist-src, ignore

        **Mutual Exclusion:** max-payload-size-action and max-payload-size-action-list-name are mutually exclusive

    **max-payload-size-action-list-name**

        **Description** Configure action-list to take for max-payload-size exceed

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

        **Mutual Exclusion:** max-payload-size-action-list-name and max-payload-size-action are mutually exclusive

        **Reference Object:** :doc:`/axapi/v3/ddos/action-list <ddos_action_list>`

.. _1243_min-payload-size-cfg:

min-payload-size-cfg
^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **min-payload-size**

        **Description** Minimum UDP payload size for each single packet

        **Type:** number

        **Range:** 1-1470

    **min-payload-size-action**

        **Description** 'drop': Drop packets for min-payload-size (Default); 'blacklist-src': Blacklist-src for min-payload-size; 'ignore': Do nothing for min-payload-size exceed; 

        **Type:** string

        **Supported Values:** drop, blacklist-src, ignore

        **Mutual Exclusion:** min-payload-size-action and min-payload-size-action-list-name are mutually exclusive

    **min-payload-size-action-list-name**

        **Description** Configure action-list to take for min-payload-size exceed

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

        **Mutual Exclusion:** min-payload-size-action-list-name and min-payload-size-action are mutually exclusive

        **Reference Object:** :doc:`/axapi/v3/ddos/action-list <ddos_action_list>`

.. _1243_filter-list:

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

	 **Block object keys**             

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

    **byte-offset-filter**

        **Description** Filter using Berkeley Packet Filter syntax

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 1275 characters

        **Maximum Length:** 1 characters

    **udp-filter-action**

        **Description** 'drop': Drop packets (Default); 'ignore': Take no action; 'blacklist-src': Blacklist-src; 'authenticate-src': Authenticate-src; 

        **Type:** string

        **Supported Values:** drop, ignore, blacklist-src, authenticate-src

        **Mutual Exclusion:** udp-filter-action and udp-filter-action-list-name are mutually exclusive

    **udp-filter-action-list-name**

        **Description** Configure action-list to take

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

        **Mutual Exclusion:** udp-filter-action-list-name and udp-filter-action are mutually exclusive

    **udp-filter-inverse-match**

        **Description** Inverse the result of the matching

        **Type:** boolean

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

        **Default:** 0

    **udp-filter-name**

        **Description** 

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **udp-filter-regex**

        **Description** Regex Expression

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 1275 characters

        **Maximum Length:** 1 characters

    **udp-filter-seq**

        **Description** Sequence number

        **Type:** number

        **Range:** 1-200

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