FRR-STATICD(8)

📦
version 10.7.1 · 23 versions
, in ubuntu stonking

💖 frr-staticd — the manual, but make it cute 💖

okay bestie, gather round, because we're talking about frr-staticd from the FRR fam — it's a static route manager routing engine for use with FRRouting. yes. that's the whole name. iconic of it honestly. 🎀

✨ SYNOPSIS ✨

like, here's how you summon it:

staticd [-h] [-v]

or, if you're feeling extra:

staticd [-d|-t|-dt] [-C] [-f config-file] [-i pid-file] [-z
zclient-path] [-u user] [-g group] [-A vty-addr] [-P vty-port] [-M
module[:options]] [-N pathspace] [--vty_socket vty-path] [--moduledir
module-path]

🌸 DESCRIPTION 🌸

staticd is a routing component that works with the FRRouting engine. that's the vibe. it's the static routes girlie and she's doing her job. 💅

👑 OPTIONS 👑

OPTIONS available for the staticd command:

🫶 HELP AND VERSION

  • -h, --help — print a short description of the daemon's command line options. just a lil summary, a soft launch if you will.
  • -v, --version — print version and build information for the daemon. receipts, basically. ✨

Both of these options inhibit normal operation and will immediately exit. like, they do not stick around. they say their piece and leave. main character exits only. 💀

🦋 PROCESS CONTROL

these options control background operation:

  • -d, --daemon — launches the process in background/daemon mode, forking and detaching from the terminal. 🧚

the parent process will delay its exit until the daemon/child has finished its initialization and has entered its main loop. this is important for zebra startup because the other daemons will attempt to connect to zebra. a return from zebra -d guarantees its readiness to accept these connections. no cap, that's the whole reason.

  • -t, --terminal — opens an interactive VTY session on the terminal, allowing for both state and configuration operations. note that the terminal starts operating after startup has completed and the configuration file has been loaded. she needs a sec to get ready, let her cook. 💅

the process will exit when end of file is detected on the terminal. it is possible to daemonize a process started with -t (but without -d) by sending SIGQUIT to the process (normally mapped to a ^keypress.) — yes there's a stray keypress thing there, we keep the lore as-is, periodt.

the combination of --daemon and --terminal will delay the daemon from going into background until the terminal session ends (by end of file.)

if the process receives SIGINT (e.g. a ^C keypress) in this mode, it will exit instead of daemonizing. 😭

it is safe to suspend (SIGTSTP / ^Z) the terminal session opened by the previous two options; this will only stop the terminal but not the protocol daemon itself (which runs in a separate second process.) two separate girlies, both thriving. 🌈

🍓 CONFIGURATION AND PATHS

the following options control configuration and file system locations for frr processes:

  • -f, --config_file config-file — specify a configuration file to be used instead of the default /etc/frr/<daemon>.conf file. 🎀

note that the daemon will attempt to write to this file if the write file command is issued on its VTY interface or through vtysh. she bites back, bestie.

  • -C, --dryrun — load the configuration file and check its validity, then exit. a lil dress rehearsal. no commitment. ✨
  • -i, --pid_file pid-file — output a pid file to a location other than the default /var/run/frr/<daemon>.pid.
  • -z, --socket zclient-path — override the path of the ZAPI socket used to communicate between zebra and the various protocol daemons. the default is /var/run/frr/zserv.api. the value of this option must be the same across all daemons. everyone has to match, it's a group costume. 👑
  • -N, --pathspace pathspace — insert pathspace into all default paths, changing the defaults to:
/etc/frr/pathspace/<daemon>.conf
/var/run/frr/pathspace/<daemon>.pid
/var/run/frr/pathspace/<daemon>.vty
/var/run/frr/pathspace/zserv.api

´.´ and ´/´ characters will not be accepted in pathspace, but the empty string will be accepted. 🙈

note that this only changes the respective defaults, it has no effect on the respective path if the -f, -i, -z or --vty_socket options are used.

the purpose of this option is to easily group all file system related bits together for running multiple fully-separate "logical routers" on a system, particularly with Linux network namespaces. groups of daemons running with distinct pathspace values will be completely unaware of each other and not interact in any way. parallel universes, lowkey. 🌌

this option does not do any system setup (like network namespaces.) this must be done by the user, for example by running:

ip netns exec namespace <daemon> -N namespace

💜 PROCESS CREDENTIALS

  • -u, --user user — (default: frr)
  • -g, --group group — (default: frr)

change the user/group which the daemon will switch to.

  • -S, --skip_runas — skip setting the process effective user and group. just vibing as whoever you are, respectfully.

