.. _template_limit_policy:

template limit-policy
=====================

Create a Limit Policy


limit-policy Specification
--------------------------

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

	 **Object Key(s)**                     *policy-number*

	 **Collection Name**                   :ref:`2202_limit-policy_list`

	 **Collection URI**                    /axapi/v3/template/limit-policy

	                                       

	 **Element Name**                      limit-policy

	 **Element URI**                       /axapi/v3/template/limit-policy/{policy-number}

	 **Element Attributes**                limit-policy_attributes

	 **Schema**                             :download:`limit-policy schema <template-limit-policy/template-limit-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/template/limit-policy



.. raw:: html

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


:ref:`2202_limit-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/template/limit-policy



.. raw:: html

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


:ref:`2202_limit-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/template/limit-policy/{policy-number}



.. raw:: html

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


:ref:`2202_limit-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/template/limit-policy



.. raw:: html

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


:ref:`2202_limit-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/template/limit-policy/{policy-number}



.. raw:: html

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


:ref:`2202_limit-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/template/limit-policy/{policy-number}



.. raw:: html

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


:ref:`2202_limit-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/template/limit-policy



.. raw:: html

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


:ref:`2202_limit-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/template/limit-policy/{policy-number}



.. raw:: html

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


:ref:`2202_limit-policy_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _2202_limit-policy_list:

limit-policy-list
-----------------


    limit-policy-list is **JSON List** of :ref:`2202_limit-policy_attributes` 

        limit-policy-list : [

             { :ref:`2202_limit-policy_attributes` },

             { :ref:`2202_limit-policy_attributes` },

             ...

         ]

.. _2202_limit-policy_attributes:

limit-policy attributes
-----------------------

    **ddos-protection-factor**

        **Description** Enable DDoS Protection (Multiplier of the downlink PPS)

        **Type:** number

        **Range:** 1-50

    **downlink-pps**

        **Description** Downlink PPS limit (Number of Packets per second)

        **Type:** number

        **Range:** 1-2147483647

    **downlink-throughput**

        **Description** Downlink Throughput limit (Mega Bits per second)

        **Type:** number

        **Range:** 1-100000

    **limit-concurrent-sessions**

        **Description** Enable Concurrent Session Limit (Number of Concurrent Sessions)

        **Type:** number

        **Range:** 1-2147483647

    **limit-cps**

        **Description** Enable Connections Per Second Rate Limit (Number of Connections per second)

        **Type:** number

        **Range:** 1-2147483647

    **limit-rate**

        **Description** 'limit-pps': Enable Packets Per Second Rate Limit; 'limit-throughput': Enable Throughput Rate Limit; 

        **Type:** string

        **Supported Values:** limit-pps, limit-throughput

    **limit-scope**

        **Description** 'aggregate': Rule Level; 'subscriber-ip': Subscriber IP Level; 'subscriber-prefix': Subscriber Prefix Level; 

        **Type:** string

        **Supported Values:** aggregate, subscriber-ip, subscriber-prefix

        **Default:** subscriber-ip

    **log**

        **Description** Log when Session Limit is exceeded

        **Type:** boolean

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

        **Default:** 0

    **policy-number**

        **Description** Limit Policy Number

        **Type:** number

        **Range:** 1-1023

    **prefix-length**

        **Description** Prefix length

        **Type:** number

        **Range:** 1-128

    **total-pps**

        **Description** Total PPS limit (Number of Packets per second)

        **Type:** number

        **Range:** 1-2147483647

    **total-throughput**

        **Description** Total Throughput limit (Mega Bits per second)

        **Type:** number

        **Range:** 1-100000

    **uplink-pps**

        **Description** Uplink PPS limit (Number of Packets per second)

        **Type:** number

        **Range:** 1-2147483647

    **uplink-throughput**

        **Description** Uplink Throughput limit (Mega Bits per second)

        **Type:** number

        **Range:** 1-100000

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