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 geo-location schemaOperations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
Create Object | POST | /axapi/v3/system/geo-location | ||
Get Object | GET | /axapi/v3/system/geo-location | ||
Modify Object | POST | /axapi/v3/system/geo-location | ||
Replace Object | PUT | /axapi/v3/system/geo-location | ||
Delete Object | DELETE | /axapi/v3/system/geo-location | ||
geo-location attributes¶
entry-list
Type: List
Reference Object: /axapi/v3/system/geo-location/entry/{geo-locn-obj-name}
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: Listuuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
entry-list¶
Specification Value Type list Block object keys geo-locn-multiple-addresses
Type: Listgeo-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
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
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: /axapi/v3/template/csv