summaryrefslogtreecommitdiffstats
path: root/doc/user
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-27 04:24:32 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-27 04:24:32 +0000
commit35cadacd2bb9383686753731e31bd7e145fb2506 (patch)
tree4489adbde75a837989533837185b2b8369a0bf68 /doc/user
parentAdding debian version 9.1-0.1. (diff)
downloadfrr-35cadacd2bb9383686753731e31bd7e145fb2506.tar.xz
frr-35cadacd2bb9383686753731e31bd7e145fb2506.zip
Merging upstream version 10.0.
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'doc/user')
-rw-r--r--doc/user/.readthedocs.yaml3
-rw-r--r--doc/user/babeld.rst3
-rw-r--r--doc/user/basic.rst72
-rw-r--r--doc/user/bfd.rst6
-rw-r--r--doc/user/bgp.rst196
-rw-r--r--doc/user/bmp.rst8
-rw-r--r--doc/user/config-include.rst12
-rw-r--r--doc/user/eigrpd.rst12
-rw-r--r--doc/user/installation.rst24
-rw-r--r--doc/user/isisd.rst3
-rw-r--r--doc/user/ldpd.rst4
-rw-r--r--doc/user/mgmtd.rst12
-rw-r--r--doc/user/ospf6d.rst136
-rw-r--r--doc/user/ospfd.rst5
-rw-r--r--doc/user/overview.rst2
-rw-r--r--doc/user/pathd.rst7
-rw-r--r--doc/user/pbr.rst6
-rw-r--r--doc/user/pim.rst9
-rw-r--r--doc/user/pimv6.rst9
-rw-r--r--doc/user/prior-config-files.rst23
-rw-r--r--doc/user/requirements.txt1
-rw-r--r--doc/user/ripd.rst12
-rw-r--r--doc/user/ripngd.rst2
-rw-r--r--doc/user/routemap.rst14
-rw-r--r--doc/user/rpki.rst82
-rw-r--r--doc/user/sharp.rst11
-rw-r--r--doc/user/snmptrap.rst20
-rw-r--r--doc/user/static.rst12
-rw-r--r--doc/user/vrrp.rst6
-rw-r--r--doc/user/vtysh.rst10
-rw-r--r--doc/user/zebra.rst100
31 files changed, 614 insertions, 208 deletions
diff --git a/doc/user/.readthedocs.yaml b/doc/user/.readthedocs.yaml
index c5a11da..ba5698c 100644
--- a/doc/user/.readthedocs.yaml
+++ b/doc/user/.readthedocs.yaml
@@ -7,6 +7,9 @@ build:
tools:
python: "3.11"
+python:
+ install:
+ - requirements: doc/user/requirements.txt
# Build documentation in the docs/ directory with Sphinx
sphinx:
configuration: doc/user/conf.py
diff --git a/doc/user/babeld.rst b/doc/user/babeld.rst
index bda0045..b7b7c1f 100644
--- a/doc/user/babeld.rst
+++ b/doc/user/babeld.rst
@@ -26,8 +26,7 @@ The *zebra* daemon must be running before *babeld* is
invoked. Also, if *zebra* is restarted then *babeld*
must be too.
-Configuration of *babeld* is done in its configuration file
-:file:`babeld.conf`.
+.. include:: config-include.rst
.. _babel-configuration:
diff --git a/doc/user/basic.rst b/doc/user/basic.rst
index bbf24c5..5fdd188 100644
--- a/doc/user/basic.rst
+++ b/doc/user/basic.rst
@@ -11,45 +11,22 @@ The following sections discuss commands common to all the routing daemons.
Config Commands
===============
-
-
-
-
-In a config file, you can write the debugging options, a vty's password,
+In the config file, you can write the debugging options, a vty's password,
routing daemon configurations, a log file name, and so forth. This information
forms the initial command set for a routing beast as it is starting.
-Config files are generally found in |INSTALL_PREFIX_ETC|.
-
-Config Methods
---------------
-
-There are two ways of configuring FRR.
-
-Traditionally each of the daemons had its own config file. The daemon name plus
-``.conf`` was the default config file name. For example, zebra's default config
-file was :file:`zebra.conf`. This method is deprecated.
-
-Because of the amount of config files this creates, and the tendency of one
-daemon to rely on others for certain functionality, most deployments now use
-"integrated" configuration. In this setup all configuration goes into a single
-file, typically :file:`/etc/frr/frr.conf`. When starting up FRR using an init
-script or systemd, ``vtysh`` is invoked to read the config file and send the
-appropriate portions to only the daemons interested in them. Running
-configuration updates are persisted back to this single file using ``vtysh``.
-This is the recommended method. To use this method, add the following line to
-:file:`/etc/frr/vtysh.conf`:
-
-.. code-block:: frr
-
- service integrated-vtysh-config
+.. _config-file:
-If you installed from source or used a package, this is probably already
-present.
+Integrated Config File
+----------------------
-If desired, you can specify a config file using the :option:`-f` or
-:option:`--config_file` options when starting a daemon.
+FRR uses a single configuration file located in |INSTALL_PREFIX_ETC|/frr.conf.
+When FRR is started using an init script or ``systemd``, ``vtysh`` is invoked to
+read the config file and send the appropriate portions to only the daemons
+interested in them. Running configuration updates are persisted back to this
+single file using ``vtysh`` as well.
+.. include:: prior-config-files.rst
.. _basic-config-commands:
@@ -152,6 +129,20 @@ Basic Config Commands
deprecated ``log trap`` command) will be used. The ``no`` form of the command
disables logging to a file.
+.. clicmd:: log daemon DAEMON file [FILENAME [LEVEL]]
+
+ Configure file logging for a single FRR daemon. If you want to log
+ into a file, please specify ``filename`` as in this example:
+
+ ::
+
+ log daemon bgpd file /var/log/frr/bgpd.log informational
+
+ If the optional second argument specifying the logging level is not present,
+ the default logging level (typically debugging, but can be changed using the
+ deprecated ``log trap`` command) will be used. The ``no`` form of the command
+ disables logging to a file for a single FRR daemon.
+
.. clicmd:: log syslog [LEVEL]
Enable logging output to syslog. If the optional second argument specifying
@@ -215,7 +206,7 @@ Basic Config Commands
enabled log destinations. The note that logging includes full command lines,
including passwords. If the daemon startup option `--command-log-always`
is used to start the daemon then this command is turned on by default
- and cannot be turned off and the [no] form of the command is dissallowed.
+ and cannot be turned off and the [no] form of the command is disallowed.
.. clicmd:: log filtered-file [FILENAME [LEVEL]]
@@ -673,24 +664,29 @@ Terminal Mode Commands
.. _common-show-commands:
-.. clicmd:: show thread cpu [r|w|t|e|x]
+.. clicmd:: show event cpu [r|w|t|e|x]
This command displays system run statistics for all the different event
types. If no options is specified all different run types are displayed
together. Additionally you can ask to look at (r)ead, (w)rite, (t)imer,
(e)vent and e(x)ecute thread event types.
-.. clicmd:: show thread poll
+.. clicmd:: show event poll
This command displays FRR's poll data. It allows a glimpse into how
we are setting each individual fd for the poll command at that point
in time.
-.. clicmd:: show thread timers
+.. clicmd:: show event timers
This command displays FRR's timer data for timers that will pop in
the future.
+.. clicmd:: show configuration running [<json|xml> [translate WORD]] [with-defaults] DAEMON
+
+ This command displays the northbound/YANG configuration data for a
+ daemon in text/vty, json, or xml format.
+
.. clicmd:: show yang operational-data XPATH [{format <json|xml>|translate TRANSLATOR|with-config}] DAEMON
Display the YANG operational data starting from XPATH. The default
@@ -773,7 +769,7 @@ These options apply to all |PACKAGE_NAME| daemons.
.. option:: --command-log-always
Cause the daemon to always log commands entered to the specified log file.
- This also makes the `no log commands` command dissallowed. Enabling this
+ This also makes the `no log commands` command disallowed. Enabling this
is suggested if you have need to track what the operator is doing on
this router.
diff --git a/doc/user/bfd.rst b/doc/user/bfd.rst
index 6c57822..3ca104a 100644
--- a/doc/user/bfd.rst
+++ b/doc/user/bfd.rst
@@ -27,6 +27,8 @@ This document will focus on the later implementation: *bfdd*.
Starting BFD
============
+.. include:: config-include.rst
+
*bfdd* default configuration file is :file:`bfdd.conf`. *bfdd* searches
the current directory first then |INSTALL_PREFIX_ETC|/bfdd.conf. All of
*bfdd*'s command must be configured in :file:`bfdd.conf`.
@@ -44,9 +46,7 @@ may also be specified (:ref:`common-invocation-options`).
/usr/lib/frr/bfdd --bfdctl /tmp/bfdd.sock
- The default UNIX socket location is:
-
- #define BFDD_CONTROL_SOCKET "|INSTALL_PREFIX_STATE|/bfdd.sock"
+ The default UNIX socket location is |INSTALL_PREFIX_STATE|/bfdd.sock
This option overrides the location addition that the -N option provides
to the bfdd.sock
diff --git a/doc/user/bgp.rst b/doc/user/bgp.rst
index 5b8ec11..53dc551 100644
--- a/doc/user/bgp.rst
+++ b/doc/user/bgp.rst
@@ -14,10 +14,7 @@ interdomain routing protocol. BGP-4 is described in :rfc:`1771` and updated by
Starting BGP
============
-The default configuration file of *bgpd* is :file:`bgpd.conf`. *bgpd* searches
-the current directory first, followed by |INSTALL_PREFIX_ETC|/bgpd.conf. All of
-*bgpd*'s commands must be configured in :file:`bgpd.conf` when the integrated
-config is not being used.
+.. include:: config-include.rst
*bgpd* specific invocation options are described below. Common options may also
be specified (:ref:`common-invocation-options`).
@@ -494,8 +491,8 @@ Require policy on EBGP
exit1# show bgp summary
- IPv4 Unicast Summary (VRF default):
- BGP router identifier 10.10.10.1, local AS number 65001 vrf-id 0
+ IPv4 Unicast Summary:
+ BGP router identifier 10.10.10.1, local AS number 65001 VRF default vrf-id 0
BGP table version 4
RIB entries 7, using 1344 bytes of memory
Peers 2, using 43 KiB of memory
@@ -527,6 +524,27 @@ Reject routes with AS_SET or AS_CONFED_SET types
This command enables rejection of incoming and outgoing routes having AS_SET or AS_CONFED_SET type.
+Enforce first AS
+----------------
+
+.. clicmd:: bgp enforce-first-as
+
+ To configure a router to deny an update received from an external BGP (eBGP)
+ peer that does not list its autonomous system number at the beginning of
+ the `AS_PATH` in the incoming update, use the ``bgp enforce-first-as`` command
+ in router configuration mode.
+
+ In order to exclude an arbitrary neighbor from this enforcement, use the
+ command ``no neighbor NAME enforce-first-as``. And vice-versa if a global
+ enforcement is disabled, you can override this behavior per neighbor too.
+
+ Default: enabled.
+
+.. note::
+
+ If you have a peering to RS (Route-Server), most likely you MUST disable the
+ first AS enforcement.
+
Suppress duplicate updates
--------------------------
@@ -1309,10 +1327,31 @@ section for the specific AF to redistribute into. Protocol availability for
redistribution is determined by BGP AF; for example, you cannot redistribute
OSPFv3 into ``address-family ipv4 unicast`` as OSPFv3 supports IPv6.
-.. clicmd:: redistribute <babel|connected|eigrp|isis|kernel|openfabric|ospf|ospf6|rip|ripng|sharp|static|table> [metric (0-4294967295)] [route-map WORD]
+.. clicmd:: redistribute <babel|connected|eigrp|isis|kernel|openfabric|ospf|ospf6|rip|ripng|sharp|static> [metric (0-4294967295)] [route-map WORD]
Redistribute routes from other protocols into BGP.
+.. clicmd:: redistribute <table|table-direct> (1-65535)] [metric (0-4294967295)] [route-map WORD]
+
+ Redistribute routes from a routing table ID into BGP. There are two
+ techniques for redistribution:
+
+ - Standard Table Redistribution ``table (1-65535)``:
+ - Routes from the specified routing table ID are imported into the
+ default routing table using the ``ip import-table ID`` command.
+ - These routes are identified by the protocol type "T[ID]" when
+ displayed with ``show (ip|ipv6) route``.
+ - The ``redistribute table ID`` command then integrates these routes
+ into BGP.
+
+ - Direct Table Redistribution ``table-direct (1-65535)``:
+ - This method directly imports routes from the designated routing table
+ ID into BGP, omitting the step of adding to the default routing table.
+ - This method is especially relevant when the specified table ID is
+ checked against routing by appending the appropriate `ip rules`.
+
+Redistribute routes from a routing table number into BGP.
+
.. clicmd:: redistribute vnc-direct
Redistribute VNC direct (not via zebra) routes to BGP process.
@@ -1432,6 +1471,23 @@ Defining Peers
peers ASN is the same as mine as specified under the :clicmd:`router bgp ASN`
command the connection will be denied.
+.. clicmd:: neighbor PEER oad
+
+ Mark a peer belonging to the One Administrative Domain.
+
+ Some networks span more than one autonomous system and require more
+ flexibility in the propagation of path attributes.It is worth noting that
+ these multi-AS networks have a common or single administrative entity.
+ These networks are said to belong to One Administrative Domain (OAD).
+ It is desirable to carry IBGP-only attributes across EBGP peerings when
+ the peers belong to an OAD.
+
+ Enabling this peering sub-type will allow the propagation of non-transitive
+ attributes across EBGP peerings (e.g. local-preference). Make sure to
+ turn this peering type on for all peers in the OAD.
+
+ Disabled by default.
+
.. clicmd:: bgp listen range <A.B.C.D/M|X:X::X:X/M> peer-group PGNAME
Accept connections from any peers in the specified prefix. Configuration
@@ -1509,7 +1565,10 @@ Configuring Peers
Discard updates received from the specified (eBGP) peer if the AS_PATH
attribute does not contain the PEER's ASN as the first AS_PATH segment.
- Default: disabled.
+ You can enable or disable this enforcement globally too using
+ ``bgp enforce-first-as`` command.
+
+ Default: enabled.
.. clicmd:: neighbor PEER extended-optional-parameters
@@ -1545,7 +1604,10 @@ Configuring Peers
Configure an unnumbered BGP peer. ``PEER`` should be an interface name. The
session will be established via IPv6 link locals. Use ``internal`` for iBGP
- and ``external`` for eBGP sessions, or specify an ASN if you wish.
+ and ``external`` for eBGP sessions, or specify an ASN if you wish. Finally
+ this connection type is meant for point to point connections. If you are
+ on an ethernet segment and attempt to use this with more than one bgp
+ neighbor, only one neighbor will come up, due to how this feature works.
.. clicmd:: neighbor PEER next-hop-self [force]
@@ -1564,10 +1626,12 @@ Configuring Peers
.. clicmd:: neighbor PEER update-source <IFNAME|ADDRESS>
- Specify the IPv4 source address to use for the :abbr:`BGP` session to this
- neighbour, may be specified as either an IPv4 address directly or as an
+ Specify the IPv4 or IPv6 source address to use for the :abbr:`BGP` session to this
+ neighbour, may be specified as either an IP address directly or as an
interface name (in which case the *zebra* daemon MUST be running in order
- for *bgpd* to be able to retrieve interface state).
+ for *bgpd* to be able to retrieve interface state). When there are multiple
+ addresses on the choosen IFNAME then BGP will use the address that matches
+ the most number of bits in comparison to the destination peer address.
.. code-block:: frr
@@ -1610,7 +1674,18 @@ Configuring Peers
modifying the `net.core.optmem_max` sysctl to a larger value to
avoid out of memory errors from the linux kernel.
-.. clicmd:: neighbor PEER send-community
+.. clicmd:: neighbor PEER send-community <both|all|extended|standard|large>
+
+ Send the communities to the peer.
+
+ Default: enabled.
+
+.. clicmd:: neighbor PEER send-community extended rpki
+
+ Send the extended RPKI communities to the peer. RPKI extended community
+ can be send only to iBGP and eBGP-OAD peers.
+
+ Default: enabled.
.. clicmd:: neighbor PEER weight WEIGHT
@@ -1730,6 +1805,18 @@ Configuring Peers
This includes changing graceful-restart (LLGR also) timers,
enabling/disabling add-path, and other supported capabilities.
+.. clicmd:: neighbor PEER capability fqdn
+
+ Allow BGP to negotiate the FQDN Capability with its peers.
+
+ FQDN Capability defines a new BGP message (CAPABILITY) allowing the
+ use of peer's name and domain name.
+
+ This capability is activated by default. The ``no neighbor PEER capability
+ fqdn`` avoid negotiation of that capability. This is useful for peers who
+ are not supporting this capability or supporting BGP Capabilities
+ Negotiation RFC 2842.
+
.. clicmd:: neighbor <A.B.C.D|X:X::X:X|WORD> accept-own
Enable handling of self-originated VPN routes containing ``accept-own`` community.
@@ -1860,8 +1947,8 @@ Configuring Peers
.. code-block:: frr
- IPv4 Unicast Summary (VRF default):
- BGP router identifier 10.0.0.6, local AS number 65001 vrf-id 0
+ IPv4 Unicast Summary:
+ BGP router identifier 10.0.0.6, local AS number 65001 VRF default vrf-id 0
BGP table version 12
RIB entries 23, using 4600 bytes of memory
Peers 3, using 2174 KiB of memory
@@ -2059,7 +2146,6 @@ Capability Negotiation
.. clicmd:: neighbor PEER strict-capability-match
-
Strictly compares remote capabilities and local capabilities. If
capabilities are different, send Unsupported Capability error then reset
connection.
@@ -2986,7 +3072,33 @@ address-family:
Specifies the route-target list to be attached to a route (export) or the
route-target list to match against (import) when exporting/importing between
- the current unicast VRF and VPN.
+ the current unicast VRF and VPN. The `rt vpn export RTLIST` command is not
+ mandatory and can be replaced or completed by the `set extcommunity rt`
+ command in the route-map attached with the `route-map vpn export`. The below
+ configuration illustrates how the route target is selected based on the
+ prefixes, and not solely on vrf criterium:
+
+ .. code-block:: frr
+
+ access-list acl1 permit 192.0.2.0/24
+ access-list acl2 permit 192.0.3.0/24
+ route-map rmap permit 10
+ match address acl1
+ set extcommunity rt 65001:10
+ !
+ route-map rmap permit 20
+ match address acl1
+ set extcommunity rt 65001:20
+ !
+ router bgp 65001 vrf vrf1
+ !
+ address-family ipv4 unicast
+ rd vpn export 65001:1
+ import vpn
+ export vpn
+ rt vpn import 65001:1
+ route-map vpn export rmap
+
The RTLIST is a space-separated list of route-targets, which are BGP
extended community values as described in
@@ -3374,7 +3486,7 @@ The import filtering described in item (2) is constrained just to Type-2
The EVPN MAC-VRF Site-of-Origin can be configured using a single CLI command
under ``address-family l2vpn evpn`` of the EVPN underlay BGP instance.
-.. clicmd:: [no] mac-vrf soo <site-of-origin-string>
+.. clicmd:: mac-vrf soo <site-of-origin-string>
Example configuration:
@@ -3520,7 +3632,7 @@ route maybe fragmented.
The number of EVIs per-EAD route can be configured via the following
BGP command -
-.. clicmd:: [no] ead-es-frag evi-limit (1-1000)
+.. clicmd:: ead-es-frag evi-limit (1-1000)
Sample Configuration
^^^^^^^^^^^^^^^^^^^^^
@@ -3698,7 +3810,7 @@ When default route is present in R2'2 BGP table, 10.139.224.0/20 and 192.0.2.1/3
*> 192.0.2.1/32 10.10.10.1 0 0 1 i
*> 192.0.2.5/32 10.10.10.1 0 0 1 i
- Displayed 4 routes and 4 total paths
+ Displayed 4 routes and 4 total paths
Router2# show ip bgp neighbors 10.10.20.3
!--- Output suppressed.
@@ -3746,7 +3858,7 @@ When default route is not present in R2'2 BGP table, 10.139.224.0/20 and 192.0.2
*> 192.0.2.1/32 10.10.10.1 0 0 1 i
*> 192.0.2.5/32 10.10.10.1 0 0 1 i
- Displayed 3 routes and 3 total paths
+ Displayed 3 routes and 3 total paths
Router2# show ip bgp neighbors 10.10.20.3
@@ -3815,12 +3927,20 @@ Debugging
information on BGP events such as peer connection / disconnection, session
establishment / teardown, and capability negotiation.
-.. clicmd:: debug bgp updates
+.. clicmd:: debug bgp updates [detail]
Enable or disable debugging for BGP updates. This provides information on
BGP UPDATE messages transmitted and received between local and remote
instances.
+ If ``detail`` is specified, the output will include the full BGP UPDATE with
+ detailed information such as attribute length, withdraw length, and more.
+
+.. clicmd:: debug bgp updates <in|out> [<A.B.C.D|X:X::X:X|WORD> [prefix-list WORD]]
+
+ Enable or disable debugging for BGP updates. Optionally, you can specify
+ a prefix-list to filter the updates for an arbitrary neighbor.
+
.. clicmd:: debug bgp keepalives
Enable or disable debugging for BGP keepalives. This provides information on
@@ -3921,6 +4041,26 @@ The following are available in the top level *enable* mode:
Clear BGP message statistics for a specified peer or for all peers,
optionally filtered by activated address-family and sub-address-family.
+.. clicmd:: clear bgp [ipv4|ipv6] [unicast] PEER|\* capabilities
+
+ Clear specific BGP capabilities for a specified peer or for all peers. This
+ includes such capabilities like FQDN capability, that can't be controlled by
+ any other configuration knob.
+
+ For example, if you want to change the FQDN, you MUST reset the BGP session
+ in order to send a new FQDN capability to the peer. This command allows you
+ to resend FQDN capability without resetting the session.
+
+ .. code-block:: frr
+
+ hostname bgp-new.example.com
+ clear bgp 10.10.10.1 capabilities
+
+.. note::
+
+ Changing the hostname is possible only when connected to the specific daemon.
+ If you change the hostname via ``vtysh``, it won't be changed.
+
The following are available in the ``router bgp`` mode:
.. clicmd:: write-quanta (1-64)
@@ -4044,8 +4184,8 @@ structure is extended with :clicmd:`show bgp [afi] [safi]`.
exit1# show ip bgp summary wide
- IPv4 Unicast Summary (VRF default):
- BGP router identifier 192.168.100.1, local AS number 65534 vrf-id 0
+ IPv4 Unicast Summary:
+ BGP router identifier 192.168.100.1, local AS number 65534 VRF default vrf-id 0
BGP table version 3
RIB entries 5, using 920 bytes of memory
Peers 1, using 27 KiB of memory
@@ -4339,7 +4479,7 @@ incoming/outgoing directions.
Origin incomplete, metric 0, weight 32768, valid, sourced, bestpath-from-AS Local, best (First path received)
Last update: Wed May 8 12:54:41 2023
- Displayed 2 routes and 2 total paths
+ Displayed 2 routes and 2 total paths
.. code-block:: frr
@@ -4364,7 +4504,7 @@ incoming/outgoing directions.
Origin incomplete, metric 0, weight 32768, valid, sourced, bestpath-from-AS Local, best (First path received)
Last update: Wed May 8 12:45:01 2023
- Displayed 2 routes and 2 total paths
+ Displayed 2 routes and 2 total paths
Instance vrf3:
@@ -4389,7 +4529,7 @@ incoming/outgoing directions.
Extended Community: RT:65000:1009 ET:8 Rmac:00:02:00:00:00:58
Last update: Fri May 8 02:41:55 2023
- Displayed 2 routes and 2 total paths
+ Displayed 2 routes and 2 total paths
.. code-block:: frr
@@ -4417,7 +4557,7 @@ incoming/outgoing directions.
Extended Community: RT:65000:1009 ET:8 Rmac:00:02:00:00:00:58
Last update: Fri May 8 02:23:55 2023
- Displayed 2 routes and 2 total paths
+ Displayed 2 routes and 2 total paths
.. _bgp-display-routes-by-community:
diff --git a/doc/user/bmp.rst b/doc/user/bmp.rst
index 1983995..0f46832 100644
--- a/doc/user/bmp.rst
+++ b/doc/user/bmp.rst
@@ -36,8 +36,8 @@ The `BMP` implementation in FRR has the following properties:
successfully. OPEN messages for failed sessions cannot currently be
mirrored.
-- **route monitoring** is available for IPv4 and IPv6 AFIs, unicast and
- multicast SAFIs. Other SAFIs (VPN, Labeled-Unicast, Flowspec, etc.) are not
+- **route monitoring** is available for IPv4 and IPv6 AFIs, unicast, multicast,
+ EVPN and VPN SAFIs. Other SAFIs (VPN, Labeled-Unicast, Flowspec, etc.) are not
currently supported.
- monitoring peers that have BGP **add-path** enabled on the session will
@@ -146,10 +146,10 @@ associated with a particular ``bmp targets``:
Send BMP Statistics (counter) messages at the specified interval (in
milliseconds.)
-.. clicmd:: bmp monitor AFI SAFI <pre-policy|post-policy>
+.. clicmd:: bmp monitor AFI SAFI <pre-policy|post-policy|loc-rib>
Perform Route Monitoring for the specified AFI and SAFI. Only IPv4 and
- IPv6 are currently valid for AFI. SAFI valid values are currently
+ IPv6 are currently valid for AFI. SAFI valid values are currently
unicast, multicast, evpn and vpn.
Other AFI/SAFI combinations may be added in the future.
diff --git a/doc/user/config-include.rst b/doc/user/config-include.rst
new file mode 100644
index 0000000..3a34151
--- /dev/null
+++ b/doc/user/config-include.rst
@@ -0,0 +1,12 @@
+..
+.. January 12 2024, Christian Hopps <chopps@labn.net>
+..
+.. Copyright (c) 2024, LabN Consulting, L.L.C.
+..
+..
+
+Configuration for the daemon should be saved in the FRR integrated configuration
+file located in |INSTALL_PREFIX_ETC|/frr.conf, see :ref:`config-file` for more
+information on system configuration.
+
+.. include:: prior-config-files.rst
diff --git a/doc/user/eigrpd.rst b/doc/user/eigrpd.rst
index fa157c4..58a2957 100644
--- a/doc/user/eigrpd.rst
+++ b/doc/user/eigrpd.rst
@@ -24,21 +24,17 @@ known topology.
Starting and Stopping eigrpd
============================
-The default configuration file name of *eigrpd*'s is :file:`eigrpd.conf`. When
-invocation *eigrpd* searches directory |INSTALL_PREFIX_ETC|. If
-:file:`eigrpd.conf` is not there next search current directory. If an
-integrated config is specified configuration is written into :file:`frr.conf`.
+.. include:: config-include.rst
-The EIGRP protocol requires interface information maintained by *zebra* daemon.
-So running *zebra* is mandatory to run *eigrpd*. Thus minimum sequence for
-running EIGRP is:
+If starting daemons by hand then please note, the EIGRP protocol requires
+interface information maintained by *zebra* daemon. So running *zebra* is
+mandatory to run *eigrpd*. Thus minimum sequence for running EIGRP is:
::
# zebra -d
# eigrpd -d
-
Please note that *zebra* must be invoked before *eigrpd*.
To stop *eigrpd*, please use::
diff --git a/doc/user/installation.rst b/doc/user/installation.rst
index 24c6c22..fb9e23d 100644
--- a/doc/user/installation.rst
+++ b/doc/user/installation.rst
@@ -234,10 +234,9 @@ options from the list below.
assigned to the realm. See the tc man page. This option is currently not
compatible with the usage of nexthop groups in the linux kernel itself.
-.. option:: --disable-irdp
+.. option:: --enable-irdp
- Disable IRDP server support. This is enabled by default if we have
- both `struct in_pktinfo` and `struct icmphdr` available to us.
+ Enable IRDP server support. This is deprecated.
.. option:: --disable-rtadv
@@ -394,13 +393,20 @@ options to the configuration script.
.. option:: --sysconfdir <dir>
- Look for configuration files in `dir` [`prefix`/etc]. Note that sample
- configuration files will be installed here.
+ Look for configuration files in `dir`/frr [`prefix`/etc]. Note that sample
+ configuration files will be installed here. Should be ``/etc`` unless
+ your platform splits package configuration locations.
.. option:: --localstatedir <dir>
- Configure zebra to use `dir` for local state files, such as pid files and
- unix sockets.
+ Configure base directory for local state. Indirectly controls
+ ``--runstatedir``. Should be ``/var`` in most cases.
+
+.. option:: --runstatedir <dir>
+
+ Configure FRR to use `dir`/frr for local state files, such as pid files and
+ unix sockets. Should be ``/var/run`` (default through ``--localstatedir``)
+ or ``/run`` in most cases.
.. option:: --with-scriptdir <dir>
@@ -579,9 +585,9 @@ the options you chose:
./configure \
--prefix=/usr \
- --localstatedir=/var/run/frr \
+ --sysconfdir=/etc \
+ --localstatedir=/var \
--sbindir=/usr/lib/frr \
- --sysconfdir=/etc/frr \
--enable-pimd \
--enable-watchfrr \
...
diff --git a/doc/user/isisd.rst b/doc/user/isisd.rst
index 63c9213..d37dfa6 100644
--- a/doc/user/isisd.rst
+++ b/doc/user/isisd.rst
@@ -22,8 +22,7 @@ interface information from *zebra* in order to function. Therefore *zebra* must
be running before invoking *isisd*. Also, if *zebra* is restarted then *isisd*
must be too.
-Like other daemons, *isisd* configuration is done in :abbr:`ISIS` specific
-configuration file :file:`isisd.conf`.
+.. include:: config-include.rst
.. _isis-router:
diff --git a/doc/user/ldpd.rst b/doc/user/ldpd.rst
index 682443a..cbed734 100644
--- a/doc/user/ldpd.rst
+++ b/doc/user/ldpd.rst
@@ -32,9 +32,7 @@ options (:ref:`common-invocation-options`).
The *zebra* daemon must be running before *ldpd* is invoked.
-Configuration of *ldpd* is done in its configuration file
-:file:`ldpd.conf`.
-
+.. include:: config-include.rst
.. _understanding-ldp:
diff --git a/doc/user/mgmtd.rst b/doc/user/mgmtd.rst
index 42bc860..aa7ccaa 100644
--- a/doc/user/mgmtd.rst
+++ b/doc/user/mgmtd.rst
@@ -371,22 +371,22 @@ MGMT Daemon debug commands
The following debug commands enable debugging within the management daemon:
-.. clicmd:: [no] debug mgmt backend
+.. clicmd:: debug mgmt backend
Enable[/Disable] debugging messages related to backend operations within the
management daemon.
-.. clicmd:: [no] debug mgmt datastore
+.. clicmd:: debug mgmt datastore
Enable[/Disable] debugging messages related to YANG datastore operations
within the management daemon.
-.. clicmd:: [no] debug mgmt frontend
+.. clicmd:: debug mgmt frontend
Enable[/Disable] debugging messages related to frontend operations within the
management daemon.
-.. clicmd:: [no] debug mgmt transaction
+.. clicmd:: debug mgmt transaction
Enable[/Disable] debugging messages related to transactions within the
management daemon.
@@ -398,12 +398,12 @@ MGMT Client debug commands
The following debug commands enable debugging within the management front and
backend clients:
-.. clicmd:: [no] debug mgmt client backend
+.. clicmd:: debug mgmt client backend
Enable[/Disable] debugging messages related to backend operations inside the
backend mgmtd clients.
-.. clicmd:: [no] debug mgmt client frontend
+.. clicmd:: debug mgmt client frontend
Enable[/Disable] debugging messages related to frontend operations inside the
frontend mgmtd clients.
diff --git a/doc/user/ospf6d.rst b/doc/user/ospf6d.rst
index 2f4c956..ad58610 100644
--- a/doc/user/ospf6d.rst
+++ b/doc/user/ospf6d.rst
@@ -9,8 +9,13 @@ described in :rfc:`2740`.
.. _ospf6-router:
-OSPF6 router
-============
+Configuring OSPF6
+*****************
+
+.. include:: config-include.rst
+
+Configuration Commands
+======================
.. clicmd:: router ospf6 [vrf NAME]
@@ -312,10 +317,135 @@ OSPF6 interface
Sets interface's Inf-Trans-Delay. Default value is 1.
-.. clicmd:: ipv6 ospf6 network (broadcast|point-to-point)
+.. clicmd:: ipv6 ospf6 network (broadcast|point-to-point|point-to-multipoint)
Set explicitly network type for specified interface.
+ The only functional difference between ``point-to-point`` (PtP) and
+ ``point-to-multipoint`` (PtMP) mode is the packet addressing for database
+ flooding and updates. PtP will use multicast packets while PtMP will
+ unicast them. Apart from this,
+ :clicmd:`ipv6 ospf6 p2p-p2mp connected-prefixes <include|exclude>` has a
+ different default for PtP and PtMP. There are no other differences, in
+ particular FRR does not impose a limit of one neighbor in PtP mode.
+
+ FRR does not support NBMA mode for IPv6 and likely never will, as NBMA is
+ considered deprecated for IPv6. Refer to `this IETF OSPF working group
+ discussion
+ <https://mailarchive.ietf.org/arch/msg/ospf/8GAbr4qSMMt5J7SvAcZQ1H7ARhk/>`_
+ for context.
+
+OSPF6 point-to-point and point-to-multipoint operation
+======================================================
+
+OSPFv3, by default, operates in broadcast mode where it elects a DR and BDR
+for each network segment. This can be changed to point-to-point (PtP) /
+point-to-multipoint (PtMP) mode by configuration. The actual physical
+interface characteristics do not matter for this setting, all interfaces can
+be configured for all modes. However, routers must be configured for the same
+mode to form adjacencies.
+
+The main advantages of PtP/PtMP mode are:
+
+- no DR/BDR election
+- adjacencies can be suppressed in a pairwise manner for any two routers, e.g.
+ to represent the underlying topology if it isn't a true full mesh
+- distinct costs can be set for each pair of routers and direction
+
+The main downside is less efficient flooding on networks with a large number
+of OSPFv3 routers.
+
+.. warning::
+
+ All options in this section should be considered "advanced" configuration
+ options. Inconsistent or nonsensical combinations can easily result in a
+ non-functional setup.
+
+.. clicmd:: ipv6 ospf6 p2p-p2mp disable-multicast-hello
+
+ Disables sending normal multicast hellos when in PtP/PtMP mode. Some
+ vendors do this automatically for PtMP mode while others have a separate
+ ``no-broadcast`` option matching this.
+
+ If this setting is used, you must issue
+ :clicmd:`ipv6 ospf6 neighbor X:X::X:X poll-interval (1-65535)` for each
+ neighbor to send unicast hello packets.
+
+.. clicmd:: ipv6 ospf6 p2p-p2mp config-neighbors-only
+
+ Only form adjacencies with neighbors that are explicitly configured with
+ the :clicmd:`ipv6 ospf6 neighbor X:X::X:X` command. Hellos from other
+ routers are ignored.
+
+ .. warning::
+
+ This setting is not intended to provide any security benefit. Do not
+ run OSPFv3 over untrusted links without additional security measures
+ (e.g. IPsec.)
+
+.. clicmd:: ipv6 ospf6 p2p-p2mp connected-prefixes <include|exclude>
+
+ For global/ULA prefixes configured on this interfaces, do (not) advertise
+ the full prefix to the area. Regardless of this setting, the router's own
+ address, as a /128 host route with the "LA" (Local Address) bit set, will
+ always be advertised.
+
+ The default is to include connected prefixes for PtP mode and exclude them
+ for PtMP mode. Since these prefixes will cover other router's addresses,
+ these addresses can become unreachable if the link is partitioned if the
+ other router does not advertise the address as a /128. However, conversely,
+ if all routers have this flag set, the overall prefix will not be advertised
+ anywhere. End hosts on this link will therefore be unreachable (and
+ blackholing best-practices for non-existing prefixes apply.) It may be
+ preferable to have only one router announce the connected prefix.
+
+ The Link LSA (which is not propagated into the area) always includes all
+ prefixes on the interface. This setting only affects the Router LSA that
+ is visible to all routers in the area.
+
+ .. note::
+
+ Before interacting with this setting, consider either not configuring
+ any global/ULA IPv6 address on the interface, or directly configuring a
+ /128 if needed. OSPFv3 relies exclusively on link-local addresses to do
+ its signaling and there is absolutely no reason to configure global/ULA
+ addresses as far as OSPFv3 is concerned.
+
+.. clicmd:: ipv6 ospf6 neighbor X:X::X:X
+
+ Explicitly configure a neighbor by its link-local address on this interface.
+ This statement has no effect other than allowing an adjacency when
+ :clicmd:`ipv6 ospf6 p2p-p2mp config-neighbors-only` is set. This command
+ does **not** cause unicast hellos to be sent.
+
+ Only link-local addresses can be used to establish explicit neighbors.
+ When using this command, you should probably assign static IPv6 link-local
+ addresses to all routers on this link. It would technically be possible to
+ use the neighbor's Router ID (IPv4 address) here to ease working with
+ changing link-local addresses but this is not planned as a feature at the
+ time of writing. Global/ULA IPv6 addresses cannot be supported here due to
+ the way OSPFv3 works.
+
+.. clicmd:: ipv6 ospf6 neighbor X:X::X:X poll-interval (1-65535)
+
+ Send unicast hellos to this neighbor at the specified interval (in seconds.)
+ The interval is only used while there is no adjacency with this neighbor.
+ As soon as an adjacency is formed, the interface's
+ :clicmd:`ipv6 ospf6 hello-interval HELLOINTERVAL` value is used.
+ (``hello-interval`` must be the same on all routers on this link.)
+
+ :rfc:`2328` recommends a "much larger" value than ``hello-interval`` for
+ this setting, but this is a legacy of ATM and X.25 networks and nowadays you
+ should probably just use the same value as for ``hello-interval``.
+
+.. clicmd:: ipv6 ospf6 neighbor X:X::X:X cost (1-65535)
+
+ Use a distinct cost for paths traversing this neighbor. The default is
+ to use the interface's cost value (which may be automatically calculated
+ based on link bandwidth.) Note that costs are directional in OSPF and the
+ reverse direction must be set on the other router.
+
+
OSPF6 route-map
===============
diff --git a/doc/user/ospfd.rst b/doc/user/ospfd.rst
index d61522b..3bc4487 100644
--- a/doc/user/ospfd.rst
+++ b/doc/user/ospfd.rst
@@ -32,8 +32,7 @@ Configuring OSPF
Therefore *zebra* must be running before invoking *ospfd*. Also, if *zebra* is
restarted then *ospfd* must be too.
-Like other daemons, *ospfd* configuration is done in :abbr:`OSPF` specific
-configuration file :file:`ospfd.conf` when the integrated config is not used.
+.. include:: config-include.rst
.. _ospf-multi-instance:
@@ -853,7 +852,7 @@ Graceful Restart
affects the restarting router.
By default 'strict-lsa-checking' is enabled"
-.. clicmd:: graceful-restart helper supported-grace-time
+.. clicmd:: graceful-restart helper supported-grace-time (10-1800)
Supports as HELPER for configured grace period.
diff --git a/doc/user/overview.rst b/doc/user/overview.rst
index a1cb0cc..2ef88ac 100644
--- a/doc/user/overview.rst
+++ b/doc/user/overview.rst
@@ -428,6 +428,8 @@ BGP
:t:`Route Leak Prevention and Detection Using Roles in UPDATE and OPEN Messages. A. Azimov, E. Bogomazov, R. Bush, K. Patel, K. Sriram. May 2022.`
- :rfc:`9384`
:t:`A BGP Cease NOTIFICATION Subcode for Bidirectional Forwarding Detection (BFD). J. Haas. March 2023.`
+- :rfc:`9494`
+ :t:`Long-Lived Graceful Restart for BGP. J. Uttaro, E. Chen, B. Decraene, J. Scudder. November 2023.`
OSPF
----
diff --git a/doc/user/pathd.rst b/doc/user/pathd.rst
index ec107fb..2519ac4 100644
--- a/doc/user/pathd.rst
+++ b/doc/user/pathd.rst
@@ -327,7 +327,7 @@ Configuration Commands
Delete or specify a bandwidth constraint for a dynamic candidate path.
-.. clicmd:: metric [bound] METRIC VALUE [required]
+.. clicmd:: metric [bound] METRIC VALUE [required] [computed]
Delete or specify a metric constraint for a dynamic candidate path.
@@ -475,6 +475,9 @@ Configuration Commands
Specify the maximum SID depth in a PCC definition.
+.. clicmd:: no msd [(1-32)]
+
+ Default the maximum SID depth to 4.
.. clicmd:: peer WORD [precedence (1-255)]
@@ -531,7 +534,7 @@ retrieved via PCEP a random number based name is generated.
Display PCC information.
-.. clicmd:: show sr-te pcep session [NAME]
+.. clicmd:: show sr-te pcep session [NAME] [json]
Display the information of a PCEP session, if not name is specified all the
sessions will be displayed.
diff --git a/doc/user/pbr.rst b/doc/user/pbr.rst
index 7a4effd..6ea153c 100644
--- a/doc/user/pbr.rst
+++ b/doc/user/pbr.rst
@@ -15,11 +15,7 @@ the default Linux kernel dataplane provider.
Starting PBR
============
-Default configuration file for *pbrd* is :file:`pbrd.conf`. The typical
-location of :file:`pbrd.conf` is |INSTALL_PREFIX_ETC|/pbrd.conf.
-
-If FRR is using integrated config, then :file:`pbrd.conf` need not be
-present and the :file:`frr.conf` is read instead.
+.. include:: config-include.rst
.. program:: pbrd
diff --git a/doc/user/pim.rst b/doc/user/pim.rst
index d70c3c0..80a6a27 100644
--- a/doc/user/pim.rst
+++ b/doc/user/pim.rst
@@ -23,12 +23,11 @@ network for optimizing forwarding of overlay BUM traffic.
Starting and Stopping pimd
==========================
-The default configuration file name of *pimd*'s is :file:`pimd.conf`. When
-invoked *pimd* searches directory |INSTALL_PREFIX_ETC|. If
-:file:`pimd.conf` is not there then next search current directory.
+.. include:: config-include.rst
-*pimd* requires zebra for proper operation. Additionally *pimd* depends on
-routing properly setup and working in the network that it is working on.
+If starting daemons by hand then please note, *pimd* requires zebra for proper
+operation. Additionally *pimd* depends on routing properly setup and working in
+the network that it is working on.
::
diff --git a/doc/user/pimv6.rst b/doc/user/pimv6.rst
index 8569390..d550c8e 100644
--- a/doc/user/pimv6.rst
+++ b/doc/user/pimv6.rst
@@ -15,12 +15,11 @@ do S,G mrouting.
Starting and Stopping pim6d
===========================
-The default configuration file name of *pim6d*'s is :file:`pim6d.conf`. When
-invoked *pim6d* searches directory |INSTALL_PREFIX_ETC|. If
-:file:`pim6d.conf` is not there then next search current directory.
+.. include:: config-include.rst
-*pim6d* requires zebra for proper operation. Additionally *pim6d* depends on
-routing properly setup and working in the network that it is working on.
+If starting daemons by hand then please note, *pim6d* requires zebra for proper
+operation. Additionally *pim6d* depends on routing properly setup and working in
+the network that it is working on.
::
diff --git a/doc/user/prior-config-files.rst b/doc/user/prior-config-files.rst
new file mode 100644
index 0000000..a01b688
--- /dev/null
+++ b/doc/user/prior-config-files.rst
@@ -0,0 +1,23 @@
+..
+.. January 12 2024, Christian Hopps <chopps@labn.net>
+..
+.. Copyright (c) 2024, LabN Consulting, L.L.C.
+..
+..
+
+Prior versions of FRR supported reading and writing per-daemon config files;
+however, with the introduction of the centralized management daemon ``mgmtd``
+this could no longer be supported.
+
+In order to allow for an orderly transition from per-daemon config files to the
+integrated config file, FRR daemons will continue to try and **read** their
+specific per-daemon configuration file as before. Additionally the config can
+still be loaded directly using the ``-f`` or ``--config-file`` CLI options;
+however, these files will **not** be updated when the configuration is written
+(e.g., with the ``write mem`` command).
+
+.. warning::
+
+ Per-daemon files will **no longer** be updated when the user issues a ``write
+ memory`` command. Therefore these per-daemon config files should only be used
+ as a mechanism for transitioning to the integrated config, and then removed.
diff --git a/doc/user/requirements.txt b/doc/user/requirements.txt
new file mode 100644
index 0000000..483a4e9
--- /dev/null
+++ b/doc/user/requirements.txt
@@ -0,0 +1 @@
+sphinx_rtd_theme
diff --git a/doc/user/ripd.rst b/doc/user/ripd.rst
index f9c7724..ea13dc9 100644
--- a/doc/user/ripd.rst
+++ b/doc/user/ripd.rst
@@ -21,15 +21,15 @@ version 1 as described in RFC1058.
Starting and Stopping ripd
==========================
-The default configuration file name of *ripd*'s is :file:`ripd.conf`. When
-invocation *ripd* searches directory |INSTALL_PREFIX_ETC|. If :file:`ripd.conf`
-is not there next search current directory.
+.. include:: config-include.rst
RIP uses UDP port 520 to send and receive RIP packets. So the user must have
the capability to bind the port, generally this means that the user must have
-superuser privileges. RIP protocol requires interface information maintained by
-*zebra* daemon. So running *zebra* is mandatory to run *ripd*. Thus minimum
-sequence for running RIP is like below:
+superuser privileges.
+
+If starting daemons by hand then please note, RIP protocol requires interface
+information maintained by *zebra* daemon. So running *zebra* is mandatory to run
+*ripd*. Thus minimum sequence for running RIP is like below:
::
diff --git a/doc/user/ripngd.rst b/doc/user/ripngd.rst
index 1e78294..f898bed 100644
--- a/doc/user/ripngd.rst
+++ b/doc/user/ripngd.rst
@@ -12,6 +12,8 @@ reincarnation of the RIP protocol.
Invoking ripngd
===============
+.. include:: config-include.rst
+
There are no `ripngd` specific invocation options. Common options can be
specified (:ref:`common-invocation-options`).
diff --git a/doc/user/routemap.rst b/doc/user/routemap.rst
index 3d43e74..791762a 100644
--- a/doc/user/routemap.rst
+++ b/doc/user/routemap.rst
@@ -185,9 +185,11 @@ Route Map Match Command
Matches the specified `local-preference`.
-.. clicmd:: match community COMMUNITY_LIST
+.. clicmd:: match community COMMUNITY_LIST [<exact-match|any>]
- Matches the specified `community_list`
+ Matches the specified `community_list`. ``exact-match`` specifies to
+ do the exact matching of the communities, while ``any`` - can match any
+ community specified in COMMUNITY_LIST.
.. clicmd:: match peer IPV4_ADDR
@@ -378,13 +380,13 @@ Route Map Exit Action Command
.. clicmd:: on-match next
-.. clicmd:: continue
-
Proceed on to the next entry in the route-map.
-.. clicmd:: on-match goto N
+.. clicmd:: continue (1-65535)
-.. clicmd:: continue N
+ Proceed to the specified sequence in the route-map.
+
+.. clicmd:: on-match goto N
Proceed processing the route-map at the first entry whose order is >= N
diff --git a/doc/user/rpki.rst b/doc/user/rpki.rst
index 4053536..76910ee 100644
--- a/doc/user/rpki.rst
+++ b/doc/user/rpki.rst
@@ -62,8 +62,9 @@ otherwise ``bgpd`` daemon won't startup.
This command enables the RPKI configuration mode. Most commands that start
with *rpki* can only be used in this mode.
- When it is used in a telnet session, leaving of this mode cause rpki to be
- initialized.
+ This command is available either in *configure node* for default *vrf* or
+ in *vrf node* for specific *vrf*. When it is used in a telnet session,
+ leaving of this mode cause rpki to be initialized.
Executing this command alone does not activate prefix validation. You need
to configure at least one reachable cache server. See section
@@ -90,6 +91,9 @@ Examples of the error::
router(config)# rpki
% [BGP] Unknown command: rpki
+ router(config-vrf)# rpki
+ % [BGP] Unknown command: rpki
+
Note that the RPKI commands will be available in vtysh when running
``find rpki`` regardless of whether the module is loaded.
@@ -98,7 +102,14 @@ Note that the RPKI commands will be available in vtysh when running
Configuring RPKI/RTR Cache Servers
----------------------------------
-The following commands are independent of a specific cache server.
+RPKI/RTR can be configured independently, either in configure node, or in *vrf*
+sub context. If configured in configure node, the core *bgp* instance of default
+*vrf* is impacted by the configuration.
+
+Each RPKI/RTR context is mapped to a *vrf* and can be made up of a specific list
+of cache-servers, and specific settings.
+
+The following commands are available for independent of a specific cache server.
.. clicmd:: rpki polling_period (1-3600)
@@ -166,7 +177,7 @@ Validating BGP Updates
.. code-block:: frr
! Allow for invalid routes in route selection process
- route bgp 60001
+ route bgp 65001
!
! Set local preference of invalid prefixes to 10
route-map rpki permit 10
@@ -200,35 +211,39 @@ Debugging
Displaying RPKI
---------------
-.. clicmd:: show rpki prefix <A.B.C.D/M|X:X::X:X/M> [(1-4294967295)] [json]
+.. clicmd:: show rpki configuration [vrf NAME] [json]
+
+ Display RPKI configuration state including timers values.
+
+.. clicmd:: show rpki prefix <A.B.C.D/M|X:X::X:X/M> [(1-4294967295)] [vrf NAME] [json]
Display validated prefixes received from the cache servers filtered
by the specified prefix.
-.. clicmd:: show rpki as-number ASN [json]
+.. clicmd:: show rpki as-number ASN [vrf NAME] [json]
Display validated prefixes received from the cache servers filtered
by ASN.
-.. clicmd:: show rpki prefix-table [json]
+.. clicmd:: show rpki prefix-table [vrf NAME] [json]
Display all validated prefix to origin AS mappings/records which have been
received from the cache servers and stored in the router. Based on this data,
the router validates BGP Updates.
-.. clicmd:: show rpki cache-server [json]
+.. clicmd:: show rpki cache-server [vrf NAME] [json]
Display all configured cache servers, whether active or not.
-.. clicmd:: show rpki cache-connection [json]
+.. clicmd:: show rpki cache-connection [vrf NAME] [json]
Display all cache connections, and show which is connected or not.
-.. clicmd:: show bgp [afi] [safi] <A.B.C.D|A.B.C.D/M|X:X::X:X|X:X::X:X/M> rpki <valid|invalid|notfound>
+.. clicmd:: show bgp [vrf NAME] [afi] [safi] <A.B.C.D|A.B.C.D/M|X:X::X:X|X:X::X:X/M> rpki <valid|invalid|notfound>
Display for the specified prefix or address the bgp paths that match the given rpki state.
-.. clicmd:: show bgp [afi] [safi] rpki <valid|invalid|notfound>
+.. clicmd:: show bgp [vrf NAME] [afi] [safi] rpki <valid|invalid|notfound>
Display all prefixes that match the given rpki state.
@@ -244,25 +259,52 @@ RPKI Configuration Example
debug bgp keepalives
debug rpki
!
+ vrf VRF1
+ rpki
+ rpki polling_period 1000
+ rpki timeout 10
+ ! SSH Example:
+ rpki cache example.com 22 rtr-ssh ./ssh_key/id_rsa preference 1
+ ! TCP Example:
+ rpki cache rpki-validator.realmv6.org 8282 preference 2
+ exit
+ !
+ exit-vrf
+ !
rpki
rpki polling_period 1000
rpki timeout 10
! SSH Example:
- rpki cache example.com source 141.22.28.223 22 rtr-ssh ./ssh_key/id_rsa ./ssh_key/id_rsa.pub preference 1
+ rpki cache example.com source 198.51.100.223 22 rtr-ssh ./ssh_key/id_rsa preference 1
! TCP Example:
rpki cache rpki-validator.realmv6.org 8282 preference 2
exit
!
- router bgp 60001
- bgp router-id 141.22.28.223
- network 192.168.0.0/16
- neighbor 123.123.123.0 remote-as 60002
- neighbor 123.123.123.0 route-map rpki in
- neighbor 123.123.123.0 update-source 141.22.28.223
+ router bgp 65001
+ bgp router-id 198.51.100.223
+ neighbor 203.0.113.1 remote-as 65002
+ neighbor 203.0.113.1 update-source 198.51.100.223
+ address-family ipv4
+ network 192.0.2.0/24
+ neighbor 203.0.113.1 route-map rpki in
+ exit-address-family
+ !
+ address-family ipv6
+ neighbor 203.0.113.1 activate
+ neighbor 203.0.113.1 route-map rpki in
+ exit-address-family
+ !
+ router bgp 65001 vrf VRF1
+ bgp router-id 198.51.100.223
+ neighbor 203.0.113.1 remote-as 65002
+ address-family ipv4
+ network 192.0.2.0/24
+ neighbor 203.0.113.1 route-map rpki in
+ exit-address-family
!
address-family ipv6
- neighbor 123.123.123.0 activate
- neighbor 123.123.123.0 route-map rpki in
+ neighbor 203.0.113.1 activate
+ neighbor 203.0.113.1 route-map rpki in
exit-address-family
!
route-map rpki permit 10
diff --git a/doc/user/sharp.rst b/doc/user/sharp.rst
index 3e73a59..2be38a3 100644
--- a/doc/user/sharp.rst
+++ b/doc/user/sharp.rst
@@ -13,11 +13,7 @@ labs.
Starting SHARP
==============
-Default configuration file for *sharpd* is :file:`sharpd.conf`. The typical
-location of :file:`sharpd.conf` is |INSTALL_PREFIX_ETC|/sharpd.conf.
-
-If the user is using integrated config, then :file:`sharpd.conf` need not be
-present and the :file:`frr.conf` is read instead.
+.. include:: config-include.rst
.. program:: sharpd
@@ -67,6 +63,11 @@ keyword. At present, no sharp commands will be preserved in the config.
Install a label into the kernel that causes the specified vrf NAME table to
be used for pop and forward operations when the specified label is seen.
+.. clicmd:: sharp watch [vrf VRF_NAME] neighbor
+
+ Instruct zebra to notify sharpd about neighbor events in the specified vrf.
+ If no vrf is specified then assume default.
+
.. clicmd:: sharp watch <nexthop <A.B.C.D|X:X::X:X>|import <A.B.C.D/M:X:X::X:X/M> [connected]
Instruct zebra to monitor and notify sharp when the specified nexthop is
diff --git a/doc/user/snmptrap.rst b/doc/user/snmptrap.rst
index 7e306b7..df534e2 100644
--- a/doc/user/snmptrap.rst
+++ b/doc/user/snmptrap.rst
@@ -4,8 +4,9 @@ Handling SNMP Traps
To handle snmp traps make sure your snmp setup of frr works correctly as
described in the frr documentation in :ref:`snmp-support`.
-The BGP4 mib will send traps on peer up/down events. These should be visible in
-your snmp logs with a message similar to:
+BGP handles both :rfc:`4273` and [Draft-IETF-idr-bgp4-mibv2-11]_ MIBs.
+The BGP4 MIBs will send traps on peer up/down events. These should be
+visible in your snmp logs with a message similar to:
::
@@ -199,3 +200,18 @@ a siren, have your display flash, etc., be creative ;).
# mail the notification
echo "$MAIL" | mail -s "$SUBJECT" $EMAILADDR
+
+.. _traps-mib-selection:
+
+Traps Mib Selection in BGP
+--------------------------
+
+Both :rfc:`4273` and [Draft-IETF-idr-bgp4-mibv2-11]_ MIBs define traps for
+dealing with up/down events and state transition. The user has the
+possibility to select the MIB he wants to receive traps from:
+
+.. clicmd:: bgp snmp traps <rfc4273|bgp4-mibv2>
+
+By default, only rfc4273 traps are enabled and sent.
+
+.. [Draft-IETF-idr-bgp4-mibv2-11] <https://tools.ietf.org/id/draft-ietf-idr-bgp4-mibv2-11.txt>
diff --git a/doc/user/static.rst b/doc/user/static.rst
index d405276..922c71a 100644
--- a/doc/user/static.rst
+++ b/doc/user/static.rst
@@ -12,21 +12,13 @@ of static routes.
Starting STATIC
===============
-Default configuration file for *staticd* is :file:`staticd.conf`. The typical
-location of :file:`staticd.conf` is |INSTALL_PREFIX_ETC|/staticd.conf.
-
-If the user is using integrated config, then :file:`staticd.conf` need not be
-present and the :file:`frr.conf` is read instead.
-
-If the user has not fully upgraded to using the staticd.conf and still has
-a non-integrated config with zebra.conf holding the static routes, *staticd*
-will read in the :file:`zebrad.conf` as a backup.
-
.. program:: staticd
:abbr:`STATIC` supports all the common FRR daemon start options which are
documented elsewhere.
+.. include:: config-include.rst
+
.. _static-route-commands:
Static Route Commands
diff --git a/doc/user/vrrp.rst b/doc/user/vrrp.rst
index ef3aebe..d99fc23 100644
--- a/doc/user/vrrp.rst
+++ b/doc/user/vrrp.rst
@@ -24,11 +24,7 @@ protocol.
Starting VRRP
=============
-The configuration file for *vrrpd* is :file:`vrrpd.conf`. The typical location
-of :file:`vrrpd.conf` is |INSTALL_PREFIX_ETC|/vrrpd.conf.
-
-If using integrated config, then :file:`vrrpd.conf` need not be present and
-:file:`frr.conf` is read instead.
+.. include:: config-include.rst
.. program:: vrrpd
diff --git a/doc/user/vtysh.rst b/doc/user/vtysh.rst
index adbdf34..9722231 100644
--- a/doc/user/vtysh.rst
+++ b/doc/user/vtysh.rst
@@ -131,14 +131,14 @@ could be made SGID (set group ID) to the |INSTALL_VTY_GROUP| group.
at all.
-.. _integrated-configuration-mode:
+.. _integrated-configuration-file:
-Integrated configuration mode
+Integrated configuration file
=============================
-Integrated configuration mode uses a single configuration file,
-:file:`frr.conf`, for all daemons. This replaces the individual files like
-:file:`zebra.conf` or :file:`bgpd.conf`.
+FRR uses a single configuration file, :file:`frr.conf`, for all daemons. This
+replaces the individual files like :file:`zebra.conf` or :file:`bgpd.conf` used
+in previous versions of the software.
:file:`frr.conf` is located in |INSTALL_PREFIX_ETC|. All daemons check for the
existence of this file at startup, and if it exists will not load their
diff --git a/doc/user/zebra.rst b/doc/user/zebra.rst
index ba6e3bf..30b0204 100644
--- a/doc/user/zebra.rst
+++ b/doc/user/zebra.rst
@@ -50,7 +50,8 @@ Besides the common invocation options (:ref:`common-invocation-options`), the
When *Zebra* starts with this option, the VRF backend is based on Linux
network namespaces. That implies that all network namespaces discovered by
ZEBRA will create an associated VRF. The other daemons will operate on the VRF
- VRF defined by *Zebra*, as usual.
+ VRF defined by *Zebra*, as usual. If this option is specified when running
+ *Zebra*, one must also specify the same option for *mgmtd*.
.. seealso:: :ref:`zebra-vrf`
@@ -177,16 +178,15 @@ Standard Commands
work on non-linux systems at all. 'enable' and 'disable' will respectively turn
on and off mpls on the given interface.
-.. clicmd:: multicast
+.. clicmd:: multicast <enable|disable>
Enable or disable multicast flag for the interface.
-.. clicmd:: bandwidth (1-10000000)
+.. clicmd:: bandwidth (1-1000000)
-
- Set bandwidth value of the interface in kilobits/sec. This is for
+ Set bandwidth value of the interface in Megabits/sec. This is for
calculating OSPF cost. This command does not affect the actual device
configuration.
@@ -213,20 +213,14 @@ Link Parameters Commands
.. clicmd:: link-params
+ Enter into the link parameters sub node. This command activates the link
+ parameters and allows to configure routing information that could be used
+ as part of Traffic Engineering on this interface. MPLS-TE must be enabled at
+ the OSPF (:ref:`ospf-traffic-engineering`) or ISIS
+ (:ref:`isis-traffic-engineering`) router level in complement to this. To
+ disable link parameters, use the ``no`` version of this command.
- Enter into the link parameters sub node. At least 'enable' must be
- set to activate the link parameters, and consequently routing
- information that could be used as part of Traffic Engineering on
- this interface. MPLS-TE must be enable at the OSPF
- (:ref:`ospf-traffic-engineering`) or ISIS
- (:ref:`isis-traffic-engineering`) router level in complement to
- this.
-
- Under link parameter statement, the following commands set the different TE values:
-
-.. clicmd:: enable
-
- Enable link parameters for this interface.
+Under link parameter statement, the following commands set the different TE values:
.. clicmd:: metric (0-4294967295)
@@ -252,7 +246,7 @@ Link Parameters Commands
as specified in RFC3630 (OSPF) or RFC5305 (ISIS). Admin-group is also known
as Resource Class/Color in the OSPF protocol.
-.. clicmd:: [no] affinity AFFINITY-MAP-NAME
+.. clicmd:: affinity AFFINITY-MAP-NAME
This commands configures the Traffic Engineering Admin-Group of the
interface using the affinity-map definitions (:ref:`affinity-map`).
@@ -263,7 +257,7 @@ Link Parameters Commands
``admin-grp`` and ``affinity`` commands provide two ways of setting
admin-groups. They cannot be both set on the same interface.
-.. clicmd:: [no] affinity-mode [extended|standard|both]
+.. clicmd:: affinity-mode [extended|standard|both]
This commands configures which admin-group format is set by the affinity
command. ``extended`` Admin-Group is the default and uses the RFC7308 format.
@@ -783,9 +777,25 @@ presence of the entry.
21 Static 10.125.0.2 IPv4 Explicit Null
+MPLS label chunks
+-----------------
+
+MPLS label chunks are handled in the zebra label manager service,
+which ensures a same label value or label chunk can not be used by
+multiple CP routing daemons at the same time.
+
+Label requests originate from CP routing daemons, and are resolved
+over the default MPLS range (16-1048575). There are two kind of
+requests:
+- Static label requests request an exact label value or range. For
+instance, segment routing label blocks requests originating from
+IS-IS are part of it.
+- Dynamic label requests only need a range of label values. The
+'bgp l3vpn export auto' command uses such requests.
+
Allocated label chunks table can be dumped using the command
-.. clicmd:: show debugging label-table
+.. clicmd:: show debugging label-table [json]
::
@@ -796,6 +806,15 @@ Allocated label chunks table can be dumped using the command
Proto ospf: [20000/21000]
Proto isis: [22000/23000]
+.. clicmd:: mpls label dynamic-block (16-1048575) (16-1048575)
+
+ Define a range of labels where dynamic label requests will
+ allocate label chunks from. This command guarantees that
+ static label values outside that range will not conflict
+ with the dynamic label requests. When the dynamic-block
+ range is configured, static label requests that match that
+ range are not accepted.
+
.. _zebra-srv6:
Segment-Routing IPv6
@@ -813,6 +832,35 @@ FRR's cli or frr.conf or zebra.conf. This section shows how
to configure SRv6 on FRR. Of course SRv6 can be used as standalone,
and this section also helps that case.
+.. clicmd:: show segment-routing srv6 manager [json]
+
+ This command dumps the SRv6 information configured on zebra, including
+ the encapsulation parameters (e.g., the IPv6 source address used for
+ the encapsulated packets).
+
+ Example::
+
+ router# sh segment-routing srv6 manager
+ Parameters:
+ Encapsulation:
+ Source Address:
+ Configured: fc00:0:1::1
+
+
+ To get the same information in json format, you can use the ``json`` keyword::
+
+ rose-srv6# sh segment-routing srv6 manager json
+ {
+ "parameters":{
+ "encapsulation":{
+ "sourceAddress":{
+ "configured":"fc00:0:1::1"
+ }
+ }
+ }
+ }
+
+
.. clicmd:: show segment-routing srv6 locator [json]
This command dump SRv6-locator configured on zebra. SRv6-locator is used
@@ -973,6 +1021,14 @@ and this section also helps that case.
!
...
+.. clicmd:: encapsulation
+
+ Configure parameters for SRv6 encapsulation.
+
+.. clicmd:: source-address X:X::X:X
+
+ Configure the source address of the outer encapsulating IPv6 header.
+
.. _multicast-rib-commands:
Multicast RIB Commands
@@ -1434,8 +1490,6 @@ zebra Terminal Mode Commands
.. clicmd:: show ip prefix-list [NAME]
-.. clicmd:: show route-map [NAME]
-
.. clicmd:: show ip protocol
.. clicmd:: show ip forward