doc/zebra.8

   1 .TH ZEBRA 8 "25 November 2004" "Zebra daemon" "Version 0.97.3"
   2 .SH NAME
   3 zebra \- a routing manager for use with associated Quagga components.
   4 .SH SYNOPSIS
   5 .B zebra
   6 [
   7 .B \-bdhklrv
   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
  23 ] [
  24 .B \-g
  25 .I group
  26 ]
  27 .SH DESCRIPTION
  28 .B zebra
  29 is a routing manager that implements the
  30 .B zebra
  31 route engine.
  32 .B zebra
  33 supports RIPv1, RIPv2, RIPng, OSPF, OSPF6, IS-IS, BGP4+, and BGP4-.
  34 .SH OPTIONS
  35 Options available for the
  36 .B zebra
  37 command:
  38 .TP
  39 \fB\-b\fR, \fB\-\-batch\fR
  40 Runs in batch mode, \fBzebra\fR parses its config and exits.
  41 .TP
  42 \fB\-d\fR, \fB\-\-daemon\fR
  43 Runs in daemon mode, forking and exiting from tty.
  44 .TP
  45 \fB\-f\fR, \fB\-\-config-file \fR\fIconfig-file\fR
  46 Specifies the config file to use for startup. If not specified this
  47 option will likely default to \fB\fI/usr/local/etc/zebra.conf\fR.
  48 .TP
  49 \fB\-g\fR, \fB\-\-group \fR\fIgroup\fR
  50 Specify the group to run as. Default is \fIquagga\fR.
  51 .TP
  52 \fB\-h\fR, \fB\-\-help\fR
  53 A brief message.
  54 .TP
  55 \fB\-i\fR, \fB\-\-pid_file \fR\fIpid-file\fR
  56 When zebra starts its process identifier is written to
  57 \fB\fIpid-file\fR.  The init system uses the recorded PID to stop or
  58 restart zebra.  The likely default is \fB\fI/var/run/zebra.pid\fR.
  59 .TP
  60 \fB\-k\fR, \fB\-\-keep_kernel\fR
  61 On startup, don't delete self inserted routes.
  62 .TP
  63 \fB\-l\fR, \fB\-\-log_mode\fR
  64 Turn verbose logging on.
  65 .TP
  66 \fB\-P\fR, \fB\-\-vty_port \fR\fIport-number\fR
  67 Specify the port that the zebra VTY will listen on. This defaults to
  68 2602, as specified in \fB\fI/etc/services\fR.
  69 .TP
  70 \fB\-A\fR, \fB\-\-vty_addr \fR\fIvty-address\fR
  71 Specify the address that the zebra VTY will listen on. Default is all
  72 interfaces.
  73 .TP
  74 \fB\-u\fR, \fB\-\-user \fR\fIuser\fR
  75 Specify the user to run as. Default is \fIquagga\fR.
  76 .TP
  77 \fB\-r\fR, \fB\-\-retain\fR
  78 When the program terminates, retain routes added by \fBzebra\fR.
  79 .TP
  80 \fB\-s\fR, \fB\-\-nl-bufsize \fR\fInetlink-buffer-size\fR
  81 Set netlink receive buffer size. There are cases where zebra daemon can't
  82 handle flood of netlink messages from kernel. If you ever see "recvmsg overrun"
  83 messages in zebra log, you are in trouble.
  84
  85 Solution is to increase receive buffer of netlink socket. Note that kernel
  86 doesn'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
  88 maximum before starting zebra.
  89
  90 Note that this affects Linux only.
  91 .TP
  92 \fB\-v\fR, \fB\-\-version\fR
  93 Print the version and exit.
  94 .SH FILES
  95 .TP
  96 .BI /usr/local/sbin/zebra
  97 The default location of the
  98 .B zebra
  99 binary.
 100 .TP
 101 .BI /usr/local/etc/zebra.conf
 102 The default location of the
 103 .B zebra
 104 config file.
 105 .TP
 106 .BI $(PWD)/zebra.log
 107 If the
 108 .B zebra
 109 process is config'd to output logs to a file, then you will find this
 110 file in the directory where you started \fBzebra\fR.
 111 .SH WARNING
 112 This man page is intended to be a quick reference for command line
 113 options. The definitive document is the Info file \fBQuagga\fR.
 114 .SH DIAGNOSTICS
 115 The zebra process may log to standard output, to a VTY, to a log
 116 file, or through syslog to the system logs. \fBzebra\fR supports many
 117 debugging options, see the Info file, or the source for details.
 118 .SH "SEE ALSO"
 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)
 126 .SH BUGS
 127 .B zebra
 128 eats bugs for breakfast. If you have food for the maintainers try
 129 .BI http://bugzilla.quagga.net
 130 .SH AUTHORS
 131 See
 132 .BI http://www.zebra.org
 133 and
 134 .BI http://www.quagga.org
 135 or the Info file for an accurate list of authors.
 136