.\" Man page generated from reStructuredText. . .TH "FRR-PBRD" "8" "Dec 31, 2024" "8.5.7" "FRR" .SH NAME frr-pbrd \- a PBR routing engine for use with FRRouting. . .nr rst2man-indent-level 0 . .de1 rstReportMargin \\$1 \\n[an-margin] level \\n[rst2man-indent-level] level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] - \\n[rst2man-indent0] \\n[rst2man-indent1] \\n[rst2man-indent2] .. .de1 INDENT .\" .rstReportMargin pre: . RS \\$1 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] . nr rst2man-indent-level +1 .\" .rstReportMargin post: .. .de UNINDENT . RE .\" indent \\n[an-margin] .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] .nr rst2man-indent-level -1 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. .SH SYNOPSIS .sp pbrd [\-h] [\-v] .sp pbrd [\-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] .SH DESCRIPTION .sp pbrd is a routing component that works with the FRRouting engine. .SH OPTIONS .sp OPTIONS available for the pbrd command: .SS HELP AND VERSION .INDENT 0.0 .TP .B \-h, \-\-help Print a short description of the daemon\(aqs command line options. .UNINDENT .INDENT 0.0 .TP .B \-v, \-\-version Print version and build information for the daemon. .UNINDENT .sp Both of these options inhibit normal operation and will immediately exit. .SS PROCESS CONTROL .sp These options control background operation: .INDENT 0.0 .TP .B \-d, \-\-daemon .INDENT 7.0 .INDENT 3.5 Launches the process in background/daemon mode, forking and detaching from the terminal. .UNINDENT .UNINDENT .sp 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. .UNINDENT .INDENT 0.0 .TP .B \-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. .sp 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.) .UNINDENT .sp The combination of \fB\-\-daemon\fP and \fB\-\-terminal\fP will delay the daemon from going into background until the terminal session ends (by end of file.) .sp If the process receives SIGINT (e.g. a ^C keypress) in this mode, it will exit instead of daemonizing. .sp 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.) .SS CONFIGURATION AND PATHS .sp The following options control configuration and file system locations for frr processes: .INDENT 0.0 .TP .B \-f, \-\-config_file config\-file Specify a configuration file to be used instead of the default /etc/frr/.conf file. .sp 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. .UNINDENT .INDENT 0.0 .TP .B \-C, \-\-dryrun Load the configuration file and check its validity, then exit. .UNINDENT .INDENT 0.0 .TP .B \-i, \-\-pid_file pid\-file Output a pid file to a location other than the default /var/run/frr/.pid. .UNINDENT .INDENT 0.0 .TP .B \-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. .UNINDENT .INDENT 0.0 .TP .B \-N, \-\-pathspace pathspace Insert pathspace into all default paths, changing the defaults to: .sp /etc/frr/pathspace/.conf /var/run/frr/pathspace/.pid /var/run/frr/pathspace/.vty /var/run/frr/pathspace/zserv.api .sp \'.\' and \'/\' characters will not be accepted in pathspace, but the empty string will be accepted. .sp 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. .sp 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. .sp This option does not do any system setup (like network namespaces.) This must be done by the user, for example by running: .sp ip netns exec namespace \-N namespace .UNINDENT .SS PROCESS CREDENTIALS .INDENT 0.0 .TP .B \-u, \-\-user user (default: frr) .UNINDENT .INDENT 0.0 .TP .B \-g, \-\-group group (default: frr) .sp Change the user/group which the daemon will switch to. .UNINDENT .INDENT 0.0 .TP .B \-S, \-\-skip_runas Skip setting the process effective user and group. .UNINDENT .sp 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. .SS VTY SETUP .sp These following options control the daemon\(aqs VTY (interactive command line) interface. The interface is available over TCP, using the telnet protocol, as well as through the vtysh frontend. .INDENT 0.0 .TP .B \-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. .UNINDENT .INDENT 0.0 .TP .B \-P, \-\-vty_port vty\-port Override the daemon\(aqs default TCP VTY port (each daemon has a different default value upwards of 2600, listed below.) Specifying 0 disables the TCP VTY interface. .sp Default ports are:: .INDENT 7.0 .INDENT 3.5 .sp .nf .ft C 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 .ft P .fi .UNINDENT .UNINDENT .sp Port 2607 is used for ospfd\(aqs Opaque LSA API. .UNINDENT .INDENT 0.0 .TP .B \-\-vty_socket vty\-path Overrides the directory used for the .vty sockets. vtysh connects to these sockets in order to access each daemon\(aqs VTY. Default: /var/run/frr[/] .sp NB: Unlike the other options, this option specifies a directory, not a full path. .sp This option is primarily used by the SNAP packaging system, its semantics may change. It should not be necessary in most other scenarios. .UNINDENT .SS MODULE LOADING .sp 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. .INDENT 0.0 .TP .B \-M, \-\-module module[:options] Load a module named module, optionally passing options to it. .sp If there is a \'/\' character in module, the value is assumed to be a pathname to a module. .sp If there is no \'/\' character, the module directory (see next option) is searched first for a module named "_.so", then for ".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. .sp The meaning of options is specific to the module being loaded. Most modules currently ignore it. .sp Modules are loaded in the order as listed on the command line. This is not generally relevant. .UNINDENT .INDENT 0.0 .TP .B \-\-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.) .UNINDENT .sp The list of loaded modules can be inspected at runtime with the show modules VTY command. .SH FILES .INDENT 0.0 .TP .B /usr/lib/frr/pbrd The default location of the pbrd binary. .TP .B /etc/frr/pbrd\&.conf The default location of the pbrd config file. .TP .B $(PWD)/pbrd\&.log If the pbrd process is configured to output logs to a file, then you will find this file in the directory where you started pbrd\&. .UNINDENT .SH WARNING .sp This man page is intended to be a quick reference for command line options. The definitive document is the info file frr 8.5.7 or the documentation available on the project website at \fI\%https://frrouting.org/\fP\&. .SH DIAGNOSTICS .sp 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. .SH SEE ALSO .sp 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) \fI\%https://frrouting.org/\fP .SH BUGS .sp FRR eats bugs for breakfast. If you have food for the maintainers, please email <\fI\%dev@lists.frrouting.org\fP>. .SH COPYRIGHT 2017, FRR .\" Generated by docutils manpage writer. .