Configuration

Config

peeringdb-query-timeout

PeeringDB query timeout in seconds

peeringdb-api-key

PeeringDB API key

peeringdb-cache

Global option to cache PeeringDB network records in memory for the duration of a single run, so peers with the same ASN only query PeeringDB once (this does not disable PeeringDB queries; to stop querying PeeringDB for a peer, disable auto-import-limits and auto-as-set on that peer)

irr-query-timeout

IRR query timeout in seconds

bird-directory

Directory to store BIRD configs

bird-binary

Path to BIRD binary

metrics-listen

Listen address for the Prometheus metrics endpoint used by pathvector metrics (e.g. 127.0.0.1:9517; empty uses the --listen default)

bird-socket

UNIX control socket for BIRD

backend

Routing daemon backend: bird, cairn or frr

cairn-directory

Directory for Cairn configuration files (cairnd.toml, policy.conf, staticd.toml)

cairnd-binary

Path to the cairnd binary

cairnctrl-binary

Path to the cairnctrl binary

cairn-socket

UNIX control socket for cairnd

staticd-binary

Path to the staticd binary

frr-directory

Directory for FRR configuration files

vtysh-binary

Path to the vtysh binary

cache-directory

Directory to store runtime configuration cache

keepalived-config

Configuration file for keepalived

web-ui-file

File to write web UI to (disabled if empty)

log-file

Log file location

global-config

Global BIRD configuration

device-scan-time

Time in seconds between interface scans of the BIRD device protocol (BIRD default if 0)

direct-check-link

Should the BIRD direct protocol only import routes of interfaces with link up? (check link)

disable-protocols

Built-in BIRD protocols to leave out of the configuration so they can be defined in global-config or manual*.conf instead (device, direct, kernel4, kernel6)

peeringdb-url

PeeringDB API URL, can be set to a local PeeringDB cache server

blocklist

List of ASNs, prefixes, and IP addresses to block

blocklist-urls

List of URLs to fetch blocklists from

blocklist-files

List of files to fetch blocklists from

communities

Map of community names to standard or large communities, names can be used in place of communities in any community option

origin-communities

List of communities to accept as locally originated routes

local-communities

List of communities to add to locally originated prefixes

add-on-import

List of communities to add to all imported routes

add-on-export

List of communities to add to all exported routes

hostname

Router hostname (default system hostname)

asn

Autonomous System Number

prefixes

List of prefixes to announce

router-id

Router ID (dotted quad notation)

irr-server

Internet routing registry server

rtr-server

RPKI-to-router server

bgpq-args

Additional command line arguments to pass to bgpq4

keep-filtered

Should filtered routes be kept in memory?

merge-paths

Should best and equivalent non-best routes be imported to build ECMP routes?

source4

Source IPv4 address of BGP routes installed in the kernel (krt_prefsrc), can be overridden per peer

source6

Source IPv6 address of BGP routes installed in the kernel (krt_prefsrc), can be overridden per peer

default-route

Add a default route

accept-default

Should default routes be accepted from peers? When false, default routes are rejected by filter-prefix-length. When true, learned default routes are preferred over the locally generated default route and installed in the kernel.

rpki-enable

Enable RPKI protocol

transit-asns

List of ASNs to consider transit providers for filter-transit-asns (default list in config)

bogons4

List of IPv4 bogons (default list in config)

bogons6

List of IPv6 bogons (default list in config)

bogon-asns

List of ASNs to consider bogons (default list in config)

blackhole-bogon-asns

Should routes containing bogon ASNs be blackholed?

no-announce

Don't announce any routes to any peer

no-accept

Don't accept any routes from any peer

stun

Don't accept or announce any routes from any peer (sets no-announce and no-accept)

authorized-providers

Map of origin ASN to authorized provider ASN list

peers

BGP peer configuration

templates

BGP peer templates

vrrp

List of VRRP instances

bfd

BFD instances

mrt

MRT instances

kernel

Kernel routing configuration options

optimizer

Route optimizer options

plugins

Plugin-specific configuration

BFDInstance

neighbor

Neighbor IP address

interface

Interface (pattern accepted)

interval

RX and TX interval

multiplier

Number of missed packets for the state to be declared down

Kernel

accept4

List of BIRD protocols to import into the IPv4 table

accept6

List of BIRD protocols to import into the IPv6 table

reject4

List of BIRD protocols to not import into the IPv4 table

reject6

List of BIRD protocols to not import into the IPv6 table

statics

List of static routes to include in BIRD (always exported to the kernel, BIRD protocols statics4 and statics6)

srd-communities

List of communities to filter routes exported to kernel (if list is not empty, all other prefixes will not be exported)

learn

Should routes from the kernel be learned into BIRD?

export

Export routes to kernel routing table

reject-connected

Don't export connected routes (RTS_DEVICE) to kernel?'

table

Kernel table

tables

Additional kernel tables to export routes to, with the same export policy as the main kernel table (BIRD protocols kernel4_tableN and kernel6_tableN)

scan-time

