.. _system_geoloc:

system geoloc
=============




geoloc Specification
--------------------

	===================================== ======================================================
	===================================== ======================================================
	 **Type**                              *operational*

	 **Element Name**                      geoloc

	 **Element URI**                       /axapi/v3/system/geoloc

	 **Element Attributes**                geoloc_attributes

	 **Statistics Data URI**               /axapi/v3/system/geoloc/stats

	 **Operational Data URI**              /axapi/v3/system/geoloc/oper

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


EXECUTE Object



.. raw:: html

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


POST



.. raw:: html

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


/axapi/v3/system/geoloc



.. raw:: html

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


:ref:`2032_geoloc_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _2032_geoloc_attributes:

geoloc attributes
-----------------

    **sampling-enable**

        **Type:** List

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2032_sampling-enable:

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

	 **Block object keys**             

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

    **counters1**

        **Description** 'all': all; 'place-holder': place-holder; 

        **Type:** string

        **Supported Values:** all, place-holder

.. _2032_oper_data:

operational data
----------------
.. list-table::
   :widths: 10 20 30 80
   :header-rows: 2
   :stub-columns: 1

   *  - 
      - Counter
      - Size
      - Description

   *  - 
      - 
      - 
      - 

   *  - 
      - ipv6rangestrt
      - ipv6-address
      - ipv6rangestrt

   *  - 
      - pol-name
      - string
      - pol-name

   *  - 
      - total-geolocs
      - number
      - total-geolocs

   *  - 
      - iprangestrt
      - ipv4-address
      - iprangestrt

   *  - 
      - filter4
      - enum
      -  Output contains one of the following values: - ip, ipv6, ipstat, ipv6stat

   *  - 
      - depth
      - number
      - depth

   *  - 
      - iprangeend
      - ipv4-address
      - iprangeend

   *  - 
      - filter1
      - enum
      -  Output contains one of the following values: - directory, statistics, global

   *  - 
      - filter3
      - enum
      -  Output contains one of the following values: - directory, statistics, global

   *  - 
      - filter2
      - enum
      -  Output contains one of the following values: - directory, statistics, global

   *  - 
      - geo-name
      - string
      - geo-name

   *  - 
      - geoloc-list
      - 
      - geoloc-list