contrib/ipfilter/man/ippool.8

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