Skip to main content

BGP

This section is used to configure RioRey Director's BGP instance and peers. This is optional if no BGP actions are configured.

Director uses GoBGP for its BGP instance. Besides the other documented commands, users can directly query the state of the instance using gobgp and the rest of the GoBGP command syntax. Only query operations are recommended, as setting most BGP configuration should be done using the TOML sections below, or within the specific BGP actions.

warning

Changing anything in this section currently causes Director's GoBGP instance to be restarted.

Local BGP Configuration​

[bgp]

# Router ID for our BGP instance
router-id = "192.0.2.1"
asn = 64496

This section configures the router-id and ASN used by the Director BGP instance. If using any BGP or BGP Flowspec Actions, both of these values should be configured.

  • router-id: The router ID used by the BGP instance.
  • asn: The ASN that will be used by the BGP instance.

BGP Neighbor Configuration​

[[bgp.neighbors]]
# Include one of these sections for each BGP peer

# Must be alphanumeric with underscores
name = "unique_name_for_this_peer"

# IP address of the peer
remote-address = "192.0.2.20"
remote-asn = 64496

# Bind to local address
# Optional, defaults to `bgp.router-id`
local-address = "192.0.2.1"

# Enable an address family.
# Optional, defaults to false
ipv4-unicast = true
ipv4-flowspec = true
ipv6-unicast = true
ipv6-flowspec = true

# EBGP Multihop
# Optional, defaults to false
multihop = false

# Enable md5 authentication
# Optional, auth disabled if not present
md5-auth-password = "password"

For each BGP peer you intend to communicate with, you should have a [[bgp.neighbors]] section. The list of valid keys is as follows:

  • name: A unique alphanumeric String (with underscores) that represents this peer.
  • remote-address: The remote IP address of the peer.
  • remote-asn: The ASN associated with the remote peer.
  • local-address: An optional value that specifies the address of the local end of a BGP session. This address is used to accept incoming connections to the peer and to establish connections to the remote peer. If omitted, this defaults to the value used for bgp.router-id.
  • ipv4-unicast, ipv4-flowspec, ipv6-unicast, ipv6-flowspec: These optional values, defaulting to false, indicate which address families should be used when communicating with the remote peer. In general, any configured BGP Actions will need either ipv4-unicast or ipv6-unicast to be true, and any configured BGP Flowspec Actions will need either ipv4-flowspec or ipv6-flowspec to be true, for at least one BGP peer, for those actions to have any meaningful effects.
  • multihop: Optional value, defaulting to false, that when set to true enables EBGP Multihop when communicating with this peer.
  • md5-auth-password: An optional String value, that if present, is used for MD5 Authentication with the peer. This password is expected to be the same value both in this configuration and on the remote peer. If omitted (which it is by default), authentication is disabled.