.. _template_lid:

template lid
============

Create an Lid


lid Specification
-----------------

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

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

	 **Object Key(s)**                     *lid-number*

	 **Collection Name**                   :ref:`3487_lid_list`

	 **Collection URI**                    /axapi/v3/template/lid

	                                       

	 **Element Name**                      lid

	 **Element URI**                       /axapi/v3/template/lid/{lid-number}

	 **Element Attributes**                lid_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


:ref:`3487_lid_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_lid_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/lid



.. raw:: html

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


:ref:`3487_lid_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/lid/{lid-number}



.. raw:: html

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


:ref:`3487_lid_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_lid_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/lid



.. raw:: html

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


:ref:`3487_lid_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/lid/{lid-number}



.. raw:: html

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


:ref:`3487_lid_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/lid/{lid-number}



.. raw:: html

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


:ref:`3487_lid_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_lid_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/lid



.. raw:: html

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


:ref:`3487_lid_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/lid/{lid-number}



.. raw:: html

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


:ref:`3487_lid_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_lid_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _3487_lid_list:

lid-list
--------


    lid-list is **JSON List** of :ref:`3487_lid_attributes` 

        lid-list : [

             { :ref:`3487_lid_attributes` },

             { :ref:`3487_lid_attributes` },

             ...

         ]

.. _3487_lid_attributes:

lid attributes
--------------

    **ddos-protection-factor**

        **Description** Enable DDoS Protection (Multiplier of the downlink PPS)

        **Type:** number

        **Range:** 1-50

    **downlink-pps**

        **Description** Downlink PPS limit (Number of Packets per second)

        **Type:** number

        **Range:** 1-2147483647

    **downlink-throughput**

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

        **Type:** number

        **Range:** 1-100000

    **lid-number**

        **Description** Lid Number

        **Type:** number

        **Range:** 1-1023

    **limit-cps**

        **Description** Enable Connections Per Second Rate Limit (Number of Connections per second)

        **Type:** number

        **Range:** 1-2147483647

    **limit-rate**

        **Description** 'limit-pps': Enable Packets Per Second Rate Limit; 'limit-throughput': Enable Throughput Rate Limit; 

        **Type:** string

        **Supported Values:** limit-pps, limit-throughput

    **respond-to-user-mac**

        **Description** Use the user's source MAC for the next hop rather than the routing table (default:off)

        **Type:** boolean

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

        **Default:** 0

    **src-ip**

        **Description:** src-ip is a **JSON Block**.  Please see below for :ref:`3487_src-ip` 

        **Type:** Object

    **total-pps**

        **Description** Total PPS limit (Number of Packets per second)

        **Type:** number

        **Range:** 1-2147483647

    **total-throughput**

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

        **Type:** number

        **Range:** 1-100000

    **uplink-pps**

        **Description** Uplink PPS limit (Number of Packets per second)

        **Type:** number

        **Range:** 1-2147483647

    **uplink-throughput**

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

        **Type:** number

        **Range:** 1-100000

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

.. _3487_src-ip:

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

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

    **burstsize-cps**

        **Description** CPS Token Bucket Size (Must Exceed Configured Rate) (In Connections per second)

        **Type:** number

        **Range:** 1-2147483647

    **burstsize-downlink-pps**

        **Description** Downlink PPS Token Bucket Size (Must Exceed Configured Rate) (In Packets)

        **Type:** number

        **Range:** 1-2147483647

    **burstsize-downlink-throughput**

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

        **Type:** number

        **Range:** 1-100000

    **burstsize-total-pps**

        **Description** Total PPS Token Bucket Size (Must Exceed Configured Rate) (In Packets)

        **Type:** number

        **Range:** 1-2147483647

    **burstsize-total-throughput**

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

        **Type:** number

        **Range:** 1-100000

    **burstsize-uplink-pps**

        **Description** Uplink PPS Token Bucket Size (Must Exceed Configured Rate) (In Packets)

        **Type:** number

        **Range:** 1-2147483647

    **burstsize-uplink-throughput**

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

        **Type:** number

        **Range:** 1-100000

    **concurrent-sessions**

        **Description** Concurrent Session Limit per Source IP Address (Number of Concurrent Sessions)

        **Type:** number

        **Range:** 1-2147483647

    **log**

        **Description** Log when Session Limit is exceeded

        **Type:** boolean

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

        **Default:** 0

    **prefix-length**

        **Description** Source prefix length

        **Type:** number

        **Range:** 1-128