Format reference directives and roles to match best practices.
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
-.. _Babel:
+.. _babel:
*****
Babel
FRR implements Babel as described in :rfc:`6126`.
-.. _Configuring_babeld:
+.. _configuring-babeld:
Configuring babeld
==================
The *babeld* daemon can be invoked with any of the common
-options (:ref:`Common_Invocation_Options`).
+options (:ref:`common-invocation-options`).
The *zebra* daemon must be running before *babeld* is
invoked. Also, if *zebra* is restarted then *babeld*
Configuration of *babeld* is done in its configuration file
:file:`babeld.conf`.
-.. _Babel_configuration:
+.. _babel-configuration:
Babel configuration
===================
of very slightly increasing convergence time. The value 0 disables
hysteresis, and is suitable for wired networks. The default is 4 s.
-.. _Babel_redistribution:
+.. _babel-redistribution:
Babel redistribution
====================
Specify which kind of routes should be redistributed into Babel.
-.. _Show_Babel_information:
+.. _show-babel-information:
Show Babel information
======================
-.. _Basic_commands:
+.. _basic-commands:
**************
Basic commands
The following sections discuss commands common to all the routing
daemons.
-.. _Config_Commands:
+.. _config-commands:
Config Commands
===============
:file:`zebra.conf`. You can specify a config file using the :option:`-f` or
:option:`--config-file` options when starting the daemon.
-.. _Basic_Config_Commands:
+.. _basic-config-commands:
Basic Config Commands
---------------------
Restrict vty connections with an access list.
-.. _Sample_Config_File:
+.. _sample-config-file:
Sample Config File
------------------
normal character. So in the above example '!' will not be regarded as a
comment and the password is set to 'zebra!password'.
-.. _Terminal_Mode_Commands:
+.. _terminal-mode-commands:
Terminal Mode Commands
======================
Send a message to all logging destinations that are enabled for messages
of the given severity.
-.. _Common_Invocation_Options:
+.. _common-invocation-options:
Common Invocation Options
=========================
Print program version.
-.. _Loadable_Module_Support:
+.. _loadable-module-support:
Loadable Module Support
=======================
the ``snmp`` module can be loaded for the *zebra*, *bgpd*, *ospfd*, *ospf6d*
and *ripd* daemons.
-The module ignores any options passed to it. Refer to :ref:`SNMP_Support`
+The module ignores any options passed to it. Refer to :ref:`snmp-support`
for information on its usage.
The FPM Module
The module expects its argument to be either ``netlink`` or ``protobuf``,
specifying the encapsulation to use. ``netlink`` is the default, and
``protobuf`` may not be available if the module was built without protobuf
-support. Refer to :ref:`zebra_FIB_push_interface` for more information.
+support. Refer to :ref:`zebra-fib-push-interface` for more information.
-.. _Virtual_Terminal_Interfaces:
+.. _virtual-terminal-interfaces:
Virtual Terminal Interfaces
===========================
VTY -- Virtual Terminal [aka TeletYpe] Interface is a command line
interface (CLI) for user interaction with the routing daemon.
-.. _VTY_Overview:
+.. _vty-overview:
VTY Overview
------------
:kbd:`?` and the ``find`` command are very useful for looking up commands.
-.. _VTY_Modes:
+.. _vty-modes:
VTY Modes
---------
There are commands that may be restricted to specific VTY modes.
-.. _VTY_View_Mode:
+.. _vty-view-mode:
VTY View Mode
^^^^^^^^^^^^^
This mode is for read-only access to the CLI. One may exit the mode by
leaving the system, or by entering `enable` mode.
-.. _VTY_Enable_Mode:
+.. _vty-enable-mode:
VTY Enable Mode
^^^^^^^^^^^^^^^
This mode is for read-write access to the CLI. One may exit the mode by
leaving the system, or by escaping to view mode.
-.. _VTY_Other_Modes:
+.. _vty-other-modes:
VTY Other Modes
^^^^^^^^^^^^^^^
This page is for describing other modes.
-.. _VTY_CLI_Commands:
+.. _vty-cli-commands:
VTY CLI Commands
----------------
Commands that you may use at the command-line are described in the following
three subsubsections.
-.. _CLI_Movement_Commands:
+.. _cli-movement-commands:
CLI Movement Commands
^^^^^^^^^^^^^^^^^^^^^
Move to the end of the line.
-.. _CLI_Editing_Commands:
+.. _cli-editing-commands:
CLI Editing Commands
^^^^^^^^^^^^^^^^^^^^
-.. _BGP:
+.. _bgp:
***
BGP
Many extensions have been added to :rfc:`1771`. :rfc:`2858` provides
multiprotocol support to BGP-4.
-.. _Starting_BGP:
+.. _starting-bgp:
Starting BGP
============
command must be configured in :file:`bgpd.conf`.
*bgpd* specific invocation options are described below. Common options may also
-be specified (:ref:`Common_Invocation_Options`).
+be specified (:ref:`common-invocation-options`).
.. program:: bgpd
to an internal address, or to run multiple bgpd processes on one host.
-.. _BGP_router:
+.. _bgp-router:
BGP router
==========
Enable a BGP protocol process with the specified ASN. After
this statement you can input any `BGP Commands`. You can not
create different BGP process under different ASN without
- specifying `multiple-instance` (:ref:`Multiple_instance`).
+ specifying `multiple-instance` (:ref:`multiple-instance`).
.. index:: no router bgp ASN
.. clicmd:: no router bgp ASN
not enabled *bgpd* can't get interface information so `router-id` is set to
0.0.0.0. So please set router-id by hand.
-.. _BGP_distance:
+.. _bgp-distance:
BGP distance
------------
.. index:: distance (1-255) A.B.C.D/M word
.. clicmd:: distance (1-255) A.B.C.D/M word
-.. _BGP_decision_process:
+.. _bgp-decision-process:
BGP decision process
--------------------
6. MED check
Where routes with a MED were received from the same AS, prefer the route
- with the lowest MED. :ref:`BGP_MED`.
+ with the lowest MED. :ref:`bgp-med`.
7. External check
If multi-pathing is enabled, then check whether the routes not yet
distinguished in preference may be considered equal. If
- :ref:`bgp_bestpath_as-path_multipath-relax` is set, all such routes are
+ :ref:`bgp-bestpath-as-path-multipath-relax` is set, all such routes are
considered equal, otherwise routes received via iBGP with identical AS_PATHs
or routes received from eBGP neighbours in the same AS are considered equal.
Where both routes were received from eBGP peers, then prefer the route
which is already selected. Note that this check is not applied if
- :ref:`bgp_bestpath_compare-routerid` is configured. This check can prevent
+ :ref:`bgp-bestpath-compare-routerid` is configured. This check can prevent
some cases of oscillation.
11. Router-ID check
sequences should should be taken into account during the BGP best path
decision process.
-.. _bgp_bestpath_as-path_multipath-relax:
+.. _bgp-bestpath-as-path-multipath-relax:
.. index:: bgp bestpath as-path multipath-relax
.. clicmd:: bgp bestpath as-path multipath-relax
of equal AS_PATH length candidates for multipath computation. Without
the knob, the entire AS_PATH must match for multipath computation.
-.. _bgp_bestpath_compare-routerid:
+.. _bgp-bestpath-compare-routerid:
.. clicmd:: bgp bestpath compare-routerid
Ensure that when comparing routes where both are equal on most metrics,
sensitive to the iBGP and reflection topology.
-.. _BGP_route_flap_dampening:
+.. _bgp-route-flap-dampening:
BGP route flap dampening
------------------------
`http://www.ripe.net/ripe/docs/ripe-378,,RIPE-378 <http://www.ripe.net/ripe/docs/ripe-378,,RIPE-378>`_
-.. _BGP_MED:
+.. _bgp-med:
BGP MED
=======
This first issue can be fixed with a more deterministic route selection that
ensures routes are ordered by the neighbouring AS during selection.
-:ref:`bgp_deterministic-med`. This may reduce the number of updates as routes
+:ref:`bgp-deterministic-med`. This may reduce the number of updates as routes
are received, and may in some cases reduce routing churn. Though, it could
equally deterministically produce the largest possible set of updates in
response to the most common sequence of received updates.
choosing to update to new a route based on a post-MED metric (e.g. router-ID),
at the cost of a non-deterministic selection process. FRR implements this, as
do many other implementations, so long as it is not overridden by setting
-:ref:`bgp_bestpath_compare-routerid`, and see also :ref:`BGP_decision_process`,
+:ref:`bgp-bestpath-compare-routerid`, and see also :ref:`bgp-decision-process`,
.
However, more complex and insidious cycles of oscillation are possible with
paper above for an example. Hence the guideline that the iBGP topology should
follow the IGP topology.
-.. _bgp_deterministic-med:
+.. _bgp-deterministic-med:
.. index:: bgp deterministic-med
.. clicmd:: bgp deterministic-med
Note that there are other sources of indeterminism in the route selection
process, specifically, the preference for older and already selected routes
-from eBGP peers, :ref:`BGP_decision_process`.
+from eBGP peers, :ref:`bgp-decision-process`.
-.. _bgp_always-compare-med:
+.. _bgp-always-compare-med:
.. index:: bgp always-compare-med
.. clicmd:: bgp always-compare-med
oscillations.
If using this option, it may also be desirable to use
- :ref:`routemap_set_metric` to set MED to 0 on routes received from external
+ :ref:`routemap-set-metric` to set MED to 0 on routes received from external
neighbours.
- This option can be used, together with :ref:`routemap_set_metric` to use MED
+ This option can be used, together with :ref:`routemap-set-metric` to use MED
as an intra-AS metric to steer equal-length AS_PATH routes to, e.g., desired
exit points.
-.. _BGP_network:
+.. _bgp-network:
BGP network
===========
-.. _BGP_route:
+.. _bgp-route:
BGP route
---------
.. clicmd:: no network A.B.C.D/M
-.. _Route_Aggregation:
+.. _route-aggregation:
Route Aggregation
-----------------
-.. _Redistribute_to_BGP:
+.. _redistribute-to-bgp:
Redistribute to BGP
-------------------
Supported for ipv4 and ipv6 address families. It works on multi-paths as
well, however, metric setting is based on the best-path only.
-.. _BGP_Peer:
+.. _bgp-peer:
BGP Peer
========
-.. _Defining_Peer:
+.. _defining-peer:
Defining Peer
-------------
can't find neighbor 10.0.0.1
-.. _BGP_Peer_commands:
+.. _bgp-peer-commands:
BGP Peer commands
-----------------
specified number of hops away will be allowed to become neighbors. This
command is mututally exclusive with *ebgp-multihop*.
-.. _Peer_filtering:
+.. _peer-filtering:
Peer filtering
--------------
on reflected routes. This option allows the modifications to be reflected as
well. Once enabled, it affects all reflected routes.
-.. _BGP_Peer_Group:
+.. _bgp-peer-group:
BGP Peer Group
==============
This command bind specific peer to peer group WORD.
-.. _BGP_Address_Family:
+.. _bgp-address-family:
BGP Address Family
==================
Print a summary of neighbor connections for the specified AFI/SAFI combination.
-.. _Autonomous_System:
+.. _autonomous-system:
Autonomous System
=================
numbers 64512 through 65535 are defined as private AS numbers. Private AS
numbers must not to be advertised in the global Internet.
-.. _Display_BGP_Routes_by_AS_Path:
+.. _display-bgp-routes-by-as-path:
Display BGP Routes by AS Path
-----------------------------
.. clicmd:: show bgp ipv4|ipv6 regexp LINE
This commands displays BGP routes that matches a regular
- expression `line` (:ref:`BGP_Regular_Expressions`).
+ expression `line` (:ref:`bgp-regular-expressions`).
-.. _AS_Path_Access_List:
+.. _as-path-access-list:
AS Path Access List
-------------------
.. index:: no ip as-path access-list WORD permit|deny LINE
.. clicmd:: no ip as-path access-list WORD permit|deny LINE
-.. _Using_AS_Path_in_Route_Map:
+.. _using-as-path-in-route-map:
Using AS Path in Route Map
--------------------------
Prepend the existing last AS number (the leftmost ASN) to the AS_PATH.
-.. _Private_AS_Numbers:
+.. _private-as-numbers:
Private AS Numbers
------------------
-.. _BGP_Communities_Attribute:
+.. _bgp-communities-attribute:
BGP Communities Attribute
=========================
communities attribute is ignored and each communities values are sorted in
numerical order.
-.. _BGP_Community_Lists:
+.. _bgp-community-lists:
BGP Community Lists
-------------------
This command defines a new expanded community list. COMUNITY is a
string expression of communities attribute. COMUNITY can be a
- regular expression (:ref:`BGP_Regular_Expressions`) to match
+ regular expression (:ref:`bgp-regular-expressions`) to match
the communities attribute in BGP updates.
.. index:: no ip community-list NAME
deny internet
-.. _Numbered_BGP_Community_Lists:
+.. _numbered-bgp-community-lists:
Numbered BGP Community Lists
----------------------------
Otherwise it is defined as an expanded community list. This feature is left
for backward compability. Use of this feature is not recommended.
-.. _BGP_Community_in_Route_Map:
+.. _bgp-community-in-route-map:
BGP Community in Route Map
--------------------------
-In Route Map (:ref:`Route_Map`), we can match or set BGP
+In Route Map (:ref:`route-map`), we can match or set BGP
communities attribute. Using this feature network operator can
implement their network policy based on BGP communities attribute.
is removed. When all of communities value is removed eventually, the
BGP update's communities attribute is completely removed.
-.. _Display_BGP_Routes_by_Community:
+.. _display-bgp-routes-by-community:
Display BGP Routes by Community
-------------------------------
community list `word`. When `exact-match` is specified, display only
routes that have an exact match.
-.. _Using_BGP_Communities_Attribute:
+.. _using-bgp-communities-attribute:
Using BGP Communities Attribute
-------------------------------
set comm-list DEL delete
-.. _BGP_Extended_Communities_Attribute:
+.. _bgp-extended-communities-attribute:
BGP Extended Communities Attribute
==================================
`VAL` part is 2 octets Local Administrator subfield.
`10.0.0.1:100` represents
-.. _BGP_Extended_Community_Lists:
+.. _bgp-extended-community-lists:
BGP Extended Community Lists
----------------------------
This command defines a new expanded extcommunity-list. `line` is
a string expression of extended communities attribute. `line` can
- be a regular expression (:ref:`BGP_Regular_Expressions`) to match an
+ be a regular expression (:ref:`bgp-regular-expressions`) to match an
extended communities attribute in BGP updates.
.. index:: no ip extcommunity-list NAME
# show ip extcommunity-list
-.. _BGP_Extended_Communities_in_Route_Map:
+.. _bgp-extended-communities-in-route-map:
BGP Extended Communities in Route Map
-------------------------------------
This command set Site of Origin value.
-.. _BGP_Large_Communities_Attribute:
+.. _bgp-large-communities-attribute:
BGP Large Communities Attribute
===============================
function 1 and parameter 10.
The referenced RFC above gives some guidelines on recommended usage.
-.. _BGP_Large_Community_Lists:
+.. _bgp-large-community-lists:
BGP Large Community Lists
-------------------------
This command displays the current large communities in use.
-.. _BGP_Large_Communities_in_Route_Map:
+.. _bgp-large-communities-in-route-map:
BGP Large Communities in Route Map
----------------------------------
large-community list. The third will add a large-community value without
overwriting other values. Multiple large-community values can be specified.
-.. _Displaying_BGP_information:
+.. _displaying-bgp-information:
Displaying BGP information
==========================
-.. _Showing_BGP_information:
+.. _showing-bgp-information:
Showing BGP information
-----------------------
.. clicmd:: show ip bgp regexp LINE
This command displays BGP routes using AS path regular expression
- (:ref:`BGP_Regular_Expressions`).
+ (:ref:`bgp-regular-expressions`).
.. index:: show ip bgp community COMMUNITY
.. clicmd:: show ip bgp community COMMUNITY
.. index:: show ip bgp community COMMUNITY exact-match
.. clicmd:: show ip bgp community COMMUNITY exact-match
- This command displays BGP routes using `community` (:ref:`Display_BGP_Routes_by_Community`).
+ This command displays BGP routes using `community` (:ref:`display-bgp-routes-by-community`).
.. index:: show ip bgp community-list WORD
.. clicmd:: show ip bgp community-list WORD
.. index:: show ip bgp community-list WORD exact-match
.. clicmd:: show ip bgp community-list WORD exact-match
- This command displays BGP routes using community list (:ref:`Display_BGP_Routes_by_Community`).
+ This command displays BGP routes using community list (:ref:`display-bgp-routes-by-community`).
.. index:: show bgp ipv4|ipv6 summary
.. clicmd:: show bgp ipv4|ipv6 summary
Display flap statistics of routes.
-.. _Other_BGP_commands:
+.. _other-bgp-commands:
Other BGP commands
------------------
.. clicmd:: no debug keepalive
-.. _Capability_Negotiation:
+.. _capability-negotiation:
Capability Negotiation
======================
Override the result of Capability Negotiation with local configuration.
Ignore remote peer's capability value.
-.. _Route_Reflector:
+.. _route-reflector:
Route Reflector
===============
.. clicmd:: no neighbor PEER route-reflector-client
-.. _Route_Server:
+.. _route-server:
Route Server
============
tables as different "views". *bgpd* can work as normal BGP router or Route
Server or both at the same time.
-.. _Multiple_instance:
+.. _multiple-instance:
Multiple instance
-----------------
FRR style BGP configuration. This is default.
-.. _BGP_instance_and_view:
+.. _bgp-instance-and-view:
BGP instance and view
---------------------
neighbor 10.0.0.4 remote-as 5
-.. _Routing_policy:
+.. _routing-policy:
Routing policy
--------------
applied. On the other hand, when the update is inserted into view 2,
distribute-list 2 is applied.
-.. _Viewing_the_view:
+.. _viewing-the-view:
Viewing the view
----------------
Display routing table of BGP view ``NAME``.
-.. _BGP_Regular_Expressions:
+.. _bgp-regular-expressions:
BGP Regular Expressions
=======================
the end of the line. So `_` can be used for AS value boundaries match. This
character technically evaluates to `(^|[,{}() ]|$)`.
-.. _How_to_set_up_a_6-Bone_connection:
+.. _How-to-set-up-a-6-Bone-connection:
How to set up a 6-Bone connection
=================================
!
-.. _Dump_BGP_packets_and_table:
+.. _dump-bgp-packets-and-table:
Dump BGP packets and table
==========================
Dump all BGP packet and events to `path` file.
If `interval` is set, a new file will be created for echo `interval` of seconds.
The path `path` can be set with date and time formatting (strftime).
- The type ‘all-et’ enables support for Extended Timestamp Header (:ref:`Packet_Binary_Dump_Format`).
- (:ref:`Packet_Binary_Dump_Format`)
+ The type ‘all-et’ enables support for Extended Timestamp Header (:ref:`packet-binary-dump-format`).
+ (:ref:`packet-binary-dump-format`)
.. index:: dump bgp updates PATH [INTERVAL]
.. clicmd:: dump bgp updates PATH [INTERVAL]
Dump only BGP updates messages to `path` file.
If `interval` is set, a new file will be created for echo `interval` of seconds.
The path `path` can be set with date and time formatting (strftime).
- The type ‘updates-et’ enables support for Extended Timestamp Header (:ref:`Packet_Binary_Dump_Format`).
+ The type ‘updates-et’ enables support for Extended Timestamp Header (:ref:`packet-binary-dump-format`).
.. index:: dump bgp routes-mrt PATH
.. clicmd:: dump bgp routes-mrt PATH
set community additive 64512:3200
-.. _Configuring_FRR_as_a_Route_Server:
+.. _configuring-frr-as-a-route-server:
Configuring FRR as a Route Server
=================================
-.. _EIGRP:
+.. _eigrp:
*****
EIGRP
*eigrpd* supports EIGRP as described in RFC7868
-.. _Starting_and_Stopping_eigrpd:
+.. _starting-and-stopping-eigrpd:
Starting and Stopping eigrpd
============================
*eigrpd* invocation options. Common options that can be specified
-(:ref:`Common_Invocation_Options`).
+(:ref:`common-invocation-options`).
.. program:: eigrpd
When the program terminates, retain routes added by *eigrpd*.
-.. _EIGRP_Configuration:
+.. _eigrp-configuration:
EIGRP Configuration
===================
The default is to be passive on all interfaces.
-.. _How_to_Announce_EIGRP_route:
+.. _how-to-announce-eigrp-route:
How to Announce EIGRP route
===========================
`redistribute bgp` redistributes routing information from bgp route entries
into the EIGRP tables. `no redistribute bgp` disables the routes.
-.. _Show_EIGRP_Information:
+.. _show-eigrp-information:
Show EIGRP Information
======================
.. index:: no ip prefix-list NAME
.. clicmd:: no ip prefix-list NAME
-.. _ip_prefix-list_description:
+.. _ip-prefix-list-description:
ip prefix-list description
--------------------------
Deletes the description from a prefix list. It is possible to use the
command without the full description.
-.. _ip_prefix-list_sequential_number_control:
+.. _ip-prefix-list-sequential-number-control:
ip prefix-list sequential number control
----------------------------------------
With this command, the IP prefix list sequential number is not
displayed.
-.. _Showing_ip_prefix-list:
+.. _Showing-ip-prefix-list:
Showing ip prefix-list
----------------------
-.. _Installation:
+.. _installation:
************
Installation
$ make install
-.. _Configure_the_Software:
+.. _configure-the-software:
Configure the Software
======================
-.. _The_Configure_Script:
+.. _the-configure-script:
The Configure Script
--------------------
Configure zebra to use `dir` for local state files, such as pid files and
unix sockets.
-.. _Least-Privilege_support:
+.. _Least-Privilege-support:
Least-Privilege Support
-----------------------
raise these capabilities for brief periods. On systems without libcap, FRR will
run as the user specified and only raise its UID to 0 for brief periods.
-.. _Linux_Notes:
+.. _linux-notes:
Linux Notes
-----------
- :makevar:`CONFIG_NETLINK`
Kernel/User netlink socket. This is a brand new feature which enables an
- advanced interface between the Linux kernel and zebra (:ref:`Kernel_Interface`).
+ advanced interface between the Linux kernel and zebra (:ref:`kernel-interface`).
- :makevar:`CONFIG_RTNETLINK`
Routing messages.
This makes it possible to receive netlink routing messages. If you
specify this option, *zebra* can detect routing information
- updates directly from the kernel (:ref:`Kernel_Interface`).
+ updates directly from the kernel (:ref:`kernel-interface`).
- :makevar:`CONFIG_IP_MULTICAST`
IP: multicasting.
- This option should be specified when you use *ripd* (:ref:`RIP`) or
- *ospfd* (:ref:`OSPFv2`) because these protocols use multicast.
+ This option should be specified when you use *ripd* (:ref:`rip`) or
+ *ospfd* (:ref:`ospfv2`) because these protocols use multicast.
IPv6 support has been added in GNU/Linux kernel version 2.2. If you
try to use the FRR IPv6 feature on a GNU/Linux kernel, please
utility. It contains *ifconfig*, *route*, *netstat*, and other tools.
`net-tools` may be found at http://www.tazenda.demon.co.uk/phil/net-tools/.
-.. _Build_the_Software:
+.. _build-the-software:
Build the Software
==================
Simply issue the command *make* in the root of the source directory and the
software will be compiled. Cliff Notes versions of different compilation
examples can be found in the Developer's Manual Appendix. If you have *any*
-problems at this stage, please send a bug report :ref:`Bug-Reports`.
+problems at this stage, please send a bug report :ref:`bug-reports`.
::
needed.
You may need to make changes to the config files in
-|INSTALL_PREFIX_ETC|. :ref:`Config_Commands`.
+|INSTALL_PREFIX_ETC|. :ref:`config-commands`.
.. [#] GNU/Linux has very flexible kernel configuration features.
-.. _IPv6_Support:
+.. _IPv6-Support:
************
IPv6 Support
-.. _ISIS:
+.. _isis:
****
ISIS
like :abbr:`OSPF`. ISIS is widely used in large networks such as :abbr:`ISP
(Internet Service Provider)` and carrier backbone networks.
-.. _Configuring_isisd:
+.. _configuring-isisd:
Configuring isisd
=================
There are no *isisd* specific options. Common options can be specified
-(:ref:`Common_Invocation_Options`) to *isisd*. *isisd* needs to acquire
+(:ref:`common-invocation-options`) to *isisd*. *isisd* needs to acquire
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`.
-.. _ISIS_router:
+.. _isis-router:
ISIS router
===========
.. index:: no router isis WORD
.. clicmd:: no router isis WORD
- .. _router_isis_WORD:
+ .. _router-isis-word:
Enable or disable the ISIS process by specifying the ISIS domain with
'WORD'. *isisd* does not yet support multiple ISIS processes but you must
specify the name of ISIS process. The ISIS process name 'WORD' is then used
- for interface (see command :ref:`ip_router_isis_WORD`).
+ for interface (see command :ref:`ip-router-isis-word`).
.. index:: net XX.XXXX. ... .XXX.XX
.. clicmd:: net XX.XXXX. ... .XXX.XX
Set overload bit to avoid any transit traffic.
-.. _ISIS_Timer:
+.. _isis-timer:
ISIS Timer
==========
Set minimum interval between consecutive SPF calculations in seconds.
-.. _ISIS_region:
+.. _isis-region:
ISIS region
===========
- level-2-only
Act as an area router only
-.. _ISIS_interface:
+.. _isis-interface:
ISIS interface
==============
.. index:: no ip router isis WORD
.. clicmd:: no ip router isis WORD
-.. _ip_router_isis_WORD:
+.. _ip-router-isis-word:
Activate ISIS adjacency on this interface. Note that the name
of ISIS instance must be the same as the one used to configure the ISIS process
- (see command :ref:`router_isis_WORD`).
+ (see command :ref:`router-isis-word`).
.. index:: isis circuit-type [level-1 | level-1-2 | level-2]
.. clicmd:: isis circuit-type [level-1 | level-1-2 | level-2]
Set PSNP interval in seconds globally, for an area (level-1) or a domain
(level-2).
-.. _Showing_ISIS_information:
+.. _showing-isis-information:
Showing ISIS information
========================
:ref:`ospf-traffic-engineering`
-.. _Debugging_ISIS:
+.. _debugging-isis:
Debugging ISIS
==============
-.. _Kernel_Interface:
+.. _kernel-interface:
****************
Kernel Interface
-.. _NHRP:
+.. _nhrp:
****
NHRP
Cisco Dynamic Multipoint VPN (DMVPN) is based on NHRP, and |PACKAGE_NAME| nhrpd
implements this scenario.
-.. _Routing_Design:
+.. _routing-design:
Routing Design
==============
exit-address-family
-.. _Configuring_NHRP:
+.. _configuring-nhrp:
Configuring NHRP
================
FIXME
-.. _Hub_Functionality:
+.. _hub-functionality:
Hub Functionality
=================
interface gre1
ip nhrp redirect
-.. _Integration_with_IKE:
+.. _integration-with-ike:
Integration with IKE
====================
`http://git.alpinelinux.org/cgit/user/tteras/strongswan/log/?h=tteras,working tree <http://git.alpinelinux.org/cgit/user/tteras/strongswan/log/?h=tteras,working tree>`_
git repositories for the patches.
-.. _NHRP_Events:
+.. _nhrp-events:
NHRP Events
===========
*ospf6d* is a daemon support OSPF version 3 for IPv6 network. OSPF for IPv6 is
described in :rfc:`2740`.
-.. _OSPF6_router:
+.. _OSPF6-router:
OSPF6 router
============
This configuration setting MUST be consistent across all routers
within the OSPF domain.
-.. _OSPF6_area:
+.. _OSPF6-area:
OSPF6 area
==========
Area support for OSPFv3 is not yet implemented.
-.. _OSPF6_interface:
+.. _OSPF6-interface:
OSPF6 interface
===============
Set explicitly network type for specifed interface.
-.. _Redistribute_routes_to_OSPF6:
+.. _Redistribute-routes-to-OSPF6:
Redistribute routes to OSPF6
============================
.. clicmd:: redistribute ripng
-.. _Showing_OSPF6_information:
+.. _Showing-OSPF6-information:
Showing OSPF6 information
=========================
-.. _OSPF_Fundamentals:
+.. _ospf-fundamentals:
OSPF Fundamentals
=================
:abbr:`LSDB` s between neighbours as neighbours form adjacencies and the
propogation, or :term:`flooding` of new or updated :abbr:`LSA` s.
-:ref:`OSPF_Flooding`.
+:ref:`ospf-flooding`.
.. index:: OSPF Areas overview
- Advertising Router
- The Router ID of the router originating the LSA, see :ref:`ospf_router-id`.
+ The Router ID of the router originating the LSA, see :ref:`ospf-router-id`.
- LSA ID
The combination of the Type, ID and Advertising Router ID must uniquely
identify the :abbr:`LSA`. There can however be multiple instances of
an LSA with the same Type, LSA ID and Advertising Router ID, see
- :ref:`OSPF_LSA_sequence_number,,LSA_Sequence_Number`.
+ :ref:`ospf-lsa-sequence-number,,lsa-sequence-number`.
- Age
a router has shutdown without flushing its LSA(s), e.g. where it has
become disconnected from the network. Such LSAs do little harm.
- .. _OSPF_LSA_sequence_number:
+ .. _ospf-lsa-sequence-number:
- Sequence Number
Cost
The output cost of that interface, scaled inversely to some commonly known
- reference value, :ref:`OSPF_auto-cost_reference-bandwidth,,auto-cost_reference-bandwidth`.
+ reference value, :ref:`ospf-auto-cost-reference-bandwidth,,auto-cost-reference-bandwidth`.
Link Type
Transit Network
Stub links may also be used as a way to describe links on which OSPF is
*not* spoken, known as :term:`passive interfaces`, see
- :ref:`OSPF_passive-interface,,passive-interface`.
+ :ref:`ospf-passive-interface,,passive-interface`.
- Network LSA
most other :abbr:`LSA` s, which are flooded only within the area in
which they originate, External :abbr:`LSA` s are flooded through-out
the :abbr:`OSPF` network to all areas capable of carrying External
-:abbr:`LSA` s (:ref:`OSPF_Areas`).
+:abbr:`LSA` s (:ref:`ospf-areas`).
Routes internal to OSPF (intra-area or inter-area) are always preferred
over external routes.
=================
There are no *ospfd* specific options. Common options can be specified
-(:ref:`Common_Invocation_Options`) to *ospfd*. *ospfd* needs to acquire
+(:ref:`common-invocation-options`) to *ospfd*. *ospfd* needs to acquire
interface information from *zebra* in order to function. 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`.
-.. _OSPF_router:
+.. _ospf-router:
OSPF router
===========
.. index:: no ospf router-id
.. clicmd:: no ospf router-id
-.. _ospf_router-id:
+.. _ospf-router-id:
This sets the router-ID of the OSPF process. The
router-ID may be an IP address of the router, but need not be - it can
Note that areas with fully-adjacent virtual-links are considered to be
"transit capable" and can always be used to route backbone traffic, and
- hence are unaffected by this setting (:ref:`OSPF_virtual-link`).
+ hence are unaffected by this setting (:ref:`ospf-virtual-link`).
More information regarding the behaviour controlled by this command can
be found in :rfc:`3509`, and :t:`draft-ietf-ospf-shortcut-abr-02.txt`.
.. index:: no passive-interface INTERFACE
.. clicmd:: no passive-interface INTERFACE
-.. _ospf_passive-interface:
+.. _ospf-passive-interface:
Do not speak OSPF interface on the
given interface, but do advertise the interface as a stub link in the
allows one to advertise addresses on such connected interfaces without
having to originate AS-External/Type-5 LSAs (which have global flooding
scope) - as would occur if connected addresses were redistributed into
- OSPF (:ref:`Redistribute_routes_to_OSPF`). This is the only way to
+ OSPF (:ref:`redistribute-routes-to-ospf`). This is the only way to
advertise non-OSPF links into stub areas.
.. index:: timers throttle spf DELAY INITIAL-HOLDTIME MAX-HOLDTIME
by the `maximum-holdtime` configured with this command. If the adaptive
hold-time elapses without any SPF-triggering event occuring then
the current holdtime is reset to the `initial-holdtime`. The current
- holdtime can be viewed with :ref:`show_ip_ospf`, where it is expressed as
+ holdtime can be viewed with :ref:`show-ip-ospf`, where it is expressed as
a multiplier of the `initial-holdtime`.
::
Configured state of this feature as well as current status, such as the
number of second remaining till on-startup or on-shutdown ends, can be
- viewed with the :ref:`show_ip_ospf` command.
+ viewed with the :ref:`show-ip-ospf` command.
.. index:: auto-cost reference-bandwidth (1-4294967)
.. clicmd:: auto-cost reference-bandwidth (1-4294967)
.. index:: no auto-cost reference-bandwidth
.. clicmd:: no auto-cost reference-bandwidth
-.. _OSPF_auto-cost_reference-bandwidth:
+.. _OSPF-auto-cost-reference-bandwidth:
This sets the reference
bandwidth for cost calculations, where this bandwidth is considered
.. index:: no network A.B.C.D/M area (0-4294967295)
.. clicmd:: no network A.B.C.D/M area (0-4294967295)
-.. _OSPF_network_command:
+.. _ospf-network-command:
This command specifies the OSPF enabled interface(s). If the interface has
an address from range 192.168.1.0/24 then the command below enables ospf
contains the local address prefix of the interface.
In some cases it may be more convenient to enable OSPF on a per
- interface/subnet basis (:ref:`OSPF_ip_ospf_area_command`).
+ interface/subnet basis (:ref:`ospf-ip-ospf-area-command`).
-.. _OSPF_area:
+.. _ospf-area:
OSPF area
=========
.. index:: no area (0-4294967295) virtual-link A.B.C.D
.. clicmd:: no area (0-4294967295) virtual-link A.B.C.D
-.. _OSPF_virtual-link:
+.. _OSPF-virtual-link:
.. index:: area A.B.C.D shortcut
.. clicmd:: area A.B.C.D shortcut
.. index:: area (0-4294967295) authentication message-digest
.. clicmd:: area (0-4294967295) authentication message-digest
-.. _area_authentication_message-digest:
+.. _area-authentication-message-digest:
Specify that OSPF packets
must be authenticated with MD5 HMACs within the given area. Keying
- material must also be configured on a per-interface basis (:ref:`ip_ospf_message-digest-key`).
+ material must also be configured on a per-interface basis (:ref:`ip-ospf-message-digest-key`).
MD5 authentication may also be configured on a per-interface basis
- (:ref:`ip_ospf_authentication_message-digest`). Such per-interface
+ (:ref:`ip-ospf-authentication-message-digest`). Such per-interface
settings will override any per-area authentication setting.
-.. _OSPF_interface:
+.. _ospf-interface:
OSPF interface
==============
.. index:: no ip ospf area [ADDR]
.. clicmd:: no ip ospf area [ADDR]
-.. _OSPF_ip_ospf_area_command:
+.. _ospf-ip-ospf-area-command:
Enable OSPF on the interface, optionally restricted to just the IP address
given by `ADDR`, putting it in the `AREA` area. Per interface area
- settings take precedence to network commands (:ref:`OSPF_network_command`).
+ settings take precedence to network commands (:ref:`ospf-network-command`).
If you have a lot of interfaces, and/or a lot of subnets, then enabling OSPF
via this command may result in a slight performance improvement.
all OSPF packets are authenticated. `AUTH_KEY` has length up to 8 chars.
Simple text password authentication is insecure and deprecated in favour of
- MD5 HMAC authentication (:ref:`ip_ospf_authentication_message-digest`).
+ MD5 HMAC authentication (:ref:`ip-ospf-authentication-message-digest`).
.. index:: ip ospf authentication message-digest
.. clicmd:: ip ospf authentication message-digest
-.. _ip_ospf_authentication_message-digest:
+.. _ip-ospf-authentication-message-digest:
Specify that MD5 HMAC
authentication must be used on this interface. MD5 keying material must
- also be configured (:ref:`ip_ospf_message-digest-key`). Overrides any
- authentication enabled on a per-area basis (:ref:`area_authentication_message-digest`).
+ also be configured (:ref:`ip-ospf-message-digest-key`). Overrides any
+ authentication enabled on a per-area basis (:ref:`area-authentication-message-digest`).
Note that OSPF MD5 authentication requires that time never go backwards
(correct time is NOT important, only that it never goes backwards), even
.. index:: no ip ospf message-digest-key
.. clicmd:: no ip ospf message-digest-key
-.. _ip_ospf_message-digest-key:
+.. _ip-ospf-message-digest-key:
Set OSPF authentication key to a
cryptographic password. The cryptographic algorithm is MD5.
.. index:: no ip ospf dead-interval
.. clicmd:: no ip ospf dead-interval
-.. _ip_ospf_dead-interval_minimal:
+.. _ip-ospf-dead-interval-minimal:
Set number of seconds for
RouterDeadInterval timer value used for Wait Timer and Inactivity
This value must be the same for all routers attached to a common network.
The default value is 10 seconds.
- This command has no effect if :ref:`ip_ospf_dead-interval_minimal` is also
+ This command has no effect if :ref:`ip-ospf-dead-interval-minimal` is also
specified for the interface.
.. index:: ip ospf network (broadcast|non-broadcast|point-to-multipoint|point-to-point)
Enable ospf on an interface and set associated area.
-.. _Redistribute_routes_to_OSPF:
+.. _redistribute-routes-to-ospf:
Redistribute routes to OSPF
===========================
.. index:: no redistribute (kernel|connected|static|rip|bgp)
.. clicmd:: no redistribute (kernel|connected|static|rip|bgp)
-.. _OSPF_redistribute:
+.. _ospf-redistribute:
Redistribute routes of the specified protocol
or kind into OSPF, with the metric type and metric set if specified,
filtering the routes using the given route-map if specified.
Redistributed routes may also be filtered with distribute-lists, see
- :ref:`ospf_distribute-list`.
+ :ref:`ospf-distribute-list`.
Redistributed routes are distributed as into OSPF as Type-5 External
LSAs into links to areas that accept external routes, Type-7 External LSAs
external routes are not permitted.
Note that for connected routes, one may instead use
- :term:`passive-interface`, see :ref:`OSPF_passive-interface`.
+ :term:`passive-interface`, see :ref:`ospf-passive-interface`.
.. index:: default-information originate
.. clicmd:: default-information originate
.. index:: no distribute-list NAME out (kernel|connected|static|rip|ospf
.. clicmd:: no distribute-list NAME out (kernel|connected|static|rip|ospf
-.. _ospf_distribute-list:
+.. _ospf-distribute-list:
Apply the access-list filter, NAME, to
redistributed routes of the given type before allowing the routes to
- redistributed into OSPF (:ref:`OSPF_redistribute`).
+ redistributed into OSPF (:ref:`ospf-redistribute`).
.. index:: default-metric (0-16777214)
.. clicmd:: default-metric (0-16777214)
.. clicmd:: no router zebra
-.. _Showing_OSPF_information:
+.. _showing-ospf-information:
Showing OSPF information
========================
-.. _show_ip_ospf:
+.. _show-ip-ospf:
.. index:: show ip ospf
.. clicmd:: show ip ospf
Show the OSPF routing table, as determined by the most recent SPF calculation.
-.. _Opaque_LSA:
+.. _opaque-lsa:
Opaque LSA
==========
Show Traffic Engineering router parameters.
-.. _Router_Information:
+.. _router-information:
Router Information
==================
Show Router Capabilities PCE parameters.
-.. _Debugging_OSPF:
+.. _debugging-ospf:
Debugging OSPF
==============
-.. _Overview:
+.. _overview:
********
Overview
supports special BGP Route Reflector and Route Server behavior. In addition to
traditional IPv4 routing protocols, FRR also supports IPv6 routing protocols.
With SNMP daemon which supports SMUX and AgentX protocol, FRR provides routing
-protocol MIBs (:ref:`SNMP_Support`).
+protocol MIBs (:ref:`snmp-support`).
FRR uses an advanced software architecture to provide you with a high
quality, multi server routing engine. FRR has an interactive user
Bug reports help us improve FRR and are very much appreciated.
-.. _FRR: |PACKAGE_URL|
-.. _GitHub: https://github.com/frrouting/frr/
+.. _frr: |PACKAGE-URL|
+.. _github: https://github.com/frrouting/frr/
.. _GitHub issues: https://github.com/frrouting/frr/issues
-.. _Slack: https://frrouting.slack.com/
+.. _slack: https://frrouting.slack.com/
-.. _PIM:
+.. _pim:
***
PIM
vrf aware and can work within the context of vrf's in order to
do S,G mrouting.
-.. _Starting_and_Stopping_pimd:
+.. _starting-and-stopping-pimd:
Starting and Stopping pimd
==========================
+---------+---------------------------------------------------------------------+
*pimd* invocation options. Common options that can be specified
-(:ref:`Common_Invocation_Options`).
+(:ref:`common-invocation-options`).
.. index:: ip pim rp A.B.C.D A.B.C.D/M
.. clicmd:: ip pim rp A.B.C.D A.B.C.D/M
Lookup in the Unicast Rib only.
-.. _PIM_Interface_Configuration:
+.. _pim-interface-configuration:
PIM Interface Configuration
===========================
or IGMP report is received on this interface and the Group is denyed by the
prefix-list, PIM will ignore the join or report.
-.. _PIM_Multicast_RIB_insertion:
+.. _pim-multicast-rib-insertion:
PIM Multicast RIB insertion::
=============================
Insert into the Multicast Rib Route A.B.C.D/M using the specified INTERFACE.
The distance can be specified as well if desired.
-.. _Show_PIM_Information:
+.. _show-pim-information:
Show PIM Information
====================
-.. _Zebra_Protocol
+.. _Zebra-Protocol
**************
Zebra Protocol
-.. _RIP:
+.. _rip:
***
RIP
*ripd* supports RIP version 2 as described in RFC2453 and RIP
version 1 as described in RFC1058.
-.. _Starting_and_Stopping_ripd:
+.. _starting-and-stopping-ripd:
Starting and Stopping ripd
==========================
+-------------+------------------------------------------------------+
*ripd* invocation options. Common options that can be specified
-(:ref:`Common_Invocation_Options`).
+(:ref:`common-invocation-options`).
.. option:: -r
.. option:: --retain
When the program terminates, retain routes added by *ripd*.
-.. _RIP_netmask:
+.. _rip-netmask:
RIP netmask
-----------
information will be suppressed. Ripd does not currently support equal cost
multipath routing.
-.. _RIP_Configuration:
+.. _rip-configuration:
RIP Configuration
=================
you don't perform split-horizon on the interface, please specify `no ip
split-horizon`.
-.. _RIP_Version_Control:
+.. _rip-version-control:
RIP Version Control
===================
It is important to note that RIPv1 cannot be authenticated. Further, if RIPv1
is enabled then RIP will reply to REQUEST packets, sending the state of its RIP
routing table to any remote routers that ask on demand. For a more detailed
-discussion on the security implications of RIPv1 see :ref:`RIP_Authentication`.
+discussion on the security implications of RIPv1 see :ref:`rip-authentication`.
.. index:: version VERSION
.. clicmd:: version VERSION
1.
Disabling RIPv1 by specifying version 2 is STRONGLY encouraged,
- :ref:`RIP_Authentication`. This may become the default in a future release.
+ :ref:`rip-authentication`. This may become the default in a future release.
Default: Send Version 2, and accept either version.
Default: Accept packets according to the global setting (both 1 and 2).
-.. _How_to_Announce_RIP_route:
+.. _how-to-announce-rip-route:
How to Announce RIP route
=========================
recommend creating a static route in FRR and redistributing it in RIP using
`redistribute static`.
-.. _Filtering_RIP_Routes:
+.. _filtering-rip-routes:
Filtering RIP Routes
====================
``in`` or ``out``. If DIRECT is ``in`` the access list is applied to input
packets.
-.. _RIP_Metric_Manipulation:
+.. _rip-metric-manipulation:
RIP Metric Manipulation
=======================
.. clicmd:: offset-list ACCESS-LIST (in|out) IFNAME
-.. _RIP_distance:
+.. _rip-distance:
RIP distance
============
Set default RIP distance to specified value when the route's source IP
address matches the specified prefix and the specified access-list.
-.. _RIP_route-map:
+.. _RIP-route-map:
RIP route-map
=============
(something like output filter). I think it is not so clear, but it is draft and
it may be changed at future.
-Route-map statement (:ref:`Route_Map`) is needed to use route-map
+Route-map statement (:ref:`route-map`) is needed to use route-map
functionality.
.. index:: match interface WORD
range is very large for compatibility with other protocols. For RIP, valid
metric values are from 1 to 16.
-.. _RIP_Authentication:
+.. _rip-authentication:
RIP Authentication
==================
packets.
However, unless RIPv1 reception is disabled entirely,
-:ref:`RIP_Version_Control`, RIPv1 REQUEST packets which are received,
+:ref:`rip-version-control`, RIPv1 REQUEST packets which are received,
which query the router for routing information, will still be honoured
by `ripd`, and `ripd` WILL reply to such packets. This allows
`ripd` to honour such REQUESTs (which sometimes is used by old
on the internet, via RIPv1.
To prevent such unauthenticated querying of routes disable RIPv1,
-:ref:`RIP_Version_Control`.
+:ref:`rip-version-control`.
.. index:: ip rip authentication mode md5
.. clicmd:: ip rip authentication mode md5
!
-.. _RIP_Timers:
+.. _rip-timers:
RIP Timers
==========
The `no timers basic` command will reset the timers to the default settings
listed above.
-.. _Show_RIP_Information:
+.. _show-rip-information:
Show RIP Information
====================
-.. _RIPng:
+.. _ripng:
*****
RIPng
*ripngd* supports the RIPng protocol as described in :rfc:`2080`. It's an IPv6
reincarnation of the RIP protocol.
-.. _Invoking_ripngd:
+.. _invoking-ripngd:
Invoking ripngd
===============
There are no `ripngd` specific invocation options. Common options can be
-specified (:ref:`Common_Invocation_Options`).
+specified (:ref:`common-invocation-options`).
-.. _ripngd_Configuration:
+.. _ripngd-configuration:
ripngd Configuration
====================
This command is the default and does not appear in the configuration. With
this statement, RIPng routes go to the *zebra* daemon.
-.. _ripngd_Terminal_Mode_Commands:
+.. _ripngd-terminal-mode-commands:
ripngd Terminal Mode Commands
=============================
-.. _Route_Map:
+.. _route-map:
**********
Route Maps
cont
goto next route-map entry
-.. _Route_Map_Command:
+.. _route-map-command:
Route Map Command
=================
Configure the `order`'th entry in `route-map-name` with ``Match Policy`` of
either *permit* or *deny*.
-.. _Route_Map_Match_Command:
+.. _route-map-match-command:
Route Map Match Command
=======================
interface name specified if the neighbor was specified
in this manner.
-.. _Route_Map_Set_Command:
+.. _route-map-set-command:
Route Map Set Command
=====================
Set the BGP-4+ link local IPv6 nexthop address.
-.. _Route_Map_Call_Command:
+.. _route-map-call-command:
Route Map Call Command
======================
Call route-map `name`. If it returns deny, deny the route and
finish processing the route-map.
-.. _Route_Map_Exit_Action_Command:
+.. _route-map-exit-action-command:
Route Map Exit Action Command
=============================
-.. _Prefix_Origin_Validation_Using_RPKI:
+.. _prefix-origin-validation-using-rpki:
Prefix Origin Validation Using RPKI
===================================
- [Securing-BGP]_
- [Resource-Certification]_
-.. _Features_of_the_Current_Implementation:
+.. _features-of-the-current-implementation:
Features of the Current Implementation
--------------------------------------
outcome of the Prefix Origin Validation.
-.. _Enabling_RPKI:
+.. _enabling-rpki:
Enabling RPKI
-------------
:file:`~/.ssh/known_hosts`.
-.. _Validating_BGP_Updates:
+.. _validating-bgp-updates:
Validating BGP Updates
----------------------
set local-preference 500
-.. _Debugging:
+.. _debugging:
Debugging
---------
Enable or disable debugging output for RPKI.
-.. _Displaying_RPKI:
+.. _displaying-rpki:
Displaying RPKI
---------------
-.. _SNMP_Support:
+.. _snmp-support:
************
SNMP Support
(:rfc:`2741`) and make the routing protocol MIBs available through it.
Note that SNMP Support needs to be enabled at compile-time and loaded as module
-on daemon startup. Refer to :ref:`Loadable_Module_Support` on the latter.
+on daemon startup. Refer to :ref:`loadable-module-support` on the latter.
-.. _Getting_and_installing_an_SNMP_agent:
+.. _getting-and-installing-an-snmp-agent:
Getting and installing an SNMP agent
====================================
Nowadays, SMUX is a legacy protocol. The AgentX protocol should be preferred
for any new deployment. Both protocols have the same coverage.
-.. _AgentX_configuration:
+.. _agentx-configuration:
AgentX configuration
====================
agentXSocket tcp:192.168.15.12:705
-.. _SMUX_configuration:
+.. _smux-configuration:
SMUX configuration
==================
===================
To handle snmp traps make sure your snmp setup of frr works correctly as
-described in the frr documentation in :ref:`SNMP_Support`.
+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:
-.. _VNC_and_VNC-GW:
+.. _VNC-and-VNC-GW:
**************
VNC and VNC-GW
(:abbr:`CE` s) operating within a VN.
-.. _General_VNC_Configuration:
+.. _general-vnc-configuration:
.. General VNC Configuration
.. -------------------------
-.. _RFP_Related_Configuration:
+.. _rfp-related-configuration:
RFP Related Configuration
-------------------------
This is a simple example configuration parameter included as part of the RFP
example code. VALUE must be in the range of 0 to 4294967295.
-.. _VNC_Defaults_Configuration:
+.. _vnc-defaults-configuration:
VNC Defaults Configuration
--------------------------
The VNC Defaults section allows the user to specify default values for
configuration parameters for all registered NVEs.
-Default values are overridden by :ref:`VNC_NVE_Group_Configuration`.
+Default values are overridden by :ref:`vnc-nve-group-configuration`.
.. clicmd:: vnc defaults
RT list is empty.
A complete definition of these parameters is given below
- (:ref:`VNC_NVE_Group_Configuration`).
+ (:ref:`vnc-nve-group-configuration`).
.. index:: rd route-distinguisher
.. clicmd:: rd ROUTE-DISTINGUISHER
`two-byte-autonomous-system-number=0:four-byte-integer=0`.
A complete definition of this parameter is given below
- (:ref:`VNC_NVE_Group_Configuration`).
+ (:ref:`vnc-nve-group-configuration`).
.. index:: l2rd NVE-ID-VALUE
.. clicmd:: l2rd NVE-ID-VALUE
Set the value used to distinguish NVEs connected to the same logical
Ethernet segment (i.e., L2VPN). A complete definition of this parameter is
- given below (:ref:`VNC_NVE_Group_Configuration`).
+ given below (:ref:`vnc-nve-group-configuration`).
.. index:: response-lifetime LIFETIME|infinite
.. clicmd:: response-lifetime LIFETIME|infinite
NVEs.
A complete definition of this parameter is given below
- (:ref:`VNC_NVE_Group_Configuration`).
+ (:ref:`vnc-nve-group-configuration`).
.. index:: export bgp|zebra route-map MAP-NAME
.. clicmd:: export bgp|zebra route-map MAP-NAME
Exit VNC configuration mode.
-.. _VNC_NVE_Group_Configuration:
+.. _vnc-nve-group-configuration:
VNC NVE Group Configuration
---------------------------
Specify that the named route-map should be applied to routes being exported
to bgp or zebra. This paramter is used in conjunction with
- :ref:`Configuring_Export_of_Routes_to_Other_Routing_Protocols`. This item
+ :ref:`configuring-export-of-routes-to-other-routing-protocols`. This item
is optional.
.. index:: export bgp|zebra no route-map
Specify that no route-map should be applied to routes being exported to bgp
or zebra. This paramter is used in conjunction with
- :ref:`Configuring_Export_of_Routes_to_Other_Routing_Protocols`. This item
+ :ref:`configuring-export-of-routes-to-other-routing-protocols`. This item
is optional.
.. index:: export bgp|zebra ipv4|ipv6 prefix-list LIST-NAME
Specify that the named prefix-list filter should be applied to routes being
exported to bgp or zebra. Prefix-lists for ipv4 and ipv6 are independent of
each other. This paramter is used in conjunction with
- :ref:`Configuring_Export_of_Routes_to_Other_Routing_Protocols`. This item
+ :ref:`configuring-export-of-routes-to-other-routing-protocols`. This item
is optional.
.. index:: export bgp|zebra no ipv4|ipv6 prefix-list
Specify that no prefix-list filter should be applied to routes being
exported to bgp or zebra. This parameter is used in conjunction with
- :ref:`Configuring_Export_of_Routes_to_Other_Routing_Protocols`. This item
+ :ref:`configuring-export-of-routes-to-other-routing-protocols`. This item
is optional.
-.. _VNC_L2_Group_Configuration:
+.. _VNC-L2-Group-Configuration:
VNC L2 Group Configuration
--------------------------
The route targets advertised with prefixes and addresses registered by an NVE
are determined based on the NVE's associated VNC NVE Group Configuration,
-:ref:`VNC_NVE_Group_Configuration`. Layer 2 (L2) Groups are used to override
+:ref:`vnc-nve-group-configuration`. Layer 2 (L2) Groups are used to override
the route targets for an NVE's Ethernet registrations based on the Logical
Network Identifier and label value. A Logical Network Identifier is used to
uniquely identify a logical Ethernet segment and is conceptually similar to the
Specify the route target import and export value associated with the group.
A complete definition of these parameters is given above,
- :ref:`VNC_NVE_Group_Configuration`.
+ :ref:`vnc-nve-group-configuration`.
-.. _Configuring_Redistribution_of_Routes_from_Other_Routing_Protocols:
+.. _configuring-redistribution-of-routes-from-other-routing-protocols:
Configuring Redistribution of Routes from Other Routing Protocols
-----------------------------------------------------------------
When redistributing `bgp-direct` routes,
specifies that no route-map should be applied.
-.. _Configuring_Export_of_Routes_to_Other_Routing_Protocols:
+.. _configuring-export-of-routes-to-other-routing-protocols:
Configuring Export of Routes to Other Routing Protocols
-------------------------------------------------------
Specify how routes should be exported to bgp or zebra. If the mode is
`none`, routes are not exported. If the mode is `group-nve`, routes are
exported according to nve-group or vrf-policy group configuration
- (:ref:`VNC_NVE_Group_Configuration`): if a group is configured to allow
+ (:ref:`vnc-nve-group-configuration`): if a group is configured to allow
export, then each prefix visible to the group is exported with next hops set
to the currently-registered NVEs. If the mode is `registering-nve`, then all
VNC routes are exported with their original next hops. If the mode is `ce`,
When the export mode is `group-nve`, policy for exported routes is specified
per-NVE-group or vrf-policy group inside a `nve-group` `RFG-NAME` block via
- the following commands(:ref:`VNC_NVE_Group_Configuration`):
+ the following commands(:ref:`vnc-nve-group-configuration`):
.. index:: export bgp|zebra route-map MAP-NAME
.. clicmd:: export bgp|zebra route-map MAP-NAME
that no prefix-list filter should be applied to routes being exported to
bgp or zebra.
-.. _Manual_Address_Control:
+.. _manual-address-control:
Manual Address Control
======================
`*` in lieu of any VN or UN address, in which case all registrations will
match.
-.. _Other_VNC-Related_Commands:
+.. _Other-VNC-Related-Commands:
Other VNC-Related Commands
==========================
.. clicmd:: show vnc queries PREFIX
Display active Query information. Queries remain valid for the default
- Response Lifetime (:ref:`VNC_Defaults_Configuration`) or NVE-group Response
- Lifetime (:ref:`VNC_NVE_Group_Configuration`). Specifying `prefix` limits
+ Response Lifetime (:ref:`vnc-defaults-configuration`) or NVE-group Response
+ Lifetime (:ref:`vnc-nve-group-configuration`). Specifying `prefix` limits
the output to Query Targets that fall within `prefix`.
Query information is provided for each querying NVE, and includes the Query
Display all, active and/or removed response information which are
present in the NVA Responses Cache. Responses remain valid for the
- default Response Lifetime (:ref:`VNC_Defaults_Configuration`) or
- NVE-group Response Lifetime (:ref:`VNC_NVE_Group_Configuration`.)
- When Removal Responses are enabled (:ref:`General_VNC_Configuration`),
+ default Response Lifetime (:ref:`vnc-defaults-configuration`) or
+ NVE-group Response Lifetime (:ref:`vnc-nve-group-configuration`.)
+ When Removal Responses are enabled (:ref:`general-vnc-configuration`),
such responses are listed for the Response Lifetime. Specifying
`prefix` limits the output to the addresses that fall within
`prefix`.
Print the number of memory items allocated by the NVA.
-.. _Example_VNC_and_VNC-GW_Configurations:
+.. _Example-VNC-and-VNC-GW-Configurations:
Example VNC and VNC-GW Configurations
=====================================
-.. _VTY_shell:
+.. _vty-shell:
*********
VTY shell
at all.
-.. _Integrated_configuration_mode:
+.. _integrated-configuration-mode:
Integrated configuration mode
=============================
-.. _Zebra:
+.. _zebra:
*****
Zebra
table updates, interface lookups, and redistribution of routes between
different routing protocols.
-.. _Invoking_zebra:
+.. _invoking-zebra:
Invoking zebra
==============
-Besides the common invocation options (:ref:`Common_Invocation_Options`), the
+Besides the common invocation options (:ref:`common-invocation-options`), the
*zebra* specific invocation options are listed below.
.. program:: zebra
.. program:: configure
-.. _Interface_Commands:
+.. _interface-commands:
Interface Commands
==================
-.. _Standard_Commands:
+.. _standard-commands:
Standard Commands
-----------------
Linux and Solaris, and only where network interface drivers support
reporting link-state via the ``IFF_RUNNING`` flag.
-.. _Link_Parameters_Commands:
+.. _link-parameters-commands:
Link Parameters Commands
------------------------
Enter into the link parameters sub node. At least 'enable' must be set to
activate the link parameters, and consequently Traffic Engineering on this
interface. MPLS-TE must be enable at the OSPF
- (:ref:`OSPF_Traffic_Engineering`) or ISIS (:ref:`ISIS_Traffic_Engineering`)
+ (:ref:`ospf-traffic-engineering`) or ISIS (:ref:`isis-traffic-engineering`)
router level in complement to this. Disable link parameters for this
interface.
for InterASv2 link in OSPF (RFC5392). Note that this option is not yet
supported for ISIS (RFC5316).
-.. _Static_Route_Commands:
+.. _static-route-commands:
Static Route Commands
=====================
and later). After setting TABLENO with this command,
static routes defined after this are added to the specified table.
-.. _Multicast_RIB_Commands:
+.. _multicast-rib-commands:
Multicast RIB Commands
======================
``ip route`` command, except that it inserts the route in the Multicast RIB
instead of the Unicast RIB.
-.. _zebra_Route_Filtering:
+.. _zebra-route-filtering:
zebra Route Filtering
=====================
-Zebra supports :dfn:`prefix-list` s and :ref:`Route_Map` s to match routes
+Zebra supports :dfn:`prefix-list` s and :ref:`route-map` s to match routes
received from other FRR components. The permit/deny facilities provided by
these commands can be used to filter which routes zebra will install in the
kernel.
ip protocol rip route-map RM1
-.. _zebra_FIB_push_interface:
+.. _zebra-fib-push-interface:
zebra FIB push interface
========================
Zebra supports a 'FIB push' interface that allows an external
component to learn the forwarding information computed by the FRR
routing suite. This is a loadable module that needs to be enabled
-at startup as described in :ref:`Loadable_Module_Support`.
+at startup as described in :ref:`loadable-module-support`.
In FRR, the Routing Information Base (RIB) resides inside
zebra. Routing protocols communicate their best routes to zebra, and
projects / mirror / frr.git / commitdiff