.. _template_gtp_rate_limit_policy:

template gtp rate-limit-policy
==============================

Configure GTP Rate Limit policy


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

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

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

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

	 **Collection Name**                   :ref:`3483_rate-limit-policy_list`

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

	                                       

	 **Element Name**                      rate-limit-policy

	 **Element URI**                       /axapi/v3/template/gtp/rate-limit-policy/{name}

	 **Element Attributes**                rate-limit-policy_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


:ref:`3483_rate-limit-policy_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/template_gtp_rate_limit_policy_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/template/gtp/rate-limit-policy



.. raw:: html

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


:ref:`3483_rate-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/gtp/rate-limit-policy/{name}



.. raw:: html

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


:ref:`3483_rate-limit-policy_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/template_gtp_rate_limit_policy_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/template/gtp/rate-limit-policy



.. raw:: html

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


:ref:`3483_rate-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/gtp/rate-limit-policy/{name}



.. raw:: html

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


:ref:`3483_rate-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/gtp/rate-limit-policy/{name}



.. raw:: html

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


:ref:`3483_rate-limit-policy_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/template_gtp_rate_limit_policy_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/template/gtp/rate-limit-policy



.. raw:: html

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


:ref:`3483_rate-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/gtp/rate-limit-policy/{name}



.. raw:: html

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


:ref:`3483_rate-limit-policy_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/template_gtp_rate_limit_policy_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _3483_rate-limit-policy_list:

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


    rate-limit-policy-list is **JSON List** of :ref:`3483_rate-limit-policy_attributes` 

        rate-limit-policy-list : [

             { :ref:`3483_rate-limit-policy_attributes` },

             { :ref:`3483_rate-limit-policy_attributes` },

             ...

         ]

.. _3483_rate-limit-policy_attributes:

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

    **gtp-u-downlink-byte-rate**

        **Description** Maximum allowed of rate of GTP-U bytes in downlink direction

        **Type:** number

        **Range:** 1-2147483647

    **gtp-u-downlink-packet-rate**

        **Description** Maximum allowed of rate of GTP-U packets in downlink direction

        **Type:** number

        **Range:** 1-2147483647

    **gtp-u-max-concurrent-tunnels**

        **Description** Maximum allowed GTP-U tunnels per Peer/APN Filter

        **Type:** number

        **Range:** 1-2147483647

    **gtp-u-total-byte-rate**

        **Description** Maximum allowed of rate of GTP-U bytes total in both directions

        **Type:** number

        **Range:** 1-2147483647

    **gtp-u-total-packet-rate**

        **Description** Maximum allowed of rate of GTP-U packets total in both directions

        **Type:** number

        **Range:** 1-2147483647

    **gtp-u-tunnel-create-rate**

        **Description** Maximum allowed of rate of GTP-U tunnels

        **Type:** number

        **Range:** 1-2147483647

    **gtp-u-uplink-byte-rate**

        **Description** Maximum allowed of rate of GTP-U bytes in uplink direction

        **Type:** number

        **Range:** 1-2147483647

    **gtp-u-uplink-packet-rate**

        **Description** Maximum allowed of rate of GTP-U packets in uplink direction

        **Type:** number

        **Range:** 1-2147483647

    **lockout**

        **Description** Lockout traffic from the source for a certain time period after rate exceeded (Lockout duration in minutes)

        **Type:** number

        **Range:** 1-1023

    **name**

        **Description** Specify name of the GTP Rate Limit Policy

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **rate-limit-action**

        **Description** 'monitor': Forward packet exceeding limit; 'drop': drop packet exceeding limit(default); 

        **Type:** string

        **Supported Values:** monitor, drop

        **Default:** drop

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

    **v0-agg-message-type-rate**

        **Description** Maximum allowed GTPv0-C message rate of all types

        **Type:** number

        **Range:** 1-2147483647

    **v1-agg-message-type-rate**

        **Description** Maximum allowed GTPv1-C message rate of all types

        **Type:** number

        **Range:** 1-2147483647

    **v1-create-pdp-request-rate**

        **Description** Maximum allowed rate of GTPv1-C Create PDP Request message type

        **Type:** number

        **Range:** 1-2147483647

    **v1-update-pdp-request-rate**

        **Description** Maximum allowed rate of GTPv1-C Update PDP Request message type

        **Type:** number

        **Range:** 1-2147483647

    **v2-agg-message-type-rate**

        **Description** Maximum allowed GTPv2-C message rate of all types

        **Type:** number

        **Range:** 1-2147483647

    **v2-create-session-request-rate**

        **Description** Maximum allowed rate of GTPv2-C Create Session Request message type

        **Type:** number

        **Range:** 1-2147483647

    **v2-modify-bearer-request-rate**

        **Description** Maximum allowed rate of GTPv2-C Modify Bearer Request message type

        **Type:** number

        **Range:** 1-2147483647