.. _cgnv6_lsn_port_overloading:

cgnv6 lsn port-overloading
==========================

Configure Port-Overloading Behavior (default: disabled)


port-overloading Specification
------------------------------

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

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

	 **Element Name**                      port-overloading

	 **Element URI**                       /axapi/v3/cgnv6/lsn/port-overloading

	 **Element Attributes**                port-overloading_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


port-overloading_attributes



.. raw:: html

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




.. raw:: html

   </table>

.. _380_port-overloading_attributes:

port-overloading attributes
---------------------------

    **global**

        **Description:** global is a **JSON Block**.  Please see below for :ref:`380_global` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/cgnv6/lsn/port-overloading/global <cgnv6_lsn_port_overloading_global>`

    **port-overloading-status**

        **Description:** port-overloading-status is a **JSON Block**.  Please see below for :ref:`380_port-overloading-status` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/cgnv6/lsn/port-overloading/port-overloading-status <cgnv6_lsn_port_overloading_port_overloading_status>`

    **tcp**

        **Description:** tcp is a **JSON Block**.  Please see below for :ref:`380_tcp` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/cgnv6/lsn/port-overloading/tcp <cgnv6_lsn_port_overloading_tcp>`

    **udp**

        **Description:** udp is a **JSON Block**.  Please see below for :ref:`380_udp` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/cgnv6/lsn/port-overloading/udp <cgnv6_lsn_port_overloading_udp>`

.. _380_port-overloading-status:

port-overloading-status
^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _380_udp:

udp
^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **port-list**

        **Type:** List

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _380_udp_port-list:

udp_port-list
^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **port**

        **Description** Single Destination Port or Port Range Start

        **Type:** number

    **port-end**

        **Description** Port Range End

        **Type:** number

.. _380_global:

global
^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **allow-different-user**

        **Description** Allow different users to overload the same port (default: disabled)

        **Type:** boolean

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

        **Default:** 0

    **unique**

        **Description** 'destination-address': Allow overloading when the destination addresses is unique; 'destination-address-and-port': Allow overloading when the destination address and port 2-tuple is unique (default); 

        **Type:** string

        **Supported Values:** destination-address, destination-address-and-port

        **Default:** destination-address-and-port

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _380_tcp:

tcp
^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **port-list**

        **Type:** List

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _380_tcp_port-list:

tcp_port-list
^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **port**

        **Description** Single Destination Port or Port Range Start

        **Type:** number

    **port-end**

        **Description** Port Range End

        **Type:** number