]>
Commit | Line | Data |
---|---|---|
a07169b1 | 1 | .TH ZEBRA 8 "25 November 2004" "Zebra daemon" "Version @PACKAGE_VERSION@" |
718e3744 | 2 | .SH NAME |
a07169b1 | 3 | zebra \- a routing manager for use with associated @PACKAGE_FULLNAME@ components. |
718e3744 | 4 | .SH SYNOPSIS |
5 | .B zebra | |
6 | [ | |
7 | .B \-bdhklrv | |
246c135e | 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 | |
c065230a | 23 | ] [ |
24 | .B \-g | |
25 | .I group | |
6b0275ac DL |
26 | ] [ |
27 | .B \-M | |
28 | .I module:options | |
689f5a8c DL |
29 | ] [ |
30 | .B \-z | |
31 | .I socketpath | |
718e3744 | 32 | ] |
718e3744 | 33 | .SH DESCRIPTION |
34 | .B zebra | |
35 | is a routing manager that implements the | |
36 | .B zebra | |
37 | route engine. | |
38 | .B zebra | |
246c135e | 39 | supports RIPv1, RIPv2, RIPng, OSPF, OSPF6, IS-IS, BGP4+, and BGP4-. |
718e3744 | 40 | .SH OPTIONS |
246c135e | 41 | Options available for the |
42 | .B zebra | |
43 | command: | |
718e3744 | 44 | .TP |
45 | \fB\-b\fR, \fB\-\-batch\fR | |
46 | Runs in batch mode, \fBzebra\fR parses its config and exits. | |
718e3744 | 47 | .TP |
48 | \fB\-d\fR, \fB\-\-daemon\fR | |
49 | Runs in daemon mode, forking and exiting from tty. | |
718e3744 | 50 | .TP |
51 | \fB\-f\fR, \fB\-\-config-file \fR\fIconfig-file\fR | |
c065230a | 52 | Specifies the config file to use for startup. If not specified this |
a07169b1 | 53 | option will default to \fB\fI@CFG_SYSCONF@/zebra.conf\fR. |
c065230a | 54 | .TP |
55 | \fB\-g\fR, \fB\-\-group \fR\fIgroup\fR | |
a07169b1 | 56 | Specify the group to run as. Default is \fI@enable_group@\fR. |
718e3744 | 57 | .TP |
58 | \fB\-h\fR, \fB\-\-help\fR | |
59 | A brief message. | |
718e3744 | 60 | .TP |
61 | \fB\-i\fR, \fB\-\-pid_file \fR\fIpid-file\fR | |
a0e64a63 | 62 | When zebra starts its process identifier is written to |
718e3744 | 63 | \fB\fIpid-file\fR. The init system uses the recorded PID to stop or |
a07169b1 | 64 | restart zebra. The default is \fB\fI@CFG_STATE@/zebra.pid\fR. |
718e3744 | 65 | .TP |
66 | \fB\-k\fR, \fB\-\-keep_kernel\fR | |
67 | On startup, don't delete self inserted routes. | |
718e3744 | 68 | .TP |
718e3744 | 69 | \fB\-P\fR, \fB\-\-vty_port \fR\fIport-number\fR |
70 | Specify the port that the zebra VTY will listen on. This defaults to | |
5b40b1b5 | 71 | 2601, as specified in \fB\fI/etc/services\fR. |
6c110e70 | 72 | .TP |
73 | \fB\-A\fR, \fB\-\-vty_addr \fR\fIvty-address\fR | |
74 | Specify the address that the zebra VTY will listen on. Default is all | |
151fe8a4 | 75 | interfaces. |
6c110e70 | 76 | .TP |
77 | \fB\-u\fR, \fB\-\-user \fR\fIuser\fR | |
a07169b1 | 78 | Specify the user to run as. Default is \fI@enable_user@\fR. |
718e3744 | 79 | .TP |
80 | \fB\-r\fR, \fB\-\-retain\fR | |
81 | When the program terminates, retain routes added by \fBzebra\fR. | |
718e3744 | 82 | .TP |
c34b6b57 | 83 | \fB\-s\fR, \fB\-\-nl-bufsize \fR\fInetlink-buffer-size\fR |
84 | Set netlink receive buffer size. There are cases where zebra daemon can't | |
85 | handle flood of netlink messages from kernel. If you ever see "recvmsg overrun" | |
86 | messages in zebra log, you are in trouble. | |
87 | ||
88 | Solution is to increase receive buffer of netlink socket. Note that kernel | |
f1ef81b2 | 89 | < 2.6.14 doesn't allow to increase it over maximum value defined in |
c34b6b57 | 90 | \fI/proc/sys/net/core/rmem_max\fR. If you want to do it, you have to increase |
91 | maximum before starting zebra. | |
92 | ||
93 | Note that this affects Linux only. | |
94 | .TP | |
6b0275ac DL |
95 | \fB\-M\fR, \fB\-\-module \fR\fImodule:options\fR |
96 | Load a module at startup. May be specified more than once. | |
97 | The \fBsnmp\fR and \fBfpm\fR modules may be | |
98 | available for \fBzebra\fR, if the package was built with SNMP and FPM support | |
99 | respectively. The \fBfpm\fR module takes an additional colon-separated | |
100 | argument specifying the encapsulation, either \fBnetlink\fR or \fBprotobuf\fR. | |
101 | It should thus be loaded with \fB-M fpm:netlink\fR or \fB-M fpm:protobuf\fR. | |
102 | .TP | |
689f5a8c DL |
103 | \fB\-z\fR, \fB\-\-socket \fR\fIsocketpath\fR |
104 | Use the specified path to open the zebra API socket on. | |
105 | The default is \fB\fI@CFG_STATE@/zserv.api\fR. This option must be given with | |
106 | the same value to all FRR protocol daemons. | |
689f5a8c | 107 | .TP |
718e3744 | 108 | \fB\-v\fR, \fB\-\-version\fR |
109 | Print the version and exit. | |
718e3744 | 110 | .SH FILES |
718e3744 | 111 | .TP |
a07169b1 | 112 | .BI @CFG_SBIN@/zebra |
718e3744 | 113 | The default location of the |
114 | .B zebra | |
115 | binary. | |
718e3744 | 116 | .TP |
a07169b1 | 117 | .BI @CFG_SYSCONF@/zebra.conf |
718e3744 | 118 | The default location of the |
119 | .B zebra | |
120 | config file. | |
718e3744 | 121 | .TP |
122 | .BI $(PWD)/zebra.log | |
123 | If the | |
124 | .B zebra | |
125 | process is config'd to output logs to a file, then you will find this | |
126 | file in the directory where you started \fBzebra\fR. | |
718e3744 | 127 | .SH WARNING |
246c135e | 128 | This man page is intended to be a quick reference for command line |
a07169b1 | 129 | options. The definitive document is the Info file \fB@PACKAGE_NAME@\fR. |
718e3744 | 130 | .SH DIAGNOSTICS |
246c135e | 131 | The zebra process may log to standard output, to a VTY, to a log |
132 | file, or through syslog to the system logs. \fBzebra\fR supports many | |
133 | debugging options, see the Info file, or the source for details. | |
718e3744 | 134 | .SH "SEE ALSO" |
246c135e | 135 | .BR bgpd (8), |
136 | .BR ripd (8), | |
137 | .BR ripngd (8), | |
138 | .BR ospfd (8), | |
139 | .BR ospf6d (8), | |
140 | .BR isisd (8), | |
caba6093 | 141 | .BR nhrpd (8), |
246c135e | 142 | .BR vtysh (1) |
718e3744 | 143 | .SH BUGS |
144 | .B zebra | |
246c135e | 145 | eats bugs for breakfast. If you have food for the maintainers try |
a07169b1 | 146 | .BI @PACKAGE_BUGREPORT@ |
246c135e | 147 | .SH AUTHORS |
148 | See | |
149 | .BI http://www.zebra.org | |
150 | and | |
a07169b1 | 151 | .BI @PACKAGE_URL@ |
246c135e | 152 | or the Info file for an accurate list of authors. |
718e3744 | 153 |