src/modules/rlm_ippool/rlm_ippool_tool.8

   1 .\" Automatically generated by Pod::Man v1.34, Pod::Parser v1.13
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sh \" Subsection heading
   6 .br
   7 .if t .Sp
   8 .ne 5
   9 .PP
  10 \fB\\$1\fR
  11 .PP
  12 ..
  13 .de Sp \" Vertical space (when we can't use .PP)
  14 .if t .sp .5v
  15 .if n .sp
  16 ..
  17 .de Vb \" Begin verbatim text
  18 .ft CW
  19 .nf
  20 .ne \\$1
  21 ..
  22 .de Ve \" End verbatim text
  23 .ft R
  24 .fi
  25 ..
  26 .\" Set up some character translations and predefined strings.  \*(-- will
  27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  28 .\" double quote, and \*(R" will give a right double quote.  | will give a
  29 .\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
  30 .\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
  31 .\" expand to `' in nroff, nothing in troff, for use with C<>.
  32 .tr \(*W-|\(bv\*(Tr
  33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  34 .ie n \{\
  35 .    ds -- \(*W-
  36 .    ds PI pi
  37 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  38 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  39 .    ds L" ""
  40 .    ds R" ""
  41 .    ds C` ""
  42 .    ds C' ""
  43 'br\}
  44 .el\{\
  45 .    ds -- \|\(em\|
  46 .    ds PI \(*p
  47 .    ds L" ``
  48 .    ds R" ''
  49 'br\}
  50 .\"
  51 .\" If the F register is turned on, we'll generate index entries on stderr for
  52 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
  53 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  54 .\" output yourself in some meaningful fashion.
  55 .if \nF \{\
  56 .    de IX
  57 .    tm Index:\\$1\t\\n%\t"\\$2"
  58 ..
  59 .    nr % 0
  60 .    rr F
  61 .\}
  62 .\"
  63 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
  64 .\" way too many mistakes in technical documents.
  65 .hy 0
  66 .if n .na
  67 .\"
  68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  70 .    \" fudge factors for nroff and troff
  71 .if n \{\
  72 .    ds #H 0
  73 .    ds #V .8m
  74 .    ds #F .3m
  75 .    ds #[ \f1
  76 .    ds #] \fP
  77 .\}
  78 .if t \{\
  79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80 .    ds #V .6m
  81 .    ds #F 0
  82 .    ds #[ \&
  83 .    ds #] \&
  84 .\}
  85 .    \" simple accents for nroff and troff
  86 .if n \{\
  87 .    ds ' \&
  88 .    ds ` \&
  89 .    ds ^ \&
  90 .    ds , \&
  91 .    ds ~ ~
  92 .    ds /
  93 .\}
  94 .if t \{\
  95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 101 .\}
 102 .    \" troff and (daisy-wheel) nroff accents
 103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 110 .ds ae a\h'-(\w'a'u*4/10)'e
 111 .ds Ae A\h'-(\w'A'u*4/10)'E
 112 .    \" corrections for vroff
 113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 115 .    \" for low resolution devices (crt and lpr)
 116 .if \n(.H>23 .if \n(.V>19 \
 117 \{\
 118 .    ds : e
 119 .    ds 8 ss
 120 .    ds o a
 121 .    ds d- d\h'-1'\(ga
 122 .    ds D- D\h'-1'\(hy
 123 .    ds th \o'bp'
 124 .    ds Th \o'LP'
 125 .    ds ae ae
 126 .    ds Ae AE
 127 .\}
 128 .rm #[ #] #H #V #F C
 129 .\" ========================================================================
 130 .\"
 131 .IX Title "RLM_IPPOOL_TOOL 8"
 132 .TH RLM_IPPOOL_TOOL 8 "October 2nd, 2003" " " "FreeRADIUS Daemon"
 133 .SH "NAME"
 134 \&\fBrlm_ippool_tool\fR \- dump the contents of the FreeRadius ippool database files.
 135 .SH "SYNOPSIS"
 136 .IX Header "SYNOPSIS"
 137 \&\fBrlm_ippool_tool\fR [\fBoptions\fR] <\fIsession-db\fR> <\fIindex-db\fR> [\fBipaddress\fR]
 138 .PP
 139 \&\fBrlm_ippool_tool\fR \fI\-n\fR <\fIsession-db\fR> <\fIindex-db\fR> <\fIipaddress\fR> <\fInasIP\fR> <\fInasPort\fR>
 140 .SH "DESCRIPTION"
 141 .IX Header "DESCRIPTION"
 142 \&\fBrlm_ippool_tool\fR dumps the contents of the FreeRADIUS ippool databases for
 143 analyses or for removal of active (stuck?) entries.
 144 .PP
 145 \&\fBrlm_ippool_tool \-n\fR adds a usage entry to the FreeRADIUS ippool databases.
 146 .PP
 147 Options are:
 148 .IP "\fB\-a\fR" 8
 149 .IX Item "-a"
 150 Print all active entries.
 151 .IP "\fB\-c\fR" 8
 152 .IX Item "-c"
 153 Report the number of active entries.
 154 .IP "\fB\-r\fR" 8
 155 .IX Item "-r"
 156 Remove active entries.
 157 .IP "\fB\-v\fR" 8
 158 .IX Item "-v"
 159 Verbose report of all entries
 160 .IP "\fB\-n\fR" 8
 161 .IX Item "-n"
 162 Database addition mode (\*(L"New\*(R")
 163 .SH "EXAMPLES"
 164 .IX Header "EXAMPLES"
 165 Given the syntax in the FreeRadius radiusd.conf:
 166 .PP
 167 .Vb 7
 168 \& ippool myippool {
 169 \&        range-start = 192.168.1.0
 170 \&        range-stop = 192.168.1.255
 171 \&        [...]
 172 \&        session-db = ${raddbdir}/ip-pool.db
 173 \&        ip-index = ${raddbdir}/ip-index.db
 174 \& }
 175 .Ve
 176 .PP
 177 To see the number of active entries in this pool, use:
 178 .PP
 179 .Vb 2
 180 \& $ rlm_ippool_tool -c ip-pool.db ip-index.db
 181 \& 13
 182 .Ve
 183 .PP
 184 To see all active entries in this pool, use:
 185 .PP
 186 .Vb 8
 187 \& $ rlm_ippool_tool -a ip-pool.db ip-index.db
 188 \& 192.168.1.5
 189 \& 192.168.1.82
 190 \& 192.168.1.244
 191 \& 192.168.1.57
 192 \& 192.168.1.120
 193 \& 192.168.1.27
 194 \& [...]
 195 .Ve
 196 .PP
 197 To see all information about the active entries in the use, use:
 198 .PP
 199 .Vb 8
 200 \& $ rlm_ippool_tool -av ip-pool.db ip-index.db
 201 \& NAS:172.16.1.1 port:0x2e8 - ipaddr:192.168.1.5 active:1 cli:0 num:1
 202 \& NAS:172.16.1.1 port:0x17c - ipaddr:192.168.1.82 active:1 cli:0 num:1
 203 \& NAS:172.16.1.1 port:0x106 - ipaddr:192.168.1.244 active:1 cli:0 num:1
 204 \& NAS:172.16.1.1 port:0x157 - ipaddr:192.168.1.57 active:1 cli:0 num:1
 205 \& NAS:172.16.1.1 port:0x2d8 - ipaddr:192.168.1.120 active:1 cli:0 num:1
 206 \& NAS:172.16.1.1 port:0x162 - ipaddr:192.168.1.27 active:1 cli:0 num:1
 207 \& [...]
 208 .Ve
 209 .PP
 210 To see only information of one entry, use:
 211 .PP
 212 .Vb 2
 213 \& $ rlm_ippool_tool -v ip-pool.db ip-index.db 192.168.1.1
 214 \& NAS:172.16.1.1 port:0x90 - ipaddr:192.168.1.1 active:0 cli:0 num:0
 215 .Ve
 216 .PP
 217 To add an \s-1IP\s0 address usage entry, use:
 218 .PP
 219 .Vb 4
 220 \& $ rlm_ippool_tool -n ip-pool.db ip-index.db 192.168.1.1 172.16.1.1 0x90
 221 \& rlm_ippool_tool: Allocating ip to nas/port: 172.16.1.1/144
 222 \& rlm_ippool_tool: num: 1
 223 \& rlm_ippool_tool: Allocated ip 192.168.1.1 to client on nas 172.16.1.1,port 144
 224 .Ve
 225 .SH "AUTHOR"
 226 .IX Header "AUTHOR"
 227 Currently part of the FreeRADIUS Project (http://www.freeradius.org)
 228 Originally by Edwin Groothuis, edwin@mavetju.org (http://www.mavetju.org)
 229 .PP
 230 Mailing list details are at http://www.freeradius.org/
 231 .SH "BUGS"
 232 .IX Header "BUGS"