blob: e27cb92c2c912e0d85c77f06f85c7dc790f146e0 [file] [log] [blame] [view] [raw]
cvs2git55401132006-06-15 16:38:29 +00001.TH IPPOOL 8
2.SH NAME
3ippool \- user interface to the IPFilter pools
4.SH SYNOPSIS
5.br
6.B ippool
7-a [-dnv] [-m <name>] [-o <role>] -i <ipaddr>[/<netmask>]
8.br
9.B ippool
10-A [-dnv] [-m <name>] [-o <role>] [-S <seed>] [-t <type>]
11.br
12.B ippool
13-f <file> [-dnuv]
14.br
15.B ippool
16-F [-dv] [-o <role>] [-t <type>]
17.br
18.B ippool
19-l [-dv] [-m <name>] [-t <type>]
20.br
21.B ippool
22-r [-dnv] [-m <name>] [-o <role>] -i <ipaddr>[/<netmask>]
23.br
24.B ippool
25-R [-dnv] [-m <name>] [-o <role>] [-t <type>]
26.br
27.B ippool
28-s [-dtv] [-M <core>] [-N <namelist>]
29.SH DESCRIPTION
30.PP
31.B Ippool
32is used to manage information stored in the IP pools subsystem of IPFilter.
33Configuration file information may be parsed and loaded into the kernel,
34currently configured pools removed or changed as well as inspected.
35.PP
36The command line options used are broken into two sections: the global
37options and the instance specific options.
38.SH GLOBAL OPTIONS
39.TP
40.B \-d
41Toggle debugging of processing the configuration file.
42.TP
43.B \-n
44This flag (no-change) prevents
45.B ippool
46from actually making any ioctl
47calls or doing anything which would alter the currently running kernel.
48.TP
49.B \-v
50Turn verbose mode on.
51.SH COMMAND OPTIONS
52.TP
53.B -a
54Add a new data node to an existing pool in the kernel.
55.TP
56.B -A
57Add a new (empty) pool to the kernel.
58.TP
59.B -f <file>
60Read in IP pool configuration information from the file and load it into
61the kernel.
62.TP
63.B -F
64Flush loaded pools from the kernel.
65.TP
66.B -l
67Display a list of pools currently loaded into the kernel.
68.TP
69.B -r
70Remove an existing data node from a pool in the kernel.
71.TP
72.B -R
73Remove an existing pool from within the kernel.
74.TP
75.B -s
76Display IP pool statistical information.
77.SH OPTIONS
78.TP
79.B -i <ipaddr>[/<netmask>]
80Sets the IP address for the operation being undertaken with an
81all-one's mask or, optionally, a specific netmask given in either
82the dotted-quad notation or a single integer.
83.TP
84.B -m <name>
85Sets the pool name for the current operation.
86.TP
87.B -M <core>
88Specify an alternative path to /dev/kmem to retrieve statistical information
89from.
90.TP
91.B -N <namelist>
92Specify an alternative path to lookup symbol name information from when
93retrieving statistical information.
94.TP
95.B -o <role>
96Sets the role with which this pool is to be used. Currently only
97.B ipf,
98.B auth
99and
100.B count
101are accepted as arguments to this option.
102.TP
103.B -S <seed>
104Sets the hashing seed to the number specified. Only for use with
105.B hash
106type pools.
107.TP
108.B -t <type>
109Sets the type of pool being defined. Myst be one of
Darren Reed83f3fb12006-06-15 17:43:57 +0000110.B tree,
cvs2git55401132006-06-15 16:38:29 +0000111.B hash,
112.B group-map.
113.TP
114.B -u
115When parsing a configuration file, rather than load new pool data into the
116kernel, unload it.
117.DT
118.SH FILES
119.br
Darren Reed83f3fb12006-06-15 17:43:57 +0000120/dev/iplookup
cvs2git55401132006-06-15 16:38:29 +0000121.br
122/etc/ippool.conf
123.SH SEE ALSO
124ippool(5), ipf(8), ipfstat(8)