.. _fw_rate_limit_oper:

fw rate-limit oper
==================

Operational Status for the object rate-limit


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

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

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

	 **Element Name**                      rate-limit

	 **Element URI**                       /axapi/v3/fw/rate-limit/oper

	 **Element Attributes**                rate-limit_attributes

	 **Partition Visibility**              None

	 **Schema**                             :download:`rate-limit schema <fw-rate-limit-oper/fw-rate-limit-oper.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/fw/rate-limit/oper



.. raw:: html

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


:ref:`1652_rate-limit_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/fw/rate-limit/oper



.. raw:: html

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


:ref:`1652_rate-limit_attributes`



.. 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/fw/rate-limit/oper



.. raw:: html

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


:ref:`1652_rate-limit_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/fw/rate-limit/oper



.. raw:: html

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


:ref:`1652_rate-limit_attributes`



.. 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/fw/rate-limit/oper



.. raw:: html

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


:ref:`1652_rate-limit_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _1652_rate-limit_attributes:

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

    **oper**

        **Description:** oper is a **JSON Block**.  Please see below for :ref:`1652_oper` 

        **Type:** Object

    **summary**

        **Description:** summary is a **JSON Block**.  Please see below for :ref:`1652_summary` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/fw/rate-limit/summary <fw_rate_limit_summary>`

.. _1652_oper:

oper
^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **rate-limit-list**

        **Type:** List

    **template-id**

        **Description** 

        **Type:** number

    **v4-address**

        **Description** 

        **Type:** string

        **Format:** ipv4-address

    **v4-netmask**

        **Description** 

        **Type:** string

        **Format:** ipv4-netmask-brief

    **v6-prefix**

        **Description** 

        **Type:** string

        **Format:** ipv6-address-plen

.. _1652_oper_rate-limit-list:

oper_rate-limit-list
^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **address**

        **Description** 

        **Type:** string

    **cps-allowed**

        **Description** 

        **Type:** number

    **cps-received**

        **Description** 

        **Type:** number

    **downlink-traffic-allowed**

        **Description** 

        **Type:** number

    **downlink-traffic-received**

        **Description** 

        **Type:** number

    **drop-count**

        **Description** 

        **Type:** number

    **prefix-len**

        **Description** 

        **Type:** number

    **rule-name**

        **Description** 

        **Type:** string

    **template-id**

        **Description** 

        **Type:** number

    **total-traffic-allowed**

        **Description** 

        **Type:** number

    **total-traffic-received**

        **Description** 

        **Type:** number

    **type**

        **Description** 

        **Type:** string

    **uplink-traffic-allowed**

        **Description** 

        **Type:** number

    **uplink-traffic-received**

        **Description** 

        **Type:** number

.. _1652_summary:

summary
^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **oper**

        **Description:** oper is a **JSON Block**.  Please see below for :ref:`1652_summary_oper` 

        **Type:** Object

.. _1652_summary_oper:

summary_oper
^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **alloc_failures**

        **Description** 

        **Type:** number

    **mem_reserved**

        **Description** 

        **Type:** number

    **mem_used**

        **Description** 

        **Type:** number

    **total_entries_scope_aggregate**

        **Description** 

        **Type:** number

    **total_entries_scope_parent**

        **Description** 

        **Type:** number

    **total_entries_scope_parent_subscriber-prefix**

        **Description** 

        **Type:** number

    **total_entries_scope_parent_subscriber_ip**

        **Description** 

        **Type:** number

    **total_entries_scope_subscriber_ip**

        **Description** 

        **Type:** number

    **total_entries_scope_subscriber_prefix**

        **Description** 

        **Type:** number

    **total_num_entries**

        **Description** 

        **Type:** number