.\" Automatically generated by Pod::Man v1.34, Pod::Parser v1.13
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings. \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote. | will give a
.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
.\" expand to `' in nroff, nothing in troff, for use with C<>.
.tr \(*W-|\(bv\*(Tr
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
. ds -- \(*W-
. ds PI pi
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
. ds L" ""
. ds R" ""
. ds C` ""
. ds C' ""
'br\}
.el\{\
. ds -- \|\(em\|
. ds PI \(*p
. ds L" ``
. ds R" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. nr % 0
. rr F
.\}
.\"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff
.if n \{\
. ds #H 0
. ds #V .8m
. ds #F .3m
. ds #[ \f1
. ds #] \fP
.\}
.if t \{\
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
. ds #V .6m
. ds #F 0
. ds #[ \&
. ds #] \&
.\}
. \" simple accents for nroff and troff
.if n \{\
. ds ' \&
. ds ` \&
. ds ^ \&
. ds , \&
. ds ~ ~
. ds /
.\}
.if t \{\
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
. \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
. \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
. \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
. ds : e
. ds 8 ss
. ds o a
. ds d- d\h'-1'\(ga
. ds D- D\h'-1'\(hy
. ds th \o'bp'
. ds Th \o'LP'
. ds ae ae
. ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "RLM_IPPOOL_TOOL 8"
.TH RLM_IPPOOL_TOOL 8 "October 2nd, 2003" " " "FreeRADIUS Daemon"
.SH "NAME"
\&\fBrlm_ippool_tool\fR \- dump the contents of the FreeRadius ippool database files.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
\&\fBrlm_ippool_tool\fR [\fBoptions\fR] <\fIsession-db\fR> <\fIindex-db\fR> [\fBipaddress\fR]
.PP
\&\fBrlm_ippool_tool\fR \fI\-n\fR <\fIsession-db\fR> <\fIindex-db\fR> <\fIipaddress\fR> <\fInasIP\fR> <\fInasPort\fR>
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fBrlm_ippool_tool\fR dumps the contents of the FreeRADIUS ippool databases for
analyses or for removal of active (stuck?) entries.
.PP
\&\fBrlm_ippool_tool \-n\fR adds a usage entry to the FreeRADIUS ippool databases.
.PP
Options are:
.IP "\fB\-a\fR" 8
.IX Item "-a"
Print all active entries.
.IP "\fB\-c\fR" 8
.IX Item "-c"
Report the number of active entries.
.IP "\fB\-r\fR" 8
.IX Item "-r"
Remove active entries.
.IP "\fB\-v\fR" 8
.IX Item "-v"
Verbose report of all entries
.IP "\fB\-n\fR" 8
.IX Item "-n"
Database addition mode (\*(L"New\*(R")
.SH "EXAMPLES"
.IX Header "EXAMPLES"
Given the syntax in the FreeRadius radiusd.conf:
.PP
.Vb 7
\& 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
\& }
.Ve
.PP
To see the number of active entries in this pool, use:
.PP
.Vb 2
\& $ rlm_ippool_tool -c ip-pool.db ip-index.db
\& 13
.Ve
.PP
To see all active entries in this pool, use:
.PP
.Vb 8
\& $ 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
\& [...]
.Ve
.PP
To see all information about the active entries in the use, use:
.PP
.Vb 8
\& $ 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
\& [...]
.Ve
.PP
To see only information of one entry, use:
.PP
.Vb 2
\& $ 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
.Ve
.PP
To add an \s-1IP\s0 address usage entry, use:
.PP
.Vb 4
\& $ 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
.Ve
.SH "AUTHOR"
.IX Header "AUTHOR"
Currently part of the FreeRADIUS Project (http://www.freeradius.org)
Originally by Edwin Groothuis, edwin@mavetju.org (http://www.mavetju.org)
.PP
Mailing list details are at http://www.freeradius.org/
.SH "BUGS"
.IX Header "BUGS"