.. _template_limit_policy_limit_throughput:

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

Enable Throughput Rate Limit


limit-throughput Specification
------------------------------

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

	===================================== ===============================================================================================
	 **Type**                              *Configuration Resource*

	 **Element Name**                      limit-throughput

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

	 **Element Attributes**                limit-throughput_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`limit-throughput schema <template-limit-policy-limit-throughput/template-limit-policy-limit-throughput.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/{policy-number}/limit-throughput



.. raw:: html

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


:ref:`3490_limit-throughput_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_limit_policy_limit_throughput_POST.txt
   :literal:




.. raw:: html

   </div></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}/limit-throughput



.. raw:: html

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


:ref:`3490_limit-throughput_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_limit_policy_limit_throughput_GET.txt
   :literal:




.. raw:: html

   </div></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}/limit-throughput



.. raw:: html

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


:ref:`3490_limit-throughput_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}/limit-throughput



.. raw:: html

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


:ref:`3490_limit-throughput_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_limit_policy_limit_throughput_PUT.txt
   :literal:




.. raw:: html

   </div></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}/limit-throughput



.. raw:: html

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


:ref:`3490_limit-throughput_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_limit_policy_limit_throughput_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _3490_limit-throughput_attributes:

limit-throughput attributes
---------------------------

    **downlink**

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

        **Type:** number

        **Range:** 1-100000

    **downlink-burstsize**

        **Description** Token Bucket Size (Must Exceed Configured Rate) (In Mega Bits per second)

        **Type:** number

        **Range:** 1-100000

    **downlink-relaxed**

        **Description** Relax the limitation when the policy has more tokens from the parent of policy

        **Type:** boolean

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

        **Default:** 0

    **total**

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

        **Type:** number

        **Range:** 1-100000

    **total-burstsize**

        **Description** Token Bucket Size (Must Exceed Configured Rate) (In Mega Bits per second)

        **Type:** number

        **Range:** 1-100000

    **total-relaxed**

        **Description** Relax the limitation when the policy has more tokens from the parent of policy

        **Type:** boolean

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

        **Default:** 0

    **uplink**

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

        **Type:** number

        **Range:** 1-100000

    **uplink-burstsize**

        **Description** Token Bucket Size (Must Exceed Configured Rate) (In Mega Bits per second)

        **Type:** number

        **Range:** 1-100000

    **uplink-relaxed**

        **Description** Relax the limitation when the policy has more tokens from the parent of policy

        **Type:** boolean

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

        **Default:** 0

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters