Some initial sqlippool documentation and schema update
[freeradius.git] / doc / rlm_sqlippool
1 Welcome to the new SQL Based IP Pool module.
2
3 To use the sqlipool module you simply need to have an IP-Pool Attribute
4 (Keep in mind that its a **CHECK** item, not reply) in the required
5 configuration file, which is either in files(users),sql or any other
6 type of configuration schema.
7
8 The initialization of the radippool table is left to the user instead of
9 being handled inside the module. This allows pool management to be done
10 from any sql capable programming language and pools can be created,
11 resized, deleted at run time without radiusd needing to be restarted.
12
13 The only required fields are, pool_name and ip_address. A pool consists
14 of one or more rows in the table with the same pool_name and a different
15 ip_address. The is no restriction on which ip addresses/ranges may be in
16 the same pool, and addresses do not need to be concurrent.
17
18 We are currently using the variable definitions of the xlat module, so
19 before editing the sqlippool.conf file, please go and read the
20 variables.txt in the freeradius/doc directory. It will help you alot!..
21
22 On the other hand, there is a "key", which is really the key for the
23 pool modules in freeradius. As you may noticed, there is a pool-key
24 variable on the config file to have a unique connection identifier for
25 the requests.So, it should be set to the unique attribute of the
26 packages that we are receiving. Also this unique identifier must be
27 received in accounting-stop packages so that we release the used ip,
28 from the pool and put it to the free-ips list.