diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/developer/building-frr-for-centos6.rst | 1 | ||||
| -rw-r--r-- | doc/developer/building-frr-for-centos7.rst | 1 | ||||
| -rw-r--r-- | doc/developer/building-frr-for-centos8.rst | 1 | ||||
| -rw-r--r-- | doc/developer/building-frr-for-debian8.rst | 1 | ||||
| -rw-r--r-- | doc/developer/building-frr-for-debian9.rst | 1 | ||||
| -rw-r--r-- | doc/developer/building-frr-for-netbsd6.rst | 1 | ||||
| -rw-r--r-- | doc/developer/building-frr-for-netbsd7.rst | 1 | ||||
| -rw-r--r-- | doc/developer/include-compile.rst | 1 | ||||
| -rw-r--r-- | doc/developer/topotests.rst | 1 | ||||
| -rw-r--r-- | doc/user/basic.rst | 37 | ||||
| -rw-r--r-- | doc/user/bgp.rst | 70 | ||||
| -rw-r--r-- | doc/user/installation.rst | 24 | ||||
| -rw-r--r-- | doc/user/ipv6.rst | 5 | ||||
| -rw-r--r-- | doc/user/ospf6d.rst | 14 | ||||
| -rw-r--r-- | doc/user/ospfd.rst | 4 | ||||
| -rw-r--r-- | doc/user/zebra.rst | 7 |
16 files changed, 123 insertions, 47 deletions
diff --git a/doc/developer/building-frr-for-centos6.rst b/doc/developer/building-frr-for-centos6.rst index 5d3be492de..7a7af42119 100644 --- a/doc/developer/building-frr-for-centos6.rst +++ b/doc/developer/building-frr-for-centos6.rst @@ -172,7 +172,6 @@ an example.) --enable-user=frr \ --enable-group=frr \ --enable-vty-group=frrvty \ - --disable-exampledir \ --disable-ldpd \ --enable-fpm \ --with-pkg-git-version \ diff --git a/doc/developer/building-frr-for-centos7.rst b/doc/developer/building-frr-for-centos7.rst index 8d0aea943c..93b9993a38 100644 --- a/doc/developer/building-frr-for-centos7.rst +++ b/doc/developer/building-frr-for-centos7.rst @@ -67,7 +67,6 @@ an example.) --enable-group=frr \ --enable-vty-group=frrvty \ --enable-systemd=yes \ - --disable-exampledir \ --disable-ldpd \ --enable-fpm \ --with-pkg-git-version \ diff --git a/doc/developer/building-frr-for-centos8.rst b/doc/developer/building-frr-for-centos8.rst index 77fe489358..65c93286b7 100644 --- a/doc/developer/building-frr-for-centos8.rst +++ b/doc/developer/building-frr-for-centos8.rst @@ -60,7 +60,6 @@ an example.) --enable-group=frr \ --enable-vty-group=frrvty \ --enable-systemd=yes \ - --disable-exampledir \ --disable-ldpd \ --enable-fpm \ --with-pkg-git-version \ diff --git a/doc/developer/building-frr-for-debian8.rst b/doc/developer/building-frr-for-debian8.rst index 51dd07c42a..475e0303fc 100644 --- a/doc/developer/building-frr-for-debian8.rst +++ b/doc/developer/building-frr-for-debian8.rst @@ -57,7 +57,6 @@ an example.) cd frr ./bootstrap.sh ./configure \ - --enable-exampledir=/usr/share/doc/frr/examples/ \ --localstatedir=/var/run/frr \ --sbindir=/usr/lib/frr \ --sysconfdir=/etc/frr \ diff --git a/doc/developer/building-frr-for-debian9.rst b/doc/developer/building-frr-for-debian9.rst index 919b010314..1981127b3d 100644 --- a/doc/developer/building-frr-for-debian9.rst +++ b/doc/developer/building-frr-for-debian9.rst @@ -44,7 +44,6 @@ an example.) cd frr ./bootstrap.sh ./configure \ - --enable-exampledir=/usr/share/doc/frr/examples/ \ --localstatedir=/var/opt/frr \ --sbindir=/usr/lib/frr \ --sysconfdir=/etc/frr \ diff --git a/doc/developer/building-frr-for-netbsd6.rst b/doc/developer/building-frr-for-netbsd6.rst index e50d11130a..a78f8b3c2f 100644 --- a/doc/developer/building-frr-for-netbsd6.rst +++ b/doc/developer/building-frr-for-netbsd6.rst @@ -64,7 +64,6 @@ an example) export CPPFLAGS="-I/usr/pkg/include" ./configure \ --sysconfdir=/usr/pkg/etc/frr \ - --enable-exampledir=/usr/pkg/share/examples/frr \ --enable-pkgsrcrcdir=/usr/pkg/share/examples/rc.d \ --localstatedir=/var/run/frr \ --enable-multipath=64 \ diff --git a/doc/developer/building-frr-for-netbsd7.rst b/doc/developer/building-frr-for-netbsd7.rst index 32d1145edc..a52ece19a1 100644 --- a/doc/developer/building-frr-for-netbsd7.rst +++ b/doc/developer/building-frr-for-netbsd7.rst @@ -55,7 +55,6 @@ an example) export CPPFLAGS="-I/usr/pkg/include" ./configure \ --sysconfdir=/usr/pkg/etc/frr \ - --enable-exampledir=/usr/pkg/share/examples/frr \ --enable-pkgsrcrcdir=/usr/pkg/share/examples/rc.d \ --localstatedir=/var/run/frr \ --enable-multipath=64 \ diff --git a/doc/developer/include-compile.rst b/doc/developer/include-compile.rst index 0ff0ae3ffe..d9fa260221 100644 --- a/doc/developer/include-compile.rst +++ b/doc/developer/include-compile.rst @@ -15,7 +15,6 @@ obtained by running ``./configure -h``. The options shown below are examples. ./configure \ --prefix=/usr \ --includedir=\${prefix}/include \ - --enable-exampledir=\${prefix}/share/doc/frr/examples \ --bindir=\${prefix}/bin \ --sbindir=\${prefix}/lib/frr \ --libdir=\${prefix}/lib/frr \ diff --git a/doc/developer/topotests.rst b/doc/developer/topotests.rst index ba03aa9045..18317cd33c 100644 --- a/doc/developer/topotests.rst +++ b/doc/developer/topotests.rst @@ -221,7 +221,6 @@ for ``master`` branch: --prefix=/usr/lib/frr --sysconfdir=/etc/frr \ --localstatedir=/var/run/frr \ --sbindir=/usr/lib/frr --bindir=/usr/lib/frr \ - --enable-exampledir=/usr/lib/frr/examples \ --with-moduledir=/usr/lib/frr/modules \ --enable-multipath=0 --enable-rtadv \ --enable-tcp-zebra --enable-fpm --enable-pimd \ diff --git a/doc/user/basic.rst b/doc/user/basic.rst index 6a0249f316..16708adb50 100644 --- a/doc/user/basic.rst +++ b/doc/user/basic.rst @@ -66,10 +66,6 @@ Basic Config Commands Set domainname of the router. It is only for current ``vtysh``, it will not be saved to any configuration file even with ``write file``. -.. clicmd:: domainname DOMAINNAME - - Set domainname of the router. - .. clicmd:: password PASSWORD Set password for vty interface. The ``no`` form of the command deletes the @@ -80,6 +76,39 @@ Basic Config Commands Set enable password. The ``no`` form of the command deletes the enable password. +.. clicmd:: service cputime-stats + + Collect CPU usage statistics for individual FRR event handlers and CLI + commands. This is enabled by default and can be disabled if the extra + overhead causes a noticeable slowdown on your system. + + Disabling these statistics will also make the + :clicmd:`service cputime-warning (1-4294967295)` limit non-functional. + +.. clicmd:: service cputime-warning (1-4294967295) + + Warn if the CPU usage of an event handler or CLI command exceeds the + specified limit (in milliseconds.) Such warnings are generally indicative + of some routine in FRR mistakenly blocking/hogging the processing loop and + should be reported as a FRR bug. + + The default limit is 5 seconds (i.e. 5000), but this can be changed by the + deprecated ``--enable-time-check=...`` compile-time option. + + This command has no effect if :clicmd:`service cputime-stats` is disabled. + +.. clicmd:: service walltime-warning (1-4294967295) + + Warn if the total wallclock time spent handling an event or executing a CLI + command exceeds the specified limit (in milliseconds.) This includes time + spent waiting for I/O or other tasks executing and may produce excessive + warnings if the system is overloaded. (This may still be useful to + provide an immediate sign that FRR is not operating correctly due to + externally caused starvation.) + + The default limit is 5 seconds as above, including the same deprecated + ``--enable-time-check=...`` compile-time option. + .. clicmd:: log trap LEVEL These commands are deprecated and are present only for historical diff --git a/doc/user/bgp.rst b/doc/user/bgp.rst index 7f23f7a633..b5950538dd 100644 --- a/doc/user/bgp.rst +++ b/doc/user/bgp.rst @@ -1597,16 +1597,67 @@ Configuring Peers .. clicmd:: bgp default ipv4-unicast - This command allows the user to specify that v4 peering is turned - on by default or not. This command defaults to on and is not displayed. + This command allows the user to specify that the IPv4 Unicast address + family is turned on by default or not. This command defaults to on + and is not displayed. The `no bgp default ipv4-unicast` form of the command is displayed. +.. clicmd:: bgp default ipv4-multicast + + This command allows the user to specify that the IPv4 Multicast address + family is turned on by default or not. This command defaults to off + and is not displayed. + The `bgp default ipv4-multicast` form of the command is displayed. + +.. clicmd:: bgp default ipv4-vpn + + This command allows the user to specify that the IPv4 MPLS VPN address + family is turned on by default or not. This command defaults to off + and is not displayed. + The `bgp default ipv4-vpn` form of the command is displayed. + +.. clicmd:: bgp default ipv4-flowspec + + This command allows the user to specify that the IPv4 Flowspec address + family is turned on by default or not. This command defaults to off + and is not displayed. + The `bgp default ipv4-flowspec` form of the command is displayed. + .. clicmd:: bgp default ipv6-unicast - This command allows the user to specify that v6 peering is turned - on by default or not. This command defaults to off and is not displayed. + This command allows the user to specify that the IPv6 Unicast address + family is turned on by default or not. This command defaults to off + and is not displayed. The `bgp default ipv6-unicast` form of the command is displayed. +.. clicmd:: bgp default ipv6-multicast + + This command allows the user to specify that the IPv6 Multicast address + family is turned on by default or not. This command defaults to off + and is not displayed. + The `bgp default ipv6-multicast` form of the command is displayed. + +.. clicmd:: bgp default ipv6-vpn + + This command allows the user to specify that the IPv6 MPLS VPN address + family is turned on by default or not. This command defaults to off + and is not displayed. + The `bgp default ipv6-vpn` form of the command is displayed. + +.. clicmd:: bgp default ipv6-flowspec + + This command allows the user to specify that the IPv6 Flowspec address + family is turned on by default or not. This command defaults to off + and is not displayed. + The `bgp default ipv6-flowspec` form of the command is displayed. + +.. clicmd:: bgp default l2vpn-evpn + + This command allows the user to specify that the L2VPN EVPN address + family is turned on by default or not. This command defaults to off + and is not displayed. + The `bgp default l2vpn-evpn` form of the command is displayed. + .. clicmd:: bgp default show-hostname This command shows the hostname of the peer in certain BGP commands @@ -2727,10 +2778,12 @@ Host1 MAC/IP as type-2 route which is used to resolve host1 gateway IP. PE2 receives this type-5 route and imports it into the vrf based on route targets. BGP prefix imported into the vrf uses gateway IP as its BGP nexthop. This route is installed into zebra if following conditions are satisfied: + 1. Gateway IP nexthop is L3 reachable. 2. PE2 has received EVPN type-2 route with IP field set to gateway IP. Topology requirements: + 1. This feature is supported for asymmetric routing model only. While sending packets to SN1, ingress PE (PE2) performs routing and egress PE (PE1) performs only bridging. @@ -2749,8 +2802,7 @@ route with gateway IP. 1. CLI to add gateway IP while generating EVPN type-5 route from a BGP IPv4/IPv6 prefix: -.. index:: advertise <ipv4|ipv6> unicast [gateway-ip] -.. clicmd:: [no] advertise <ipv4|ipv6> unicast [gateway-ip] +.. clicmd:: advertise <ipv4|ipv6> unicast [gateway-ip] When this CLI is configured for a BGP vrf under L2VPN EVPN address family, EVPN type-5 routes are generated for BGP prefixes in the vrf. Nexthop of the BGP @@ -2761,8 +2813,7 @@ routes are generated without overlay index. 2. Add gateway IP to EVPN type-5 route using a route-map: -.. index:: set evpn gateway-ip <ipv4|ipv6> <addr> -.. clicmd:: [no] set evpn gateway-ip <ipv4|ipv6> <addr> +.. clicmd:: set evpn gateway-ip <ipv4|ipv6> <addr> When route-map with above set clause is applied as outbound policy in BGP, it will set the gateway-ip in EVPN type-5 NLRI. @@ -2786,8 +2837,7 @@ A PE that receives a type-5 route with gateway IP overlay index should have "enable-resolve-overlay-index" configuration enabled to recursively resolve the overlay index nexthop and install the prefix into zebra. -.. index:: enable-resolve-overlay-index -.. clicmd:: [no] enable-resolve-overlay-index +.. clicmd:: enable-resolve-overlay-index Example configuration: diff --git a/doc/user/installation.rst b/doc/user/installation.rst index f7e45a6231..63254555d9 100644 --- a/doc/user/installation.rst +++ b/doc/user/installation.rst @@ -199,6 +199,10 @@ options from the list below. .. option:: --enable-datacenter + This option is deprecated as it is superseded by the `-F` (profile) command + line option which allows adjusting the setting at startup rather than + compile time. + Enable system defaults to work as if in a Data Center. See defaults.h for what is changed by this configure option. @@ -343,20 +347,17 @@ options from the list below. .. option:: --enable-time-check XXX - When this is enabled with a XXX value in microseconds, any thread that - runs for over this value will cause a warning to be issued to the log. - If you do not specify any value or don't include this option then - the default time is 5 seconds. If --disable-time-check is specified - then no warning is issued for any thread run length. + This option is deprecated as it was replaced by the + :clicmd:`service cputime-stats` CLI command, which may be adjusted at + runtime rather than being a compile-time setting. See there for further + detail. .. option:: --disable-cpu-time - Disable cpu process accounting, this command also disables the `show thread cpu` - command. If this option is disabled, --enable-time-check is ignored. This - disabling of cpu time effectively means that the getrusage call is skipped. - Since this is a process switch into the kernel, systems with high FRR - load might see improvement in behavior. Be aware that `show thread cpu` - is considered a good data gathering tool from the perspective of developers. + This option is deprecated as it was replaced by the + :clicmd:`service cputime-warning NNN` CLI command, which may be adjusted at + runtime rather than being a compile-time setting. See there for further + detail. .. option:: --enable-pcreposix @@ -561,7 +562,6 @@ the options you chose: ./configure \ --prefix=/usr \ - --enable-exampledir=/usr/share/doc/frr/examples/ \ --localstatedir=/var/run/frr \ --sbindir=/usr/lib/frr \ --sysconfdir=/etc/frr \ diff --git a/doc/user/ipv6.rst b/doc/user/ipv6.rst index 089fae39b1..4f01061e7b 100644 --- a/doc/user/ipv6.rst +++ b/doc/user/ipv6.rst @@ -17,6 +17,11 @@ no longer possible. Router Advertisement ==================== +.. clicmd:: show ipv6 nd ra-interfaces [vrf <VRFNAME|all>] + + Show configured route advertisement interfaces. VRF subcommand only + applicable for netns-based vrfs. + .. clicmd:: ipv6 nd suppress-ra Don't send router advertisement messages. The ``no`` form of this command diff --git a/doc/user/ospf6d.rst b/doc/user/ospf6d.rst index 7c01b6f136..04ee1643d8 100644 --- a/doc/user/ospf6d.rst +++ b/doc/user/ospf6d.rst @@ -77,20 +77,26 @@ OSPF6 router of packets to process before returning. The default value of this parameter is 20. +.. clicmd:: clear ipv6 ospf6 process [vrf NAME] + + This command clears up the database and routing tables and resets the + neighborship by restarting the interface state machine. This will be + helpful when there is a change in router-id and if user wants the router-id + change to take effect, user can use this cli instead of restarting the + ospf6d daemon. .. _ospf6-area: OSPF6 area ========== -.. index:: [no] area A.B.C.D nssa -.. clicmd:: [no] area A.B.C.D nssa +.. clicmd:: area A.B.C.D nssa NSSA Support in OSPFv3 ======================= The configuration of NSSA areas in OSPFv3 is supported using the CLI command -area A.B.C.D nssa in ospf6 router configuration mode. +``area A.B.C.D nssa`` in ospf6 router configuration mode. The following functionalities are implemented as per RFC 3101: 1. Advertising Type-7 LSA into NSSA area when external route is redistributed @@ -98,7 +104,7 @@ The following functionalities are implemented as per RFC 3101: 2. Processing Type-7 LSA received from neighbor and installing route in the route table 3. Support for NSSA ABR functionality which is generating Type-5 LSA when - backbone area is configured. Currently translation od TYpe-7 LSA to Type-5 LSA + backbone area is configured. Currently translation of Type-7 LSA to Type-5 LSA is enabled by default. 4. Support for NSSA Translator functionality when there are multiple NSSA ABR in an area diff --git a/doc/user/ospfd.rst b/doc/user/ospfd.rst index 692ce8c1b2..8d67ec865f 100644 --- a/doc/user/ospfd.rst +++ b/doc/user/ospfd.rst @@ -80,11 +80,13 @@ Routers To start OSPF process you have to specify the OSPF router. -.. clicmd:: router ospf [(1-65535)] vrf NAME +.. clicmd:: router ospf [{(1-65535)|vrf NAME}] Enable or disable the OSPF process. + Multiple instances don't support `vrf NAME`. + .. clicmd:: ospf router-id A.B.C.D diff --git a/doc/user/zebra.rst b/doc/user/zebra.rst index ee9da63445..3654801100 100644 --- a/doc/user/zebra.rst +++ b/doc/user/zebra.rst @@ -647,7 +647,6 @@ 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. -.. index:: show segment-routing srv6 locator [json] .. clicmd:: show segment-routing srv6 locator [json] This command dump SRv6-locator configured on zebra. SRv6-locator is used @@ -666,7 +665,6 @@ and this section also helps that case. loc1 1 2001:db8:1:1::/64 Up loc2 2 2001:db8:2:2::/64 Up -.. index:: show segment-routing srv6 locator NAME detail [json] .. clicmd:: show segment-routing srv6 locator NAME detail [json] As shown in the example, by specifying the name of the locator, you @@ -696,29 +694,24 @@ and this section also helps that case. Chunks: - prefix: 2001:db8:2:2::/64, owner: sharp -.. index:: segment-routing .. clicmd:: segment-routing Move from configure mode to segment-routing node. -.. index:: srv6 .. clicmd:: srv6 Move from segment-routing node to srv6 node. -.. index:: locators .. clicmd:: locators Move from srv6 node to locator node. In this locator node, user can configure detailed settings such as the actual srv6 locator. -.. index:: locator NAME .. clicmd:: locator NAME Create a new locator. If the name of an existing locator is specified, move to specified locator's configuration node to change the settings it. -.. index:: prefix X:X::X:X/M [function-bits-length 32] .. clicmd:: prefix X:X::X:X/M [function-bits-length 32] Set the ipv6 prefix block of the locator. SRv6 locator is defined by |