CINXE.COM

<!DOCTYPE html> <html> <head> <meta charset="UTF-8"/> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <link rel="stylesheet" href="/mandoc.css" type="text/css" media="all"> <title>bgpd(8) - OpenBSD manual pages</title> </head> <body> <header> <section> <h1><a href="https://www.openbsd.org/">OpenBSD</a> manual page server</h1> </section> <form role="search" action="/" method="get" autocomplete="off" autocapitalize="none"> <fieldset> <legend>Manual Page Search Parameters</legend> <label>Search query: <input type="search" name="query" value="bgpd" size="40"> </label> <button type="submit" name="apropos" value="0">man</button> <button type="submit" name="apropos" value="1">apropos</button> <select name="sec" aria-label="Manual section"> <option value="0">All Sections</option> <option value="1">1 - General Commands</option> <option value="2">2 - System Calls</option> <option value="3">3 - Library Functions</option> <option value="3p">3p - Perl Library</option> <option value="4">4 - Device Drivers</option> <option value="5">5 - File Formats</option> <option value="6">6 - Games</option> <option value="7">7 - Miscellaneous Information</option> <option value="8" selected="selected">8 - System Manager's Manual</option> <option value="9">9 - Kernel Developer's Manual</option> </select> <select name="arch" aria-label="CPU architecture"> <option value="default" selected="selected">All Architectures</option> <option>amd64</option> <option>alpha</option> <option>armv7</option> <option>arm64</option> <option>hppa</option> <option>i386</option> <option>landisk</option> <option>loongson</option> <option>luna88k</option> <option>macppc</option> <option>mips64</option> <option>octeon</option> <option>powerpc64</option> <option>riscv64</option> <option>sparc64</option> <option>amiga</option> <option>arc</option> <option>armish</option> <option>arm32</option> <option>atari</option> <option>aviion</option> <option>beagle</option> <option>cats</option> <option>hppa64</option> <option>hp300</option> <option>ia64</option> <option>mac68k</option> <option>mvme68k</option> <option>mvme88k</option> <option>mvmeppc</option> <option>palm</option> <option>pc532</option> <option>pegasos</option> <option>pmax</option> <option>powerpc</option> <option>sgi</option> <option>socppc</option> <option>solbourne</option> <option>sparc</option> <option>sun3</option> <option>vax</option> <option>wgrisc</option> <option>x68k</option> <option>zaurus</option> </select> <select name="manpath" aria-label="Manual path"> <option selected="selected">OpenBSD-current</option> <option>OpenBSD-7.6</option> <option>OpenBSD-7.5</option> <option>OpenBSD-7.4</option> <option>OpenBSD-7.3</option> <option>OpenBSD-7.2</option> <option>OpenBSD-7.1</option> <option>OpenBSD-7.0</option> <option>OpenBSD-6.9</option> <option>OpenBSD-6.8</option> <option>OpenBSD-6.7</option> <option>OpenBSD-6.6</option> <option>OpenBSD-6.5</option> <option>OpenBSD-6.4</option> <option>OpenBSD-6.3</option> <option>OpenBSD-6.2</option> <option>OpenBSD-6.1</option> <option>OpenBSD-6.0</option> <option>OpenBSD-5.9</option> <option>OpenBSD-5.8</option> <option>OpenBSD-5.7</option> <option>OpenBSD-5.6</option> <option>OpenBSD-5.5</option> <option>OpenBSD-5.4</option> <option>OpenBSD-5.3</option> <option>OpenBSD-5.2</option> <option>OpenBSD-5.1</option> <option>OpenBSD-5.0</option> <option>OpenBSD-4.9</option> <option>OpenBSD-4.8</option> <option>OpenBSD-4.7</option> <option>OpenBSD-4.6</option> <option>OpenBSD-4.5</option> <option>OpenBSD-4.4</option> <option>OpenBSD-4.3</option> <option>OpenBSD-4.2</option> <option>OpenBSD-4.1</option> <option>OpenBSD-4.0</option> <option>OpenBSD-3.9</option> <option>OpenBSD-3.8</option> <option>OpenBSD-3.7</option> <option>OpenBSD-3.6</option> <option>OpenBSD-3.5</option> <option>OpenBSD-3.4</option> <option>OpenBSD-3.3</option> <option>OpenBSD-3.2</option> <option>OpenBSD-3.1</option> <option>OpenBSD-3.0</option> <option>OpenBSD-2.9</option> <option>OpenBSD-2.8</option> <option>OpenBSD-2.7</option> <option>OpenBSD-2.6</option> <option>OpenBSD-2.5</option> <option>OpenBSD-2.4</option> <option>OpenBSD-2.3</option> <option>OpenBSD-2.2</option> </select> </fieldset> </form> </header> <hr> <div class="head" role="doc-pageheader" aria-label="Manual header line">BGPD(8) System Manager's Manual BGPD(8)</div> <main class="manual-text"> <section class="Sh"> <h2 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h2> <code class="Nm">bgpd</code> — Border Gateway Protocol (BGP) routing daemon </section> <section class="Sh"> <h2 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h2> <table class="Nm"> <tr> <td><code class="Nm">bgpd</code></td> <td>[<code class="Fl">-cdnvV</code>] [<code class="Fl">-D</code> <var class="Ar">macro</var>=<var class="Ar">value</var>] [<code class="Fl">-f</code> <var class="Ar">file</var>]</td> </tr> </table> </section> <section class="Sh"> <h2 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h2> <code class="Nm">bgpd</code> is a Border Gateway Protocol (BGP) daemon which manages the network routing tables. Its main purpose is to exchange information concerning "network reachability" with other BGP systems. <code class="Nm">bgpd</code> uses the Border Gateway Protocol, Version 4, as described in RFC 4271. 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 <code class="Nm">bgpd</code> 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. 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. <ol class="Bl-enum Bd-indent"> <li>All paths with errors or loops are not eligible.</li> <li>Paths with an unreachable nexthop are not eligible. After this step all remaining paths are valid.</li> <li id="LOCAL_PREF">The path with the highest <a class="permalink" href="#LOCAL_PREF">LOCAL_PREF</a> is selected.</li> <li id="AS">The path with the shortest <a class="permalink" href="#AS">AS path</a> attribute is selected.</li> <li id="ORIGIN">The <a class="permalink" href="#ORIGIN">ORIGIN</a> attribute is compared. The order is IGP before EGP before incomplete origins.</li> <li id="MULTI_EXIT_DISC">The path with the lowest <a class="permalink" href="#MULTI_EXIT_DISC">MULTI_EXIT_DISC</a> metric is selected. Normally, this value is only considered when choosing between multiple routes sent by the same neighbouring AS. However, if “<code class="Li">rde med compare always</code>” is set in the configuration, the metric is compared for routes sent by any AS.</li> <li>Comparison of the BGP session type. Paths learned over an external (EBGP) session are preferred over those learned via an internal (IBGP) session.</li> <li>The path with the highest local weight is selected.</li> <li>If “<code class="Li">rde route-age evaluate</code>” is set then the oldest path is selected.</li> <li id="BGP">The path coming from the neighbor with the lowest <a class="permalink" href="#BGP">BGP ID</a> wins. If the <a class="permalink" href="#ORIGINATOR_ID">ORIGINATOR_ID</a> attribute is present, that value will be used in the comparison instead.</li> <li id="CLUSTER_LIST">The path with the shortest <a class="permalink" href="#CLUSTER_LIST">CLUSTER_LIST</a> attribute is selected. If it is not present then a length of 0 is used in the comparison.</li> <li>The path coming from the peer with the lowest IP address is selected. IPv4 sessions will be preferred over IPv6 ones.</li> </ol> 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 <a class="permalink" href="#localpref">localpref</a>, med, or weight attributes. AS path prepending or changing the med or <a class="permalink" href="#origin">origin</a> attribute can be used to influence the routing behaviour on remote systems. To have <code class="Nm">bgpd</code> enabled at boot time, use “rcctl enable bgpd”, which sets <div class="Bd Bd-indent"><code class="Li">bgpd_flags=""</code></div> in <a class="Xr" href="/rc.conf.local.8" aria-label="rc.conf.local, section 8">rc.conf.local(8)</a>. When <code class="Nm">bgpd</code> starts up, it reads settings from a configuration file, typically <a class="Xr" href="/bgpd.conf.5" aria-label="bgpd.conf, section 5">bgpd.conf(5)</a>. A running <code class="Nm">bgpd</code> process can be controlled using the <a class="Xr" href="/bgpctl.8" aria-label="bgpctl, section 8">bgpctl(8)</a> utility. The options are as follows: <dl class="Bl-tag"> <dt id="c"><a class="permalink" href="#c"><code class="Fl">-c</code></a></dt> <dd>Force <code class="Nm">bgpd</code> to do <a class="Xr" href="/carp.4" aria-label="carp, section 4">carp(4)</a> demotion at startup when the <a class="permalink" href="#demote">demote</a> functionality is used. Normally, <code class="Nm">bgpd</code> will only do demotion at startup when the demotion counter for the group in question is already greater than 0. <code class="Nm">bgpd</code> will start handling demotion after all sessions with demotion configured for the given group have been successfully established. At system startup, <a class="Xr" href="/rc.8" aria-label="rc, section 8">rc(8)</a> has the demotion counter for the group <a class="permalink" href="#carp">carp</a> increased until after <code class="Nm">bgpd</code> is started, so this option should <a class="permalink" href="#not">not</a> be used in <a class="Xr" href="/rc.conf.8" aria-label="rc.conf, section 8">rc.conf(8)</a>.</dd> <dt id="D"><a class="permalink" href="#D"><code class="Fl">-D</code></a> <var class="Ar">macro</var>=<var class="Ar">value</var></dt> <dd>Define <var class="Ar">macro</var> to be set to <var class="Ar">value</var> on the command line. Overrides the definition of <var class="Ar">macro</var> in the configuration file.</dd> <dt id="d"><a class="permalink" href="#d"><code class="Fl">-d</code></a></dt> <dd>Do not daemonize. If this option is specified, <code class="Nm">bgpd</code> will run in the foreground and log to <a class="permalink" href="#stderr">stderr</a>.</dd> <dt id="f"><a class="permalink" href="#f"><code class="Fl">-f</code></a> <var class="Ar">file</var></dt> <dd>Use <var class="Ar">file</var> as the configuration file, instead of the default /etc/bgpd.conf.</dd> <dt id="n"><a class="permalink" href="#n"><code class="Fl">-n</code></a></dt> <dd>Configtest mode. Only check the configuration file for validity.</dd> <dt id="v"><a class="permalink" href="#v"><code class="Fl">-v</code></a></dt> <dd>Produce more verbose output.</dd> <dt id="V"><a class="permalink" href="#V"><code class="Fl">-V</code></a></dt> <dd>Show the version and exit.</dd> </dl> </section> <section class="Sh"> <h2 class="Sh" id="FILES"><a class="permalink" href="#FILES">FILES</a></h2> <dl class="Bl-tag Bl-compact"> <dt>/etc/bgpd.conf</dt> <dd>Default <code class="Nm">bgpd</code> configuration file.</dd> <dt>/var/run/bgpd.sock.<rdomain></dt> <dd>Default <code class="Nm">bgpd</code> control socket, where <var class="Ar"><rdomain></var> is the routing domain in which <code class="Nm">bgpd</code> has been started.</dd> </dl> </section> <section class="Sh"> <h2 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE ALSO</a></h2> <a class="Xr" href="/bgpd.conf.5" aria-label="bgpd.conf, section 5">bgpd.conf(5)</a>, <a class="Xr" href="/bgpctl.8" aria-label="bgpctl, section 8">bgpctl(8)</a>, <a class="Xr" href="/bgplg.8" aria-label="bgplg, section 8">bgplg(8)</a>, <a class="Xr" href="/bgplgsh.8" aria-label="bgplgsh, section 8">bgplgsh(8)</a> </section> <section class="Sh"> <h2 class="Sh" id="STANDARDS"><a class="permalink" href="#STANDARDS">STANDARDS</a></h2> <cite class="RsB">BGP Communities Attribute</cite>, <a class="RsR" href="https://www.rfc-editor.org/rfc/rfc1997.html">RFC 1997</a>, August 1996. <cite class="RsB">Protection of BGP Sessions via the TCP MD5 Signature Option</cite>, <a class="RsR" href="https://www.rfc-editor.org/rfc/rfc2385.html">RFC 2385</a>, August 1998. <cite class="RsB">Use of BGP-4 Multiprotocol Extensions for IPv6 Inter-Domain Routing</cite>, <a class="RsR" href="https://www.rfc-editor.org/rfc/rfc2545.html">RFC 2545</a>, March 1999. <cite class="RsB">Route Refresh Capability for BGP-4</cite>, <a class="RsR" href="https://www.rfc-editor.org/rfc/rfc2918.html">RFC 2918</a>, September 2000. <cite class="RsB">NOPEER Community for Border Gateway Protocol (BGP) Route Scope Control</cite>, <a class="RsR" href="https://www.rfc-editor.org/rfc/rfc3765.html">RFC 3765</a>, April 2004. <cite class="RsB">A Border Gateway Protocol 4 (BGP-4)</cite>, <a class="RsR" href="https://www.rfc-editor.org/rfc/rfc4271.html">RFC 4271</a>, January 2006. <cite class="RsB">BGP Extended Communities Attribute</cite>, <a class="RsR" href="https://www.rfc-editor.org/rfc/rfc4360.html">RFC 4360</a>, February 2006. <cite class="RsB">BGP/MPLS IP Virtual Private Networks (VPNs)</cite>, <a class="RsR" href="https://www.rfc-editor.org/rfc/rfc4364.html">RFC 4364</a>, February 2006. <cite class="RsB">BGP Route Reflection: An Alternative to Full Mesh Internal BGP (IBGP)</cite>, <a class="RsR" href="https://www.rfc-editor.org/rfc/rfc4456.html">RFC 4456</a>, April 2006. <cite class="RsB">Subcodes for BGP Cease Notification Message</cite>, <a class="RsR" href="https://www.rfc-editor.org/rfc/rfc4486.html">RFC 4486</a>, April 2006. <cite class="RsB">Graceful Restart Mechanism for BGP</cite>, <a class="RsR" href="https://www.rfc-editor.org/rfc/rfc4724.html">RFC 4724</a>, January 2007. <cite class="RsB">Multiprotocol Extensions for BGP-4</cite>, <a class="RsR" href="https://www.rfc-editor.org/rfc/rfc4760.html">RFC 4760</a>, January 2007. <cite class="RsB">The Generalized TTL Security Mechanism (GTSM)</cite>, <a class="RsR" href="https://www.rfc-editor.org/rfc/rfc5082.html">RFC 5082</a>, October 2007. <cite class="RsB">Capabilities Advertisement with BGP-4</cite>, <a class="RsR" href="https://www.rfc-editor.org/rfc/rfc5492.html">RFC 5492</a>, February 2009. <cite class="RsB">4-Octet AS Specific BGP Extended Community</cite>, <a class="RsR" href="https://www.rfc-editor.org/rfc/rfc5668.html">RFC 5668</a>, October 2009. <cite class="RsB">Autonomous-System-Wide Unique BGP Identifier for BGP-4</cite>, <a class="RsR" href="https://www.rfc-editor.org/rfc/rfc6286.html">RFC 6286</a>, June 2011. <cite class="RsB">Subcodes for BGP Finite State Machine Error</cite>, <a class="RsR" href="https://www.rfc-editor.org/rfc/rfc6608.html">RFC 6608</a>, May 2012. <cite class="RsB">BGP Support for Four-Octet Autonomous System (AS) Number Space</cite>, <a class="RsR" href="https://www.rfc-editor.org/rfc/rfc6793.html">RFC 6793</a>, Dec 2012. <cite class="RsB">Revised Error Handling for BGP UPDATE Messages</cite>, <a class="RsR" href="https://www.rfc-editor.org/rfc/rfc7606.html">RFC 7606</a>, August 2015. <cite class="RsB">Multi-Threaded Routing Toolkit (MRT) Routing Information Export Format</cite>, <a class="RsR" href="https://www.rfc-editor.org/rfc/rfc6396.html">RFC 6396</a>, October 2011. <cite class="RsB">Subcodes for BGP Finite State Machine Error</cite>, <a class="RsR" href="https://www.rfc-editor.org/rfc/rfc6608.html">RFC 6608</a>, May 2012. <cite class="RsB">Enhanced Route Refresh Capability for BGP-4</cite>, <a class="RsR" href="https://www.rfc-editor.org/rfc/rfc7313.html">RFC 7313</a>, July 2014. <cite class="RsB">Codification of AS 0 Processing</cite>, <a class="RsR" href="https://www.rfc-editor.org/rfc/rfc7607.html">RFC 7607</a>, August 2015. <cite class="RsB">Advertisement of Multiple Paths in BGP</cite>, <a class="RsR" href="https://www.rfc-editor.org/rfc/rfc7911.html">RFC 7911</a>, July 2016. <cite class="RsB">Internet Exchange BGP Route Server</cite>, <a class="RsR" href="https://www.rfc-editor.org/rfc/rfc7947.html">RFC 7947</a>, September 2016. <cite class="RsB">Multi-Threaded Routing Toolkit (MRT) Routing Information Export Format with BGP Additional Path Extensions</cite>, <a class="RsR" href="https://www.rfc-editor.org/rfc/rfc8050.html">RFC 8050</a>, May 2017. <cite class="RsB">BGP Large Communities Attribute</cite>, <a class="RsR" href="https://www.rfc-editor.org/rfc/rfc8092.html">RFC 8092</a>, February 2017. <cite class="RsB">BGP Prefix Origin Validation State Extended Community</cite>, <a class="RsR" href="https://www.rfc-editor.org/rfc/rfc8097.html">RFC 8097</a>, March 2017. <cite class="RsB">BGP Administrative Shutdown Communication</cite>, <a class="RsR" href="https://www.rfc-editor.org/rfc/rfc8203.html">RFC 8203</a>, July 2017. <cite class="RsB">The Resource Public Key Infrastructure (RPKI) to Router Protocol, Version 1</cite>, <a class="RsR" href="https://www.rfc-editor.org/rfc/rfc8210.html">RFC 8210</a>, September 2017. <cite class="RsB">Default External BGP (EBGP) Route Propagation Behavior without Policies</cite>, <a class="RsR" href="https://www.rfc-editor.org/rfc/rfc8212.html">RFC 8212</a>, July 2017. <cite class="RsB">Graceful BGP Session Shutdown</cite>, <a class="RsR" href="https://www.rfc-editor.org/rfc/rfc8326.html">RFC 8326</a>, March 2018. <cite class="RsB">Notification Message Support for BGP Graceful Restart</cite>, <a class="RsR" href="https://www.rfc-editor.org/rfc/rfc8538.html">RFC 8538</a>, March 2019. <cite class="RsB">Extended Message Support for BGP</cite>, <a class="RsR" href="https://www.rfc-editor.org/rfc/rfc8654.html">RFC 8654</a>, October 2019. <cite class="RsB">Advertising IPv4 Network Layer Reachability Information (NLRI) with an IPv6 Next Hop</cite>, <a class="RsR" href="https://www.rfc-editor.org/rfc/rfc8950.html">RFC 8950</a>, November 2020. <cite class="RsB">Dissemination of Flow Specification Rules</cite>, <a class="RsR" href="https://www.rfc-editor.org/rfc/rfc8955.html">RFC 8955</a>, December 2020. <cite class="RsB">Dissemination of Flow Specification Rules for IPv6</cite>, <a class="RsR" href="https://www.rfc-editor.org/rfc/rfc8956.html">RFC 8956</a>, December 2020. <cite class="RsB">Extended Optional Parameters Length for BGP OPEN Message</cite>, <a class="RsR" href="https://www.rfc-editor.org/rfc/rfc9072.html">RFC 9072</a>, July 2021. <cite class="RsB">Route Leak Prevention and Detection Using Roles in UPDATE and OPEN Messages</cite>, <a class="RsR" href="https://www.rfc-editor.org/rfc/rfc9234.html">RFC 9234</a>, May 2022. <cite class="RsB">Border Gateway Protocol 4 (BGP-4) Send Hold Timer</cite>, <a class="RsR" href="https://www.rfc-editor.org/rfc/rfc9687.html">RFC 9687</a>, November 2024. <cite class="RsB">BGP AS_PATH Verification Based on Resource Public Key Infrastructure (RPKI) Autonomous System Provider Authorization (ASPA) Objects</cite>, draft-ietf-sidrops-aspa-verification, October 2022. <cite class="RsB">Deprecation of AS_SET and AS_CONFED_SET in BGP</cite>, draft-ietf-idr-deprecate-as-set-confed-set, February 2025. </section> <section class="Sh"> <h2 class="Sh" id="HISTORY"><a class="permalink" href="#HISTORY">HISTORY</a></h2> The <code class="Nm">bgpd</code> program first appeared in OpenBSD 3.5. </section> </main> <div class="foot" role="doc-pagefooter" aria-label="Manual footer line">February 27, 2025 OpenBSD-current</div> </body> </html>