The bgpctl program controls the bgpd(8) daemon. Commands may be abbreviated to the minimum unambiguous
prefix; for example, ssu for showsummary.
The options are as follows:
-j Create output as JSON object.
-n Show neighbors' IP addresses instead of their description.
-ssocket
Use socket to communicate with bgpd(8) instead of the default /run/openbgpd/bgpd.sock.<rdomain>
where <rdomain> is the routing domain bgpctl is running in. To administer bgpd(8) in a different
routing domain, run bgpctl in said routing domain.
-V Show the version and exit.
The commands are as follows:
fib [tablenumber] couple
Insert the learned routes into the specified Forwarding Information Base a.k.a. the kernel
routing table.
fib [tablenumber] decouple
Remove the learned routes from the specified Forwarding Information Base a.k.a. the kernel
routing table.
flowspecaddfamilyrule [setargument...]
Add the specified flowspec rule to the list of announced rules. Currently family can be either
inet or inet6. It is possible to set various path attributes with additional arguments. Adding
a rule will replace an existing equal rule, including rules loaded from the configuration. See
bgpd.conf(5) for information on how to write a flowspec rule.
flowspecdeletefamilyrule
Remove the specified flowspec rule from the list of announced rules.
flowspecflush
Remove all dynamically added (i.e. with bgpctlflowspecadd) flowspec rules from the list of
announced rules.
flowspecshowfamily
Show all announced flowspec rules. family, if given, limits the output to the given address
family. The supported families are inet and inet6.
logbrief
Disable verbose debug logging.
logverbose
Enable verbose debug logging.
neighborpeerclear [reason]
Stop and restart the BGP session to the specified neighbor. If a reason is provided, the reason
is sent as Administrative Shutdown Communication to the neighbor. peer may be the neighbor's
address, description or the word group followed by a group description.
neighborpeerdestroy
Destroy a previously cloned peer. The peer must be down before calling this function. peer may
be the neighbor's address, description or the word group followed by a group description.
neighborpeerdown [reason]
Take the BGP session to the specified neighbor down. If a reason is provided, the reason is sent
as Administrative Shutdown Communication to the neighbor. peer may be the neighbor's address,
description or the word group followed by a group description.
neighborpeerrefresh
Request the neighbor to re-send all routes. Note that the neighbor is not obliged to re-send all
routes, or any routes at all, even if it announced the route refresh capability. peer may be the
neighbor's address, description or the word group followed by a group description.
neighborpeerup
Bring the BGP session to the specified neighbor up. peer may be the neighbor's address,
description or the word group followed by a group description.
networkaddprefix [argument...]
Add the specified prefix to the list of announced networks. It is possible to set various path
attributes with additional arguments. Adding a prefix will replace an existing equal prefix,
including prefixes loaded from the configuration.
networkbulkadd [argument...]
Bulk add specified prefixes to the list of announced networks. Prefixes should be sent via
stdin. It is possible to set various path attributes with additional arguments.
networkbulkdelete
Bulk remove the specified prefixes from the list of announced networks. Prefixes should be sent
via stdin.
networkdeleteprefix
Remove the specified prefix from the list of announced networks.
networkflush
Remove all dynamically added (i.e. with bgpctlnetworkadd) prefixes from the list of announced
networks.
networkmrtfilefilefilter
Import networks from an MRT table dump for debugging purposes. filter can be specified similarly
to the showmrt command. Only networks matching the filter will be imported.
networkshowfamily
Show all announced networks. family, if given, limits the output to the given address family.
The supported families are inet and inet6.
reload [reason]
Reload the configuration file. Changes to the following neighbor options in bgpd.conf(5) only
take effect when the session is reset: ipsec and tcpmd5sig.
showfibfilter
Show routes from bgpd(8)'s view of the Forwarding Information Base. filter can be an IP address,
in which case the route to this address is shown, or a flag:
bgp Show only routes originating from bgpd(8) itself.
connected Show only connected routes.
inet Show only IPv4 routes.
inet6 Show only IPv6 routes.
nexthop Show only routes required to reach a BGP nexthop.
static Show only static routes.
tablenumber Show the routing table with ID number instead of the default routing table with ID
0.
showinterfaces
Show the interface states.
showmetrics
Dump various BGP statistics in OpenMetrics format.
showmrt [options] filter
Show routes from an MRT table dump file. filter can be an IP address, a CIDR prefix, an AS
filter, a combination or nothing:
address Show best matching route for address.
address/len Show RIB entry for this CIDR prefix.
address/lenall Show all entries in the specified range.
address/lenor-shorter Show all entries covering and including the specified prefix.
asas Show all entries with as anywhere in the AS path.
empty-as Show all entries that are internal routes with no AS's in the AS path.
neighborip Show only entries from the specified peer.
peer-asas Show all entries with as as leftmost AS.
source-asas Show all entries with as as rightmost AS.
transit-asas Show all entries with as anywhere but rightmost.
Additionally, the following options are defined:
detail Show more detailed output for matching routes.
family Limit the output to the given address family.
filename Read the MRT dump from file name instead of using stdin.
peers Print the neighbor table of MRT TABLE_DUMP_V2 dumps. Using this on other table dumps
will only show the neighbor of the first entry.
Multiple options and filters can be used at the same time.
showneighborpeermodifier
Show detailed information about the neighbor identified by peer, according to the given modifier:
messages Show statistics about sent and received BGP messages.
terse Show statistics in an easily parseable terse format. The printed numbers are the sent
and received open, sent and received notifications, sent and received updates, sent and
received keepalives, and sent and received route refresh messages plus the current and
maximum prefix count, the number of sent and received updates, sent and received
withdraws, the neighbor's address (or subnet, for a template), AS number, and finally
description.
timers Show the BGP timers.
peer may be the neighbor's address, description or the word group followed by a group
description.
shownexthop
Show the list of BGP nexthops and the result of their validity check.
showrib [options] filter
Show routes from the bgpd(8) Routing Information Base. filter can be an IP address, a CIDR
prefix, an AS filter or nothing:
address Show best matching route for address.
address/len Show RIB entry for this CIDR prefix.
address/lenall Show all entries in the specified range.
address/lenor-shorter Show all entries covering and including the specified prefix.
asas Show all entries with as anywhere in the AS path.
avs (valid | unknown | invalid)
Show all entries with matching ASAP Validation State (AVS).
communitycommunity Show all entries with community community.
empty-as Show all entries that are internal routes with no AS's in the AS path.
large-communitylarge-community
Show all entries with large-community large-community.
memory Show RIB memory statistics.
neighborpeer Show only entries from the specified peer.
neighborgroupdescription
Show only entries from the specified peer group.
ovs (valid | not-found | invalid)
Show all entries with matching Origin Validation State (OVS).
path-idpathid Show only entries which match the specified pathid. Must be used
together with either neighbor or out.
peer-asas Show all entries with as as leftmost AS.
source-asas Show all entries with as as rightmost AS.
summary This is the same as the showsummary command.
tablerib Show only entries from the specified RIB table.
transit-asas Show all entries with as anywhere but rightmost.
Additionally, the following options are defined:
best Alias for selected.
detail Show more detailed output for matching routes.
disqualified Show only routes which are not eligible.
error Show only prefixes which are marked invalid and were treated as withdrawn.
family Limit the output to the given address family.
filtered Show only routes which were filtered out. Requires rderibLoc-RIBincludefiltered to be set in the config.
in Show routes from the unfiltered Adj-RIB-In. The neighbor needs to be specified.
leaked Show only routes where a route leak was detected.
out Show the filtered routes sent to a neighbor. The neighbor needs to be specified.
selected Show only selected routes.
ssv Show each RIB entry as a single line, with fields separated by semicolons. Only
works if detail is specified.
Options are silently ignored when used together with summary or memory. Multiple options can be
used at the same time and the neighbor filter can be combined with other filters.
showrtr
Show a list of all RTR sessions, including information about the session state.
showsets
Show a list summarizing all roa-set, as-set, prefix-set, and origin-set tables.
showsummary
Show a list of all neighbors, including information about the session state and message counters:
Neighbor Description of the neighbor.
AS Autonomous system number.
MsgRcvd Number of messages received from the neighbor.
MsgSent Number of messages sent to the neighbor.
OutQ Number of outgoing messages queued.
Up/Down Number of days and hours that the session has been up.
State/PrfRcvd State of the session / Number of routes received. The session is up if there is
no information for the State column (Established is not displayed).
showsummaryterse
Show a list of all neighbors, including information about the session state, in a terse format.
showtables
Show a list of all currently loaded fib routing tables.
Install Now
PNG Icons
SVG Icons