Time in seconds between scans of the kernel routing table

MRTInstance

file

File to store MRT dumps (supports strftime replacements and %N as table name)

interval

Number of seconds between dumps

table

Routing table to read from

Optimizer

targets

List of probe targets

latency-threshold

Maximum allowable latency in milliseconds

packet-loss-threshold

Maximum allowable packet loss (percent)

modifier

Amount to lower local pref by for depreferred peers

probe-count

Number of pings to send in each run

probe-timeout

Number of seconds to wait before considering the ICMP message unanswered

probe-interval

Number of seconds wait between each optimizer run

cache-size

Number of probe results to store per peer

probe-udp

Use UDP probe (else ICMP)

alert-script

Script to call on optimizer event

exit-on-cache-full

Exit optimizer on cache full

Peer

template

Configuration template (templates may also set a parent template)

merge-template-lists

Merge list and map options configured on both this peer and its template instead of replacing the template's value (lists are appended to the template's, map entries override the template's)

description

Peer description

tags

Peer tags

disabled

Should the sessions be disabled?

import

Import routes from this peer

export

Export routes to this peer

asn

Local ASN

neighbors

List of neighbor IPs

prepends

Number of times to prepend local AS on export

prepend-path

List of ASNs to prepend

clear-path

Remove all ASNs from path (before prepends and prepend-path)

local-pref

BGP local preference

local-pref4

IPv4 BGP local preference (overrides local-pref, not included in optimizer)

local-pref6

IPv6 BGP local preference (overrides local-pref, not included in optimizer)

set-local-pref

Should an explicit local pref be set? (iBGP sessions without local-pref, local-pref4/6 or set-local-pref configured keep the local pref received from the neighbor)

multihop

Should BGP multihop be enabled? (255 max hops)

listen4

IPv4 BGP listen address (local address the session is sourced from)

listen6

IPv6 BGP listen address (local address the session is sourced from)

source4

Source IPv4 address of routes from this peer installed in the kernel (overrides the global source4)

source6

Source IPv6 address of routes from this peer installed in the kernel (overrides the global source6)

local-asn

Local ASN as defined in the global ASN field

local-port

Local TCP port

neighbor-port

Neighbor TCP port

passive

Should we listen passively?

direct

Specify that the neighbor is directly connected

next-hop-self

Should BGP next-hop-self be enabled?

next-hop-self-ebgp

Should BGP next-hop-self for eBGP be enabled?

next-hop-self-ibgp

Should BGP next-hop-self for iBGP be enabled?

extended-next-hop

Should RFC 8950 extended next hop encoding be enabled?

bfd

Should BFD be enabled?

password

BGP MD5 password

password-file

Read the BGP MD5 password from this file instead of embedding it in the config (used only when password is unset)

password-env

Read the BGP MD5 password from this environment variable (used only when password is unset)

rs-client

Should this peer be a route server client?

rr-client

Should this peer be a route reflector client?

remove-private-asns

Should private ASNs be removed from path before exporting?

l3vpn

Should VPNv4 and VPNv6 (MPLS L3VPN, RFC 4364) routes be exchanged with this peer? Routes are kept in the vpntab4 and vpntab6 tables, e.g. for a route reflector

mp-unicast-46

Should this peer be configured with multiprotocol IPv4 and IPv6 unicast?

allow-local-as

Should routes originated by the local ASN be accepted?

add-path-tx

Enable BGP additional paths on export?

add-path-rx

Enable BGP additional paths on import?

gateway

BGP gateway mode, 'direct' or 'recursive' (BIRD defaults to direct for directly connected eBGP neighbors and recursive otherwise)

cost

Distance (IGP metric) to the BGP next hop for sessions in direct gateway mode (mainly direct sessions), used in best path selection in place of the IGP metric

import-next-hop

Rewrite the BGP next hop before importing routes learned from this peer

export-next-hop

Rewrite the BGP next hop before announcing routes to this peer

confederation

BGP confederation (RFC 5065)

confederation-member

Should this peer be a member of the local confederation?

ttl-security

RFC 5082 Generalized TTL Security Mechanism

interpret-communities

Should well-known BGP communities be interpreted by their intended action?

default-local-pref

Default value for local preference

advertise-hostname

Advertise hostname capability

disable-after-error

Disable peer after error

prefer-older-routes

Prefer older routes instead of comparing router IDs (RFC 5004)

irr-accept-child-prefixes

Accept prefixes up to /24 and /48 from covering parent IRR objects

irr-prefix-length4

Override the IPv4 max prefix length bound used with irr-accept-child-prefixes (bgpq4 -R; default 32)

irr-prefix-length6

Override the IPv6 max prefix length bound used with irr-accept-child-prefixes (bgpq4 -R; default 128)

add-on-import

List of communities to add to all imported routes

add-on-export

List of communities to add to all exported routes

announce

Announce all routes matching these communities to the peer

remove-communities

List of communities to remove before from routes announced by this peer

remove-all-communities

Remove all standard and large communities beginning with this value

as-prefs

