BIRD

From Gentoo Wiki
Jump to:navigation Jump to:search

BIRD (recursive acronym for BIRD Internet Routing Daemon) is a routing daemon implementing OSPF, RIPv2 & BGP, Babel for IP on Unix-like operating systems.


Installation

USE flags

USE flags for net-misc/bird A routing daemon implementing OSPF, RIPv2 & BGP for IPv4 & IPv6

client Build the ncurses/readline full featured CLI
custom-cflags Build with user-specified CFLAGS (unsupported)
debug Enable extra debug codepaths, like asserts and extra output. If you want to get meaningful backtraces see https://wiki.gentoo.org/wiki/Project:Quality_Assurance/Backtraces
filecaps Use Linux file capabilities to control privilege rather than set*id (this is orthogonal to USE=caps which uses capabilities at runtime e.g. libcap)
libssh Enables net-libs/libssh binding, mendatory for RPKI support

Emerge

root #emerge --ask net-misc/bird

Configuration

Extract the default bird example configuration file:

root #bzcat /usr/share/doc/bird-2.*/bird.conf.example.bz2 >/etc/bird.conf

Content of the default configration file, without comments:

FILE /etc/bird.conf
log syslog all;                                                                                                                                                                                                                                                                  
protocol device {
}

protocol direct {
}

protocol kernel {
        };
}

protocol kernel {
        ipv6 { export all; };
}

protocol static {
}

Adjust the daemon configuration file to run as bird default system user/group:

FILE /etc/conf.d/bird
# /etc/init.d/bird

# Options to pass to the bird process
# See https://bird.network.cz/?get_doc&v=20&f=bird-1.html#ss1.3
# BIRD_GROUP and BIRD_USER will be appended to BIRD_OPTS

BIRD_GROUP="bird"
BIRD_USER="bird"
#BIRD_OPTS=""

Add larry to the bird system group:

root #gpasswd -a larry bird

Files

  • /etc/bird.conf - Global (system wide) configuration file.
  • /etc/conf.d/bird - System daemon configuration file.

Service

OpenRC

Start the daemon:

root #rc-service bird start

Add the daemon to the default bootup routine:

root #rc-update add bird default

systemd

There is no systemd unit installed by the package at the moment.

Note
If the main routing table is large, you may want to remove the myhostname module from the host entry in /etc/nsswitch.conf to avoid slow DNS lookups [1]

Usage

Invocation

To configure and operate BIRD, the routing daemon, use the birdc client:

user $birdc

Show basic mode commands, use the ? key for displaying help:

bird>?
quit                                           Quit the client
exit                                           Exit the client
help                                           Description of the help system
show ...                                       Show status information
dump ...                                       Dump debugging information
eval <expr>                                    Evaluate an expression
echo ...                                       Control echoing of log messages
disable (<protocol> | "<pattern>" | all) [message]  Disable protocol
enable (<protocol> | "<pattern>" | all) [message]  Enable protocol
restart (<protocol> | "<pattern>" | all) [message]  Restart protocol
reload <protocol> | "<pattern>" | all          Reload protocol
debug ...                                      Control protocol debugging via BIRD logs
mrtdump ...                                    Control protocol debugging via MRTdump files
restrict                                       Restrict current CLI session to safe commands
configure ...                                  Reload configuration
down                                           Shut the daemon down
graceful restart                               Shut the daemon down for graceful restart
bird> 

show

Use the show status command, to verify the BIRD daemon is up and running:

bird>show status
BIRD 2.0.12
Router ID is 192.0.2.1
Hostname is gentoobird
Current server time is 2023-10-08 19:02:39.392
Last reboot on 2023-10-08 18:41:26.247
Last reconfiguration on 2023-10-08 18:41:26.247
Daemon is up and running

configure

Use the configure ? to show basic routing configuration commands:

bird>configure ?
configure ["<file>"] [timeout [<sec>]]         Reload configuration
configure soft ["<file>"] [timeout [<sec>]]    Reload configuration and ignore changes in filters
configure timeout [<sec>]                      Reload configuration with undo timeout
configure confirm                              Confirm last configuration change - deactivate undo timeout
configure undo                                 Undo last configuration change
configure status                               Show configuration status
configure check ["<file>"]                     Parse configuration and check its validity

verify

Use the configure check command, to verify the current, running BIRD configuration file is sane:

bird>configure check
Reading configuration from /etc/bird.conf
Configuration OK

Use the show ? to display more IP routing and system verification commands:

bird>show ?
show status                                    Show router status
show memory                                    Show memory usage
show protocols [<protocol> | "<pattern>"]      Show routing protocols
show interfaces                                Show network interfaces
show route ...                                 Show routing table
show symbols ...                               Show all known symbolic names
show bfd ...                                   Show information about BFD protocol
show babel ...                                 Show information about Babel protocol
show ospf ...                                  Show information about OSPF protocol
show rip ...                                   Show information about RIP protocol
show static [<name>]                           Show details of static protocol

Unmerge

root #emerge --ask --depclean --verbose net-misc/bird

See also

  • iproute2 — a tool developed to unify network interface configuration, routing, and tunneling for Linux systems.
  • static_routing — covers routing of the IP protocol in the Linux kernel.
  • Frr — a set of unified tools to configure and manage dynamic routing protocols.

External resources