ipset  7.15
About: ipset is an administration tool for IP sets (which e.g. can be added to IPTables rules).
  Fossies Dox: ipset-7.15.tar.bz2  ("unofficial" and yet experimental doxygen-generated source code documentation)  

ipset Documentation

Some Fossies usage hints in advance:

  1. To see the Doxygen generated documentation please click on one of the items in the steelblue colored "quick index" bar above or use the side panel at the left which displays a hierarchical tree-like index structure and is adjustable in width.
  2. If you want to search for something by keyword rather than browse for it you can use the client side search facility (using Javascript and DHTML) that provides live searching, i.e. the search results are presented and adapted as you type in the Search input field at the top right.
  3. Doxygen doesn't incorporate all member files but just a definable subset (basically the main project source code files that are written in a supported language). So to search and browse all member files you may visit the Fossies ipset-7.15.tar.bz2 contents page and use the Fossies standard member browsing features (also with source code highlighting and additionally with optional code folding).
This is the ipset source tree. Follow the next steps to install ipset.
If you upgrade from an earlier 5.x release, please read the UPGRADE
instructions too.

0. You need the source tree of your kernel (version >= 2.6.32)
   and it have to be configured with ip6tables support enabled,
   modules compiled. For kernel versions < 2.6.39 please apply
   the netlink.patch against your kernel tree, which adds the
   new subsystem identifier for ipset.

   Recompile and install the patched kernel and its modules. Please note,
   you have to run the patched kernel for ipset to work.

   The ipset source code depends on the libmnl library so the library
   must be installed. You can download the libmnl library from


1. Initialize the compiling environment for ipset. The packages automake,
   autoconf, pkg-config and libtool are required.

   % ./autogen.sh

2. Run `./configure` and then compile the ipset binary and the kernel

   Configure parameters can be used to to override the default path
   to the kernel source tree (/lib/modules/`uname -r`/build),
   the maximum number of sets (256), the default hash sizes (1024).
   See `./configure --help`.

   % ./configure
   % make
   % make modules

3. Install the binary and the kernel modules

   # make install
   # make modules_install

   After installing the modules, you can run the testsuite as well.
   Please note, several assumptions must be met for the testsuite:

	- no sets defined
	- iptables/ip6tables rules are not set up
	- the destination for kernel logs is /var/log/kern.log
	- the networks and 1002:1002:1002:1002::/64
	  are not in use
	- sendip utility is installed

   # make tests

4. Cleanup the source tree

   % make clean
   % make modules_clean

That's it! 

Read the ipset(8) and iptables(8), ip6tables(8) manpages on how to use
ipset and its match and target from iptables.

Compatibilities and incompatibilities:

- The ipset 6.x userspace utility contains a backward compatibility
  interface to support the commandline syntax of ipset 4.x.
  The commandline syntax of ipset 6.x is fully compatible with 5.x.
- The ipset 6.x userspace utility can't talk to the kernel part of ipset 5.x
  or 4.x.
- The ipset 6.x kernel part can't talk to the userspace utility from
  ipset 5.x or 4.x.
- The ipset 6.x kernel part can work together with the set match and SET
  target from iptables 1.4.7 and below, however if you need the IPv6 support
  from ipset 6.x, then you have to use iptables 1.4.9 or above.

The ipset 6.x can interpret the commandline syntax of ipset 4.x, however
some internal changes mean different behaviour:

- The "--matchunset" flag for the macipmap type is ignored and not used
- The "--probes" and "--resize" parameters of the hash types are ignored
  and not used anymore.
- The "--from", "--to" and "--network" parameters of the ipporthash,
  ipportiphash and ipportnethash types are ignored and not used anymore.
- The hash types are not resized when new entries are added by the SET
  target. If you use a set together with the SET target, create it with
  the proper size because it won't be resized automatically.
- The iptree, iptreemap types are not implemented in ipset 6.x. The types
  are automatically substituted with the hash:ip type.