.. _ip_list:

ip-list
=======

Configure ip list


ip-list Specification
---------------------

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

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

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

	 **Collection Name**                   :ref:`2100_ip-list_list`

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

	                                       

	 **Element Name**                      ip-list

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

	 **Element Attributes**                ip-list_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


:ref:`2100_ip-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_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-list



.. raw:: html

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


:ref:`2100_ip-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-list/{name}



.. raw:: html

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


:ref:`2100_ip-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_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-list



.. raw:: html

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


:ref:`2100_ip-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-list/{name}



.. raw:: html

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


:ref:`2100_ip-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-list/{name}



.. raw:: html

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


:ref:`2100_ip-list_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/ip_list_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/ip-list



.. raw:: html

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


:ref:`2100_ip-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-list/{name}



.. raw:: html

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


:ref:`2100_ip-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_list_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _2100_ip-list_list:

ip-list-list
------------


    ip-list-list is **JSON List** of :ref:`2100_ip-list_attributes` 

        ip-list-list : [

             { :ref:`2100_ip-list_attributes` },

             { :ref:`2100_ip-list_attributes` },

             ...

         ]

.. _2100_ip-list_attributes:

ip-list attributes
------------------

    **ipv4-config**

        **Type:** List

    **ipv6-config**

        **Type:** List

    **ipv6-prefix-config**

        **Type:** List

    **name**

        **Description** Specify name of the ip list

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

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

.. _2100_ipv6-config:

ipv6-config
^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **ipv6-end-addr**

        **Description** IPv6 Range End Address

        **Type:** string

        **Format:** ipv6-address

    **ipv6-start-addr**

        **Description** IPv6 Range Start Address / IPv6 Address

        **Type:** string

        **Format:** ipv6-address

.. _2100_ipv4-config:

ipv4-config
^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **ipv4-end-addr**

        **Description** IPv4 Range End Address

        **Type:** string

        **Format:** ipv4-address

    **ipv4-start-addr**

        **Description** IPv4 Range Start Address / IPv4 Address

        **Type:** string

        **Format:** ipv4-address

.. _2100_ipv6-prefix-config:

ipv6-prefix-config
^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **count**

        **Description** Number of IPv6 prefixes

        **Type:** number

        **Range:** 1-2147483647

    **ipv6-addr-prefix**

        **Description** IPv6 Prefix Range Start / IPv6 Prefix

        **Type:** string

        **Format:** ipv6-address-plen

    **ipv6-prefix-to**

        **Description** IPv6 Prefix Range End

        **Type:** string

        **Format:** ipv6-address-plen