summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorChristian Breunig <christian@breunig.cc>2023-12-15 07:37:18 +0100
committerChristian Breunig <christian@breunig.cc>2023-12-15 10:47:44 +0100
commit6f1ed9681b8ef95134c65fac9c7f6595c93a7dca (patch)
treee4796192bda5250851442ba496d99f20a07d0a2d /docs
parent689d38c812b471d54b119ed3dffde85c2a19ceb0 (diff)
downloadvyos-documentation-6f1ed9681b8ef95134c65fac9c7f6595c93a7dca.tar.gz
vyos-documentation-6f1ed9681b8ef95134c65fac9c7f6595c93a7dca.zip
frr: T4020: document multiple per daemon config knobs
(cherry picked from commit 4aeedc96c2168bd6e19c2be7d30584c8a9fa6ab7)
Diffstat (limited to 'docs')
-rw-r--r--docs/configuration/system/frr.rst38
-rw-r--r--docs/configuration/system/index.rst1
2 files changed, 39 insertions, 0 deletions
diff --git a/docs/configuration/system/frr.rst b/docs/configuration/system/frr.rst
new file mode 100644
index 00000000..a7f7ff93
--- /dev/null
+++ b/docs/configuration/system/frr.rst
@@ -0,0 +1,38 @@
+.. _system_frr:
+
+###
+FRR
+###
+
+VyOS uses [FRRouting](https://frrouting.org/) as the control plane for dynamic
+and static routing. The routing daemon behavior can be adjusted during runtime,
+but require either a restart of the routing daemon, or a reboot of the system.
+
+.. cfgcmd:: set system frr bmp
+
+ Enable :abbr:`BMP (BGP Monitoring Protocol)` support
+
+.. cfgcmd:: set system frr descriptors <numer>
+
+ This allows the operator to control the number of open file descriptors
+ each daemon is allowed to start with. If the operator plans to run bgp with
+ several thousands of peers then this is where we would modify FRR to allow
+ this to happen.
+
+.. cfgcmd:: set system frr irdp
+
+ Enable ICMP Router Discovery Protocol support
+
+.. cfgcmd:: set system frr snmp <daemon>
+
+ Enable SNMP support for an individual routing daemon.
+
+ Supported daemons:
+
+ - bgpd
+ - isisd
+ - ldpd
+ - ospf6d
+ - ospfd
+ - ripd
+ - zebra
diff --git a/docs/configuration/system/index.rst b/docs/configuration/system/index.rst
index 23edaa3f..bfda7747 100644
--- a/docs/configuration/system/index.rst
+++ b/docs/configuration/system/index.rst
@@ -11,6 +11,7 @@ System
conntrack
console
flow-accounting
+ frr
host-name
ip
ipv6