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