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 .B \-z
  31 .I socketpath
  32 ]
  33 .SH DESCRIPTION
  34 .B zebra
  35 is a routing manager that implements the
  36 .B zebra
  37 route engine.
  38 .B zebra
  39 supports RIPv1, RIPv2, RIPng, OSPF, OSPF6, IS-IS, BGP4+, and BGP4-.
  40 .SH OPTIONS
  41 Options available for the
  42 .B zebra
  43 command:
  44 .TP
  45 \fB\-b\fR, \fB\-\-batch\fR
  46 Runs in batch mode, \fBzebra\fR parses its config and exits.
  47 .TP
  48 \fB\-d\fR, \fB\-\-daemon\fR
  49 Runs in daemon mode, forking and exiting from tty.
  50 .TP
  51 \fB\-f\fR, \fB\-\-config-file \fR\fIconfig-file\fR
  52 Specifies the config file to use for startup. If not specified this
  53 option will default to \fB\fI@CFG_SYSCONF@/zebra.conf\fR.
  54 .TP
  55 \fB\-g\fR, \fB\-\-group \fR\fIgroup\fR
  56 Specify the group to run as. Default is \fI@enable_group@\fR.
  57 .TP
  58 \fB\-h\fR, \fB\-\-help\fR
  59 A brief message.
  60 .TP
  61 \fB\-i\fR, \fB\-\-pid_file \fR\fIpid-file\fR
  62 When zebra starts its process identifier is written to
  63 \fB\fIpid-file\fR.  The init system uses the recorded PID to stop or
  64 restart zebra.  The default is \fB\fI@CFG_STATE@/zebra.pid\fR.
  65 .TP
  66 \fB\-k\fR, \fB\-\-keep_kernel\fR
  67 On startup, don't delete self inserted routes.
  68 .TP
  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
  71 2601, as specified in \fB\fI/etc/services\fR.
  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
  75 interfaces.
  76 .TP
  77 \fB\-u\fR, \fB\-\-user \fR\fIuser\fR
  78 Specify the user to run as. Default is \fI@enable_user@\fR.
  79 .TP
  80 \fB\-r\fR, \fB\-\-retain\fR
  81 When the program terminates, retain routes added by \fBzebra\fR.
  82 .TP
  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
  89 < 2.6.14 doesn't allow to increase it over maximum value defined in
  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
  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
 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.
 107
 108 For debugging purposes (using tcpdump or wireshark to trace cross-daemon
 109 communication), a TCP socket can be used by specifying \fI@tcp[46][:port]\fR.
 110 It is intentionally not possible to bind this to anything other than localhost
 111 since zebra and the other daemons need to be running on the same host.  Using
 112 this feature \fBCREATES A SECURITY ISSUE\fR since nothing prevents other users
 113 on the local system from connecting to zebra and injecting bogus routing
 114 information.
 115 .TP
 116 \fB\-v\fR, \fB\-\-version\fR
 117 Print the version and exit.
 118 .SH FILES
 119 .TP
 120 .BI @CFG_SBIN@/zebra
 121 The default location of the
 122 .B zebra
 123 binary.
 124 .TP
 125 .BI @CFG_SYSCONF@/zebra.conf
 126 The default location of the
 127 .B zebra
 128 config file.
 129 .TP
 130 .BI $(PWD)/zebra.log
 131 If the
 132 .B zebra
 133 process is config'd to output logs to a file, then you will find this
 134 file in the directory where you started \fBzebra\fR.
 135 .SH WARNING
 136 This man page is intended to be a quick reference for command line
 137 options. The definitive document is the Info file \fB@PACKAGE_NAME@\fR.
 138 .SH DIAGNOSTICS
 139 The zebra process may log to standard output, to a VTY, to a log
 140 file, or through syslog to the system logs. \fBzebra\fR supports many
 141 debugging options, see the Info file, or the source for details.
 142 .SH "SEE ALSO"
 143 .BR bgpd (8),
 144 .BR ripd (8),
 145 .BR ripngd (8),
 146 .BR ospfd (8),
 147 .BR ospf6d (8),
 148 .BR isisd (8),
 149 .BR nhrpd (8),
 150 .BR vtysh (1)
 151 .SH BUGS
 152 .B zebra
 153 eats bugs for breakfast. If you have food for the maintainers try
 154 .BI @PACKAGE_BUGREPORT@
 155 .SH AUTHORS
 156 See
 157 .BI http://www.zebra.org
 158 and
 159 .BI @PACKAGE_URL@
 160 or the Info file for an accurate list of authors.
 161