Gitiles
Code Review Sign In
gerrit.opencord.org / quagga / 5973ee73f0931d666a733afad8b198ca3b050592 / . / doc / bgpd.8
blob: 6ff3fa454d7922dccf238906c4f36357a9320340 [file] [log] [blame]
hasso246c1352004-08-10 12:00:34 +0000[diff] [blame]1.TH BGPD 8 "10 August 2004" "Quagga BGPD daemon" "Version 0.96.5"
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]2.SH NAME
hasso246c1352004-08-10 12:00:34 +0000[diff] [blame]3bgpd \- a BGPv4, BGPv4+, BGPv4- routing engine for use with Quagga routing
4software
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]5
6.SH SYNOPSIS
7.B bgpd
8[
hasso2f04e672004-02-20 18:53:22 +0000[diff] [blame]9.B \-dhrv
hasso246c1352004-08-10 12:00:34 +0000[diff] [blame]10] [
11.B \-f
12.I config-file
13] [
14.B \-i
15.I pid-file
16] [
17.B \-p
18.I bgp-port-number
19] [
20.B \--bgp_port=
21.I port-number
22] [
23.B \-P
24.I port-number
25] [
26.B \-A
27.I vty-address
28] [
29.B \-u
30.I user
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]31]
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]32.SH DESCRIPTION
33.B bgpd
34is a routing component that works with the
hasso246c1352004-08-10 12:00:34 +0000[diff] [blame]35.B Quagga
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]36routing engine.
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]37.SH OPTIONS
hasso246c1352004-08-10 12:00:34 +0000[diff] [blame]38Options available for the
39.B bgpd
40command:
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
46Specifies the config file to use for startup. If not specified this
47option will likely default to \fB\fI/usr/local/etc/bgpd.conf\fR.
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]48.TP
49\fB\-h\fR, \fB\-\-help\fR
50A brief message.
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]51.TP
52\fB\-i\fR, \fB\-\-pid_file \fR\fIpid-file\fR
53When bgpd starts its process idenifier is written to
54\fB\fIpid-file\fR. The init system uses the recorded PID to stop or
55restart bgpd. The likely default is \fB\fI/var/run/bgpd.pid\fR.
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]56.TP
57\fB\-p\fR, \fB\-\-bgp_port=\fR\fIport\fR
58Set the port that bgpd will listen to for bgp data.
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]59.TP
60\fB\-P\fR, \fB\-\-vty_port \fR\fIport-number\fR
61Specify the port that the bgpd VTY will listen on. This defaults to
622605, as specified in \fI/etc/services\fR.
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]63.TP
hasso6c110e72003-11-27 13:02:03 +0000[diff] [blame]64\fB\-A\fR, \fB\-\-vty_addr \fR\fIvty-address\fR
65Specify the address that the bgpd VTY will listen on. Default is all
66intrefaces.
hasso6c110e72003-11-27 13:02:03 +0000[diff] [blame]67.TP
68\fB\-u\fR, \fB\-\-user \fR\fIuser\fR
69Specify the user and group to run as. User and group have to have same
70name at the moment. Default is \fIquagga\fR.
hasso6c110e72003-11-27 13:02:03 +0000[diff] [blame]71.TP
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]72\fB\-r\fR, \fB\-\-retain\fR
73When the program terminates, retain routes added by \fBbgpd\fR.
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]74.TP
75\fB\-v\fR, \fB\-\-version\fR
76Print the version and exit.
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]77.SH FILES
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]78.TP
79.BI /usr/local/sbin/bgpd
80The default location of the
81.B bgpd
82binary.
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]83.TP
84.BI /usr/local/etc/bgpd.conf
85The default location of the
86.B bgpd
87config file.
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]88.TP
89.BI $(PWD)/bgpd.log
90If the
91.B bgpd
92process is config'd to output logs to a file, then you will find this
93file in the directory where you started \fBbgpd\fR.
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]94.SH WARNING
hasso246c1352004-08-10 12:00:34 +0000[diff] [blame]95This man page is intended to be a quick reference for command line
96options. The definitive document is the Info file \fBQuagga\fR.
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]97.SH DIAGNOSTICS
98The bgpd process may log to standard output, to a VTY, to a log
99file, or through syslog to the system logs. \fBbgpd\fR supports many
100debugging options, see the Info file, or the source for details.
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]101.SH "SEE ALSO"
hasso246c1352004-08-10 12:00:34 +0000[diff] [blame]102.BR ripd (8),
103.BR ripngd (8),
104.BR ospfd (8),
105.BR ospf6d (8),
106.BR isisd (8),
107.BR zebra (8),
108.BR vtysh (1)
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]109.SH BUGS
110.B bgpd
111eats bugs for breakfast. If you have food for the maintainers try
hasso2f04e672004-02-20 18:53:22 +0000[diff] [blame]112.BI http://bugzilla.quagga.net
hasso246c1352004-08-10 12:00:34 +0000[diff] [blame]113.SH AUTHORS
114See
115.BI http://www.zebra.org
116and
117.BI http://www.quagga.org
118or the Info file for an accurate list of authors.
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]119