Gitiles
Code Review Sign In
gerrit.opencord.org / quagga / f371b1fb2bd0c615d44653d56a26df8f7245481d / . / doc / zebra.8
blob: 558e27beee5f846bea13fcaa3ec0e8bb08f4d447 [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
63\fB\-l\fR, \fB\-\-log_mode\fR
64Turn verbose logging on.
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]65.TP
66\fB\-P\fR, \fB\-\-vty_port \fR\fIport-number\fR
67Specify the port that the zebra VTY will listen on. This defaults to
682602, as specified in \fB\fI/etc/services\fR.
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]69.TP
hasso6c110e72003-11-27 13:02:03 +0000[diff] [blame]70\fB\-A\fR, \fB\-\-vty_addr \fR\fIvty-address\fR
71Specify the address that the zebra VTY will listen on. Default is all
ajs151fe8a2005-04-22 12:56:37 +0000[diff] [blame]72interfaces.
hasso6c110e72003-11-27 13:02:03 +0000[diff] [blame]73.TP
74\fB\-u\fR, \fB\-\-user \fR\fIuser\fR
hassoc0652302004-11-25 19:33:48 +0000[diff] [blame]75Specify the user to run as. Default is \fIquagga\fR.
hasso6c110e72003-11-27 13:02:03 +0000[diff] [blame]76.TP
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]77\fB\-r\fR, \fB\-\-retain\fR
78When the program terminates, retain routes added by \fBzebra\fR.
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]79.TP
hassoc34b6b52004-08-31 13:41:49 +0000[diff] [blame]80\fB\-s\fR, \fB\-\-nl-bufsize \fR\fInetlink-buffer-size\fR
81Set netlink receive buffer size. There are cases where zebra daemon can't
82handle flood of netlink messages from kernel. If you ever see "recvmsg overrun"
83messages in zebra log, you are in trouble.
84
85Solution is to increase receive buffer of netlink socket. Note that kernel
86doesn't allow to increase it over maximum value defined in
87\fI/proc/sys/net/core/rmem_max\fR. If you want to do it, you have to increase
88maximum before starting zebra.
89
90Note that this affects Linux only.
91.TP
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]92\fB\-v\fR, \fB\-\-version\fR
93Print the version and exit.
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]94.SH FILES
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]95.TP
96.BI /usr/local/sbin/zebra
97The default location of the
98.B zebra
99binary.
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]100.TP
101.BI /usr/local/etc/zebra.conf
102The default location of the
103.B zebra
104config file.
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]105.TP
106.BI $(PWD)/zebra.log
107If the
108.B zebra
109process is config'd to output logs to a file, then you will find this
110file in the directory where you started \fBzebra\fR.
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]111.SH WARNING
hasso246c1352004-08-10 12:00:34 +0000[diff] [blame]112This man page is intended to be a quick reference for command line
113options. The definitive document is the Info file \fBQuagga\fR.
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]114.SH DIAGNOSTICS
hasso246c1352004-08-10 12:00:34 +0000[diff] [blame]115The zebra process may log to standard output, to a VTY, to a log
116file, or through syslog to the system logs. \fBzebra\fR supports many
117debugging options, see the Info file, or the source for details.
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]118.SH "SEE ALSO"
hasso246c1352004-08-10 12:00:34 +0000[diff] [blame]119.BR bgpd (8),
120.BR ripd (8),
121.BR ripngd (8),
122.BR ospfd (8),
123.BR ospf6d (8),
124.BR isisd (8),
125.BR vtysh (1)
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]126.SH BUGS
127.B zebra
hasso246c1352004-08-10 12:00:34 +0000[diff] [blame]128eats bugs for breakfast. If you have food for the maintainers try
hasso2f04e672004-02-20 18:53:22 +0000[diff] [blame]129.BI http://bugzilla.quagga.net
hasso246c1352004-08-10 12:00:34 +0000[diff] [blame]130.SH AUTHORS
131See
132.BI http://www.zebra.org
133and
134.BI http://www.quagga.org
135or the Info file for an accurate list of authors.
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]136