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