.. _ip_nat_range_list:

ip nat range-list
=================

IP Source NAT Static range list


range-list Specification
------------------------

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

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

	 **Object Key(s)**                     *name*

	 **Collection Name**                   :ref:`2124_range-list_list`

	 **Collection URI**                    /axapi/v3/ip/nat/range-list

	                                       

	 **Element Name**                      range-list

	 **Element URI**                       /axapi/v3/ip/nat/range-list/{name}

	 **Element Attributes**                range-list_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`range-list schema <ip-nat-range-list/ip-nat-range-list.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/ip/nat/range-list



.. raw:: html

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


:ref:`2124_range-list_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/ip_nat_range_list_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/ip/nat/range-list



.. raw:: html

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


:ref:`2124_range-list_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/ip/nat/range-list/{name}



.. raw:: html

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


:ref:`2124_range-list_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/ip_nat_range_list_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/ip/nat/range-list



.. raw:: html

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


:ref:`2124_range-list_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/ip/nat/range-list/{name}



.. raw:: html

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


:ref:`2124_range-list_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/ip/nat/range-list/{name}



.. raw:: html

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


:ref:`2124_range-list_attributes`



.. raw:: html

   </td><td></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/ip/nat/range-list



.. raw:: html

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


:ref:`2124_range-list_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/ip/nat/range-list/{name}



.. raw:: html

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


:ref:`2124_range-list_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/ip_nat_range_list_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _2124_range-list_list:

range-list-list
---------------


    range-list-list is **JSON List** of :ref:`2124_range-list_attributes` 

        range-list-list : [

             { :ref:`2124_range-list_attributes` },

             { :ref:`2124_range-list_attributes` },

             ...

         ]

.. _2124_range-list_attributes:

range-list attributes
---------------------

    **global-netmaskv4**

        **Description** Mask for this Address range

        **Type:** string

        **Format:** ipv4-netmask

    **global-start-ipv4-addr**

        **Description** Global Start IPv4 Address of this list

        **Type:** string

        **Format:** ipv4-address

    **global-start-ipv6-addr**

        **Description** Global Start IPv6 Address of this list

        **Type:** string

        **Format:** ipv6-address-plen

    **local-netmaskv4**

        **Description** Mask for this Address range

        **Type:** string

        **Format:** ipv4-netmask

    **local-start-ipv4-addr**

        **Description** Local Start IPv4 Address of this list

        **Type:** string

        **Format:** ipv4-address

    **local-start-ipv6-addr**

        **Description** Local Start IPv6 Address of this list

        **Type:** string

        **Format:** ipv6-address-plen

    **name**

        **Description** Name for this Static List

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **v4-acl-id**

        **Description** Access list ID

        **Type:** number

        **Range:** 1-199

    **v4-acl-name**

        **Description** Access list name

        **Type:** string

        **Maximum Length:** 16 characters

        **Maximum Length:** 1 characters

    **v4-count**

        **Description** Number of addresses to be translated in this range

        **Type:** number

        **Range:** 1-200000

    **v4-vrid**

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

        **Type:** number

        **Range:** 1-31

        **Reference Object:** :doc:`/axapi/v3/vrrp-a/vrid <vrrp_a_vrid>`

    **v6-acl-name**

        **Description** Access list name

        **Type:** string

        **Maximum Length:** 16 characters

        **Maximum Length:** 1 characters

    **v6-count**

        **Description** Number of addresses to be translated in this range

        **Type:** number

        **Range:** 1-200000

    **v6-vrid**

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

        **Type:** number

        **Range:** 1-31

        **Reference Object:** :doc:`/axapi/v3/vrrp-a/vrid <vrrp_a_vrid>`