doc/zebra.8.in

   1 .TH ZEBRA 8 "25 November 2004" "Zebra daemon" "Version @PACKAGE_VERSION@"
   2 .SH NAME
   3 zebra \- a routing manager for use with associated @PACKAGE_FULLNAME@ 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 .B \-M
  28 .I module:options
  29 ]
  30 .SH DESCRIPTION
  31 .B zebra
  32 is a routing manager that implements the
  33 .B zebra
  34 route engine.
  35 .B zebra
  36 supports RIPv1, RIPv2, RIPng, OSPF, OSPF6, IS-IS, BGP4+, and BGP4-.
  37 .SH OPTIONS
  38 Options available for the
  39 .B zebra
  40 command:
  41 .TP
  42 \fB\-b\fR, \fB\-\-batch\fR
  43 Runs in batch mode, \fBzebra\fR parses its config and exits.
  44 .TP
  45 \fB\-d\fR, \fB\-\-daemon\fR
  46 Runs in daemon mode, forking and exiting from tty.
  47 .TP
  48 \fB\-f\fR, \fB\-\-config-file \fR\fIconfig-file\fR
  49 Specifies the config file to use for startup. If not specified this
  50 option will default to \fB\fI@CFG_SYSCONF@/zebra.conf\fR.
  51 .TP
  52 \fB\-g\fR, \fB\-\-group \fR\fIgroup\fR
  53 Specify the group to run as. Default is \fI@enable_group@\fR.
  54 .TP
  55 \fB\-h\fR, \fB\-\-help\fR
  56 A brief message.
  57 .TP
  58 \fB\-i\fR, \fB\-\-pid_file \fR\fIpid-file\fR
  59 When zebra starts its process identifier is written to
  60 \fB\fIpid-file\fR.  The init system uses the recorded PID to stop or
  61 restart zebra.  The default is \fB\fI@CFG_STATE@/zebra.pid\fR.
  62 .TP
  63 \fB\-k\fR, \fB\-\-keep_kernel\fR
  64 On startup, don't delete self inserted routes.
  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 2601, 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 \fI@enable_user@\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 < 2.6.14 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\-M\fR, \fB\-\-module \fR\fImodule:options\fR
  93 Load a module at startup.  May be specified more than once.
  94 The \fBsnmp\fR and \fBfpm\fR modules may be
  95 available for \fBzebra\fR, if the package was built with SNMP and FPM support
  96 respectively.  The \fBfpm\fR module takes an additional colon-separated
  97 argument specifying the encapsulation, either \fBnetlink\fR or \fBprotobuf\fR.
  98 It should thus be loaded with \fB-M fpm:netlink\fR or \fB-M fpm:protobuf\fR.
  99 .TP
 100 \fB\-v\fR, \fB\-\-version\fR
 101 Print the version and exit.
 102 .SH FILES
 103 .TP
 104 .BI @CFG_SBIN@/zebra
 105 The default location of the
 106 .B zebra
 107 binary.
 108 .TP
 109 .BI @CFG_SYSCONF@/zebra.conf
 110 The default location of the
 111 .B zebra
 112 config file.
 113 .TP
 114 .BI $(PWD)/zebra.log
 115 If the
 116 .B zebra
 117 process is config'd to output logs to a file, then you will find this
 118 file in the directory where you started \fBzebra\fR.
 119 .SH WARNING
 120 This man page is intended to be a quick reference for command line
 121 options. The definitive document is the Info file \fB@PACKAGE_NAME@\fR.
 122 .SH DIAGNOSTICS
 123 The zebra process may log to standard output, to a VTY, to a log
 124 file, or through syslog to the system logs. \fBzebra\fR supports many
 125 debugging options, see the Info file, or the source for details.
 126 .SH "SEE ALSO"
 127 .BR bgpd (8),
 128 .BR ripd (8),
 129 .BR ripngd (8),
 130 .BR ospfd (8),
 131 .BR ospf6d (8),
 132 .BR isisd (8),
 133 .BR nhrpd (8),
 134 .BR vtysh (1)
 135 .SH BUGS
 136 .B zebra
 137 eats bugs for breakfast. If you have food for the maintainers try
 138 .BI @PACKAGE_BUGREPORT@
 139 .SH AUTHORS
 140 See
 141 .BI http://www.zebra.org
 142 and
 143 .BI @PACKAGE_URL@
 144 or the Info file for an accurate list of authors.
 145