.. _ddos_dst_zone_port_range_src_based_policy:

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

Configure src-based policy


src-based-policy Specification
------------------------------

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

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

	 **Object Key(s)**                     *src-based-policy-name*

	 **Collection Name**                   :ref:`927_src-based-policy_list`

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

	                                       

	 **Element Name**                      src-based-policy

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

	 **Element Attributes**                src-based-policy_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`src-based-policy schema <ddos-dst-zone-port-range-src-based-policy/ddos-dst-zone-port-range-src-based-policy.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}/port-range/{port-range-start}+{port-range-end}+{protocol}/src-based-policy



.. raw:: html

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


:ref:`927_src-based-policy_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}/port-range/{port-range-start}+{port-range-end}+{protocol}/src-based-policy



.. raw:: html

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


:ref:`927_src-based-policy_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}/port-range/{port-range-start}+{port-range-end}+{protocol}/src-based-policy/{src-based-policy-name}



.. raw:: html

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


:ref:`927_src-based-policy_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}/port-range/{port-range-start}+{port-range-end}+{protocol}/src-based-policy



.. raw:: html

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


:ref:`927_src-based-policy_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}/port-range/{port-range-start}+{port-range-end}+{protocol}/src-based-policy/{src-based-policy-name}



.. raw:: html

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


:ref:`927_src-based-policy_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}/port-range/{port-range-start}+{port-range-end}+{protocol}/src-based-policy/{src-based-policy-name}



.. raw:: html

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


:ref:`927_src-based-policy_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}/port-range/{port-range-start}+{port-range-end}+{protocol}/src-based-policy



.. raw:: html

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


:ref:`927_src-based-policy_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}/port-range/{port-range-start}+{port-range-end}+{protocol}/src-based-policy/{src-based-policy-name}



.. raw:: html

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


:ref:`927_src-based-policy_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _927_src-based-policy_list:

src-based-policy-list
---------------------


    src-based-policy-list is **JSON List** of :ref:`927_src-based-policy_attributes` 

        src-based-policy-list : [

             { :ref:`927_src-based-policy_attributes` },

             { :ref:`927_src-based-policy_attributes` },

             ...

         ]

.. _927_src-based-policy_attributes:

src-based-policy attributes
---------------------------

    **policy-class-list-list**

        **Type:** List

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

    **src-based-policy-name**

        **Description** Specify name of the policy

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

.. _927_policy-class-list-list:

policy-class-list-list
^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **action**

        **Description** 'bypass': Always permit for the Source to bypass all feature & limit checks; 'deny': Blacklist incoming packets for service; 

        **Type:** string

        **Supported Values:** bypass, deny

    **class-list-name**

        **Description** Class-list name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **class-list-overflow-policy-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/ddos/dst/zone/{zone-name}/port-range/{port-range-start}+{port-range-end}+{protocol}/src-based-policy/{src-based-policy-name}/policy-class-list/{class-list-name}/class-list-overflow-policy/{dummy-name} <ddos_dst_zone>`

    **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); 'blacklist-src': Blacklist-src for glid exceed; 'ignore': Do nothing for glid exceed; 

        **Type:** string

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

    **max-dynamic-entry-count**

        **Description** Maximum count for dynamic source zone service entry allowed for this class-list

        **Type:** number

        **Range:** 0-2147483647

    **sampling-enable**

        **Type:** List

    **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:`927_policy-class-list-list_zone-template` 

        **Type:** Object

.. _927_policy-class-list-list_zone-template:

policy-class-list-list_zone-template
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **dns**

        **Description** DDOS dns template

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **encap**

        **Description** DDOS encap template (IPv6-over-IPv4 / IPv4-over-IPv6 are not supported.)

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **http**

        **Description** DDOS http template

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **logging**

        **Description** DDOS logging template

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **quic**

        **Description** DDOS quic template

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **sip**

        **Description** DDOS sip template

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **ssl-l4**

        **Description** DDOS ssl-l4 template

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **tcp**

        **Description** DDOS tcp template

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **udp**

        **Description** DDOS udp template

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

.. _927_policy-class-list-list_sampling-enable:

policy-class-list-list_sampling-enable
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **counters1**

        **Description** 'all': all; 'packet_received': Packets Received; 'packet_dropped': Packets Dropped; 'entry_learned': Entry Learned; 'entry_count_overflow': Entry Count Overflow; 

        **Type:** string

        **Supported Values:** all, packet_received, packet_dropped, entry_learned, entry_count_overflow

.. _927_policy-class-list-list_class-list-overflow-policy-list:

policy-class-list-list_class-list-overflow-policy-list
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **action**

        **Description** 'bypass': Always permit for the Source to bypass all feature & limit checks; 'deny': Blacklist incoming packets for service; 

        **Type:** string

        **Supported Values:** bypass, deny

    **dummy-name**

        **Description** 'configuration': Configure overflow policy for class-list; 

        **Type:** string

        **Supported Values:** configuration

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

    **log-enable**

        **Description** Enable logging

        **Type:** boolean

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

        **Default:** 0

    **log-periodic**

        **Description** Enable log periodic

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

    **zone-template**

        **Description:** zone-template is a **JSON Block**.  Please see below for :ref:`927_policy-class-list-list_class-list-overflow-policy-list_zone-template` 

        **Type:** Object

.. _927_policy-class-list-list_class-list-overflow-policy-list_zone-template:

policy-class-list-list_class-list-overflow-policy-list_zone-template
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **dns**

        **Description** DDOS dns template

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **encap**

        **Description** DDOS encap template (IPv6-over-IPv4 / IPv4-over-IPv6 are not supported.)

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **http**

        **Description** DDOS http template

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **logging**

        **Description** DDOS logging template

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **quic**

        **Description** DDOS quic template

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **sip**

        **Description** DDOS sip template

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **ssl-l4**

        **Description** DDOS ssl-l4 template

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **tcp**

        **Description** DDOS tcp template

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **udp**

        **Description** DDOS udp template

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters