Core Geolocation Support
This configuration documentation is for functionality provided by res_geolocation.
geolocation.conf
location
Location
Configuration Option Reference
Option Name |
Type |
Default Value |
Regular Expression |
Description |
|---|---|---|---|---|
|
|
|
|
Must be of type 'location'. |
|
|
|
Location specification type |
|
|
|
|
Location information |
|
|
|
|
Fully qualified host name |
|
|
|
|
Location determination method |
|
|
|
|
Level of confidence |
Configuration Option Descriptions
format
civicAddress- Thelocation_infoparameter must contain a comma separated list of IANA codes or synonyms describing the civicAddress of this location. The IANA codes and synonyms can be obtained by executing the CLI commandgeoloc show civicAddr_mapping.GML- Thelocation_infoparameter must contain a comma separated list valid GML elements describing this location.URI- Thelocation_infoparameter must contain a single URI parameter which contains an external URI describing this location.
location_info
The contents of this parameter are specific to the location format.
civicAddress- location_info = country=US,A1="New York",city_district=Manhattan, A3="New York", house_number=1633, street=46th, street_suffix = Street, postal_code=10222,floor=20,room=20A2GML- location_info = Shape=Sphere, pos3d="39.12345 -105.98766 1920", radius=200URI- location_info = URI=https:/something.com?exten=${EXTEN}
location_source
This parameter isn't required but if provided, RFC8787 says it MUST be a fully qualified host name. IP addresses are specifically NOT allowed. The value will be placed in a loc-src parameter appended to the URI in the {{ Geolocation}} header.
method
This is a rarely used field in the specification that would indicate the method used to determine the location. Its usage and values should be pre-negotiated with any recipients.
GPSA-GPSManualDHCPTriangulationCell802.11
confidence
This is a rarely used field in the specification that would indicate the confidence in the location specified. See RFC7459 for exact details.
Sub-parameters:
pdf- One of:unknownnormalrectangular
value- A percentage indicating the confidence.
profile
Profile
Configuration Option Reference
Option Name |
Type |
Default Value |
Regular Expression |
Description |
|---|---|---|---|---|
|
|
|
|
Must be of type 'profile'. |
|
|
|
PIDF-LO element to place this profile in |
|
|
|
|
|
Reference to a location object |
|
|
|
|
Reference to a location object |
|
|
|
|
Reference to a location object |
|
|
|
location specification type |
|
|
|
|
Notes to be added to the outgoing PIDF-LO document |
|
|
|
|
|
Sets the value of the Geolocation-Routing header. |
|
|
|
|
Sets if empty Civic Address elements should be suppressed from the PIDF-LO document. |
|
|
|
Determine which profile on a channel should be used |
|
|
|
|
Location specification type |
|
|
|
|
Location information |
|
|
|
|
Level of confidence |
|
|
|
|
Fully qualified host name |
|
|
|
|
Location determination method |
Configuration Option Descriptions
pidf_element
tupledeviceperson
Based on RFC5491 (see below) the recommended and default element isdevice.
usage_rules
xxxx
notes
The specification of this parameter will cause a <note-well> element to be added to the outgoing PIDF-LO document. Its usage should be pre-negotiated with any recipients.
profile_precedence
prefer_incoming- Use the incoming profile if it exists and has location information, otherwise use the configured profile if it exists and has location information. If neither profile has location information, nothing is sent.prefer_config- Use the configured profile if it exists and has location information, otherwise use the incoming profile if it exists and has location information. If neither profile has location information, nothing is sent.discard_incoming- Discard any incoming profile and use the configured profile if it exists and it has location information. If the configured profile doesn't exist or has no location information, nothing is sent.discard_config- Discard any configured profile and use the incoming profile if it exists and it has location information. If the incoming profile doesn't exist or has no location information, nothing is sent.
format
civicAddress- Thelocation_infoparameter must contain a comma separated list of IANA codes or synonyms describing the civicAddress of this location. The IANA codes and synonyms can be obtained by executing the CLI commandgeoloc show civicAddr_mapping.GML- Thelocation_infoparameter must contain a comma separated list valid GML elements describing this location.URI- Thelocation_infoparameter must contain a single URI parameter which contains an external URI describing this location.
location_info
The contents of this parameter are specific to the location format.
civicAddress- location_info = country=US,A1="New York",city_district=Manhattan, A3="New York", house_number=1633, street=46th, street_suffix = Street, postal_code=10222,floor=20,room=20A2GML- location_info = Shape=Sphere, pos3d="39.12345 -105.98766 1920", radius=200URI- location_info = URI=https:/something.com?exten=${EXTEN}
confidence
This is a rarely used field in the specification that would indicate the confidence in the location specified. See RFC7459 for exact details.
Sub-parameters:
pdf- One of:unknownnormalrectangular
value- A percentage indicating the confidence.
location_source
This parameter isn't required but if provided, RFC8787 says it MUST be a fully qualified host name. IP addresses are specifically NOT allowed. The value will be placed in a loc-src parameter appended to the URI in the {{ Geolocation}} header.
method
This is a rarely used field in the specification that would indicate the method used to determine the location. Its usage and values should be pre-negotiated with any recipients.
GPSA-GPSManualDHCPTriangulationCell802.11
Import Version
This documentation was imported from Asterisk Version GIT-18-91a12a5