.. _cgnv6_fixed_nat_inside_iplist:

cgnv6 fixed-nat inside iplist
=============================

Configure Fixed NAT with Inside IP List


iplist Specification
--------------------

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

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

	 **Object Key(s)**                     *inside-ip-list, partition*

	 **Collection Name**                   :ref:`300_iplist_list`

	 **Collection URI**                    /axapi/v3/cgnv6/fixed-nat/inside/iplist

	                                       

	 **Element Name**                      iplist

	 **Element URI**                       /axapi/v3/cgnv6/fixed-nat/inside/iplist/{inside-ip-list}+{partition}

	 **Element Attributes**                iplist_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`iplist schema <cgnv6-fixed-nat-inside-iplist/cgnv6-fixed-nat-inside-iplist.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/fixed-nat/inside/iplist



.. raw:: html

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


:ref:`300_iplist_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_fixed_nat_inside_iplist_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/fixed-nat/inside/iplist



.. raw:: html

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


:ref:`300_iplist_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/fixed-nat/inside/iplist/{inside-ip-list}+{partition}



.. raw:: html

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


:ref:`300_iplist_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_fixed_nat_inside_iplist_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/fixed-nat/inside/iplist



.. raw:: html

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


:ref:`300_iplist_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/fixed-nat/inside/iplist/{inside-ip-list}+{partition}



.. raw:: html

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


:ref:`300_iplist_attributes`



.. 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/fixed-nat/inside/iplist/{inside-ip-list}+{partition}



.. raw:: html

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


:ref:`300_iplist_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_fixed_nat_inside_iplist_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _300_iplist_list:

iplist-list
-----------


    iplist-list is **JSON List** of :ref:`300_iplist_attributes` 

        iplist-list : [

             { :ref:`300_iplist_attributes` },

             { :ref:`300_iplist_attributes` },

             ...

         ]

.. _300_iplist_attributes:

iplist attributes
-----------------

    **dest-rule-list**

        **Description** Bind destination based Rule-List (Fixed NAT Rule-List Name)

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **dynamic-pool-size**

        **Description** Configure size of Dynamic pool (Default: 0)

        **Type:** number

        **Range:** 0-64511

        **Default:** 0

    **inside-ip-list**

        **Description** Name of IP List used to specify Inside Users

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **method**

        **Description** 'use-all-nat-ips': Use all the NAT IP addresses configured; 'use-least-nat-ips': Use the least number of NAT IP addresses required (default); 

        **Type:** string

        **Supported Values:** use-all-nat-ips, use-least-nat-ips

        **Default:** use-least-nat-ips

    **nat-end-address**

        **Description** IPv4 End NAT Address

        **Type:** string

        **Format:** ipv4-address

    **nat-ip-list**

        **Description** Name of IP List used to specify NAT addresses

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **nat-netmask**

        **Description** NAT Addresses IP Netmask

        **Type:** string

        **Format:** ipv4-netmask-brief

    **nat-start-address**

        **Description** Start NAT Address

        **Type:** string

        **Format:** ipv4-address

    **offset**

        **Description:** offset is a **JSON Block**.  Please see below for :ref:`300_offset` 

        **Type:** Object

    **partition**

        **Description** Inside User Partition (Partition Name)

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **ports-per-user**

        **Description** Configure Ports per Inside User (ports-per-user)

        **Type:** number

        **Range:** 1-64512

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

    **session-quota**

        **Description** Configure per user quota on sessions

        **Type:** number

        **Range:** 1-2147483647

    **skip-ports-on-rollover**

        **Description** Not using the first block of ports for NAT IPs smaller than the configured offset

        **Type:** boolean

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

        **Default:** 0

    **usable-nat-ports**

        **Description:** usable-nat-ports is a **JSON Block**.  Please see below for :ref:`300_usable-nat-ports` 

        **Type:** Object

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **vrid**

        **Description** VRRP-A vrid (Specify ha VRRP-A vrid)

        **Type:** number

        **Range:** 1-31

.. _300_usable-nat-ports:

usable-nat-ports
^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **usable-end-port**

        **Description** End Port of Usable NAT Ports

        **Type:** number

        **Range:** 1024-65535

    **usable-start-port**

        **Description** Start Port of Usable NAT Ports

        **Type:** number

        **Range:** 1024-65535

.. _300_offset:

offset
^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **numeric-offset**

        **Description** Configure a numeric offset to the first NAT IP address

        **Type:** number

        **Range:** 0-1024000

        **Default:** 0

        **Mutual Exclusion:** numeric-offset and random are mutually exclusive

    **random**

        **Description** Randomly choose the first NAT IP address

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** random and numeric-offset are mutually exclusive