ospf6d: Intra-prefix LSA update after frr restart

[mirror_frr.git] / doc / zebra.8.in

.TH ZEBRA 8 "25 November 2004" "Zebra daemon" "Version @PACKAGE_VERSION@"
.SH NAME
zebra \- a routing manager for use with associated @PACKAGE_FULLNAME@ components.
.SH SYNOPSIS
.B zebra
[
.B \-bdhklrv
] [
.B \-f
.I config-file
] [
.B \-i
.I pid-file
] [
.B \-P
.I port-number
] [
.B \-A
.I vty-address
] [
.B \-u
.I user
] [
.B \-g
.I group
] [
.B \-M
.I module:options
] [
.B \-z
.I socketpath
]
.SH DESCRIPTION
.B zebra 
is a routing manager that implements the 
.B zebra
route engine.
.B zebra 
supports RIPv1, RIPv2, RIPng, OSPF, OSPF6, IS-IS, BGP4+, and BGP4-.
.SH OPTIONS
Options available for the
.B zebra
command:
.TP
\fB\-b\fR, \fB\-\-batch\fR
Runs in batch mode, \fBzebra\fR parses its config and exits.
.TP
\fB\-d\fR, \fB\-\-daemon\fR
Runs in daemon mode, forking and exiting from tty.
.TP
\fB\-f\fR, \fB\-\-config-file \fR\fIconfig-file\fR
Specifies the config file to use for startup. If not specified this
option will default to \fB\fI@CFG_SYSCONF@/zebra.conf\fR.
.TP
\fB\-g\fR, \fB\-\-group \fR\fIgroup\fR
Specify the group to run as. Default is \fI@enable_group@\fR.
.TP
\fB\-h\fR, \fB\-\-help\fR
A brief message.
.TP
\fB\-i\fR, \fB\-\-pid_file \fR\fIpid-file\fR
When zebra starts its process identifier is written to
\fB\fIpid-file\fR.  The init system uses the recorded PID to stop or
restart zebra.  The default is \fB\fI@CFG_STATE@/zebra.pid\fR.
.TP
\fB\-k\fR, \fB\-\-keep_kernel\fR
On startup, don't delete self inserted routes.
.TP
\fB\-P\fR, \fB\-\-vty_port \fR\fIport-number\fR 
Specify the port that the zebra VTY will listen on. This defaults to
2601, as specified in \fB\fI/etc/services\fR.
.TP
\fB\-A\fR, \fB\-\-vty_addr \fR\fIvty-address\fR
Specify the address that the zebra VTY will listen on. Default is all
interfaces.
.TP
\fB\-u\fR, \fB\-\-user \fR\fIuser\fR
Specify the user to run as. Default is \fI@enable_user@\fR.
.TP
\fB\-r\fR, \fB\-\-retain\fR 
When the program terminates, retain routes added by \fBzebra\fR.
.TP
\fB\-s\fR, \fB\-\-nl-bufsize \fR\fInetlink-buffer-size\fR
Set netlink receive buffer size. There are cases where zebra daemon can't
handle flood of netlink messages from kernel. If you ever see "recvmsg overrun"
messages in zebra log, you are in trouble.

Solution is to increase receive buffer of netlink socket. Note that kernel
< 2.6.14 doesn't allow to increase it over maximum value defined in
\fI/proc/sys/net/core/rmem_max\fR. If you want to do it, you have to increase
maximum before starting zebra.

Note that this affects Linux only.
.TP
\fB\-n\fR, \fB\-\-vrfwnetns \fR\fIEnable namespace VRF\fR
Enable namespace VRF backend. By default, the VRF backend relies on VRF-lite
support from Linux devices. This option permits discovering using Linux named
Netns and map it to FRR VRF contexts.
.TP
\fB\-M\fR, \fB\-\-module \fR\fImodule:options\fR
Load a module at startup.  May be specified more than once.
The \fBsnmp\fR and \fBfpm\fR modules may be
available for \fBzebra\fR, if the package was built with SNMP and FPM support
respectively.  The \fBfpm\fR module takes an additional colon-separated
argument specifying the encapsulation, either \fBnetlink\fR or \fBprotobuf\fR.
It should thus be loaded with \fB-M fpm:netlink\fR or \fB-M fpm:protobuf\fR.
.TP
\fB\-z\fR, \fB\-\-socket \fR\fIsocketpath\fR
Use the specified path to open the zebra API socket on.
The default is \fB\fI@CFG_STATE@/zserv.api\fR.  This option must be given with
the same value to all FRR protocol daemons.
.TP
\fB\-v\fR, \fB\-\-version\fR
Print the version and exit.
.SH FILES
.TP
.BI @CFG_SBIN@/zebra
The default location of the 
.B zebra
binary.
.TP
.BI @CFG_SYSCONF@/zebra.conf
The default location of the 
.B zebra
config file.
.TP
.BI $(PWD)/zebra.log 
If the 
.B zebra
process is config'd to output logs to a file, then you will find this
file in the directory where you started \fBzebra\fR.
.SH WARNING
This man page is intended to be a quick reference for command line
options. The definitive document is the Info file \fB@PACKAGE_NAME@\fR.
.SH DIAGNOSTICS
The zebra process may log to standard output, to a VTY, to a log
file, or through syslog to the system logs. \fBzebra\fR supports many
debugging options, see the Info file, or the source for details.
.SH "SEE ALSO"
.BR bgpd (8),
.BR ripd (8),
.BR ripngd (8),
.BR ospfd (8),
.BR ospf6d (8),
.BR isisd (8),
.BR nhrpd (8),
.BR vtysh (1)
.SH BUGS
.B zebra
eats bugs for breakfast. If you have food for the maintainers try
.BI @PACKAGE_BUGREPORT@
.SH AUTHORS
See
.BI http://www.zebra.org
and
.BI @PACKAGE_URL@
or the Info file for an accurate list of authors.