aggregate (1) - Linux Man Pages
aggregate: optimise a list of route prefixes to help make nice short filters
NAMEaggregate - optimise a list of route prefixes to help make nice short filters
SYNOPSISaggregate [-m max-length] [-o max-opt-length] [-p default-length] [-q] [-t] [-v]
DESCRIPTIONTakes a list of prefixes in conventional format on stdin, and performs two optimisations to attempt to reduce the length of the prefix list.
The first optimisation is to remove any supplied prefixes which are superfluous because they are already included in another supplied prefix. For example, 126.96.36.199/24 would be removed if 188.8.131.52/17 was also supplied.
The second optimisation identifies adjacent prefixes that can be combined under a single, shorter-length prefix. For example, 184.108.40.206/24 and 220.127.116.11/24 can be combined into the single prefix 18.104.22.168/23.
- -m max-length
Sets the maximum prefix length for entries read from stdin
bits. The default is 32. Prefixes with longer lengths will be
discarded prior to processing.
- -o max-opt-length
Sets the maximum prefix length for optimisation to
bits. The default is 32. Prefixes with longer lengths will not
be subject to optimisation.
- -p default-length
Sets the default prefix length. There is no default; without
this option a prefix without a mask length is treated as invalid.
-p 32 -m 32 -o 32
to aggregate a list of host routes specified as bare addresses,
Sets quiet mode -- instructs
never to generate warning messages or other output on stderr.
Silently truncate prefixes that seem to have an inconsistent
prefix: e.g. an input prefix 22.214.171.124/24 would be truncated
to 126.96.36.199/24. Without this option an input prefix
188.8.131.52/24 would not be accepted, and a warning about
the inconsistent mask would be generated.
- Sets verbose mode. This changes the output format to display the source line number that the prefix was obtained from, together with a preceding "-" to indicate a route that can be suppressed, or a "+" to indicate a shorter-prefix aggregate that was added by aggregate as an adjacency optimisation. Note that verbose output continues even if -q is selected.
DIAGNOSTICSAggregate exits 0 on success, and >0 if an error occurs.
EXAMPLESThe following list of prefixes:
is optimised as followed by aggregate (output shown using the -v flag):
Note that 184.108.40.206/22 and 220.127.116.11/22 were combined under the single prefix 18.104.22.168/21, and 22.214.171.124/23 was suppressed because it was included in 126.96.36.199/22. The number in square brackets at the beginning of each line indicates the original line number, or zero for new prefixes that were introduced by aggregate.
The output without the -v flag is as follows:
HISTORYAggregate was written by Joe Abley <jabley [at] mfnx.net>, and has been reasonably well tested. It is suitable for reducing customer prefix filters for production use without extensive hand-proving of results.
Autoconf bits were donated by Michael Shields <michael.shields [at] mfn.com>. The -t option was suggested by Robin Johnson <robbat2 [at] fermi.orbis-terrarum.net>, and the treatment of leading zeros on octet parsing was changed following comments from Arnold Nipper <arnold [at] nipper.de>.
An early version of aggregate would attempt to combine adjacent prefixes regardless of whether the first prefix lay on an appropriate bit boundary or not (pointed out with great restraint by Robert Noland <rnoland [at] 2hip.net>).
BUGSCommon unix parsing of IPv4 addresses understands the representation of individual octets in octal or hexadecimal, following a "0" or "0x" prefix, respectively. That convention has been deliberately disabled here, since resources such as the IRR do not follow the convention, and confusion can result.
For extremely sensitive applications, judicious use of the -v option together with a pencil and paper is probably advisable.