1 files changed, 81 insertions, 3 deletions

diff --git a/notes/projects/radius/sql/README.ippool.md b/notes/projects/radius/sql/README.ippool.md
index b463df8..d6ed50f 100644
--- a/notes/projects/radius/sql/README.ippool.md
+++ b/notes/projects/radius/sql/README.ippool.md
@@ -5,7 +5,7 @@ IP Engineering RADIUS IP Pool Database
 Objectives
 ----------
 
-   * Psuedo static IP addresses
+   * Psuedo static IP addresses (i.e. "sticky" IP addresses)
    * Per NAS Preference for geographic regions
    * Ability to deavtivate/busy out specific netblocks
 
@@ -77,10 +77,88 @@ The following PostgreSQL (psql) commands will purge RADIUS roles from Postgresql
       DROP ROLE radius;
 
 
-Network Block Management
-------------------------
+Auditing Reports
+----------------
 
+The following displays IP usage by IP pool:
+
+      SELECT * FROM pool_audit()     ORDER BY poolname, regionType;   
+
+The following displays IP usage by IP pool and region:
+
+      SELECT * FROM region_audit()   ORDER BY poolName, regionName;
+
+The following displays IP usage by defined netblocks:
+
+      SELECT * FROM netblock_audit() ORDER BY poolName, network;
+
+The following displays the state of each IP address:
+
+      SELECT * FROM ip_audit()       ORDER BY ipAddress;
 
 
 IP Address Assignments
 ----------------------
+
+IP addresses can be manually assigned or auto-assigned based upon the NAS and
+pool type specified.
+
+The following is an example of manually specifing an IP address assignment:
+
+      SELECT ip_assign
+             ( assignIp      := '209.193.4.8/32',
+               assignNas     := 'br1.sol',
+               assignUser    := 'jdoe8@example.net'
+             );
+
+The above assignment will fail if a netblock containing '209.193.4.8/32' has
+been marked as 'busyout'.  A assignment to a busy netblock can be forced using
+the 'assignForce' option:
+
+      SELECT ip_assign
+             ( assignIp      := '209.193.4.3/32',
+               assignNas     := 'br1.sol',
+               assignUser    := 'busy1@example.net',
+               assignForce   := TRUE
+             );
+
+The following is an example of auto-assigning an IP address based upon a client
+session's NAS and pool type:
+
+      SELECT ip_autoassign
+             ( assignUser    := 'autoassign1@example.net',
+               assignNas     := 'br1.sol',
+               assignPool    := 'dhcp'
+             );
+
+By default, `ip_autoassign()` will attempt to assign "sticky" IP addresses to a
+session. A sticky address is a best effort attempt to re-assign the IP address
+previously used by the subscriber.  Sticky IP address assignments use the
+following logic to assign an IP address to a user session:
+
+   * Attempt to assign regional pool address which was last used by subscriber.
+   * Attempt to assign regional pool address which has been idle the longest.
+   * Attempt to assign non-regional pool address which was last used by subscriber.
+   * Attempt to assign non-regional pool address which has been idle the longest.
+   * Fail address assignment.
+
+Dynamic IP addresses can be requested by passing 'assignPrevIp' with a value of
+FALSE to `ip_autoassign()`:
+
+      SELECT ip_autoassign
+             ( assignUser    := 'autoassign2@example.net',
+               assignNas     := 'br1.sol',
+               assignPool    := 'dhcp',
+               assignPrevIp  := FALSE
+             );
+
+When assigning auto-assigning dynamic IP addresses, the following logic is used:
+
+   * Attempt to assign regional pool address which has been idle the longest.
+   * Attempt to assign non-regional pool address which has been idle the longest.
+   * Fail address assignment.
+
+Both manual and auto-assigned IP addresses are freed using `ip_release()`:
+
+      SELECT ip_release( '209.193.4.3' );
+