Gitiles
Code Review Sign In
gerrit.opencord.org / quagga / 2bfc7c05dde63f828a06892e33abcae2e30dd18a / . / doc / zebra.8
blob: 25cbb36392012761d0538057db10aaaf5021d167 [file] [log] [blame]
hasso246c1352004-08-10 12:00:34 +0000[diff] [blame]1.TH ZEBRA 8 "10 August 2004" "Zebra daemon" "Version 0.96.5"
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]2.SH NAME
hasso246c1352004-08-10 12:00:34 +0000[diff] [blame]3zebra \- a routing manager for use with associated Quagga components.
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]4.SH SYNOPSIS
5.B zebra
6[
7.B \-bdhklrv
hasso246c1352004-08-10 12:00:34 +0000[diff] [blame]8] [
9.B \-f
10.I config-file
11] [
12.B \-i
13.I pid-file
14] [
15.B \-P
16.I port-number
17] [
18.B \-A
19.I vty-address
20] [
21.B \-u
22.I user
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]23]
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]24.SH DESCRIPTION
25.B zebra
26is a routing manager that implements the
27.B zebra
28route engine.
29.B zebra
hasso246c1352004-08-10 12:00:34 +0000[diff] [blame]30supports RIPv1, RIPv2, RIPng, OSPF, OSPF6, IS-IS, BGP4+, and BGP4-.
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]31.SH OPTIONS
hasso246c1352004-08-10 12:00:34 +0000[diff] [blame]32Options available for the
33.B zebra
34command:
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]35.TP
36\fB\-b\fR, \fB\-\-batch\fR
37Runs in batch mode, \fBzebra\fR parses its config and exits.
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]38.TP
39\fB\-d\fR, \fB\-\-daemon\fR
40Runs in daemon mode, forking and exiting from tty.
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]41.TP
42\fB\-f\fR, \fB\-\-config-file \fR\fIconfig-file\fR
43Specifies the config file to use for startup. If not specified this option will likely default to \fB\fI/usr/local/etc/zebra.conf\fR.
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]44.TP
45\fB\-h\fR, \fB\-\-help\fR
46A brief message.
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]47.TP
48\fB\-i\fR, \fB\-\-pid_file \fR\fIpid-file\fR
49When zebra starts its process idenifier is written to
50\fB\fIpid-file\fR. The init system uses the recorded PID to stop or
51restart zebra. The likely default is \fB\fI/var/run/zebra.pid\fR.
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]52.TP
53\fB\-k\fR, \fB\-\-keep_kernel\fR
54On startup, don't delete self inserted routes.
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]55.TP
56\fB\-l\fR, \fB\-\-log_mode\fR
57Turn verbose logging on.
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]58.TP
59\fB\-P\fR, \fB\-\-vty_port \fR\fIport-number\fR
60Specify the port that the zebra VTY will listen on. This defaults to
612602, as specified in \fB\fI/etc/services\fR.
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]62.TP
hasso6c110e72003-11-27 13:02:03 +0000[diff] [blame]63\fB\-A\fR, \fB\-\-vty_addr \fR\fIvty-address\fR
64Specify the address that the zebra VTY will listen on. Default is all
65intrefaces.
hasso6c110e72003-11-27 13:02:03 +0000[diff] [blame]66.TP
67\fB\-u\fR, \fB\-\-user \fR\fIuser\fR
68Specify the user and group to run as. User and group have to have same
69name at the moment. Default is \fIquagga\fR.
hasso6c110e72003-11-27 13:02:03 +0000[diff] [blame]70.TP
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]71\fB\-r\fR, \fB\-\-retain\fR
72When the program terminates, retain routes added by \fBzebra\fR.
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]73.TP
hassoc34b6b52004-08-31 13:41:49 +0000[diff] [blame]74\fB\-s\fR, \fB\-\-nl-bufsize \fR\fInetlink-buffer-size\fR
75Set netlink receive buffer size. There are cases where zebra daemon can't
76handle flood of netlink messages from kernel. If you ever see "recvmsg overrun"
77messages in zebra log, you are in trouble.
78
79Solution is to increase receive buffer of netlink socket. Note that kernel
80doesn't allow to increase it over maximum value defined in
81\fI/proc/sys/net/core/rmem_max\fR. If you want to do it, you have to increase
82maximum before starting zebra.
83
84Note that this affects Linux only.
85.TP
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]86\fB\-v\fR, \fB\-\-version\fR
87Print the version and exit.
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]88.SH FILES
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]89.TP
90.BI /usr/local/sbin/zebra
91The default location of the
92.B zebra
93binary.
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]94.TP
95.BI /usr/local/etc/zebra.conf
96The default location of the
97.B zebra
98config file.
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]99.TP
100.BI $(PWD)/zebra.log
101If the
102.B zebra
103process is config'd to output logs to a file, then you will find this
104file in the directory where you started \fBzebra\fR.
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]105.SH WARNING
hasso246c1352004-08-10 12:00:34 +0000[diff] [blame]106This man page is intended to be a quick reference for command line
107options. The definitive document is the Info file \fBQuagga\fR.
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]108.SH DIAGNOSTICS
hasso246c1352004-08-10 12:00:34 +0000[diff] [blame]109The zebra process may log to standard output, to a VTY, to a log
110file, or through syslog to the system logs. \fBzebra\fR supports many
111debugging options, see the Info file, or the source for details.
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]112.SH "SEE ALSO"
hasso246c1352004-08-10 12:00:34 +0000[diff] [blame]113.BR bgpd (8),
114.BR ripd (8),
115.BR ripngd (8),
116.BR ospfd (8),
117.BR ospf6d (8),
118.BR isisd (8),
119.BR vtysh (1)
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]120.SH BUGS
121.B zebra
hasso246c1352004-08-10 12:00:34 +0000[diff] [blame]122eats bugs for breakfast. If you have food for the maintainers try
hasso2f04e672004-02-20 18:53:22 +0000[diff] [blame]123.BI http://bugzilla.quagga.net
hasso246c1352004-08-10 12:00:34 +0000[diff] [blame]124.SH AUTHORS
125See
126.BI http://www.zebra.org
127and
128.BI http://www.quagga.org
129or the Info file for an accurate list of authors.
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]130