IPPOOL(8)

📦
version 15.1 · 2 versions
, in freebsd 15.1

💅 IPPOOL(8) — like, the user interface to the IPFilter pools, bestie

okay so this page is ippool(8) from the System Manager's Manual, and it's genuinely the main character of IPFilter pool management. let's get into it 🫶

✨ SYNOPSIS ✨

ippool -a [-dnv] [-m <name>] [-o <role>] [-t <type>] [-T ttl] -i
<ipaddr>[/<netmask>]
ippool -A [-dnv] [-m <name>] [-o <role>] [-S <seed>] -t <type>
ippool -f <file> [-dnuvR] [-f <file [-dnuvR]] ...
ippool -F [-dv] [-o <role>] [-t <type>]
ippool -l [-dDv] [-m <name>] [-t <type>] [-o <role>] [-M <core>] [-N
<namelist>]
ippool -r [-dnv] [-m <name>] [-o <role>] [-t <type>] -i
<ipaddr>[/<netmask>]
ippool -R [-dnv] [-m <name>] [-o <role>] -t <type>
ippool -s [-dtv]

🌸 DESCRIPTION 🌸

So ippool is literally the girl whose whole job is managing the info stored in the IP pools subsystem of IPFilter. That's it, that's the gig. 💅

She can parse configuration file information and load it into the kernel, remove or change the pools that are currently configured, and also inspect them for you. Full service, no cap.

The command line options are split into two little sections, and you're gonna wanna know the difference: the global options and the instance specific options. 🎀

🦋 GLOBAL OPTIONS 🦋

  • -d — toggles debugging of the processing of the configuration file. like, she'll show you her work ✨
  • -n — this flag (no-change) stops ippool from actually making any ioctl calls or doing anything that would alter the currently running kernel. window shopping only, bestie 🛍️
  • -v — turn verbose mode on. she talks more. honestly slay.

👑 COMMAND OPTIONS 👑

  • -a — add a new data node to an existing pool in the kernel.
  • -A — add a new (empty) pool to the kernel. brand new, blank slate, main character energy ✨
  • -f <file> — read in IP pool configuration information from the file and load it into the kernel.
  • -F — flush loaded pools from the kernel. bye bye 👋
  • -l — display a list of pools currently loaded into the kernel.
  • -r — remove an existing data node from a pool in the kernel.
  • -R — remove an existing pool from within the kernel.
  • -s — display IP pool statistical information. numbers. stats. the data 📊

💖 OPTIONS 💖

  • -i <ipaddr>[/<netmask>] — sets the IP address for the operation being undertaken, with an all-one's mask or, optionally, a specific netmask given in either the dotted-quad notation or a single integer. iykyk 🌈
  • -m <name> — sets the pool name for the current operation.
  • -M <core> — specify an alternative path to /dev/kmem to retrieve statistical information from.
  • -N <namelist> — specify an alternative path to lookup symbol name information from when retrieving statistical information.
  • -o <role> — sets the role with which this pool is to be used. currently only ipf (the default) is accepted as arguments to this option. so, like, just ipf, bestie 💅
  • -S <seed> — sets the hashing seed to the number specified. only for use with hash type pools, okay? don't use it on the others 🎀
  • -t <type> — sets the type of pool being defined. must be one of tree, hash, group-map. those three, periodt.
  • -T <ttl> — sets the expiration of the node being added. the timeout is expressed as a number of seconds. tree, hash, group-map. ⏳
  • -u — when parsing a configuration file, rather than load new pool data into the kernel, unload it. reverse uno 🃏
  • -D — when used in conjunction with -l, dump the ippool configuration to stdout in a format that can be subsequently used as input into ippool -f. round trip, iconic 💫

🧚 FILES 🧚

  • /dev/iplookup
  • /etc/ippool.conf

⭐ SEE ALSO ⭐

go read these too, fr fr — that's where the rest of the lore lives 🦋

and that's the whole page, bestie 💜 this was IPPOOL(8) out of the System Manager's Manual — mwah, go manage some pools, you're gonna ate 🎀✨🔥

📦 where this page comes from