#
# $Id: rlm_ippool_tool.pod,v 1.2 2003/10/02 00:43:20 phampson Exp $
#

=head1 NAME

B<rlm_ippool_tool> - dump the contents of the FreeRadius ippool database files.

=head1 SYNOPSIS

B<rlm_ippool_tool> [B<options>] <I<session-db>> <I<index-db>> [B<ipaddress>]

B<rlm_ippool_tool> I<-n> <I<session-db>> <I<index-db>> <I<ipaddress>> <I<nasIP>> <I<nasPort>>

=head1 DESCRIPTION

B<rlm_ippool_tool> dumps the contents of the FreeRADIUS ippool databases for
analyses or for removal of active (stuck?) entries.

B<rlm_ippool_tool -n> adds a usage entry to the FreeRADIUS ippool databases.

Options are:

=over 8

=item B<-a>

Print all active entries.

=item B<-c>

Report the number of active entries.

=item B<-r>

Remove active entries.

=item B<-v>

Verbose report of all entries

=item B<-n>

Database addition mode ("New")

=back

=head1 EXAMPLES

Given the syntax in the FreeRadius radiusd.conf:

 ippool myippool {
	range-start = 192.168.1.0
	range-stop = 192.168.1.255
	[...]
	session-db = ${raddbdir}/ip-pool.db
	ip-index = ${raddbdir}/ip-index.db
 }

To see the number of active entries in this pool, use:

 $ rlm_ippool_tool -c ip-pool.db ip-index.db
 13

To see all active entries in this pool, use:

 $ rlm_ippool_tool -a ip-pool.db ip-index.db
 192.168.1.5
 192.168.1.82
 192.168.1.244
 192.168.1.57
 192.168.1.120
 192.168.1.27
 [...]

To see all information about the active entries in the use, use:

 $ rlm_ippool_tool -av ip-pool.db ip-index.db
 NAS:172.16.1.1 port:0x2e8 - ipaddr:192.168.1.5 active:1 cli:0 num:1
 NAS:172.16.1.1 port:0x17c - ipaddr:192.168.1.82 active:1 cli:0 num:1
 NAS:172.16.1.1 port:0x106 - ipaddr:192.168.1.244 active:1 cli:0 num:1
 NAS:172.16.1.1 port:0x157 - ipaddr:192.168.1.57 active:1 cli:0 num:1
 NAS:172.16.1.1 port:0x2d8 - ipaddr:192.168.1.120 active:1 cli:0 num:1
 NAS:172.16.1.1 port:0x162 - ipaddr:192.168.1.27 active:1 cli:0 num:1
 [...]

To see only information of one entry, use:

 $ rlm_ippool_tool -v ip-pool.db ip-index.db 192.168.1.1
 NAS:172.16.1.1 port:0x90 - ipaddr:192.168.1.1 active:0 cli:0 num:0

To add an IP address usage entry, use:

 $ rlm_ippool_tool -n ip-pool.db ip-index.db 192.168.1.1 172.16.1.1 0x90
 rlm_ippool_tool: Allocating ip to nas/port: 172.16.1.1/144
 rlm_ippool_tool: num: 1
 rlm_ippool_tool: Allocated ip 192.168.1.1 to client on nas 172.16.1.1,port 144

=head1 AUTHOR

Currently part of the FreeRADIUS Project (http://www.freeradius.org)
Originally by Edwin Groothuis, edwin@mavetju.org (http://www.mavetju.org)

Mailing list details are at http://www.freeradius.org/

=head1 BUGS
