.. _ddos_src_port_template:

ddos src-port-template
======================

Define a DDOS src template


src-port-template Specification
-------------------------------

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

	===================================== ===============================================================
	 **Type**                              *Intermediate Resource*

	 **Element Name**                      src-port-template

	 **Element URI**                       /axapi/v3/ddos/src-port-template

	 **Element Attributes**                src-port-template_attributes

	 **Partition Visibility**              shared

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


Get Object



.. raw:: html

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


GET



.. raw:: html

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


/axapi/v3/ddos/src-port-template



.. raw:: html

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


src-port-template_attributes



.. raw:: html

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




.. raw:: html

   </table>

.. _1171_src-port-template_attributes:

src-port-template attributes
----------------------------

    **dns-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/ddos/src-port-template/dns/{name} <ddos_src_port_template_dns>`

    **tcp-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/ddos/src-port-template/tcp/{name} <ddos_src_port_template_tcp>`

    **udp-list**

        **Type:** List

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

.. _1171_udp-list:

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

	 **Block object keys**             

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

    **drop-ntp-monlist**

        **Description** Drop NTP monlist request/response

        **Type:** boolean

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

        **Default:** 0

    **filter-list**

        **Type:** List

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

    **max-payload-size**

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

        **Type:** number

        **Range:** 1-1470

    **min-payload-size**

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

        **Type:** number

        **Range:** 1-1470

    **name**

        **Description** DDOS UDP Template Name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

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

.. _1171_udp-list_filter-list:

udp-list_filter-list
^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **byte-offset-filter**

        **Description** Filter Expression using Berkeley Packet Filter syntax

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 1275 characters

        **Maximum Length:** 1 characters

    **udp-filter-action**

        **Description** 'blacklist-src': Also blacklist the source when action is taken; 'whitelist-src': Whitelist the source after filter passes, packets are dropped until then; 'count-only': Take no action and continue processing the next filter; 

        **Type:** string

        **Supported Values:** blacklist-src, whitelist-src, count-only

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

    **udp-filter-unmatched**

        **Description** action taken when it does not match

        **Type:** boolean

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

        **Default:** 0

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

.. _1171_dns-list:

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

	 **Block object keys**             

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

    **name**

        **Description** 

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **query-resolution-check**

        **Description:** query-resolution-check is a **JSON Block**.  Please see below for :ref:`1171_dns-list_query-resolution-check` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/ddos/src-port-template/dns/{name}/query-resolution-check <ddos_src_port_template_dns>`

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

.. _1171_dns-list_query-resolution-check:

dns-list_query-resolution-check
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **big-response-action**

        **Description** 'default': Default, No action for future connections; 'blacklist-src': Blacklist the external server for future connections; 

        **Type:** string

        **Supported Values:** default, blacklist-src

        **Default:** default

    **big-response-size**

        **Description** Max DNS response size (in Bytes)

        **Type:** number

        **Range:** 1-4096

    **domain-lockup-action**

        **Description** 'default': Default, No action for future connections; 'blacklist-src': Blacklist the external server for future connections; 

        **Type:** string

        **Supported Values:** default, blacklist-src

        **Default:** default

    **session-timeout-value**

        **Description** max session timeout (secs) between DNS external server and Protected object

        **Type:** number

        **Range:** 1-30

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1171_tcp-list:

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

	 **Block object keys**             

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

    **filter-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/ddos/src-port-template/tcp/{name}/filter/{tcp-filter-seq} <ddos_src_port_template_tcp>`

    **name**

        **Description** 

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

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

.. _1171_tcp-list_filter-list:

tcp-list_filter-list
^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **byte-offset-filter**

        **Description** Filter Expression using Berkeley Packet Filter syntax

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 1275 characters

        **Maximum Length:** 1 characters

    **tcp-filter-action**

        **Description** 'blacklist-src': Also blacklist the source when action is taken; 'whitelist-src': Whitelist the source after filter passes, packets are dropped until then; 'count-only': Take no action and continue processing the next filter; 

        **Type:** string

        **Supported Values:** blacklist-src, whitelist-src, count-only

    **tcp-filter-regex**

        **Description** Regex Expression

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 1275 characters

        **Maximum Length:** 1 characters

    **tcp-filter-seq**

        **Description** Sequence number

        **Type:** number

        **Range:** 1-5

    **tcp-filter-unmatched**

        **Description** action taken when it does not match

        **Type:** boolean

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

        **Default:** 0

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