.. _cgnv6_ds_lite_port_reservation:

cgnv6 ds-lite port-reservation
==============================

DS-Lite Static Port Reservation


port-reservation Specification
------------------------------

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

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

	 **Object Key(s)**                     *inside, tunnel-dest-address, inside-addr, inside-start-port, inside-end-port, nat, nat-start-port, nat-end-port*

	 **Collection Name**                   :ref:`267_port-reservation_list`

	 **Collection URI**                    /axapi/v3/cgnv6/ds-lite/port-reservation

	                                       

	 **Element Name**                      port-reservation

	 **Element URI**                       /axapi/v3/cgnv6/ds-lite/port-reservation/{inside}+{tunnel-dest-address}+{inside-addr}+{inside-start-port}+{inside-end-port}+{nat}+{nat-start-port}+{nat-end-port}

	 **Element Attributes**                port-reservation_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`port-reservation schema <cgnv6-ds-lite-port-reservation/cgnv6-ds-lite-port-reservation.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/ds-lite/port-reservation



.. raw:: html

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


:ref:`267_port-reservation_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_ds_lite_port_reservation_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/ds-lite/port-reservation



.. raw:: html

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


:ref:`267_port-reservation_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/ds-lite/port-reservation/{inside}+{tunnel-dest-address}+{inside-addr}+{inside-start-port}+{inside-end-port}+{nat}+{nat-start-port}+{nat-end-port}



.. raw:: html

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


:ref:`267_port-reservation_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_ds_lite_port_reservation_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/ds-lite/port-reservation



.. raw:: html

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


:ref:`267_port-reservation_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/ds-lite/port-reservation/{inside}+{tunnel-dest-address}+{inside-addr}+{inside-start-port}+{inside-end-port}+{nat}+{nat-start-port}+{nat-end-port}



.. raw:: html

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


:ref:`267_port-reservation_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/ds-lite/port-reservation/{inside}+{tunnel-dest-address}+{inside-addr}+{inside-start-port}+{inside-end-port}+{nat}+{nat-start-port}+{nat-end-port}



.. raw:: html

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


:ref:`267_port-reservation_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_ds_lite_port_reservation_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/ds-lite/port-reservation



.. raw:: html

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


:ref:`267_port-reservation_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/ds-lite/port-reservation/{inside}+{tunnel-dest-address}+{inside-addr}+{inside-start-port}+{inside-end-port}+{nat}+{nat-start-port}+{nat-end-port}



.. raw:: html

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


:ref:`267_port-reservation_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_ds_lite_port_reservation_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _267_port-reservation_list:

port-reservation-list
---------------------


    port-reservation-list is **JSON List** of :ref:`267_port-reservation_attributes` 

        port-reservation-list : [

             { :ref:`267_port-reservation_attributes` },

             { :ref:`267_port-reservation_attributes` },

             ...

         ]

.. _267_port-reservation_attributes:

port-reservation attributes
---------------------------

    **inside**

        **Description** Inside User Address and Port Range (DS-Lite Inside User's Tunnel Source IPv6 Address)

        **Type:** string

        **Format:** ipv6-address

    **inside-addr**

        **Description** Inside User IP address

        **Type:** string

        **Format:** ipv4-address

    **inside-end-port**

        **Description** Inside End Port

        **Type:** number

        **Range:** 1-65535

    **inside-start-port**

        **Description** Inside Start Port

        **Type:** number

        **Range:** 1-65535

    **nat**

        **Description** NAT Port Range (NAT IP address)

        **Type:** string

        **Format:** ipv4-address

    **nat-end-port**

        **Description** NAT End Port

        **Type:** number

        **Range:** 1-65535

    **nat-start-port**

        **Description** NAT Start Port

        **Type:** number

        **Range:** 1-65535

    **tunnel-dest-address**

        **Description** DS-Lite Inside User's Tunnel Destination IPv6 Address

        **Type:** string

        **Format:** ipv6-address

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters