.. _ddos_dst_zone_src_port_range:

ddos dst zone src-port-range
============================

DDOS Port & Protocol configuration


src-port-range Specification
----------------------------

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

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

	 **Object Key(s)**                     *src-port-range-start, src-port-range-end, protocol*

	 **Collection Name**                   :ref:`1015_src-port-range_list`

	 **Collection URI**                    /axapi/v3/ddos/dst/zone/{zone-name}/src-port-range

	                                       

	 **Element Name**                      src-port-range

	 **Element URI**                       /axapi/v3/ddos/dst/zone/{zone-name}/src-port-range/{src-port-range-start}+{src-port-range-end}+{protocol}

	 **Element Attributes**                src-port-range_attributes

	 **Partition Visibility**              shared

	 **Statistics Data URI**               /axapi/v3/ddos/dst/zone/{zone-name}/src-port-range/{src-port-range-start}+{src-port-range-end}+{protocol}/stats

	 **Operational Data URI**              /axapi/v3/ddos/dst/zone/{zone-name}/src-port-range/{src-port-range-start}+{src-port-range-end}+{protocol}/oper

	 **Schema**                             :download:`src-port-range schema <ddos-dst-zone-src-port-range/ddos-dst-zone-src-port-range.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/dst/zone/{zone-name}/src-port-range



.. raw:: html

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


:ref:`1015_src-port-range_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/dst/zone/{zone-name}/src-port-range



.. raw:: html

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


:ref:`1015_src-port-range_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/dst/zone/{zone-name}/src-port-range/{src-port-range-start}+{src-port-range-end}+{protocol}



.. raw:: html

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


:ref:`1015_src-port-range_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/dst/zone/{zone-name}/src-port-range



.. raw:: html

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


:ref:`1015_src-port-range_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/dst/zone/{zone-name}/src-port-range/{src-port-range-start}+{src-port-range-end}+{protocol}



.. raw:: html

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


:ref:`1015_src-port-range_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/dst/zone/{zone-name}/src-port-range/{src-port-range-start}+{src-port-range-end}+{protocol}



.. raw:: html

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


:ref:`1015_src-port-range_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/dst/zone/{zone-name}/src-port-range



.. raw:: html

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


:ref:`1015_src-port-range_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/dst/zone/{zone-name}/src-port-range/{src-port-range-start}+{src-port-range-end}+{protocol}



.. raw:: html

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


:ref:`1015_src-port-range_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _1015_src-port-range_list:

src-port-range-list
-------------------


    src-port-range-list is **JSON List** of :ref:`1015_src-port-range_attributes` 

        src-port-range-list : [

             { :ref:`1015_src-port-range_attributes` },

             { :ref:`1015_src-port-range_attributes` },

             ...

         ]

.. _1015_src-port-range_attributes:

src-port-range attributes
-------------------------

    **capture-config**

        **Description:** capture-config is a **JSON Block**.  Please see below for :ref:`1015_capture-config` 

        **Type:** Object

    **default-action-list**

        **Description** Configure default-action-list

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

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

    **deny**

        **Description** Blacklist and Drop all incoming packets for protocol

        **Type:** boolean

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

        **Default:** 0

    **glid-cfg**

        **Description:** glid-cfg is a **JSON Block**.  Please see below for :ref:`1015_glid-cfg` 

        **Type:** Object

    **level-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/ddos/dst/zone/{zone-name}/src-port-range/{src-port-range-start}+{src-port-range-end}+{protocol}/level/{level-num} <ddos_dst_zone>`

    **port-ind**

        **Description:** port-ind is a **JSON Block**.  Please see below for :ref:`1015_port-ind` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/ddos/dst/zone/{zone-name}/src-port-range/{src-port-range-start}+{src-port-range-end}+{protocol}/port-ind <ddos_dst_zone>`

    **protocol**

        **Description** 'udp': UDP port; 'tcp': TCP Port; 

        **Type:** string

        **Supported Values:** udp, tcp

    **set-counter-base-val**

        **Description** Set T2 counter value of current context to specified value

        **Type:** number

        **Range:** 1-4294967295

    **src-port-range-end**

        **Description** Src Port-Range End Port Number

        **Type:** number

        **Range:** 2-65535

    **src-port-range-start**

        **Description** Src Port-Range Start Port Number

        **Type:** number

        **Range:** 1-65535

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

    **zone-template**

        **Description:** zone-template is a **JSON Block**.  Please see below for :ref:`1015_zone-template` 

        **Type:** Object

.. _1015_capture-config:

capture-config
^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **capture-config-mode**

        **Description** 'drop': Apply capture-config to dropped packets; 'forward': Apply capture-config to forwarded packets; 'all': Apply capture-config to both dropped and forwarded packets; 

        **Type:** string

        **Supported Values:** drop, forward, all

    **capture-config-name**

        **Description** Capture-config name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

.. _1015_glid-cfg:

glid-cfg
^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **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>`

    **glid-action**

        **Description** 'drop': Drop packets for glid exceed (Default); 'ignore': Do nothing for glid exceed; 

        **Type:** string

        **Supported Values:** drop, ignore

.. _1015_zone-template:

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

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

    **src-tcp**

        **Description** DDOS tcp src template

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **src-udp**

        **Description** DDOS udp src template

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

.. _1015_port-ind:

port-ind
^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1015_level-list:

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

	 **Block object keys**             

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

    **indicator-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/ddos/dst/zone/{zone-name}/src-port-range/{src-port-range-start}+{src-port-range-end}+{protocol}/level/{level-num}/indicator/{type} <ddos_dst_zone>`

    **level-num**

        **Description** '0': Default policy level; '1': Policy level 1; 

        **Type:** string

        **Supported Values:** 0, 1

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

.. _1015_level-list_indicator-list:

level-list_indicator-list
^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **type**

        **Description** 'pkt-rate': rate of incoming packets; 'bit-rate': rate of incoming bits; 

        **Type:** string

        **Supported Values:** pkt-rate, bit-rate

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

    **zone-threshold-large-num**

        **Description** Threshold of the entire zone for the port-range

        **Type:** number

        **Range:** 1-10995116277760

    **zone-threshold-num**

        **Description** Threshold of the entire zone for the port-range

        **Type:** number

        **Range:** 1-2147483647