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