|
This is the manual for GNU Gatekeeper 5.13.
A manual for your version is in your GnuGk download archive.
A PDF version can be found in the download section.
Chapters:
Contents ·
Introduction ·
Installation ·
Getting started ·
Basic Config ·
Routed Mode & Proxy ·
Routing ·
RAS Config ·
Authentication ·
Accounting ·
Neighbors ·
Per Endpoint Config ·
Advanced Config ·
Monitoring ·
Advanced Topics
The GNU Gatekeeper Manual Chapter 7
Some messages from endpoints to the gatekeeper (GatekeeperRequest,
RegistrationRequest and InfoRequestResponse) contain an element
rasAddress where the endpoint tells the gatekeeper where to
send the response to these messages.
By default GnuGk will ignore this address and respond to the IP and port
where it has received the request from. It does so, because some endpoints
rely on this behavior and in case where eg. a NAT is used, the response may
not reach the sender if it is sent to another IP and port. Usually endpoints
will send the RAS messages from their RAS port anyway, so it doesn't make a difference.
This section allows you to define when GnuGk should use the rasAddress inside the
message it has received instead of the address where it has received the message from.
- Syntax:
-
network=True|False
The network is specified by an IP plus optional CIDR, eg. 192.168.1.0/24.
The network specifies the IP where the RAS message is received from, the setting specifies
whether to use the rasAddress. The default is not to use it.
The rule for the network with the longest netmask is used (the most specific).
- Example:
-
In this example messages from the 192.168.0.0/18 will use the rasAddress,
except for messages coming from the 192.168.4.0/24 network.
[ReplyToRasAddress]
192.168.0.0/18=True
192.168.4.0/24=False
This section configures how dialed E.164 numbers are routed to a specific gateway.
- Format:
-
gw-alias=prefix[:=priority][,prefix[:=priority],...]
Note that you must specify the alias of the gateway.
If a gateway has registered with the specified alias, all numbers beginning with
the prefixes are routed to that gateway. Special characters . and !
can be used here to match any digit or to disable the prefix.
A priority can be given to each prefix for each gateway (using := syntax),
so that if several gateways match the dialed number, the one
with the highest prefix priority will be selected to route the call (when
the ActivateFailover switch is ON, the call will be routed to all selected
gateways in order of the prefix priority). A smaller value corresponds to
a higher priority. Default value is 1. If the prefix priority
and overlaps the GatewayPriority (see section
[EP::...]), the prefix priority will be preferred.
In the following example, the gateway "test-gw" will be responsible for
prefixes "02" and "03" with a priority of 3, and for "04" with a priority
of 1.
- Example:
-
test-gw=02,03:=3,04:=1
In this section you may configure endpoints that don't have RAS support
or that you don't want to be expired. Their records will always
remain in the registration table of the gatekeeper.
However, you can still unregister it via the status port.
Special characters . and !
can be used with prefixes here to match any digit and disable the prefix.
You may use := syntax to set a prefix priority in the same manner as in
[RasSrv::GWPrefixes] section.
Make sure you add at least one prefix for all gateways,
even if you assign the prefixes elsewhere (eg. in the [EP::...] section),
otherwise the endpoint won't be considered a gateway and those settings won't apply!
Gateway entries may also optionally include vendor information which is stored with the gateway record
- Format:
-
IP[:port]=alias[,alias,...;prefix[:=priority][,prefix[:=priority]]...;[vendor,product]
- Example:
-
For gateway,
10.0.1.5=MyGW;009,008:=2,0.7:=3
10.0.1.5=MyGW;009,008:=2,0.7:=3;yate,4.1.0
For terminal,
10.0.1.10:1720=700
AcceptEndpointIdentifier=1
Default: 1
Whether to accept endpointIdentifier specified in a full RRQ.
AcceptGatewayPrefixes=1
Default: 1
A gateway can register its prefixes with the gatekeeper by sending
supportedPrefixes in the terminalType field of the RRQ.
This option defines whether to accept the specified prefixes of a gateway.
AcceptMCUPrefixes=1
Default: 1
A MCU can register its prefixes with the gatekeeper by sending
supportedPrefixes in the terminalType field of the RRQ.
This option defines whether to accept the specified prefixes of a MCU.
OverwriteEPOnSameAddress=1
Default: 0
In some networks an endpoint's IP address may change unexpectedly. This
may happen when an endpoint is using a PPP connection (e.g. modem or ADSL).
This option defines how to handle a registration request (RRQ) from an IP
address which does not match what we have stored. The default action is
to reject the request. With this option enabled the conflicting request
will cause an unregister request (URQ) to be sent for the existing IP
address and the entry to be removed, allowing the endpoint to register
with the new address.
IRQPollCount=0
Default: 1
When the gatekeeper does not receive a keep-alive RRQ from an endpoint
within the TimeToLive time period, it sends an IRQ message to "poll" the endpoint
and check if it is alive. After IRQPollCount messages are sent and no reply
is received, the endpoint is unregistered. To disable this feature (and unregister
endpoints immediately after TimeToLive timeout), set this variable to 0.
IRQ poll interval is 60 seconds.
SupportDynamicIP=1
Default: 0
When the IP address of an endpoint changes, the gatekeeper can maintain registration.
This will force the EP to fully re-register if its IP address changes.
AccHTTPLink=https://billing.mysite.com?account=%a&password=%p
Default: N/A
You can assign a URL for clients to access to view billing information.
If using PacPhone you can also add wildcards for the client to use so the clients
H323ID and password can be used to directly access their account information.
%a - H323ID %p - password
AliasTypeFilter=terminal;h323id,dialeddigits
Default: N/A
Use this setting where endpoints send multiple H225_AliasAddress and some Aliases are
shared across multiple registrations. You can filter out the shared alias types for
any given endpoint type. The registrations will keep all alias types listed in the
filter setting and remove all others.
You must have separate AliasTypeFilter entries for each endpoint type.
Valid endpoint types are: gatekeeper, gateway, mcu and terminal.
Valid filters are: h323id, dialeddigits, url, transport, email and partynumber.
NOTE: If no alias is found that match the filter then all aliases are registered.
GatewayAssignAliases=0
Default: 1
If AssignedAliases::SQL has been configured, apply assignments to gateway registrations (default).
This switch is designed when set to 0 to use additiveRegistrations with gateways so that the assignedAliases
are not all assigned upon registration but only when the additiveRegistration is made. This ensures only the currently
registered endpoints appear in the endpoint table.
AuthenticatedAliasesOnly=1
Default: 0
This switch removes during registration any TerminalAliases that have not been Authenticated.
Supported Authentication modules are SQLAuth, SimplePasswordAuth and SQLPasswordAuth.
ArjReasonRouteCallToGatekeeper=1
Default: 1
If enabled, the gatekeeper rejects an answered ARQ without a pre-existing
CallRec found in the CallTable by reason routeCallToGatekeeper
in routed mode.
The endpoint shall release the call immediately and re-send call Setup
to the gatekeeper.
RemoveTrailingChar=#
Default: (space)
Specify the trailing character to be removed in destinationInfo.
For example, if your endpoint incorrectly contains a termination character
such as `#' in destinationInfo you may remove it with this option.
This switch also applies to unregistered calls.
RoundRobinGateways=0
Default: 1
Enable/disable round-robin gateway selection if more than one gateway
matches a dialed number. If disabled, the first available gateway will be selected.
Otherwise, subsequent calls will be sent to gateways in round-robin fashion.
This switch also applies to unregistered calls.
LeastUsedRouting=1
Default: 0
Select the least used gateway when routing calls to achieve a more even usage.
This switch is logically incompatible with round-robin.
This switch also applies to unregistered calls.
SendRIP=9000
Default: 0
Send a RequestInProgress (RIP) message with this delay value after receiving an ARQ.
This switch can be used to extend the duration the caller will wait for an answer.
No RIP is sent when the delay is set to 0.
CheckSenderIP=1
Default: 0
Verify that the ARQ is sent from the same IP as the RRQ.
This allows the assigning of aliases to endpoints as they register, allowing them to
set their fully qualified E.164 or URI addresses.
- Example:
-
[RasSrv::AssignedAlias]
1234=3323465777,[email protected]
This section configures GnuGk to read the assigned aliases from a database.
You can use the same database parameters as defined in
[SQLPasswordAuth].
This section allows you to override the global definition of
AlternateGKs
from the [Gatekeeper::Main] section for certain IPs or IP ranges.
See there for a detailed definition of the config options.
The network is specified by an IP plus optional CIDR, eg. 192.168.1.0/24.
The rule for the network with the longest netmask is used (the most specific).
- Example:
-
In this example, 192.168.1.10 gets assigned GnuGk10 as alternate gatekeeper,
while the rest of the 192.168.0.0/18 network will use GnuGk4. Endpoints in
all other networks will use the globally defined alternate gatekeeper.
[RasSrv::AlternateGatekeeper]
192.168.0.0/18=192.0.2.4;1719;true;1;GnuGk4
192.168.1.10=192.0.2.10;1719;true;1;GnuGk10
This section allows
GnuGk to read the alternate gatekeepers from a database.
Use the
common database configuration options
to define your database connection for this module.
This allows the assigning of a gatekeeper based upon the H323ID or the
apparent source IP address of the registering endpoint.
The received H323ID in the GRQ is checked to see if it has a prefix
for an assigned gatekeeper or the IP is in a range of an assigned
gatekeeper.
The endpoint is then advised in the GCF to register with that gatekeeper.
You may have multiple gatekeepers for a specific prefix. The first
is assigned as the primary and others are then the alternates.
(requires H.323v6)
- Examples:
-
[RasSrv::AssignedGatekeeper]
;; for endpoint with alias starting with 01234
01234=192.168.1.100:1719
;; for endpoint with alias starting with 999
999=[2a01:4f8:61:2243::99]:1719
;; for endpoints in the range of 195.71.129.0/24 or 195.71.131.0/24
^195\.71\.(129|131)\.[0-9]+$=10.10.0.5:1719
;; for endpoints tarting with ^2a01:
^2a01:=[2a01:4f8:61:2243::199]:1719
This section allows
GnuGk to read the assigned gatekeepers from a database.
Use the
common database configuration options
to define your database connection for this module.
Many endpoints that support alternate gatekeepers will move to the
alternate once they can't reach their current gatekeeper, but will
never change back, causing uneven distribution of endpoints between
gatekeepers.
Many older endpoints don't support the assigned gatekeeper procedures
defined by the ITU to move back, either.
With this section, you can have GnuGk look up the intended home gatekeeper
for each endpoint and GnuGk will push the endpoints back to their intended
home gatekeeper.
For this to work, the endpoint must signal support alternate gatekeepers
in their RegistrationRequest (RRQ) and obey the alternate gatekeeper
information provided in UnregistrationRequests (URQ) from GnuGk.
The home gatekeepers must be defined as neighbors to GnuGk and should
have the neighbor ping enabled so GnuGk will know when they are up or down.
GnuGk will wait a defined amount of time before trying to move the endpoint
back and will also not try to move it while it is actively in a call.
Use the
common database configuration options
to define your database connection for this module.
RehomingWait=60
Default: 300
The number of seconds to wait until GnuGk tries ro send the endpoint back to it's home gatekeeper.
Query=SELECT ...
Default: N/A
Defines the SQL query used to retrieve the intended home gatekeepers from the database.
These parameters are defined:
%u - endpoint alias (first alias)%i - endpoint IP%g - gatekeeper ID
Sample query string:
SELECT home from users where alias = "%u"
This section configures GnuGk to read the assigned Languages from a database.
You can use the same database parameters as defined in
[SQLPasswordAuth].
The gatekeeper can automatically detect whether an endpoint is behind NAT.
However, if the detection fails, you can specify it manually in this section.
- Format:
-
alias=true | yes | 1
- Example:
-
Specify that the endpoint with alias 601 is behind NAT.
601=true
H323 SQL Presence system : Highly Experimental
Use the
common database configuration options
to define your database connection for this module.
IncrementalUpdate=1
Default: 0
Whether to poll the database to check for Presence updates
UpdateWorkerTimer=10
Default: 5
Sleep time between updating of H.460 Presence information.
QueryList=SELECT ...
Default: N/A
Define a SQL query to be used to perform database lookups to retrieve
contact information (order is important)
%i - presence identifier GUID value create externally.%u - alias to which the presence information belongs%a - contact alias%s - Is subscriber (default should be 0)%b - contact instruction values 0-subscribe 1-unsubscribe 2-block 3-unblock 4-waiting approval%y - Whether instruction active (default should be 1)%z - Update Time (should be current UNIX time)%d - Display name or friendly name of the alias (optional)%v - Path to the contacts URL (optional)%c - contact category (optional) values 0-Audio 1-Video 2-data 3-H.239 4-generic%t - Incremental Timestamp for query (set by Gatekeeper)
Example
QueryList=SELECT subscriptionID,h323id,alias,0,status,1,updated,display,avatar,category FROM subscription WHERE timestamp > '%t' ORDER BY h323id,alias
QueryAdd=INSERT ...
Default: N/A
Define a SQL query to Add contact record to the database
Example
QueryAdd=INSERT INTO subscription (subscriptionID,h323id,alias,isSubscriber,display) VALUES('%i','%u','%a','%s', '%d');
QueryDelete=Delete ...
Default: N/A
Define a SQL query to delete a contact from the database
Example
QueryDelete=DELETE FROM subscription WHERE subscriptionID = '%i'
item>QueryUpdate=UPDATE ...
Default: N/A
Define a SQL query to Update contact record status
Example
QueryUpdate=UPDATE subscription SET status = '%b' WHERE subscriptionID = '%i'
Next
Previous
Contents
Chapters:
Contents ·
Introduction ·
Installation ·
Getting started ·
Basic Config ·
Routed Mode & Proxy ·
Routing ·
RAS Config ·
Authentication ·
Accounting ·
Neighbors ·
Per Endpoint Config ·
Advanced Config ·
Monitoring ·
Advanced Topics
|
