.. _cgnv6_lsn_lid:

cgnv6 lsn-lid
=============

Create an LSN Lid


lsn-lid Specification
---------------------

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

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

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

	 **Collection Name**                   :ref:`369_lsn-lid_list`

	 **Collection URI**                    /axapi/v3/cgnv6/lsn-lid

	                                       

	 **Element Name**                      lsn-lid

	 **Element URI**                       /axapi/v3/cgnv6/lsn-lid/{lid-number}

	 **Element Attributes**                lsn-lid_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


:ref:`369_lsn-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/cgnv6_lsn_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/cgnv6/lsn-lid



.. raw:: html

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


:ref:`369_lsn-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/cgnv6/lsn-lid/{lid-number}



.. raw:: html

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


:ref:`369_lsn-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/cgnv6_lsn_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/cgnv6/lsn-lid



.. raw:: html

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


:ref:`369_lsn-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/cgnv6/lsn-lid/{lid-number}



.. raw:: html

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


:ref:`369_lsn-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/cgnv6/lsn-lid/{lid-number}



.. raw:: html

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


:ref:`369_lsn-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/cgnv6_lsn_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/cgnv6/lsn-lid



.. raw:: html

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


:ref:`369_lsn-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/cgnv6/lsn-lid/{lid-number}



.. raw:: html

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


:ref:`369_lsn-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/cgnv6_lsn_lid_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _369_lsn-lid_list:

lsn-lid-list
------------


    lsn-lid-list is **JSON List** of :ref:`369_lsn-lid_attributes` 

        lsn-lid-list : [

             { :ref:`369_lsn-lid_attributes` },

             { :ref:`369_lsn-lid_attributes` },

             ...

         ]

.. _369_lsn-lid_attributes:

lsn-lid attributes
------------------

    **conn-rate-limit**

        **Description:** conn-rate-limit is a **JSON Block**.  Please see below for :ref:`369_conn-rate-limit` 

        **Type:** Object

    **ds-lite**

        **Description:** ds-lite is a **JSON Block**.  Please see below for :ref:`369_ds-lite` 

        **Type:** Object

    **extended-user-quota**

        **Description:** extended-user-quota is a **JSON Block**.  Please see below for :ref:`369_extended-user-quota` 

        **Type:** Object

    **lid-number**

        **Description** LSN Lid

        **Type:** number

        **Range:** 1-1023

    **lsn-rule-list**

        **Description:** lsn-rule-list is a **JSON Block**.  Please see below for :ref:`369_lsn-rule-list` 

        **Type:** Object

    **name**

        **Description** LSN Lid Name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **override**

        **Description** 'none': Apply source NAT if configured (default); 'drop': Drop packets that match this LSN lid; 'pass-through': Layer-3 route packets that match this LSN lid and do not apply source NAT; 

        **Type:** string

        **Supported Values:** none, drop, pass-through

        **Default:** none

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

    **source-nat-pool**

        **Description:** source-nat-pool is a **JSON Block**.  Please see below for :ref:`369_source-nat-pool` 

        **Type:** Object

    **user-quota**

        **Description:** user-quota is a **JSON Block**.  Please see below for :ref:`369_user-quota` 

        **Type:** Object

    **user-quota-prefix-length**

        **Description** NAT64/DS-Lite user quota prefix length (Prefix Length (Default: Uses the global NAT64/DS-Lite configured value))

        **Type:** number

        **Range:** 1-128

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

.. _369_extended-user-quota:

extended-user-quota
^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **tcp**

        **Type:** List

    **udp**

        **Type:** List

.. _369_extended-user-quota_udp:

extended-user-quota_udp
^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **udp-service-port**

        **Description** Port (Port Value)

        **Type:** number

        **Range:** 1-65535

    **udp-sessions**

        **Description** Number of Extended Quota sessions allowed for this service

        **Type:** number

        **Range:** 1-255

.. _369_extended-user-quota_tcp:

extended-user-quota_tcp
^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **tcp-service-port**

        **Description** Port (Port Value)

        **Type:** number

        **Range:** 1-65535

    **tcp-sessions**

        **Description** Number of Extended Quota sessions allowed for this service

        **Type:** number

        **Range:** 1-255

.. _369_ds-lite:

ds-lite
^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **inside-src-permit-list**

        **Description** Class-List of IPv4 addresses permitted (Class-list to match for DS-Lite)

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

.. _369_user-quota:

user-quota
^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **icmp**

        **Description** User Quota for ICMP identifiers (NAT port quota per user (default: not configured))

        **Type:** number

        **Range:** 1-64000

    **quota-tcp**

        **Description:** quota-tcp is a **JSON Block**.  Please see below for :ref:`369_user-quota_quota-tcp` 

        **Type:** Object

    **quota-udp**

        **Description:** quota-udp is a **JSON Block**.  Please see below for :ref:`369_user-quota_quota-udp` 

        **Type:** Object

    **session**

        **Description** User Quota for number of data sessions

        **Type:** number

        **Range:** 1-2147483647

.. _369_user-quota_quota-tcp:

user-quota_quota-tcp
^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **tcp-quota**

        **Description** NAT port quota per user (default: not configured)

        **Type:** number

        **Range:** 1-64000

    **tcp-reserve**

        **Description** Number of ports to reserve per user (default: same as user-quota value) (Reserved quota per user (default: same as user-quota value))

        **Type:** number

        **Range:** 0-64000

.. _369_user-quota_quota-udp:

user-quota_quota-udp
^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **udp-quota**

        **Description** NAT port quota per user (default: not configured)

        **Type:** number

        **Range:** 1-64000

    **udp-reserve**

        **Description** Number of ports to reserve per user (default: same as user-quota value) (Reserved quota per user (default: same as user-quota value))

        **Type:** number

        **Range:** 0-64000

.. _369_source-nat-pool:

source-nat-pool
^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **pool-name**

        **Description** Source NAT Pool or Pool-Group

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **shared**

        **Description** Use a shared source NAT pool or pool-group

        **Type:** boolean

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

        **Default:** 0

.. _369_conn-rate-limit:

conn-rate-limit
^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **conn-rate-limit-val**

        **Description** Maximum connections per second (Default: No limit)

        **Type:** number

        **Range:** 1-65535

.. _369_lsn-rule-list:

lsn-rule-list
^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **destination**

        **Description** Apply LSN Rule-List on Destination (LSN Rule-List Name)

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/cgnv6/lsn-rule-list <cgnv6_lsn_rule_list>`