New build path variable
[freeradius.git] / raddb / sqlippool.conf
index 75d21e6..94fabc0 100644 (file)
@@ -1,95 +1,67 @@
-
-sqlippool sqlippool {
-
- #
- # SQL connection information
- #
+##  Configuration for the SQL based IP Pool module (rlm_sqlippool)
+##
+##  The database schemas are available at:
+##
+##       raddb/sql/DB/ippool.sql
+##
+##  $Id$
+
+sqlippool {
+
+ #########################################
+ ## SQL instance to use (from sql.conf) ##
+ ##
+ ##  If you have multiple sql instances, such as "sql sql1 {...}",
+ ##  use the *instance* name here: sql1.
+ #########################################
  sql-instance-name = "sql"
 
- # lease_duration. fix for lost acc-stop packets
+ ## SQL table to use for ippool range and lease info
+ ippool_table = "radippool"
+
+ ## IP lease duration. (Leases expire even if Acct Stop packet is lost)
  lease-duration = 3600
 
- # Attribute which should be considered unique per NAS
+ ## Attribute which should be considered unique per NAS
+ ## Using NAS-Port gives behaviour similar to rlm_ippool. (And ACS)
+ ## Using Calling-Station-Id works for NAS that send fixed NAS-Port
+ ## ONLY change this if you know what you are doing!
  pool-key = "%{NAS-Port}"
  # pool-key = "%{Calling-Station-Id}"
 
-
+ ################################################################
  #
- # This series of queries allocates an IP address
- #
- allocate-clear = "UPDATE radippool \
-  SET nasipaddress = '', pool_key = 0, callingstationid = '', \
-  expiry_time = 'now'::timestamp(0) - '1 second'::interval \
-  WHERE pool_key = '%{Calling-Station-Id}'"
-
- # note the ORDER BY clause of next query, it'll try to allocate IPs
- # like Cisco internal pools do - it _trys_ to allocate the same IP-address
- # which user had last session...
- allocate-find = "SELECT framedipaddress FROM radippool \
-  WHERE pool_name = '%{reply:Pool-Name}' AND expiry_time < 'now'::timestamp(0) \
-  ORDER BY pool_name, (username <> '%{User-Name}'), (callingstationid <> '%{Calling-Station-Id}'), expiry_time \
-  LIMIT 1 \
-  FOR UPDATE"
-
- allocate-update = "UPDATE radippool \
-  SET nasipaddress = '%{NAS-IP-Address}', pool_key = '%{Calling-Station-Id}', \
-  callingstationid = '%{Calling-Station-Id}', username = '%{User-Name}', \
-  expiry_time = 'now'::timestamp(0) + '${lease-duration} second'::interval \
-  WHERE framedipaddress = '%I'"
-
-
-
+ #  WARNING: MySQL has certain limitations that means it can
+ #           hand out the same IP address to 2 different users.
  #
- # This series of queries frees an IP number when an accounting
- # START record arrives
+ #           We suggest using an SQL DB with proper transaction
+ #           support, such as PostgreSQL, or using MySQL
+ #          with InnoDB.
  #
- start-update = "UPDATE radippool \
-  SET expiry_time = 'now'::timestamp(0) + '%J second'::interval \
-  WHERE nasipaddress = '%n' AND nas_port = '%p' AND pool_name = '%P'"
+ ################################################################
 
  #
- # This series of queries frees an IP number when an accounting
- # STOP record arrives
+ #  Use the same database as configured in the "sql" module, "database"
+ #  configuration item.  Change the "postgresql" name below to be the
+ #  same as the "database" field of the SQL module referred to in the
+ #  "sql-instance-name", above.
  #
- stop-clear = "UPDATE radippool \
-  SET nasipaddress = '', pool_key = 0, callingstationid = '', \
-  expiry_time = 'now'::timestamp(0) - '1 second'::interval \
 WHERE nasipaddress = '%{Nas-IP-Address}' AND pool_key = '${pool-key}' AND username = '%{User-Name}' \
-  AND callingstationid = '%{Calling-Station-Id}' AND framedipaddress = '%{Framed-IP-Address}'"
+$INCLUDE sql/postgresql/ippool.conf
+ ## Logging configuration. (Comment out to disable logging)
sqlippool_log_exists = "Existing IP: %{reply:Framed-IP-Address} \
+  (did %{Called-Station-Id} cli %{Calling-Station-Id} port %{NAS-Port} user %{User-Name})"
 
+ sqlippool_log_success = "Allocated IP: %{reply:Framed-IP-Address} from %{control:Pool-Name} \
+  (did %{Called-Station-Id} cli %{Calling-Station-Id} port %{NAS-Port} user %{User-Name})"
 
+ sqlippool_log_clear = "Released IP %{Framed-IP-Address}\
+ (did %{Called-Station-Id} cli %{Calling-Station-Id} user %{User-Name})"
 
+ sqlippool_log_failed = "IP Allocation FAILED from %{control:Pool-Name} \
+  (did %{Called-Station-Id} cli %{Calling-Station-Id} port %{NAS-Port} user %{User-Name})"
 
- #
- # This series of queries frees an IP number when an accounting
- # ALIVE record arrives
- #
- alive-update = "UPDATE radippool \
-  SET expiry_time = 'now'::timestamp(0) + '${lease-duration} seconds'::interval \
-  WHERE nasipaddress = '%{Nas-IP-Address}' AND pool_key = '${pool-key}' AND username = '%{User-Name}' \
-  AND callingstationid = '%{Calling-Station-Id}' AND framedipaddress = '%{Framed-IP-Address}'"
-
-
- #
- # This series of queries frees the IP numbers allocate to a
- # NAS when an accounting ON record arrives
- #
- on-clear = "UPDATE radippool \
-  SET nasipaddress = '', pool_key = 0, callingstationid = '', \
-  expiry_time = 'now'::timestamp(0) - '1 second'::interval \
-  WHERE nasipaddress = '%{Nas-IP-Address}' AND username = '%{User-Name}' \
-  AND callingstationid = '%{Calling-Station-Id}' AND framedipaddress = '%{Framed-IP-Address}'"
-
- #
- # This series of queries frees the IP numbers allocate to a
- # NAS when an accounting OFF record arrives
- #
- off-clear = "UPDATE radippool \
-  SET nasipaddress = '', pool_key = 0, callingstationid = '', \
-  expiry_time = 'now'::timestamp(0) - '1 second'::interval \
-  WHERE nasipaddress = '%{Nas-IP-Address}' AND username = '%{User-Name}' \
-  AND callingstationid = '%{Calling-Station-Id}' AND framedipaddress = '%{Framed-IP-Address}'"
-
+ sqlippool_log_nopool = "No Pool-Name defined \
+  (did %{Called-Station-Id} cli %{Calling-Station-Id} port %{NAS-Port} user %{User-Name})"
 
 }
-