.. _system_geo_location:

system geo-location
===================

Configure system global geo-location


geo-location Specification
--------------------------

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

	===================================== ============================================================
	 **Type**                              *Configuration Resource*

	 **Element Name**                      geo-location

	 **Element URI**                       /axapi/v3/system/geo-location

	 **Element Attributes**                geo-location_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


:ref:`3249_geo-location_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_geo_location_POST.txt
   :literal:




.. raw:: html

   </div></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/geo-location



.. raw:: html

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


:ref:`3249_geo-location_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_geo_location_GET.txt
   :literal:




.. raw:: html

   </div></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/geo-location



.. raw:: html

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


:ref:`3249_geo-location_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/geo-location



.. raw:: html

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


:ref:`3249_geo-location_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/system/geo-location



.. raw:: html

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


:ref:`3249_geo-location_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _3249_geo-location_attributes:

geo-location attributes
-----------------------

    **entry-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/system/geo-location/entry/{geo-locn-obj-name} <system_geo_location_entry>`

    **geo-location-geolite2-asn**

        **Description** Load built-in Maxmind GeoLite2-ASN database. Database available from http://www.maxmind.com

        **Type:** boolean

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

        **Default:** 0

    **geo-location-geolite2-city**

        **Description** Load built-in Maxmind GeoLite2-City database. Database available from http://www.maxmind.com

        **Type:** boolean

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

        **Default:** 0

    **geo-location-geolite2-country**

        **Description** Load built-in Maxmind GeoLite2-Country database. Database available from http://www.maxmind.com

        **Type:** boolean

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

        **Default:** 0

    **geo-location-iana**

        **Description** Load built-in IANA Database

        **Type:** boolean

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

        **Default:** 1

    **geo-location-iana-system**

        **Description** Load built-in IANA Database

        **Type:** boolean

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

        **Default:** 0

    **geolite2-asn-include-ipv6**

        **Description** Include IPv6 address

        **Type:** boolean

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

        **Default:** 0

    **geolite2-city-include-ipv6**

        **Description** Include IPv6 address

        **Type:** boolean

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

        **Default:** 0

    **geolite2-country-include-ipv6**

        **Description** Include IPv6 address

        **Type:** boolean

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

        **Default:** 0

    **geoloc-load-file-list**

        **Type:** List

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _3249_entry-list:

entry-list
^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **geo-locn-multiple-addresses**

        **Type:** List

    **geo-locn-obj-name**

        **Description** Specify geo-location name, section range is (1-15)

        **Type:** string

        **Maximum Length:** 127 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

.. _3249_entry-list_geo-locn-multiple-addresses:

entry-list_geo-locn-multiple-addresses
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **first-ip-address**

        **Description** Specify IP information (Specify IP address)

        **Type:** string

        **Format:** ipv4-address

    **first-ipv6-address**

        **Description** Specify IPv6 address

        **Type:** string

        **Format:** ipv6-address

    **geol-ipv4-mask**

        **Description** Specify IPv4 mask

        **Type:** string

        **Format:** ipv4-netmask

        **Mutual Exclusion:** geol-ipv4-mask and ip-addr2 are mutually exclusive

    **geol-ipv6-mask**

        **Description** Specify IPv6 mask

        **Type:** number

        **Range:** 0-128

        **Mutual Exclusion:** geol-ipv6-mask and ipv6-addr2 are mutually exclusive

    **ip-addr2**

        **Description** Specify IP address range

        **Type:** string

        **Format:** ipv4-address

        **Mutual Exclusion:** ip-addr2 and geol-ipv4-mask are mutually exclusive

    **ipv6-addr2**

        **Description** Specify IPv6 address range

        **Type:** string

        **Format:** ipv6-address

        **Mutual Exclusion:** ipv6-addr2 and geol-ipv6-mask are mutually exclusive

.. _3249_geoloc-load-file-list:

geoloc-load-file-list
^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **geo-location-load-file-include-ipv6**

        **Description** Include IPv6 address

        **Type:** boolean

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

        **Default:** 0

    **geo-location-load-filename**

        **Description** Specify file to be loaded

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **template-name**

        **Description** CSV template to load this file

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/template/csv <template_csv>`