.. _system_geoloc_list:

system geoloc-list
==================

Configure geolocation list


geoloc-list Specification
-------------------------

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

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

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

	 **Collection Name**                   :ref:`3252_geoloc-list_list`

	 **Collection URI**                    /axapi/v3/system/geoloc-list

	                                       

	 **Element Name**                      geoloc-list

	 **Element URI**                       /axapi/v3/system/geoloc-list/{name}

	 **Element Attributes**                geoloc-list_attributes

	 **Partition Visibility**              shared

	 **Statistics Data URI**               /axapi/v3/system/geoloc-list/{name}/stats

	 **Operational Data URI**              /axapi/v3/system/geoloc-list/{name}/oper

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



.. raw:: html

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


:ref:`3252_geoloc-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/system_geoloc_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/system/geoloc-list



.. raw:: html

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


:ref:`3252_geoloc-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/system/geoloc-list/{name}



.. raw:: html

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


:ref:`3252_geoloc-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/system_geoloc_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/system/geoloc-list



.. raw:: html

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


:ref:`3252_geoloc-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/system/geoloc-list/{name}



.. raw:: html

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


:ref:`3252_geoloc-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/system/geoloc-list/{name}



.. raw:: html

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


:ref:`3252_geoloc-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/system/geoloc-list



.. raw:: html

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


:ref:`3252_geoloc-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/system/geoloc-list/{name}



.. raw:: html

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


:ref:`3252_geoloc-list_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _3252_geoloc-list_list:

geoloc-list-list
----------------


    geoloc-list-list is **JSON List** of :ref:`3252_geoloc-list_attributes` 

        geoloc-list-list : [

             { :ref:`3252_geoloc-list_attributes` },

             { :ref:`3252_geoloc-list_attributes` },

             ...

         ]

.. _3252_geoloc-list_attributes:

geoloc-list attributes
----------------------

    **exclude-geoloc-name-list**

        **Type:** List

    **include-geoloc-name-list**

        **Type:** List

    **name**

        **Description** Specify name of Geolocation list

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **sampling-enable**

        **Type:** List

    **shared**

        **Description** Enable sharing with other partitions

        **Type:** boolean

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

        **Default:** 0

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

.. _3252_sampling-enable:

sampling-enable
^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **counters1**

        **Description** 'all': all; 'hit-count': some help string; 'total-geoloc': some help string; 'total-active': some help string; 

        **Type:** string

        **Supported Values:** all, hit-count, total-geoloc, total-active

.. _3252_include-geoloc-name-list:

include-geoloc-name-list
^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **include-geoloc-name-val**

        **Description** Geolocation name to add

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

.. _3252_exclude-geoloc-name-list:

exclude-geoloc-name-list
^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **exclude-geoloc-name-val**

        **Description** Geolocation name to exclude

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters