.. _slb_common_conn_rate_limit:

slb common conn-rate-limit
==========================

Set rate limiting on virtual ports


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

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

	===================================== ===================================================================
	 **Type**                              *Intermediate Resource*

	 **Element Name**                      conn-rate-limit

	 **Element URI**                       /axapi/v3/slb/common/conn-rate-limit

	 **Element Attributes**                conn-rate-limit_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`conn-rate-limit schema <slb-common-conn-rate-limit/slb-common-conn-rate-limit.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'>


Get Object



.. raw:: html

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


GET



.. raw:: html

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


/axapi/v3/slb/common/conn-rate-limit



.. raw:: html

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


conn-rate-limit_attributes



.. raw:: html

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




.. raw:: html

   </table>

.. _2722_conn-rate-limit_attributes:

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

    **src-ip-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/slb/common/conn-rate-limit/src-ip/{disable-ipv6-support}+{protocol} <slb_common_conn_rate_limit_src_ip>`

.. _2722_src-ip-list:

src-ip-list
^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **disable-ipv6-support**

        **Description** 

        **Type:** boolean

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

        **Default:** 0

    **exceed-action**

        **Description** Set action if threshold exceeded

        **Type:** boolean

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

        **Default:** 0

    **limit**

        **Description** Set max connections per period

        **Type:** number

        **Range:** 1-1000000

    **limit-period**

        **Description** '100': 100 ms; '1000': 1000 ms; 

        **Type:** string

        **Supported Values:** 100, 1000

    **lock-out**

        **Description** Set lockout period in seconds if threshold exceeded

        **Type:** number

        **Range:** 1-3600

    **log**

        **Description** Send log if threshold exceeded

        **Type:** boolean

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

        **Default:** 0

    **protocol**

        **Description** 'tcp': Set TCP connection rate limit; 'udp': Set UDP packet rate limit; 

        **Type:** string

        **Supported Values:** tcp, udp

    **shared**

        **Description** Set threshold shared amongst all virtual ports

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