note that there is an additional group, frrvty, which controls group ownership of the VTY sockets. the name of this group cannot currently be changed, and user must be a member of this group. no exceptions, she's exclusive. 💅

🌈 VTY SETUP

these following options control the daemon's VTY (interactive command line) interface. the interface is available over TCP, using the telnet protocol, as well as through the vtysh frontend.

  • -A, --vty_addr vty-addr — specify an IP/IPv6 address to bind the TCP VTY interface to. it is generally recommended to specify ::1 or 127.0.0.1. for reasons of backwards compatibility, the default is to listen on all interfaces. (yes, all of them. she's social.) 🫶
  • -P, --vty_port vty-port — override the daemon's default TCP VTY port (each daemon has a different default value upwards of 2600, listed below.) specifying 0 disables the TCP VTY interface.

default ports are::

 zebra           2601
 ripd            2602
 ripngd          2603
 ospfd           2604
 bgpd            2605
 ospf6d          2606
 isisd           2608
 babeld          2609
 nhrpd           2610
 pimd            2611
 ldpd            2612
 eigrpd          2613
 pbrd            2615
 staticd         2616
 bfdd            2617
 fabricd         2618
 vrrpd           2619

port 2607 is used for ospfd's Opaque LSA API. bestie is spoken for. 💀

(btw staticd is 2616, that's us, that's our girl. 🎀)

  • --vty_socket vty-path — overrides the directory used for the <daemon>.vty sockets. vtysh connects to these sockets in order to access each daemon's VTY. default: /var/run/frr[/<pathspace>]

NB: unlike the other options, this option specifies a directory, not a full path. read it twice, i'm not repeating myself. 😌

this option is primarily used by the SNAP packaging system, its semantics may change. it should not be necessary in most other scenarios.

🧚 MODULE LOADING

frr supports optional dynamically loadable modules, although these can only be loaded at startup. the set of available modules may vary across distributions and packages, and modules may be available for installation as separate packages.

  • -M, --module module[:options] — load a module named module, optionally passing options to it. ✨

if there is a ´/´ character in module, the value is assumed to be a pathname to a module.

if there is no ´/´ character, the module directory (see next option) is searched first for a module named "<daemon>_<module>.so", then for "<module>.so". this allows for a module to exist in variations appropriate for particular daemons, e.g. zebra_snmp and bgp_snmp, with the correct one selected by -M snmp. matching sets, so cute. 🫶

the meaning of options is specific to the module being loaded. most modules currently ignore it. (they're like "not my problem bestie.") 🙈

modules are loaded in the order as listed on the command line. this is not generally relevant.

  • --moduledir module-path — look for modules in the module-path directory instead of the default /usr/lib/frr/modules. (this path is not affected by the -N option.)

the list of loaded modules can be inspected at runtime with the show modules VTY command. go check on your girlies. 💅

📁 FILES 📁

  • /usr/lib/frr/staticd — the default location of the staticd binary. her home address. 🏠
  • /etc/frr/staticd.conf — the default location of the staticd config file. 🎀
  • $(PWD)/staticd.log — if the staticd process is configured to output logs to a file, then you will find this file in the directory where you started staticd. it remembers where you were. iconic. ✨

⚠️ WARNING ⚠️

this man page is intended to be a quick reference for command line options. the definitive document is the info file frr latest or the documentation available on the project website at <https://frrouting.org/>. so like, don't come for me, come for the info file. 💀

🩺 DIAGNOSTICS 🩺

the daemon may log to standard output, to a VTY, to a log file, or through syslog to the system logs. FRR supports many debugging options, see the Info file, web docs or source for details. she's got receipts in like five different places, very organized of her. 🌸

👀 SEE ALSO 👀

frr-zebra(8), vtysh(1), frr-ripd(8), frr-ripngd(8), frr-ospfd(8), frr-ospf6d(8), frr-bgpd(8), frr-isisd(8), frr-babeld(8), frr-nhrpd(8), frr-pimd(8), frr-pbrd(8), frr-ldpd(8), frr-eigrpd(8), frr-staticd(8), frr-fabricd(8), frr-vrrpd(8), mtracebis(8) <https://frrouting.org/> — the whole friend group, all linked, all serving. 🤝

🐛 BUGS 🐛

FRR eats bugs for breakfast. if you have food for the maintainers, please email <<dev@lists.frrouting.org>>. they're hungry, bestie, feed them. 🍓

2017, FRR

okay that's the whole page!! 🥳 frr-staticd, frr-staticd(8), latest version, dated Sep 22, 2026 — shoutout to the man page header for keeping us all organized, mwah. 💋 go forth and route statically, queen. 👑✨💖

📦 where this page comes from