grep / drop¶
Filter messages by matching against a BGP filter expression.
Synopsis¶
Description¶
The grep stage keeps messages that match FILTER and drops the rest. The drop stage does the inverse: it drops matching messages and keeps the rest. Both are the same stage with opposite default behavior.
The FILTER argument is a BGP filter expression that tests message attributes such as prefix, AS path, communities, and tags. See the Message Filters reference for complete syntax.
It filters the messages it reads (see direction), or both
directions with -LR. It matches UPDATE messages by
default; non-UPDATE messages (OPEN, KEEPALIVE, NOTIFICATION) are dropped unless explicitly allowed.
With --withdraw, an UPDATE that would be dropped is turned into a withdrawal
of all its prefixes instead ("treat-as-withdraw", RFC 7606),
and withdrawals are never dropped.
Use it on live BGP sessions: a dropped UPDATE may replace an earlier
announcement of the same prefixes, which the peer would otherwise keep using.
With --keep, the stage evaluates the filter but never drops messages.
This requires at least one of --event-match or --event-fail so that
the filter evaluation has a visible effect.
As an alternative to a separate grep stage, most consumer stages support
the --if flag, which skips the stage for messages that don't match the
filter. For example, stdout --if 'ipv6' prints only IPv6 updates.
Options¶
| Option | Type | Default | Description |
|---|---|---|---|
--keep |
bool | false |
Evaluate the filter but never drop (requires --event-*) |
--event-match |
string | Emit this event when a message matches (see Events) | |
--event-fail |
string | Emit this event when a message does not match | |
--kill-match |
bool | false |
Kill the process on filter match |
--kill-fail |
bool | false |
Kill the process on filter failure |
--withdraw |
bool | false |
Withdraw the prefixes of a dropped UPDATE, instead of dropping it |
Examples¶
Keep only IPv6 updates:
Drop updates with AS path containing AS64512:
Filter updates by origin AS and prefix:
Emit an event on match without dropping:
bgpipe --events grep/hijack \
-- connect 192.0.2.1 \
-- grep --keep --event-match hijack 'prefix ~ 192.0.2.0/24 && as_origin != 64496' \
-- connect 10.0.0.1
Kill the session if a default route is announced:
Use --if on a stage instead of a separate grep: