.. _glid:

glid
====

Configure global limit ID


glid Specification
------------------

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

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

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

	 **Collection Name**                   :ref:`1695_glid_list`

	 **Collection URI**                    /axapi/v3/glid

	                                       

	 **Element Name**                      glid

	 **Element URI**                       /axapi/v3/glid/{name}

	 **Element Attributes**                glid_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`glid schema <glid/glid.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/glid



.. raw:: html

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


:ref:`1695_glid_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/glid_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/glid



.. raw:: html

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


:ref:`1695_glid_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/glid/{name}



.. raw:: html

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


:ref:`1695_glid_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/glid_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/glid



.. raw:: html

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


:ref:`1695_glid_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/glid/{name}



.. raw:: html

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


:ref:`1695_glid_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/glid/{name}



.. raw:: html

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


:ref:`1695_glid_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/glid_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/glid



.. raw:: html

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


:ref:`1695_glid_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/glid/{name}



.. raw:: html

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


:ref:`1695_glid_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/glid_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _1695_glid_list:

glid-list
---------


    glid-list is **JSON List** of :ref:`1695_glid_attributes` 

        glid-list : [

             { :ref:`1695_glid_attributes` },

             { :ref:`1695_glid_attributes` },

             ...

         ]

.. _1695_glid_attributes:

glid attributes
---------------

    **bit-rate-limit**

        **Description** Kibit (kibibit / 1024-bit) rate limit per rate-interval

        **Type:** number

        **Range:** 1-16000000

    **conn-limit**

        **Description** Connection Limit for the GLID (PBSLB range 1-1048575)

        **Type:** number

        **Range:** 1-16000000

    **conn-rate-limit**

        **Description** Connection rate limit per rate-interval (TPS range 1-16000000)

        **Type:** number

        **Range:** 1-2147483647

    **conn-rate-limit-interval**

        **Description** 

        **Type:** number

        **Range:** 1-65535

    **description**

        **Description** Description for glid

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **dns**

        **Description:** dns is a **JSON Block**.  Please see below for :ref:`1695_dns` 

        **Type:** Object

    **dns64**

        **Description:** dns64 is a **JSON Block**.  Please see below for :ref:`1695_dns64` 

        **Type:** Object

    **frag-pkt-rate-limit**

        **Description** Fragmented packet rate limit per rate-interval

        **Type:** number

        **Range:** 1-16000000

    **name**

        **Description** Global Limit ID Name (PBSLB allows number only)

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **over-limit-cfg**

        **Description:** over-limit-cfg is a **JSON Block**.  Please see below for :ref:`1695_over-limit-cfg` 

        **Type:** Object

    **pkt-rate-limit**

        **Description** Packet rate limit per rate-interval

        **Type:** number

        **Range:** 1-16000000

    **rate-unit**

        **Description** '1sec': 1sec for internal glid rate unit; 'system-global-setting': use global rate interval; 

        **Type:** string

        **Supported Values:** 1sec, system-global-setting

        **Default:** system-global-setting

    **request-limit**

        **Description** Request limit

        **Type:** number

        **Range:** 1-1048575

    **request-rate-limit**

        **Description** Request rate limit

        **Type:** number

        **Range:** 1-4294967295

    **request-rate-limit-interval**

        **Description** Number of 100ms

        **Type:** number

        **Range:** 1-65535

    **syn-cookie-thr**

        **Description** Syn Cookie threshold for the GLID

        **Type:** number

        **Range:** 1-16

    **use-nat-pool**

        **Description** Use NAT pool specified to do reverse NAT for class list members bound to the lid

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

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

.. _1695_over-limit-cfg:

over-limit-cfg
^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **action-type**

        **Description** 'drop': Silently Drop the new connection / new packet when it exceeds limit; 'blacklist-src': Black List source entry for X minutes (only applied to src and src-dst entries); 

        **Type:** string

        **Supported Values:** drop, blacklist-src

    **action-value**

        **Description** 'drop': Silently Drop the new connection / new packet when it exceeds limit; 'dns-cache-disable': Disable dns cache when it exceeds limit; 'dns-cache-enable': Enable dns cache when it exceeds limit; 'forward': Forward the traffic even it exceeds limit; 'reset': Reset the connection when it exceeds limit; 

        **Type:** string

        **Supported Values:** drop, dns-cache-disable, dns-cache-enable, forward, reset

    **blacklist-src-min**

        **Description** Black List source entry for X minutes

        **Type:** number

        **Range:** 1-30

    **lockout**

        **Description** Don't accept any new connection for certain time (Lockout duration in minutes)

        **Type:** number

        **Range:** 1-1023

    **log**

        **Description** Log a message

        **Type:** boolean

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

        **Default:** 0

    **log-interval**

        **Description** Log interval (minute, by default system will log every over limit instance)

        **Type:** number

        **Range:** 1-255

    **over-limit-action**

        **Description** Action to take when limit(s) exceeds

        **Type:** boolean

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

        **Default:** 0

.. _1695_dns64:

dns64
^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **disable**

        **Description** Disable

        **Type:** boolean

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

        **Default:** 0

    **exclusive-answer**

        **Description** Exclusive Answer in DNS Response

        **Type:** boolean

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

        **Default:** 0

    **prefix**

        **Description** IPv6 prefix

        **Type:** string

        **Format:** ipv6-address-plen

.. _1695_dns:

dns
^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **action**

        **Description** 'cache-disable': Disable dns cache; 'cache-enable': Enable dns cache; 

        **Type:** string

        **Supported Values:** cache-disable, cache-enable

        **Default:** cache-disable

    **ttl**

        **Description** TTL for cache entry (TTL in seconds)

        **Type:** number

        **Range:** 1-65535

    **weight**

        **Description** Weight for cache entry

        **Type:** number

        **Range:** 1-7