path: root/usr.sbin/bgpd/bgpd.8

.\" $OpenBSD: bgpd.8,v 1.62 2019/11/10 20:51:53 landry Exp $
.\"
.\" Copyright (c) 2003, 2004 Henning Brauer <henning@openbsd.org>
.\"
.\" Permission to use, copy, modify, and distribute this software for any
.\" purpose with or without fee is hereby granted, provided that the above
.\" copyright notice and this permission notice appear in all copies.
.\"
.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.\"
.Dd $Mdocdate: November 10 2019 $
.Dt BGPD 8
.Os
.Sh NAME
.Nm bgpd
.Nd Border Gateway Protocol daemon
.Sh SYNOPSIS
.Nm bgpd
.Bk -words
.Op Fl cdnv
.Op Fl D Ar macro Ns = Ns Ar value
.Op Fl f Ar file
.Ek
.Sh DESCRIPTION
.Nm
is a Border Gateway Protocol
.Pq BGP
daemon which manages the network routing tables.
Its main purpose is to exchange information
concerning
.Qq network reachability
with other BGP systems.
.Nm
uses the Border Gateway Protocol, Version 4,
as described in RFC 4271.
.Pp
BGP is an exterior gateway protocol using a multiple step decision process
to find the best path.
Advanced filtering can be used to influence the route
decision for traffic engineering.
The session engine of
.Nm
is responsible for maintaining the TCP session with each neighbor.
Updates are passed to the Route Decision Engine (RDE) where the paths
are filtered and used to compute a Routing Information Base (RIB).
The parent process is responsible for keeping the RIB in sync with
the kernel routing table.
.Pp
The route decision process selects the best path by evaluating all paths to
the same destination.
The decision process continues to the next step if paths have equal attributes.
Paths that are less preferred are taken out of consideration until there is
only one path left.
.Bl -enum -width 42 -offset bula
.It
All paths with errors or loops are not eligible.
.It
Paths with an unreachable nexthop are not eligible.
After this step all remaining paths are valid.
.It
The path with the highest
.Em LOCAL_PREF
is selected.
.It
The path with the shortest
.Em AS path
attribute is selected.
.It
The
.Em ORIGIN
attribute is compared.
The order is IGP before EGP before incomplete origins.
.It
The path with the lowest
.Em MULTI_EXIT_DISC
metric is selected.
Normally, this value is only considered when choosing between multiple
routes sent by the same neighbouring AS.
However, if
.Dq Li rde med compare always
is set in the configuration, the metric is compared for routes sent by any AS.
.It
Comparison of the BGP session type.
Paths learned over an external (EBGP) session are preferred over those
learned via an internal (IBGP) session.
.It
The path with the lowest local
.Em weight
is selected.
.It
If
.Dq Li rde route-age evaluate
is set then the oldest path is selected.
.It
The path coming from the neighbor with the lowest
.Em BGP ID
wins.
If the
.Em ORIGINATOR_ID
attribute is present that value will be used in the comparison instead.
.It
The path with the shortest
.Em CLUSTER_LIST
attribute is selected.
If it is not present then a length of 0 is used in the comparison.
.It
The path coming from the peer with the lowest IP address is selected.
IPv4 sessions will be preferred over IPv6 ones.
.El
.Pp
Attributes set by filters can be used to tip the decision process to prefer
particular paths over others.
This can be achieved by changing the
.Em localpref ,
.Em med ,
or
.Em weight
attributes.
AS path prepending or changing the
.Em med
or
.Em origin
attribute can be used to influence the routing behaviour on remote systems.
.Pp
To have
.Nm
enabled at boot time, use
.Dq rcctl enable bgpd ,
which sets
.Pp
.Dl bgpd_flags=\(dq\(dq
.Pp
in
.Xr rc.conf.local 8 .
.Pp
When
.Nm
starts up, it reads settings from a configuration file,
typically
.Xr bgpd.conf 5 .
A running
.Nm
process can be controlled using the
.Xr bgpctl 8
utility.
.Pp
The options are as follows:
.Bl -tag -width "-f fileXXX"
.It Fl c
Force
.Nm
to do
.Xr carp 4
demotion at startup when the
.Em demote
functionality is used.
Normally,
.Nm
will only do demotion at startup when the demotion counter for the group
in question is already greater than 0.
.Nm
will start handling demotion after all sessions with demotion configured for
the given group have been successfully established.
At system startup,
.Xr rc 8
has the demotion counter for the group
.Em carp
increased until after
.Nm
is started, so this option should
.Em not
be used in
.Xr rc.conf 8 .
.It Fl D Ar macro Ns = Ns Ar value
Define
.Ar macro
to be set to
.Ar value
on the command line.
Overrides the definition of
.Ar macro
in the configuration file.
.It Fl d
Do not daemonize.
If this option is specified,
.Nm
will run in the foreground and log to
.Em stderr .
.It Fl f Ar file
Use
.Ar file
as the configuration file,
instead of the default
.Pa /etc/bgpd.conf .
.It Fl n
Configtest mode.
Only check the configuration file for validity.
.It Fl v
Produce more verbose output.
.El
.Sh FILES
.Bl -tag -width "/var/run/bgpd.sockXXX" -compact
.It Pa /etc/bgpd.conf
default
.Nm
configuration file
.It Pa /var/run/bgpd.sock
default
.Nm
control socket
.El
.Sh SEE ALSO
.Xr bgpd.conf 5 ,
.Xr bgpctl 8 ,
.Xr bgplg 8 ,
.Xr bgplgsh 8
.Sh STANDARDS
.Rs
.%A R. Chandra
.%A P. Traina
.%A "T. Li"
.%D August 1996
.%R RFC 1997
.%T BGP Communities Attribute
.Re
.Pp
.Rs
.%A A. Heffernan
.%D August 1998
.%R RFC 2385
.%T Protection of BGP Sessions via the TCP MD5 Signature Option
.Re
.Pp
.Rs
.%A P. Marques
.%A F. Dupont
.%D March 1999
.%R RFC 2545
.%T Use of BGP-4 Multiprotocol Extensions for IPv6 Inter-Domain Routing
.Re
.Pp
.Rs
.%A E. Chen
.%D September 2000
.%R RFC 2918
.%T Route Refresh Capability for BGP-4
.Re
.Pp
.Rs
.%A G. Huston
.%D April 2004
.%R RFC 3765
.%T NOPEER Community for Border Gateway Protocol (BGP) Route Scope Control
.Re
.Pp
.Rs
.%A Y. Rekhter
.%A "T. Li"
.%A S. Hares
.%D January 2006
.%R RFC 4271
.%T A Border Gateway Protocol 4 (BGP-4)
.Re
.Pp
.Rs
.%A S. Sangli
.%A D. Tappan
.%A Y. Rekhter
.%D February 2006
.%R RFC 4360
.%T BGP Extended Communities Attribute
.Re
.Pp
.Rs
.%A E. Rosen
.%A Y. Rekhter
.%D February 2006
.%R RFC 4364
.%T BGP/MPLS IP Virtual Private Networks (VPNs)
.Re
.Pp
.Rs
.%A T. Bates
.%A E. Chen
.%A R. Chandra
.%D April 2006
.%R RFC 4456
.%T "BGP Route Reflection: An Alternative to Full Mesh Internal BGP (IBGP)"
.Re
.Pp
.Rs
.%A E. Chen
.%A V. Gillet
.%D April 2006
.%R RFC 4486
.%T Subcodes for BGP Cease Notification Message
.Re
.Pp
.Rs
.%A T. Bates
.%A R. Chandra
.%A D. Katz
.%A Y. Rekhter
.%D January 2007
.%R RFC 4760
.%T Multiprotocol Extensions for BGP-4
.Re
.Pp
.Rs
.%A Q. Vohra
.%A E. Chen
.%D May 2007
.%R RFC 4893
.%T BGP Support for Four-octet AS Number Space
.Re
.Pp
.Rs
.%A V. Gill
.%A J. Heasley
.%A D. Meyer
.%A P. Savola
.%A C. Pignatoro
.%D October 2007
.%R RFC 5082
.%T The Generalized TTL Security Mechanism (GTSM)
.Re
.Pp
.Rs
.%A J. Scudder
.%A R. Chandra
.%D February 2009
.%R RFC 5492
.%T Capabilities Advertisement with BGP-4
.Re
.Pp
.Rs
.%A E. Chen
.%A J. Scudder
.%A P. Mohapatra
.%A K. Patel
.%D August 2015
.%R RFC 7606
.%T Revised Error Handling for BGP UPDATE Messages
.Re
.Pp
.Rs
.%A L. Blunk
.%A M. Karir
.%A C. Labovitz
.%D October 2011
.%R RFC 6396
.%T Multi-Threaded Routing Toolkit (MRT) Routing Information Export Format
.Re
.Pp
.Rs
.%A J. Dong
.%A M. Chen
.%A A. Suryanarayana
.%D May 2012
.%R RFC 6608
.%T Subcodes for BGP Finite State Machine Error
.Re
.Pp
.Rs
.%A W. Kumari
.%A R. Bush
.%A H. Schiller
.%A K. Patel
.%D August 2015
.%R RFC 7607
.%T Codification of AS 0 Processing
.Re
.Pp
.Rs
.%A J. Heitz
.%A J. Snijders
.%A K. Patel
.%A I. Bagdonas
.%A N. Hilliard
.%D February 2017
.%R RFC 8092
.%T BGP Large Communities Attribute
.Re
.Pp
.Rs
.%A P. Mohapatra
.%A K. Patel
.%A J. Scudder
.%A D. Ward
.%A R. Bush
.%D March 2017
.%R RFC 8097
.%T BGP Prefix Origin Validation State Extended Community
.Re
.Pp
.Rs
.%A J. Snijders
.%A J. Heitz
.%A J. Scudder
.%D July 2017
.%R RFC 8203
.%T BGP Administrative Shutdown Communication
.Re
.Pp
.Rs
.%A J. Mauch
.%A J. Snijders
.%A G. Hankins
.%D July 2017
.%R RFC 8212
.%T Default External BGP (EBGP) Route Propagation Behavior without Policies
.Re
.Pp
.Rs
.%A P. Francois
.%A B. Decraene
.%A C. Pelsser
.%A K. Patel
.%A C. Filsfils
.%D March 2018
.%R RFC 8326
.%T Graceful BGP Session Shutdown
.Re
.Sh HISTORY
The
.Nm
program first appeared in
.Ox 3.5 .