doc/rlm_sqlippool

   1 Welcome to the SQL Based IP Pool module.
   2
   3 **********************************************************************
   4 As of September 2006 this module is still under some development and
   5 currently is only tested by the developers on PostgreSQL (Version 8.1)
   6                          Use it at your own risk!
   7 If plan to attempt to use a DB other than PostgreSQL please expect to
   8 have to do extra work which is not for SQL newbies.
   9 Having said that it works great for us in production and should (with
  10 some work) function correctly with other SQL server types.
  11 **********************************************************************
  12
  13
  14 To use the sqlipool module you simply need to have an IP-Pool Attribute
  15 (Keep in mind that its a **CHECK** item, not reply) in the required
  16 configuration file, which is either in files(users), sql or any other
  17 type of configuration schema.
  18
  19 The initialization of the radippool table is left to the user instead of
  20 being handled inside the module. This allows pool management to be done
  21 from any sql capable programming language and pools can be created,
  22 resized, deleted at run time without radiusd needing to be restarted.
  23
  24 The only required fields are, pool_name and ip_address. A pool consists
  25 of one or more rows in the table with the same pool_name and a different
  26 ip_address. There is no restriction on which ip addresses/ranges may be in
  27 the same pool, and addresses do not need to be concurrent.
  28
  29 We are currently using the variable definitions of the xlat module, so
  30 before editing the sqlippool.conf file, please go and read the
  31 variables.txt in the freeradius/doc directory. It will help you alot!..
  32
  33 As you may noticed, there is a pool-key variable in the config file which
  34 allows you to select which attribute is unique according to your NAS setup.
  35 On a standard dialup NAS this is going to be "NAS-Port" but on an ethernet
  36 or wireless network it will probably be "Calling-Station-Id". Other more
  37 exotic options like "3GPP-IMSI" may also exist depending on your NAS.
  38 The only requirement is that the pool-key must be unique and must be
  39 received in both Access-Request and Accounting packages so that we know to
  40 clear the lease on the ip when the session disconnects.