Map of ASN to import local pref (not included in optimizer)

as-prefs4

Map of ASN to import local pref for IPv4 routes (overrides as-prefs, not included in optimizer)

as-prefs6

Map of ASN to import local pref for IPv6 routes (overrides as-prefs, not included in optimizer)

prefix-prefs

Map of prefix (BIRD prefix pattern, IPv4 and IPv6 may be mixed) to import local pref (not included in optimizer, takes precedence over as-prefs and community-prefs)

community-prefs

Map of community to import local pref (not included in optimizer, as-prefs take precedence)

as-set

Peer's as-set for filtering

import-limit4

Maximum number of IPv4 prefixes to import after filtering

import-limit6

Maximum number of IPv6 prefixes to import after filtering

import-limit-violation

What action should be taken when the import limit is tripped?

receive-limit4

Maximum number of IPv4 prefixes to accept (including filtered routes, requires keep-filtered)

receive-limit6

Maximum number of IPv6 prefixes to accept (including filtered routes, requires keep-filtered)

receive-limit-violation

What action should be taken when the receive limit is tripped?

export-limit4

Maximum number of IPv4 prefixes to export

export-limit6

Maximum number of IPv6 prefixes to export

export-limit-violation

What action should be taken when the export limit is tripped?

enforce-first-as

Should we only accept routes who's first AS is equal to the configured peer address?

enforce-peer-nexthop

Should we only accept routes with a next hop equal to the configured neighbor address?

force-peer-nexthop

Rewrite nexthop to peer address

allow-blackhole-community

Should this peer be allowed to send routes with the blackhole community? (Blackholed /32 and /128 routes are exempt from filter-prefix-length)

blackhole-in

Should imported routes be blackholed?

blackhole-out

Should exported routes be blackholed?

filter-irr

Should IRR filtering be applied?

filter-rpki

Should RPKI invalids be rejected?

strict-rpki

Should only RPKI valids be accepted?

filter-max-prefix

Should max prefix filtering be applied?

filter-bogon-routes

Should bogon prefixes be rejected?

filter-bogon-asns

Should paths containing a bogon ASN be rejected?

filter-transit-asns

Should paths containing transit-free ASNs be rejected? (Peerlock Lite)'

filter-prefix-length

Should too large/small prefixes (IPv4 8 > len > 24 and IPv6 12 > len > 48) be rejected?

filter-never-via-route-servers

Should routes containing an ASN reported in PeeringDB to never be reachable via route servers be filtered?

filter-as-set

Reject routes that aren't originated by an ASN within this peer's AS set

filter-aspa

Reject routes that aren't originated by an ASN within the authorized-providers map

filter-blocklist

Reject ASNs, prefixes, and IPs in the global blocklist

transit-lock

Reject routes that aren't transited by an AS in this list

dont-announce

Don't announce these prefixes to the peer (IPv4 and IPv6 may be mixed)

only-announce

Only announce these prefixes to the peer (IPv4 and IPv6 may be mixed, an address family with no prefixes in the list will not be announced)

prefix-communities

Map of prefix to community list to add to the prefix

auto-import-limits

Get import limits automatically from PeeringDB?

auto-as-set

Get as-set automatically from PeeringDB? If no as-set exists in PeeringDB, a warning will be shown and the peer ASN used instead.

auto-as-set-members

Get AS set members automatically from the peer's IRR as-set? (independent from auto-as-set)

verify-irr-policy

Check the peer's aut-num object in the IRR (irr-server whois) for import (from us ... accept) and export (to us ... announce) policy, with us listed directly or through an as-set, and disable the peer if it's missing. Checked for each address family the peer has neighbors in; as there's one disabled flag per peer, the whole peer is disabled if any of them lacks policy. If the IRR can't be queried, a warning is shown and the peer is left as configured.

honor-graceful-shutdown

Should RFC8326 graceful shutdown be enabled?

prefixes

Prefixes to accept

as-set-members

AS set members (For filter-as-set)

role

RFC 9234 Local BGP role

require-roles

Require RFC 9234 BGP roles

announce-default

Should a default route be exported to this peer?

announce-originated

Should locally originated routes be announced to this peer?

announce-all

Should all routes be exported to this peer?

session-global

Configuration to add to each session before any defined BGP protocols

pre-import-filter

Configuration to add before the filtering section of the import policy

post-import-filter

Configuration to add after the filtering section of the import filter

pre-import-accept

Configuration to add immediately before the final accept term import

pre-export

Configuration to add before the export policy

pre-export-final

Configuration to add after the export policy before the final accept/reject term

probe-sources

Optimizer probe source addresses

optimize-inbound

Should the optimizer modify inbound policy?

VRRPInstance

state

VRRP instance state ('primary' or 'backup')

interface

Interface to send VRRP packets on

vrid

RFC3768 VRRP Virtual Router ID (1-255)

priority

RFC3768 VRRP Priority

vips

List of virtual IPs

vip-interface

Interface to bind virtual IPs to (defaults to the VRRP interface)