Skip to main content
FieldTypeDescriptionValue(s)
localASNuint32Local autonomous system number for the BGP speaker.
routerIDAddrBGP router-id. If not set, it is derived from the first advertised address.
routeSourceAddrPreferred source address set on routes installed from BGP (the kernel route src / RTA_PREFSRC,
equivalent to FRR’s ip protocol bgp route-map SETSRC). Set this to the node’s loopback so that
traffic following BGP-learned routes is sourced from the node identity even though the unnumbered
fabric uplinks carry no address of their own. If not set, the kernel selects the source address.
advertise[]stringNames of the links whose addresses are originated into BGP as host routes (/32, /128).
Typically a loopback or dummy link holding the node IP.
multipathboolEnable ECMP (multipath) for routes learned from multiple neighbors.
maxPathsuint8Maximum number of ECMP next-hops to install. Zero uses the implementation default.
neighborsBGPNeighborConfigBGP neighbors to peer with.

neighbors[]

BGPNeighborConfig configures a single BGP neighbor.
FieldTypeDescriptionValue(s)
addressAddrNeighbor IP address for a numbered session. Mutually exclusive with link.
linkstringLink name for an unnumbered (IPv6 link-local) session. Mutually exclusive with address.
Link aliases are supported.
peerASNuint32Expected peer ASN. Zero accepts any ASN advertised by the peer (eBGP “external”).
holdTimeDurationBGP hold time. Zero uses the implementation default.
bfdBGPBFDConfigBFD (Bidirectional Forwarding Detection) configuration for the neighbor.

bfd

BGPBFDConfig configures BFD for a BGP neighbor.
FieldTypeDescriptionValue(s)
transmitIntervalDurationDesired minimum transmit interval. Zero uses the implementation default.
receiveIntervalDurationRequired minimum receive interval. Zero uses the implementation default.
detectMultiplieruint8BFD detection multiplier. Zero uses the implementation default.