proxmox-mirrors/mirror_frr
1
0
Fork 0
mirror of https://git.proxmox.com/git/mirror_frr synced 2025-06-15 13:30:21 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge pull request #8128 from qlyoung/docs-cleanup

Browse Source 
General docs cleanup
This commit is contained in:
Mark Stapp 2021-02-24 16:53:42 -05:00 committed by GitHub
commit eb3e4dc35c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
38 changed files with 406 additions and 2385 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
doc/developer/workflow.rst
View File

@ -1229,9 +1229,9 @@ towards making documentation easier to use, write and maintain.
CLI Commands CLI Commands
^^^^^^^^^^^^ ^^^^^^^^^^^^
When documenting CLI please use a combination of the ``.. index::`` and When documenting CLI please use the ``.. clicmd::`` directive. This directive
``.. clicmd::`` directives. For example, the command :clicmd:`show pony` would will format the command and generate index entries automatically. For example,
be documented as follows: the command :clicmd:`show pony` would be documented as follows:
.. code-block:: rest .. code-block:: rest
@ -1252,6 +1252,7 @@ be documented as follows:
hjw |_>|> /_] // hjw |_>|> /_] //
/_] /_] /_] /_]
When documented this way, CLI commands can be cross referenced with the When documented this way, CLI commands can be cross referenced with the
``:clicmd:`` inline markup like so: ``:clicmd:`` inline markup like so:
@ -1262,8 +1263,27 @@ When documented this way, CLI commands can be cross referenced with the
This is very helpful for users who want to quickly remind themselves what a This is very helpful for users who want to quickly remind themselves what a
particular command does. particular command does.
When documenting a cli that has a ``no`` form, please do not include When documenting a cli that has a ``no`` form, please do not include the ``no``
the ``no`` in the ``.. index::`` line. form. I.e. ``no show pony`` would not be documented anywhere. Since most
commands have ``no`` forms, users should be able to infer these or get help
from vtysh's completions.
When documenting commands that have lots of possible variants, just document
the single command in summary rather than enumerating each possible variant.
E.g. for ``show pony [foo|bar]``, do not:
.. code-block:: rest
.. clicmd:: show pony
.. clicmd:: show pony foo
.. clicmd:: show pony bar
Do:
.. code-block:: rest
.. clicmd:: show pony [foo|bar]
Configuration Snippets Configuration Snippets
^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^

45
doc/user/babeld.rst
View File

@ -34,26 +34,22 @@ Configuration of *babeld* is done in its configuration file
Babel configuration Babel configuration
=================== ===================
.. index:: router babel .. clicmd:: router babel
.. clicmd:: [no] router babel
Enable or disable Babel routing. Enable or disable Babel routing.
.. index:: babel resend-delay (20-655340) .. clicmd:: babel resend-delay (20-655340)
.. clicmd:: [no] babel resend-delay (20-655340)
Specifies the time after which important messages are resent when Specifies the time after which important messages are resent when
avoiding a black-hole. The default is 2000 ms. avoiding a black-hole. The default is 2000 ms.
.. index:: babel diversity .. clicmd:: babel diversity
.. clicmd:: [no] babel diversity
Enable or disable routing using radio frequency diversity. This is Enable or disable routing using radio frequency diversity. This is
highly recommended in networks with many wireless nodes. highly recommended in networks with many wireless nodes.
If you enable this, you will probably want to set `babel If you enable this, you will probably want to set `babel
diversity-factor` and `babel channel` below. diversity-factor` and `babel channel` below.
.. index:: babel diversity-factor (1-256)
.. clicmd:: babel diversity-factor (1-256) .. clicmd:: babel diversity-factor (1-256)
@ -63,12 +59,10 @@ Babel configuration
no role in route selection; you will probably want to set that to 128 no role in route selection; you will probably want to set that to 128
or less on nodes with multiple independent radios. or less on nodes with multiple independent radios.
.. index:: network IFNAME .. clicmd:: network IFNAME
.. clicmd:: [no] network IFNAME
Enable or disable Babel on the given interface. Enable or disable Babel on the given interface.
.. index:: babel <wired|wireless>
.. clicmd:: babel <wired|wireless> .. clicmd:: babel <wired|wireless>
@ -77,8 +71,7 @@ Babel configuration
Specifying `wireless` (the default) is always correct, but may Specifying `wireless` (the default) is always correct, but may
cause slower convergence and extra routing traffic. cause slower convergence and extra routing traffic.
.. index:: babel split-horizon .. clicmd:: babel split-horizon
.. clicmd:: [no] babel split-horizon
Specifies whether to perform split-horizon on the interface. Specifying Specifies whether to perform split-horizon on the interface. Specifying
``no babel split-horizon`` is always correct, while ``babel ``no babel split-horizon`` is always correct, while ``babel
@ -88,7 +81,6 @@ Babel configuration
interfaces. This flag is reset when the wired/wireless status of an interfaces. This flag is reset when the wired/wireless status of an
interface is changed. interface is changed.
.. index:: babel hello-interval (20-655340)
.. clicmd:: babel hello-interval (20-655340) .. clicmd:: babel hello-interval (20-655340)
@ -97,7 +89,6 @@ Babel configuration
on wireless links, the link quality value is reestimated at every on wireless links, the link quality value is reestimated at every
hello interval. The default is 4000 ms. hello interval. The default is 4000 ms.
.. index:: babel update-interval (20-655340)
.. clicmd:: babel update-interval (20-655340) .. clicmd:: babel update-interval (20-655340)
@ -105,7 +96,6 @@ Babel configuration
Babel makes extensive use of triggered updates, this can be set to fairly Babel makes extensive use of triggered updates, this can be set to fairly
high values on links with little packet loss. The default is 20000 ms. high values on links with little packet loss. The default is 20000 ms.
.. index:: babel channel
.. clicmd:: babel channel (1-254) .. clicmd:: babel channel (1-254)
.. clicmd:: babel channel interfering .. clicmd:: babel channel interfering
@ -121,7 +111,6 @@ Babel configuration
interfaces. This is reset when the wired/wireless status of an interface is interfaces. This is reset when the wired/wireless status of an interface is
changed. changed.
.. index:: babel rxcost (1-65534)
.. clicmd:: babel rxcost (1-65534) .. clicmd:: babel rxcost (1-65534)
@ -136,7 +125,6 @@ Babel configuration
networks, acting directly on the cost using route maps is a better networks, acting directly on the cost using route maps is a better
technique. technique.
.. index:: babel rtt-decay (1-256)
.. clicmd:: babel rtt-decay (1-256) .. clicmd:: babel rtt-decay (1-256)
@ -144,7 +132,6 @@ Babel configuration
RTT samples, in units of 1/256. Higher values discard old samples RTT samples, in units of 1/256. Higher values discard old samples
faster. The default is 42. faster. The default is 42.
.. index:: babel rtt-min (1-65535)
.. clicmd:: babel rtt-min (1-65535) .. clicmd:: babel rtt-min (1-65535)
@ -152,14 +139,12 @@ Babel configuration
increase the cost to a neighbour. The additional cost is linear in increase the cost to a neighbour. The additional cost is linear in
(rtt - rtt-min). The default is 100 ms. (rtt - rtt-min). The default is 100 ms.
.. index:: babel rtt-max (1-65535)
.. clicmd:: babel rtt-max (1-65535) .. clicmd:: babel rtt-max (1-65535)
This specifies the maximum RTT, in milliseconds, above which we don't This specifies the maximum RTT, in milliseconds, above which we don't
increase the cost to a neighbour. The default is 120 ms. increase the cost to a neighbour. The default is 120 ms.
.. index:: babel max-rtt-penalty (0-65535)
.. clicmd:: babel max-rtt-penalty (0-65535) .. clicmd:: babel max-rtt-penalty (0-65535)
@ -167,14 +152,12 @@ Babel configuration
when the RTT is higher or equal than rtt-max. The default is 0, which when the RTT is higher or equal than rtt-max. The default is 0, which
effectively disables the use of a RTT-based cost. effectively disables the use of a RTT-based cost.
.. index:: babel enable-timestamps
.. clicmd:: [no] babel enable-timestamps .. clicmd:: babel enable-timestamps
Enable or disable sending timestamps with each Hello and IHU message in Enable or disable sending timestamps with each Hello and IHU message in
order to compute RTT values. The default is `no babel enable-timestamps`. order to compute RTT values. The default is `no babel enable-timestamps`.
.. index:: babel resend-delay (20-655340)
.. clicmd:: babel resend-delay (20-655340) .. clicmd:: babel resend-delay (20-655340)
@ -182,7 +165,6 @@ Babel configuration
update will be resent. The default is 2000 ms. You probably don't want to update will be resent. The default is 2000 ms. You probably don't want to
tweak this value. tweak this value.
.. index:: babel smoothing-half-life (0-65534)
.. clicmd:: babel smoothing-half-life (0-65534) .. clicmd:: babel smoothing-half-life (0-65534)
@ -196,9 +178,8 @@ Babel configuration
Babel redistribution Babel redistribution
==================== ====================
.. index:: redistribute <ipv4|ipv6> KIND
.. clicmd:: [no] redistribute <ipv4|ipv6> KIND .. clicmd:: redistribute <ipv4|ipv6> KIND
Specify which kind of routes should be redistributed into Babel. Specify which kind of routes should be redistributed into Babel.
@ -209,50 +190,40 @@ Show Babel information
These commands dump various parts of *babeld*'s internal state. These commands dump various parts of *babeld*'s internal state.
.. index:: show babel route
.. clicmd:: show babel route .. clicmd:: show babel route
.. index:: show babel route A.B.C.D
.. clicmd:: show babel route A.B.C.D .. clicmd:: show babel route A.B.C.D
.. index:: show babel route X:X::X:X
.. clicmd:: show babel route X:X::X:X .. clicmd:: show babel route X:X::X:X
.. index:: show babel route A.B.C.D/M
.. clicmd:: show babel route A.B.C.D/M .. clicmd:: show babel route A.B.C.D/M
.. index:: show babel route X:X::X:X/M
.. clicmd:: show babel route X:X::X:X/M .. clicmd:: show babel route X:X::X:X/M
.. index:: show babel interface
.. clicmd:: show babel interface .. clicmd:: show babel interface
.. index:: show babel interface IFNAME
.. clicmd:: show babel interface IFNAME .. clicmd:: show babel interface IFNAME
.. index:: show babel neighbor
.. clicmd:: show babel neighbor .. clicmd:: show babel neighbor
.. index:: show babel parameters
.. clicmd:: show babel parameters .. clicmd:: show babel parameters
Babel debugging commands Babel debugging commands
======================== ========================
.. index::
simple: debug babel KIND simple: debug babel KIND
simple: no debug babel KIND simple: no debug babel KIND
.. clicmd:: [no] debug babel KIND .. clicmd:: debug babel KIND
Enable or disable debugging messages of a given kind. ``KIND`` can Enable or disable debugging messages of a given kind. ``KIND`` can
be one of: be one of:

78
doc/user/basic.rst
View File

@ -11,13 +11,9 @@ The following sections discuss commands common to all the routing daemons.
Config Commands Config Commands
=============== ===============
.. index:: Configuration files for running the software
.. index:: Files for running configurations
.. index:: Modifying the herd's behavior
.. index:: Getting the herd running
In a config file, you can write the debugging options, a vty's password, In a config file, you can write the debugging options, a vty's password,
routing daemon configurations, a log file name, and so forth. This information routing daemon configurations, a log file name, and so forth. This information
@ -60,25 +56,21 @@ If desired, you can specify a config file using the :option:`-f` or
Basic Config Commands Basic Config Commands
--------------------- ---------------------
.. index:: hostname HOSTNAME
.. clicmd:: hostname HOSTNAME .. clicmd:: hostname HOSTNAME
Set hostname of the router. Set hostname of the router.
.. index:: password PASSWORD .. clicmd:: password PASSWORD
.. clicmd:: [no] password PASSWORD
Set password for vty interface. The ``no`` form of the command deletes the Set password for vty interface. The ``no`` form of the command deletes the
password. If there is no password, a vty won't accept connections. password. If there is no password, a vty won't accept connections.
.. index:: enable password PASSWORD .. clicmd:: enable password PASSWORD
.. clicmd:: [no] enable password PASSWORD
Set enable password. The ``no`` form of the command deletes the enable Set enable password. The ``no`` form of the command deletes the enable
password. password.
.. index:: log trap LEVEL .. clicmd:: log trap LEVEL
.. clicmd:: [no] log trap LEVEL
These commands are deprecated and are present only for historical These commands are deprecated and are present only for historical
compatibility. The log trap command sets the current logging level for all compatibility. The log trap command sets the current logging level for all
@ -88,9 +80,8 @@ Basic Config Commands
future logging commands to debugging, but it does not change the logging future logging commands to debugging, but it does not change the logging
level of existing logging destinations. level of existing logging destinations.
.. index:: log stdout [LEVEL]
.. clicmd:: [no] log stdout LEVEL .. clicmd:: log stdout LEVEL
Enable logging output to stdout. If the optional second argument specifying Enable logging output to stdout. If the optional second argument specifying
the logging level is not present, the default logging level (typically the logging level is not present, the default logging level (typically
@ -109,8 +100,7 @@ Basic Config Commands
terminal output. Use a log file and ``tail -f`` if this rare chance is terminal output. Use a log file and ``tail -f`` if this rare chance is
inacceptable to your setup. inacceptable to your setup.
.. index:: log file FILENAME [LEVEL] .. clicmd:: log file [FILENAME [LEVEL]]
.. clicmd:: [no] log file [FILENAME [LEVEL]]
If you want to log into a file, please specify ``filename`` as If you want to log into a file, please specify ``filename`` as
in this example: in this example:
@ -124,16 +114,14 @@ Basic Config Commands
deprecated ``log trap`` command) will be used. The ``no`` form of the command deprecated ``log trap`` command) will be used. The ``no`` form of the command
disables logging to a file. disables logging to a file.
.. index:: log syslog [LEVEL] .. clicmd:: log syslog [LEVEL]
.. clicmd:: [no] log syslog [LEVEL]
Enable logging output to syslog. If the optional second argument specifying Enable logging output to syslog. If the optional second argument specifying
the logging level is not present, the default logging level (typically the logging level is not present, the default logging level (typically
debugging, but can be changed using the deprecated ``log trap`` command) will debugging, but can be changed using the deprecated ``log trap`` command) will
be used. The ``no`` form of the command disables logging to syslog. be used. The ``no`` form of the command disables logging to syslog.
.. index:: log monitor [LEVEL] .. clicmd:: log monitor [LEVEL]
.. clicmd:: [no] log monitor [LEVEL]
Enable logging output to vty terminals that have enabled logging using the Enable logging output to vty terminals that have enabled logging using the
``terminal monitor`` command. By default, monitor logging is enabled at the ``terminal monitor`` command. By default, monitor logging is enabled at the
@ -143,15 +131,13 @@ Basic Config Commands
level (typically debugging) will be used. The ``no`` form of the command level (typically debugging) will be used. The ``no`` form of the command
disables logging to terminal monitors. disables logging to terminal monitors.
.. index:: log facility [FACILITY] .. clicmd:: log facility [FACILITY]
.. clicmd:: [no] log facility [FACILITY]
This command changes the facility used in syslog messages. The default This command changes the facility used in syslog messages. The default
facility is ``daemon``. The ``no`` form of the command resets the facility facility is ``daemon``. The ``no`` form of the command resets the facility
to the default ``daemon`` facility. to the default ``daemon`` facility.
.. index:: log record-priority .. clicmd:: log record-priority
.. clicmd:: [no] log record-priority
To include the severity in all messages logged to a file, to stdout, or to To include the severity in all messages logged to a file, to stdout, or to
a terminal monitor (i.e. anything except syslog), a terminal monitor (i.e. anything except syslog),
@ -161,8 +147,7 @@ Basic Config Commands
versions of syslogd can be configured to include the facility and versions of syslogd can be configured to include the facility and
level in the messages emitted. level in the messages emitted.
.. index:: log timestamp precision (0-6) .. clicmd:: log timestamp precision [(0-6)]
.. clicmd:: [no] log timestamp precision [(0-6)]
This command sets the precision of log message timestamps to the given This command sets the precision of log message timestamps to the given
number of digits after the decimal point. Currently, the value must be in number of digits after the decimal point. Currently, the value must be in
@ -177,8 +162,7 @@ Basic Config Commands
In this example, the precision is set to provide timestamps with In this example, the precision is set to provide timestamps with
millisecond accuracy. millisecond accuracy.
.. index:: log commands .. clicmd:: log commands
.. clicmd:: [no] log commands
This command enables the logging of all commands typed by a user to all This command enables the logging of all commands typed by a user to all
enabled log destinations. The note that logging includes full command lines, enabled log destinations. The note that logging includes full command lines,
@ -186,8 +170,7 @@ Basic Config Commands
is used to start the daemon then this command is turned on by default 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 dissallowed.
.. index:: log-filter WORD [DAEMON] .. clicmd:: log-filter WORD [DAEMON]
.. clicmd:: [no] log-filter WORD [DAEMON]
This command forces logs to be filtered on a specific string. A log message This command forces logs to be filtered on a specific string. A log message
will only be printed if it matches on one of the filters in the log-filter will only be printed if it matches on one of the filters in the log-filter
@ -200,55 +183,41 @@ Basic Config Commands
Log filters prevent this but you should still expect a small performance Log filters prevent this but you should still expect a small performance
hit due to filtering each of all those logs. hit due to filtering each of all those logs.
.. index:: log-filter clear [DAEMON]
.. clicmd:: log-filter clear [DAEMON] .. clicmd:: log-filter clear [DAEMON]
This command clears all current filters in the log-filter table. Can be This command clears all current filters in the log-filter table. Can be
daemon independent. daemon independent.
.. index:: service password-encryption
.. clicmd:: service password-encryption .. clicmd:: service password-encryption
Encrypt password. Encrypt password.
.. index:: service advanced-vty
.. clicmd:: service advanced-vty .. clicmd:: service advanced-vty
Enable advanced mode VTY. Enable advanced mode VTY.
.. index:: service terminal-length (0-512)
.. clicmd:: service terminal-length (0-512) .. clicmd:: service terminal-length (0-512)
Set system wide line configuration. This configuration command applies to Set system wide line configuration. This configuration command applies to
all VTY interfaces. all VTY interfaces.
.. index:: line vty
.. clicmd:: line vty .. clicmd:: line vty
Enter vty configuration mode. Enter vty configuration mode.
.. index:: banner motd default
.. clicmd:: banner motd default .. clicmd:: banner motd default
Set default motd string. Set default motd string.
.. index:: banner motd file FILE
.. clicmd:: banner motd file FILE .. clicmd:: banner motd file FILE
Set motd string from file. The file must be in directory specified Set motd string from file. The file must be in directory specified
under ``--sysconfdir``. under ``--sysconfdir``.
.. index:: banner motd line LINE
.. clicmd:: banner motd line LINE .. clicmd:: banner motd line LINE
Set motd string from an input. Set motd string from an input.
.. index:: banner motd
.. clicmd:: no banner motd
No motd banner string will be printed.
.. index:: exec-timeout MINUTE [SECOND]
.. clicmd:: exec-timeout MINUTE [SECOND] .. clicmd:: exec-timeout MINUTE [SECOND]
Set VTY connection timeout value. When only one argument is specified Set VTY connection timeout value. When only one argument is specified
@ -256,13 +225,9 @@ Basic Config Commands
used for timeout value in seconds. Default timeout value is 10 minutes. used for timeout value in seconds. Default timeout value is 10 minutes.
When timeout value is zero, it means no timeout. When timeout value is zero, it means no timeout.
.. index:: exec-timeout Not setting this, or setting the values to 0 0, means a timeout will not be
.. clicmd:: no exec-timeout enabled.
Do not perform timeout at all. This command is as same as
``exec-timeout 0 0``.
.. index:: access-class ACCESS-LIST
.. clicmd:: access-class ACCESS-LIST .. clicmd:: access-class ACCESS-LIST
Restrict vty connections with an access list. Restrict vty connections with an access list.
@ -440,55 +405,45 @@ Puppet, etc.), upgrade considerations differ somewhat:
Terminal Mode Commands Terminal Mode Commands
====================== ======================
.. index:: write terminal
.. clicmd:: write terminal .. clicmd:: write terminal
Displays the current configuration to the vty interface. Displays the current configuration to the vty interface.
.. index:: write file
.. clicmd:: write file .. clicmd:: write file
Write current configuration to configuration file. Write current configuration to configuration file.
.. index:: configure [terminal]
.. clicmd:: configure [terminal] .. clicmd:: configure [terminal]
Change to configuration mode. This command is the first step to Change to configuration mode. This command is the first step to
configuration. configuration.
.. index:: terminal length (0-512)
.. clicmd:: terminal length (0-512) .. clicmd:: terminal length (0-512)
Set terminal display length to ``(0-512)``. If length is 0, no display Set terminal display length to ``(0-512)``. If length is 0, no display
control is performed. control is performed.
.. index:: who
.. clicmd:: who .. clicmd:: who
Show a list of currently connected vty sessions. Show a list of currently connected vty sessions.
.. index:: list
.. clicmd:: list .. clicmd:: list
List all available commands. List all available commands.
.. index:: show version
.. clicmd:: show version .. clicmd:: show version
Show the current version of |PACKAGE_NAME| and its build host information. Show the current version of |PACKAGE_NAME| and its build host information.
.. index:: show logging
.. clicmd:: show logging .. clicmd:: show logging
Shows the current configuration of the logging system. This includes the Shows the current configuration of the logging system. This includes the
status of all logging destinations. status of all logging destinations.
.. index:: show log-filter
.. clicmd:: show log-filter .. clicmd:: show log-filter
Shows the current log filters applied to each daemon. Shows the current log filters applied to each daemon.
.. index:: show memory
.. clicmd:: show memory .. clicmd:: show memory
Show information on how much memory is used for which specific things in Show information on how much memory is used for which specific things in
@ -549,18 +504,15 @@ Terminal Mode Commands
When executing this command from ``vtysh``, each of the daemons' memory When executing this command from ``vtysh``, each of the daemons' memory
usage is printed sequentially. usage is printed sequentially.
.. index:: show history
.. clicmd:: show history .. clicmd:: show history
Dump the vtysh cli history. Dump the vtysh cli history.
.. index:: logmsg LEVEL MESSAGE
.. clicmd:: logmsg LEVEL MESSAGE .. clicmd:: logmsg LEVEL MESSAGE
Send a message to all logging destinations that are enabled for messages of Send a message to all logging destinations that are enabled for messages of
the given severity. the given severity.
.. index:: find COMMAND...
.. clicmd:: find COMMAND... .. clicmd:: find COMMAND...
This command performs a simple substring search across all defined commands This command performs a simple substring search across all defined commands
@ -589,7 +541,6 @@ Terminal Mode Commands
.. _common-show-commands: .. _common-show-commands:
.. index:: show thread cpu
.. clicmd:: show thread cpu [r|w|t|e|x] .. clicmd:: show thread cpu [r|w|t|e|x]
This command displays system run statistics for all the different event This command displays system run statistics for all the different event
@ -598,7 +549,6 @@ Terminal Mode Commands
(e)vent and e(x)ecute thread event types. If you have compiled with (e)vent and e(x)ecute thread event types. If you have compiled with
disable-cpu-time then this command will not show up. disable-cpu-time then this command will not show up.
.. index:: show thread poll
.. clicmd:: show thread poll .. clicmd:: show thread poll
This command displays FRR's poll data. It allows a glimpse into how This command displays FRR's poll data. It allows a glimpse into how

99
doc/user/bfd.rst
View File

@ -90,12 +90,10 @@ may also be specified (:ref:`common-invocation-options`).
BFDd Commands BFDd Commands
============= =============
.. index:: bfd
.. clicmd:: bfd .. clicmd:: bfd
Opens the BFD daemon configuration node. Opens the BFD daemon configuration node.
.. index:: peer <A.B.C.D|X:X::X:X> [{multihop|local-address <A.B.C.D|X:X::X:X>|interface IFNAME|vrf NAME}]
.. clicmd:: peer <A.B.C.D|X:X::X:X> [{multihop|local-address <A.B.C.D|X:X::X:X>|interface IFNAME|vrf NAME}] .. clicmd:: peer <A.B.C.D|X:X::X:X> [{multihop|local-address <A.B.C.D|X:X::X:X>|interface IFNAME|vrf NAME}]
Creates and configures a new BFD peer to listen and talk to. Creates and configures a new BFD peer to listen and talk to.
@ -113,41 +111,27 @@ BFDd Commands
`vrf` selects which domain we want to use. `vrf` selects which domain we want to use.
.. index:: peer <A.B.C.D|X:X::X:X>$peer [{multihop|local-address <A.B.C.D|X:X::X:X>$local|interface IFNAME$ifname|vrf NAME$vrf_name}]
.. clicmd:: no peer <A.B.C.D|X:X::X:X>$peer [{multihop|local-address <A.B.C.D|X:X::X:X>$local|interface IFNAME$ifname|vrf NAME$vrf_name}]
Stops and removes the selected peer.
.. index:: profile WORD
.. clicmd:: profile WORD .. clicmd:: profile WORD
Creates a peer profile that can be configured in multiple peers. Creates a peer profile that can be configured in multiple peers.
Deleting the profile will cause all peers using it to reset to the default
.. index:: profile WORD values.
.. clicmd:: no profile WORD
Deletes a peer profile. Any peer using the profile will have their
configurations reset to the default values.
.. index:: show bfd [vrf NAME] peers [json]
.. clicmd:: show bfd [vrf NAME] peers [json] .. clicmd:: show bfd [vrf NAME] peers [json]
Show all configured BFD peers information and current status. Show all configured BFD peers information and current status.
.. index:: show bfd [vrf NAME$vrf_name] peer <WORD$label|<A.B.C.D|X:X::X:X>$peer [{multihop|local-address <A.B.C.D|X:X::X:X>$local|interface IFNAME$ifname}]> [json]
.. clicmd:: show bfd [vrf NAME$vrf_name] peer <WORD$label|<A.B.C.D|X:X::X:X>$peer [{multihop|local-address <A.B.C.D|X:X::X:X>$local|interface IFNAME$ifname}]> [json] .. clicmd:: show bfd [vrf NAME$vrf_name] peer <WORD$label|<A.B.C.D|X:X::X:X>$peer [{multihop|local-address <A.B.C.D|X:X::X:X>$local|interface IFNAME$ifname}]> [json]
Show status for a specific BFD peer. Show status for a specific BFD peer.
.. index:: show bfd [vrf NAME] peers brief [json]
.. clicmd:: show bfd [vrf NAME] peers brief [json] .. clicmd:: show bfd [vrf NAME] peers brief [json]
Show all configured BFD peers information and current status in brief. Show all configured BFD peers information and current status in brief.
.. index:: show bfd distributed
.. clicmd:: show bfd distributed .. clicmd:: show bfd distributed
Show the BFD data plane (distributed BFD) statistics. Show the BFD data plane (distributed BFD) statistics.
@ -160,7 +144,6 @@ Peer / Profile Configuration
BFD peers and profiles share the same BFD session configuration commands. BFD peers and profiles share the same BFD session configuration commands.
.. index:: detect-multiplier (2-255)
.. clicmd:: detect-multiplier (2-255) .. clicmd:: detect-multiplier (2-255)
Configures the detection multiplier to determine packet loss. The Configures the detection multiplier to determine packet loss. The
@ -173,26 +156,22 @@ BFD peers and profiles share the same BFD session configuration commands.
detect failures only after 900 milliseconds without receiving detect failures only after 900 milliseconds without receiving
packets. packets.
.. index:: receive-interval (10-60000)
.. clicmd:: receive-interval (10-60000) .. clicmd:: receive-interval (10-60000)
Configures the minimum interval that this system is capable of Configures the minimum interval that this system is capable of
receiving control packets. The default value is 300 milliseconds. receiving control packets. The default value is 300 milliseconds.
.. index:: transmit-interval (10-60000)
.. clicmd:: transmit-interval (10-60000) .. clicmd:: transmit-interval (10-60000)
The minimum transmission interval (less jitter) that this system The minimum transmission interval (less jitter) that this system
wants to use to send BFD control packets. Defaults to 300ms. wants to use to send BFD control packets. Defaults to 300ms.
.. index:: echo-interval (10-60000)
.. clicmd:: echo-interval (10-60000) .. clicmd:: echo-interval (10-60000)
Configures the minimal echo receive transmission interval that this Configures the minimal echo receive transmission interval that this
system is capable of handling. system is capable of handling.
.. index:: echo-mode .. clicmd:: echo-mode
.. clicmd:: [no] echo-mode
Enables or disables the echo transmission mode. This mode is disabled Enables or disables the echo transmission mode. This mode is disabled
by default. by default.
@ -204,15 +183,13 @@ BFD peers and profiles share the same BFD session configuration commands.
Echo mode is not supported on multi-hop setups (see :rfc:`5883` Echo mode is not supported on multi-hop setups (see :rfc:`5883`
section 3). section 3).
.. index:: shutdown .. clicmd:: shutdown
.. clicmd:: [no] shutdown
Enables or disables the peer. When the peer is disabled an Enables or disables the peer. When the peer is disabled an
'administrative down' message is sent to the remote peer. 'administrative down' message is sent to the remote peer.
.. index:: passive-mode .. clicmd:: passive-mode
.. clicmd:: [no] passive-mode
Mark session as passive: a passive session will not attempt to start Mark session as passive: a passive session will not attempt to start
the connection and will wait for control packets from peer before it the connection and will wait for control packets from peer before it
@ -224,8 +201,7 @@ BFD peers and profiles share the same BFD session configuration commands.
The default is active-mode (or ``no passive-mode``). The default is active-mode (or ``no passive-mode``).
.. index:: minimum-ttl (1-254) .. clicmd:: minimum-ttl (1-254)
.. clicmd:: [no] minimum-ttl (1-254)
For multi hop sessions only: configure the minimum expected TTL for For multi hop sessions only: configure the minimum expected TTL for
an incoming BFD control packet. an incoming BFD control packet.
@ -241,14 +217,12 @@ BFD peers and profiles share the same BFD session configuration commands.
BFD Peer Specific Commands BFD Peer Specific Commands
-------------------------- --------------------------
.. index:: label WORD
.. clicmd:: label WORD .. clicmd:: label WORD
Labels a peer with the provided word. This word can be referenced Labels a peer with the provided word. This word can be referenced
later on other daemons to refer to a specific peer. later on other daemons to refer to a specific peer.
.. index:: profile BFDPROF
.. clicmd:: profile BFDPROF .. clicmd:: profile BFDPROF
Configure peer to use the profile configurations. Configure peer to use the profile configurations.
@ -270,7 +244,6 @@ BGP BFD Configuration
The following commands are available inside the BGP configuration node. The following commands are available inside the BGP configuration node.
.. index:: neighbor <A.B.C.D|X:X::X:X|WORD> bfd
.. clicmd:: neighbor <A.B.C.D|X:X::X:X|WORD> bfd .. clicmd:: neighbor <A.B.C.D|X:X::X:X|WORD> bfd
Listen for BFD events registered on the same target as this BGP Listen for BFD events registered on the same target as this BGP
@ -278,12 +251,7 @@ The following commands are available inside the BGP configuration node.
the connection with its neighbor and, when it goes back up, notify the connection with its neighbor and, when it goes back up, notify
BGP to try to connect to it. BGP to try to connect to it.
.. index:: neighbor <A.B.C.D|X:X::X:X|WORD> bfd
.. clicmd:: no neighbor <A.B.C.D|X:X::X:X|WORD> bfd
Removes any notification registration for this neighbor.
.. index:: neighbor <A.B.C.D|X:X::X:X|WORD> bfd check-control-plane-failure
.. clicmd:: neighbor <A.B.C.D|X:X::X:X|WORD> bfd check-control-plane-failure .. clicmd:: neighbor <A.B.C.D|X:X::X:X|WORD> bfd check-control-plane-failure
Allow to write CBIT independence in BFD outgoing packets. Also allow to Allow to write CBIT independence in BFD outgoing packets. Also allow to
@ -293,26 +261,16 @@ The following commands are available inside the BGP configuration node.
This is the case when graceful restart is enabled, and it is wished to This is the case when graceful restart is enabled, and it is wished to
ignore the BD event while waiting for the remote router to restart. ignore the BD event while waiting for the remote router to restart.
.. index:: neighbor <A.B.C.D|X:X::X:X|WORD> bfd check-control-plane-failure Disabling this disables presence of CBIT independence in BFD outgoing
.. clicmd:: no neighbor <A.B.C.D|X:X::X:X|WORD> bfd check-control-plane-failure packets and pays attention to BFD down notifications. This is the default.
Disallow to write CBIT independence in BFD outgoing packets. Also disallow
to ignore BFD down notification. This is the default behaviour.
.. index:: neighbor <A.B.C.D|X:X::X:X|WORD> bfd profile BFDPROF
.. clicmd:: neighbor <A.B.C.D|X:X::X:X|WORD> bfd profile BFDPROF .. clicmd:: neighbor <A.B.C.D|X:X::X:X|WORD> bfd profile BFDPROF
Same as command ``neighbor <A.B.C.D|X:X::X:X|WORD> bfd``, but applies the Same as command ``neighbor <A.B.C.D|X:X::X:X|WORD> bfd``, but applies the
BFD profile to the sessions it creates or that already exist. BFD profile to the sessions it creates or that already exist.
.. index:: neighbor <A.B.C.D|X:X::X:X|WORD> bfd profile BFDPROF
.. clicmd:: no neighbor <A.B.C.D|X:X::X:X|WORD> bfd profile BFDPROF
Removes the BFD profile configuration from peer session(s).
.. _bfd-isis-peer-config: .. _bfd-isis-peer-config:
IS-IS BFD Configuration IS-IS BFD Configuration
@ -320,31 +278,20 @@ IS-IS BFD Configuration
The following commands are available inside the interface configuration node. The following commands are available inside the interface configuration node.
.. index:: isis bfd
.. clicmd:: isis bfd .. clicmd:: isis bfd
Listen for BFD events on peers created on the interface. Every time Listen for BFD events on peers created on the interface. Every time
a new neighbor is found a BFD peer is created to monitor the link a new neighbor is found a BFD peer is created to monitor the link
status for fast convergence. status for fast convergence.
.. index:: isis bfd
.. clicmd:: no isis bfd
Removes any notification registration for this interface peers.
Note that there will be just one BFD session per interface. In case both Note that there will be just one BFD session per interface. In case both
IPv4 and IPv6 support are configured then just a IPv6 based session is IPv4 and IPv6 support are configured then just a IPv6 based session is
created. created.
.. index:: isis bfd profile BFDPROF
.. clicmd:: isis bfd profile BFDPROF .. clicmd:: isis bfd profile BFDPROF
Use a BFD profile BFDPROF as provided in the BFD configuration. Use a BFD profile BFDPROF as provided in the BFD configuration.
.. index:: isis bfd profile BFDPROF
.. clicmd:: no isis bfd profile BFDPROF
Removes any BFD profile if present.
.. _bfd-ospf-peer-config: .. _bfd-ospf-peer-config:
@ -353,18 +300,12 @@ OSPF BFD Configuration
The following commands are available inside the interface configuration node. The following commands are available inside the interface configuration node.
.. index:: ip ospf bfd
.. clicmd:: ip ospf bfd .. clicmd:: ip ospf bfd
Listen for BFD events on peers created on the interface. Every time Listen for BFD events on peers created on the interface. Every time
a new neighbor is found a BFD peer is created to monitor the link a new neighbor is found a BFD peer is created to monitor the link
status for fast convergence. status for fast convergence.
.. index:: ip ospf bfd
.. clicmd:: no ip ospf bfd
Removes any notification registration for this interface peers.
.. _bfd-ospf6-peer-config: .. _bfd-ospf6-peer-config:
@ -373,18 +314,12 @@ OSPF6 BFD Configuration
The following commands are available inside the interface configuration node. The following commands are available inside the interface configuration node.
.. index:: ipv6 ospf6 bfd
.. clicmd:: ipv6 ospf6 bfd .. clicmd:: ipv6 ospf6 bfd
Listen for BFD events on peers created on the interface. Every time Listen for BFD events on peers created on the interface. Every time
a new neighbor is found a BFD peer is created to monitor the link a new neighbor is found a BFD peer is created to monitor the link
status for fast convergence. status for fast convergence.
.. index:: ipv6 ospf6 bfd
.. clicmd:: no ipv6 ospf6 bfd
Removes any notification registration for this interface peers.
.. _bfd-pim-peer-config: .. _bfd-pim-peer-config:
@ -393,18 +328,12 @@ PIM BFD Configuration
The following commands are available inside the interface configuration node. The following commands are available inside the interface configuration node.
.. index:: ip pim bfd
.. clicmd:: ip pim bfd .. clicmd:: ip pim bfd
Listen for BFD events on peers created on the interface. Every time Listen for BFD events on peers created on the interface. Every time
a new neighbor is found a BFD peer is created to monitor the link a new neighbor is found a BFD peer is created to monitor the link
status for fast convergence. status for fast convergence.
.. index:: ip pim bfd
.. clicmd:: no ip pim bfd
Removes any notification registration for this interface peers.
.. _bfd-configuration: .. _bfd-configuration:
@ -721,8 +650,7 @@ sure you have `debugging` level enabled:
You may also fine tune the debug messages by selecting one or more of the You may also fine tune the debug messages by selecting one or more of the
debug levels: debug levels:
.. index:: debug bfd distributed .. clicmd:: debug bfd distributed
.. clicmd:: [no] debug bfd distributed
Toggle BFD data plane (distributed BFD) debugging. Toggle BFD data plane (distributed BFD) debugging.
@ -731,20 +659,17 @@ debug levels:
* Data plane received / send messages * Data plane received / send messages
* Connection events * Connection events
.. index:: debug bfd network .. clicmd:: debug bfd network
.. clicmd:: [no] debug bfd network
Toggle network events: show messages about socket failures and unexpected Toggle network events: show messages about socket failures and unexpected
BFD messages that may not belong to registered peers. BFD messages that may not belong to registered peers.
.. index:: debug bfd peer .. clicmd:: debug bfd peer
.. clicmd:: [no] debug bfd peer
Toggle peer event log messages: show messages about peer creation/removal Toggle peer event log messages: show messages about peer creation/removal
and state changes. and state changes.
.. index:: debug bfd zebra .. clicmd:: debug bfd zebra
.. clicmd:: [no] debug bfd zebra
Toggle zebra message events: show messages about interfaces, local Toggle zebra message events: show messages about interfaces, local
addresses, VRF and daemon peer registrations. addresses, VRF and daemon peer registrations.

508
doc/user/bgp.rst
View File

File diff suppressed because it is too large Load Diff

25
doc/user/bmp.rst
View File

@ -73,8 +73,7 @@ setup.
There is one option that applies to the BGP instance as a whole: There is one option that applies to the BGP instance as a whole:
.. index:: bmp mirror buffer-limit(0-4294967294) .. clicmd:: bmp mirror buffer-limit(0-4294967294)
.. clicmd:: [no] bmp mirror buffer-limit(0-4294967294)
This sets the maximum amount of memory used for buffering BGP messages This sets the maximum amount of memory used for buffering BGP messages
(updates, keepalives, ...) for sending in BMP Route Mirroring. (updates, keepalives, ...) for sending in BMP Route Mirroring.
@ -94,8 +93,7 @@ There is one option that applies to the BGP instance as a whole:
All other configuration is managed per targets: All other configuration is managed per targets:
.. index:: bmp targets NAME .. clicmd:: bmp targets NAME
.. clicmd:: [no] bmp targets NAME
Create/delete a targets group. As implied by the plural name, targets may Create/delete a targets group. As implied by the plural name, targets may
cover multiple outbound active BMP sessions as well as inbound passive cover multiple outbound active BMP sessions as well as inbound passive
@ -110,8 +108,7 @@ BMP session configuration
Inside a ``bmp targets`` block, the following commands control session Inside a ``bmp targets`` block, the following commands control session
establishment: establishment:
.. index:: bmp connect HOSTNAME port (1-65535) {min-retry MSEC|max-retry MSEC} .. clicmd:: bmp connect HOSTNAME port (1-65535) {min-retry MSEC|max-retry MSEC}
.. clicmd:: [no] bmp connect HOSTNAME port (1-65535) {min-retry MSEC|max-retry MSEC}
Add/remove an active outbound BMP session. HOSTNAME is resolved via DNS, Add/remove an active outbound BMP session. HOSTNAME is resolved via DNS,
if multiple addresses are returned they are tried in nondeterministic if multiple addresses are returned they are tried in nondeterministic
@ -124,14 +121,13 @@ establishment:
``ip access-list`` and ``ipv6 access-list`` are checked for outbound ``ip access-list`` and ``ipv6 access-list`` are checked for outbound
connections resulting from ``bmp connect`` statements. connections resulting from ``bmp connect`` statements.
.. index:: bmp listener <X:X::X:X|A.B.C.D> port (1-65535) .. clicmd:: bmp listener <X:X::X:X|A.B.C.D> port (1-65535)
.. clicmd:: [no] bmp listener <X:X::X:X|A.B.C.D> port (1-65535)
Accept incoming BMP sessions on the specified address and port. You can Accept incoming BMP sessions on the specified address and port. You can
use ``0.0.0.0`` and ``::`` to listen on all IPv4/IPv6 addresses. use ``0.0.0.0`` and ``::`` to listen on all IPv4/IPv6 addresses.
.. clicmd:: [no] ip access-list NAME .. clicmd:: ip access-list NAME
.. clicmd:: [no] ipv6 access-list NAME .. clicmd:: ipv6 access-list NAME
Restrict BMP sessions to the addresses allowed by the respective access Restrict BMP sessions to the addresses allowed by the respective access
lists. The access lists are checked for both passive and active BMP lists. The access lists are checked for both passive and active BMP
@ -143,14 +139,12 @@ BMP data feed configuration
The following commands configure what BMP messages are sent on sessions The following commands configure what BMP messages are sent on sessions
associated with a particular ``bmp targets``: associated with a particular ``bmp targets``:
.. index:: bmp stats [interval (100-86400000)] .. clicmd:: bmp stats [interval (100-86400000)]
.. clicmd:: [no] bmp stats [interval (100-86400000)]
Send BMP Statistics (counter) messages at the specified interval (in Send BMP Statistics (counter) messages at the specified interval (in
milliseconds.) milliseconds.)
.. index:: bmp monitor AFI SAFI <pre-policy|post-policy> .. clicmd:: bmp monitor AFI SAFI <pre-policy|post-policy>
.. clicmd:: [no] bmp monitor AFI SAFI <pre-policy|post-policy>
Perform Route Monitoring for the specified AFI and SAFI. Only IPv4 and Perform Route Monitoring for the specified AFI and SAFI. Only IPv4 and
IPv6 are currently valid for AFI, and only unicast and multicast are valid IPv6 are currently valid for AFI, and only unicast and multicast are valid
@ -159,8 +153,7 @@ associated with a particular ``bmp targets``:
All BGP neighbors are included in Route Monitoring. Options to select All BGP neighbors are included in Route Monitoring. Options to select
a subset of BGP sessions may be added in the future. a subset of BGP sessions may be added in the future.
.. index:: bmp mirror .. clicmd:: bmp mirror
.. clicmd:: [no] bmp mirror
Perform Route Mirroring for all BGP neighbors. Since this provides a Perform Route Mirroring for all BGP neighbors. Since this provides a
direct feed of BGP messages, there are no AFI/SAFI options to be direct feed of BGP messages, there are no AFI/SAFI options to be

4
doc/user/bugs.rst
View File

@ -1,5 +1,5 @@
.. index:: Bug Reports .. index::
.. index:: Reporting bugs pair: bug reports; contact
.. _bug-reports: .. _bug-reports:

2
doc/user/conf.py
View File

@ -384,7 +384,7 @@ def vparse(s):
def setup(app): def setup(app):
# object type for FRR CLI commands, can be extended to document parent CLI # object type for FRR CLI commands, can be extended to document parent CLI
# node later on # node later on
app.add_object_type("clicmd", "clicmd") app.add_object_type("clicmd", "clicmd", indextemplate="pair: %s; configuration command")
# css overrides for HTML theme # css overrides for HTML theme
# Note sphinx version differences # Note sphinx version differences

83
doc/user/eigrpd.rst
View File

@ -65,7 +65,6 @@ Certain signals have special meanings to *eigrpd*.
EIGRP Configuration EIGRP Configuration
=================== ===================
.. index:: router eigrp (1-65535) [vrf NAME]
.. clicmd:: router eigrp (1-65535) [vrf NAME] .. clicmd:: router eigrp (1-65535) [vrf NAME]
The `router eigrp` command is necessary to enable EIGRP. To disable EIGRP, The `router eigrp` command is necessary to enable EIGRP. To disable EIGRP,
@ -73,17 +72,8 @@ EIGRP Configuration
carrying out any of the EIGRP commands. Specify vrf NAME if you want carrying out any of the EIGRP commands. Specify vrf NAME if you want
eigrp to work within the specified vrf. eigrp to work within the specified vrf.
.. index:: router eigrp (1-65535) [vrf NAME]
.. clicmd:: no router eigrp (1-65535) [vrf NAME]
Disable EIGRP.
.. index:: network NETWORK
.. clicmd:: network NETWORK .. clicmd:: network NETWORK
.. index:: network NETWORK
.. clicmd:: no network NETWORK
Set the EIGRP enable interface by `network`. The interfaces which Set the EIGRP enable interface by `network`. The interfaces which
have addresses matching with `network` are enabled. have addresses matching with `network` are enabled.
@ -104,11 +94,8 @@ EIGRP Configuration
! !
.. index:: passive-interface (IFNAME|default)
.. clicmd:: passive-interface (IFNAME|default) .. clicmd:: passive-interface (IFNAME|default)
.. index:: passive-interface IFNAME
.. clicmd:: no passive-interface IFNAME
This command sets the specified interface to passive mode. On passive mode This command sets the specified interface to passive mode. On passive mode
interface, all receiving packets are ignored and eigrpd does not send either interface, all receiving packets are ignored and eigrpd does not send either
@ -123,74 +110,26 @@ EIGRP Configuration
How to Announce EIGRP route How to Announce EIGRP route
=========================== ===========================
.. index:: redistribute kernel Redistribute routes into EIGRP:
.. clicmd:: redistribute kernel
.. index:: redistribute kernel metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535) .. clicmd:: redistribute <babel|bgp|connected|isis|kernel|openfabric|ospf|rip|sharp|static|table> [metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535)]
.. clicmd:: redistribute kernel metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535)
.. index:: redistribute kernel The ``redistribute`` family of commands imports routing information from
.. clicmd:: no redistribute kernel other sources into EIGRP's tables. Redistribution may be disabled with the
``no`` form of the commands.
`redistribute kernel` redistributes routing information from kernel route Note that connected routes on interfaces EIGRP is enabled on are announced
entries into the EIGRP tables. `no redistribute kernel` disables the routes. by default.
.. index:: redistribute static Optionally, various EIGRP metrics may be specified. These metrics will be
.. clicmd:: redistribute static applied to the imported routes.
.. index:: redistribute static metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535)
.. clicmd:: redistribute static metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535)
.. index:: redistribute static
.. clicmd:: no redistribute static
`redistribute static` redistributes routing information from static route
entries into the EIGRP tables. `no redistribute static` disables the routes.
.. index:: redistribute connected
.. clicmd:: redistribute connected
.. index:: redistribute connected metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535)
.. clicmd:: redistribute connected metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535)
.. index:: redistribute connected
.. clicmd:: no redistribute connected
Redistribute connected routes into the EIGRP tables. `no redistribute
connected` disables the connected routes in the EIGRP tables. This command
redistribute connected of the interface which EIGRP disabled. The connected
route on EIGRP enabled interface is announced by default.
.. index:: redistribute ospf
.. clicmd:: redistribute ospf
.. index:: redistribute ospf metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535)
.. clicmd:: redistribute ospf metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535)
.. index:: redistribute ospf
.. clicmd:: no redistribute ospf
`redistribute ospf` redistributes routing information from ospf route
entries into the EIGRP tables. `no redistribute ospf` disables the routes.
.. index:: redistribute bgp
.. clicmd:: redistribute bgp
.. index:: redistribute bgp metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535)
.. clicmd:: redistribute bgp metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535)
.. index:: redistribute bgp
.. clicmd:: no redistribute bgp
`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 Show EIGRP Information
====================== ======================
.. index:: show ip eigrp [vrf NAME] topology
.. clicmd:: show ip eigrp [vrf NAME] topology .. clicmd:: show ip eigrp [vrf NAME] topology
Display current EIGRP status. Display current EIGRP status.
@ -208,7 +147,6 @@ Show EIGRP Information
P 10.0.2.0/24, 1 successors, FD is 256256, serno: 0 P 10.0.2.0/24, 1 successors, FD is 256256, serno: 0
via Connected, enp0s3 via Connected, enp0s3
.. index:: show ip eigrp [vrf NAME] interface
.. clicmd:: show ip eigrp [vrf NAME] interface .. clicmd:: show ip eigrp [vrf NAME] interface
Display the list of interfaces associated with a particular eigrp Display the list of interfaces associated with a particular eigrp
@ -225,14 +163,12 @@ EIGRP Debug Commands
Debug for EIGRP protocol. Debug for EIGRP protocol.
.. index:: debug eigrp packets
.. clicmd:: debug eigrp packets .. clicmd:: debug eigrp packets
Debug eigrp packets Debug eigrp packets
``debug eigrp`` will show EIGRP packets that are sent and received. ``debug eigrp`` will show EIGRP packets that are sent and received.
.. index:: debug eigrp transmit
.. clicmd:: debug eigrp transmit .. clicmd:: debug eigrp transmit
Debug eigrp transmit events Debug eigrp transmit events
@ -240,7 +176,6 @@ Debug for EIGRP protocol.
``debug eigrp transmit`` will display detailed information about the EIGRP ``debug eigrp transmit`` will display detailed information about the EIGRP
transmit events. transmit events.
.. index:: show debugging eigrp
.. clicmd:: show debugging eigrp .. clicmd:: show debugging eigrp
Display *eigrpd*'s debugging option. Display *eigrpd*'s debugging option.

142
doc/user/fabricd.rst
View File

@ -32,37 +32,21 @@ OpenFabric router
To enable the OpenFabric routing protocol, an OpenFabric router needs to be created To enable the OpenFabric routing protocol, an OpenFabric router needs to be created
in the configuration: in the configuration:
.. index:: router openfabric WORD
.. clicmd:: router openfabric WORD .. clicmd:: router openfabric WORD
.. index:: router openfabric WORD
.. clicmd:: no router openfabric WORD
Enable or disable the OpenFabric process by specifying the OpenFabric domain with Enable or disable the OpenFabric process by specifying the OpenFabric domain with
'WORD'. 'WORD'.
.. index:: net XX.XXXX. ... .XXX.XX
.. clicmd:: net XX.XXXX. ... .XXX.XX .. clicmd:: net XX.XXXX. ... .XXX.XX
.. index:: net XX.XXXX. ... .XXX.XX
.. clicmd:: no net XX.XXXX. ... .XXX.XX
Set/Unset network entity title (NET) provided in ISO format. Set/Unset network entity title (NET) provided in ISO format.
.. index:: domain-password [clear | md5] <password>
.. clicmd:: domain-password [clear | md5] <password> .. clicmd:: domain-password [clear | md5] <password>
.. index:: domain-password
.. clicmd:: no domain-password
Configure the authentication password for a domain, as clear text or md5 one. Configure the authentication password for a domain, as clear text or md5 one.
.. index:: attached-bit [receive ignore | send]
.. clicmd:: attached-bit [receive ignore | send] .. clicmd:: attached-bit [receive ignore | send]
.. index:: attached-bit
.. clicmd:: no attached-bit
Set attached bit for inter-area traffic: Set attached bit for inter-area traffic:
- receive - receive
@ -70,35 +54,22 @@ in the configuration:
- send - send
If L1|L2 router, set attached bit in LSP sent to L1 router If L1|L2 router, set attached bit in LSP sent to L1 router
.. index:: log-adjacency-changes
.. clicmd:: log-adjacency-changes .. clicmd:: log-adjacency-changes
.. index:: log-adjacency-changes
.. clicmd:: no log-adjacency-changes
Log changes in adjacency state. Log changes in adjacency state.
.. index:: set-overload-bit
.. clicmd:: set-overload-bit .. clicmd:: set-overload-bit
.. index:: set-overload-bit
.. clicmd:: no set-overload-bit
Set overload bit to avoid any transit traffic. Set overload bit to avoid any transit traffic.
.. index:: purge-originator
.. clicmd:: purge-originator .. clicmd:: purge-originator
.. index:: purge-originator
.. clicmd:: no purge-originator
Enable or disable :rfc:`6232` purge originator identification. Enable or disable :rfc:`6232` purge originator identification.
.. index:: fabric-tier (0-14)
.. clicmd:: fabric-tier (0-14) .. clicmd:: fabric-tier (0-14)
.. index:: fabric-tier
.. clicmd:: no fabric-tier
Configure a static tier number to advertise as location in the fabric Configure a static tier number to advertise as location in the fabric
@ -107,35 +78,23 @@ in the configuration:
OpenFabric Timer OpenFabric Timer
================ ================
.. index:: lsp-gen-interval (1-120)
.. clicmd:: lsp-gen-interval (1-120) .. clicmd:: lsp-gen-interval (1-120)
.. index:: lsp-gen-interval
.. clicmd:: no lsp-gen-interval
Set minimum interval in seconds between regenerating same LSP. Set minimum interval in seconds between regenerating same LSP.
.. index:: lsp-refresh-interval (1-65235)
.. clicmd:: lsp-refresh-interval (1-65235) .. clicmd:: lsp-refresh-interval (1-65235)
.. index:: lsp-refresh-interval
.. clicmd:: no lsp-refresh-interval
Set LSP refresh interval in seconds. Set LSP refresh interval in seconds.
.. index:: max-lsp-lifetime (360-65535)
.. clicmd:: max-lsp-lifetime (360-65535) .. clicmd:: max-lsp-lifetime (360-65535)
.. index:: max-lsp-lifetime
.. clicmd:: no max-lsp-lifetime
Set LSP maximum LSP lifetime in seconds. Set LSP maximum LSP lifetime in seconds.
.. index:: spf-interval (1-120)
.. clicmd:: spf-interval (1-120) .. clicmd:: spf-interval (1-120)
.. index:: spf-interval
.. clicmd:: no spf-interval
Set minimum interval between consecutive SPF calculations in seconds. Set minimum interval between consecutive SPF calculations in seconds.
@ -144,11 +103,8 @@ OpenFabric Timer
OpenFabric interface OpenFabric interface
==================== ====================
.. index:: ip router openfabric WORD
.. clicmd:: ip router openfabric WORD .. clicmd:: ip router openfabric WORD
.. index:: ip router openfabric WORD
.. clicmd:: no ip router openfabric WORD
.. _ip-router-openfabric-word: .. _ip-router-openfabric-word:
@ -156,60 +112,39 @@ OpenFabric interface
of OpenFabric instance must be the same as the one used to configure the of OpenFabric instance must be the same as the one used to configure the
routing process (see command :clicmd:`router openfabric WORD`). routing process (see command :clicmd:`router openfabric WORD`).
.. index:: openfabric csnp-interval (1-600)
.. clicmd:: openfabric csnp-interval (1-600) .. clicmd:: openfabric csnp-interval (1-600)
.. index:: openfabric csnp-interval
.. clicmd:: no openfabric csnp-interval
Set CSNP interval in seconds. Set CSNP interval in seconds.
.. index:: openfabric hello-interval (1-600)
.. clicmd:: openfabric hello-interval (1-600) .. clicmd:: openfabric hello-interval (1-600)
.. index:: openfabric hello-interval
.. clicmd:: no openfabric hello-interval
Set Hello interval in seconds. Set Hello interval in seconds.
.. index:: openfabric hello-multiplier (2-100)
.. clicmd:: openfabric hello-multiplier (2-100) .. clicmd:: openfabric hello-multiplier (2-100)
.. index:: openfabric hello-multiplier
.. clicmd:: no openfabric hello-multiplier
Set multiplier for Hello holding time. Set multiplier for Hello holding time.
.. index:: openfabric metric (0-16777215)
.. clicmd:: openfabric metric (0-16777215) .. clicmd:: openfabric metric (0-16777215)
.. index:: openfabric metric
.. clicmd:: no openfabric metric
Set interface metric value. Set interface metric value.
.. index:: openfabric passive
.. clicmd:: openfabric passive .. clicmd:: openfabric passive
.. index:: openfabric passive
.. clicmd:: no openfabric passive
Configure the passive mode for this interface. Configure the passive mode for this interface.
.. index:: openfabric password [clear | md5] <password>
.. clicmd:: openfabric password [clear | md5] <password> .. clicmd:: openfabric password [clear | md5] <password>
.. index:: openfabric password
.. clicmd:: no openfabric password
Configure the authentication password (clear or encoded text) for the Configure the authentication password (clear or encoded text) for the
interface. interface.
.. index:: openfabric psnp-interval (1-120)
.. clicmd:: openfabric psnp-interval (1-120) .. clicmd:: openfabric psnp-interval (1-120)
.. index:: openfabric psnp-interval
.. clicmd:: no openfabric psnp-interval
Set PSNP interval in seconds. Set PSNP interval in seconds.
@ -218,56 +153,43 @@ OpenFabric interface
Showing OpenFabric information Showing OpenFabric information
============================== ==============================
.. index:: show openfabric summary
.. clicmd:: show openfabric summary .. clicmd:: show openfabric summary
Show summary information about OpenFabric. Show summary information about OpenFabric.
.. index:: show openfabric hostname
.. clicmd:: show openfabric hostname .. clicmd:: show openfabric hostname
Show which hostnames are associated with which OpenFabric system ids. Show which hostnames are associated with which OpenFabric system ids.
.. index:: show openfabric interface
.. clicmd:: show openfabric interface .. clicmd:: show openfabric interface
.. index:: show openfabric interface detail
.. clicmd:: show openfabric interface detail .. clicmd:: show openfabric interface detail
.. index:: show openfabric interface <interface name>
.. clicmd:: show openfabric interface <interface name> .. clicmd:: show openfabric interface <interface name>
Show state and configuration of specified OpenFabric interface, or all interfaces Show state and configuration of specified OpenFabric interface, or all interfaces
if no interface is given with or without details. if no interface is given with or without details.
.. index:: show openfabric neighbor
.. clicmd:: show openfabric neighbor .. clicmd:: show openfabric neighbor
.. index:: show openfabric neighbor <System Id>
.. clicmd:: show openfabric neighbor <System Id> .. clicmd:: show openfabric neighbor <System Id>
.. index:: show openfabric neighbor detail
.. clicmd:: show openfabric neighbor detail .. clicmd:: show openfabric neighbor detail
Show state and information of specified OpenFabric neighbor, or all neighbors if Show state and information of specified OpenFabric neighbor, or all neighbors if
no system id is given with or without details. no system id is given with or without details.
.. index:: show openfabric database
.. clicmd:: show openfabric database .. clicmd:: show openfabric database
.. index:: show openfabric database [detail]
.. clicmd:: show openfabric database [detail] .. clicmd:: show openfabric database [detail]
.. index:: show openfabric database <LSP id> [detail]
.. clicmd:: show openfabric database <LSP id> [detail] .. clicmd:: show openfabric database <LSP id> [detail]
.. index:: show openfabric database detail <LSP id>
.. clicmd:: show openfabric database detail <LSP id> .. clicmd:: show openfabric database detail <LSP id>
Show the OpenFabric database globally, for a specific LSP id without or with Show the OpenFabric database globally, for a specific LSP id without or with
details. details.
.. index:: show openfabric topology
.. clicmd:: show openfabric topology .. clicmd:: show openfabric topology
Show calculated OpenFabric paths and associated topology information. Show calculated OpenFabric paths and associated topology information.
@ -277,120 +199,64 @@ Showing OpenFabric information
Debugging OpenFabric Debugging OpenFabric
==================== ====================
.. index:: debug openfabric adj-packets
.. clicmd:: debug openfabric adj-packets .. clicmd:: debug openfabric adj-packets
.. index:: debug openfabric adj-packets
.. clicmd:: no debug openfabric adj-packets
OpenFabric Adjacency related packets. OpenFabric Adjacency related packets.
.. index:: debug openfabric checksum-errors
.. clicmd:: debug openfabric checksum-errors .. clicmd:: debug openfabric checksum-errors
.. index:: debug openfabric checksum-errors
.. clicmd:: no debug openfabric checksum-errors
OpenFabric LSP checksum errors. OpenFabric LSP checksum errors.
.. index:: debug openfabric events
.. clicmd:: debug openfabric events .. clicmd:: debug openfabric events
.. index:: debug openfabric events
.. clicmd:: no debug openfabric events
OpenFabric Events. OpenFabric Events.
.. index:: debug openfabric local-updates
.. clicmd:: debug openfabric local-updates .. clicmd:: debug openfabric local-updates
.. index:: debug openfabric local-updates
.. clicmd:: no debug openfabric local-updates
OpenFabric local update packets. OpenFabric local update packets.
.. index:: debug openfabric lsp-gen
.. clicmd:: debug openfabric lsp-gen .. clicmd:: debug openfabric lsp-gen
.. index:: debug openfabric lsp-gen
.. clicmd:: no debug openfabric lsp-gen
Generation of own LSPs. Generation of own LSPs.
.. index:: debug openfabric lsp-sched
.. clicmd:: debug openfabric lsp-sched .. clicmd:: debug openfabric lsp-sched
.. index:: debug openfabric lsp-sched
.. clicmd:: no debug openfabric lsp-sched
Debug scheduling of generation of own LSPs. Debug scheduling of generation of own LSPs.
.. index:: debug openfabric packet-dump
.. clicmd:: debug openfabric packet-dump .. clicmd:: debug openfabric packet-dump
.. index:: debug openfabric packet-dump
.. clicmd:: no debug openfabric packet-dump
OpenFabric packet dump. OpenFabric packet dump.
.. index:: debug openfabric protocol-errors
.. clicmd:: debug openfabric protocol-errors .. clicmd:: debug openfabric protocol-errors
.. index:: debug openfabric protocol-errors
.. clicmd:: no debug openfabric protocol-errors
OpenFabric LSP protocol errors. OpenFabric LSP protocol errors.
.. index:: debug openfabric route-events
.. clicmd:: debug openfabric route-events .. clicmd:: debug openfabric route-events
.. index:: debug openfabric route-events
.. clicmd:: no debug openfabric route-events
OpenFabric Route related events. OpenFabric Route related events.
.. index:: debug openfabric snp-packets
.. clicmd:: debug openfabric snp-packets .. clicmd:: debug openfabric snp-packets
.. index:: debug openfabric snp-packets
.. clicmd:: no debug openfabric snp-packets
OpenFabric CSNP/PSNP packets. OpenFabric CSNP/PSNP packets.
.. index:: debug openfabric spf-events
.. clicmd:: debug openfabric spf-events .. clicmd:: debug openfabric spf-events
.. index:: debug openfabric spf-statistics
.. clicmd:: debug openfabric spf-statistics .. clicmd:: debug openfabric spf-statistics
.. index:: debug openfabric spf-triggers
.. clicmd:: debug openfabric spf-triggers .. clicmd:: debug openfabric spf-triggers
.. index:: debug openfabric spf-events OpenFabric Shortest Path First Events, Timing and Statistic Data and
.. clicmd:: no debug openfabric spf-events triggering events.
.. index:: debug openfabric spf-statistics
.. clicmd:: no debug openfabric spf-statistics
.. index:: debug openfabric spf-triggers
.. clicmd:: no debug openfabric spf-triggers
OpenFabric Shortest Path First Events, Timing and Statistic Data and triggering
events.
.. index:: debug openfabric update-packets
.. clicmd:: debug openfabric update-packets .. clicmd:: debug openfabric update-packets
.. index:: debug openfabric update-packets Update-related packets.
.. clicmd:: no debug openfabric update-packets
Update related packets.
.. index:: show debugging openfabric
.. clicmd:: show debugging openfabric .. clicmd:: show debugging openfabric
Print which OpenFabric debug levels are active. Print which OpenFabric debug levels are active.
OpenFabric configuration example OpenFabric configuration example
================================ ================================

29
doc/user/filter.rst
View File

@ -9,10 +9,8 @@ defined, it can be applied in any direction.
IP Access List IP Access List
============== ==============
.. index:: access-list NAME [seq (1-4294967295)] permit IPV4-NETWORK
.. clicmd:: access-list NAME [seq (1-4294967295)] permit IPV4-NETWORK .. clicmd:: access-list NAME [seq (1-4294967295)] permit IPV4-NETWORK
.. index:: access-list NAME [seq (1-4294967295)] deny IPV4-NETWORK
.. clicmd:: access-list NAME [seq (1-4294967295)] deny IPV4-NETWORK .. clicmd:: access-list NAME [seq (1-4294967295)] deny IPV4-NETWORK
seq seq
@ -50,10 +48,8 @@ filters to arbitrary points of prefix-list using sequential number specification
If no ip prefix-list is specified, it acts as permit. If *ip prefix-list* If no ip prefix-list is specified, it acts as permit. If *ip prefix-list*
is defined, and no match is found, default deny is applied. is defined, and no match is found, default deny is applied.
.. index:: ip prefix-list NAME (permit|deny) PREFIX [le LEN] [ge LEN]
.. clicmd:: ip prefix-list NAME (permit|deny) PREFIX [le LEN] [ge LEN] .. clicmd:: ip prefix-list NAME (permit|deny) PREFIX [le LEN] [ge LEN]
.. index:: ip prefix-list NAME seq NUMBER (permit|deny) PREFIX [le LEN] [ge LEN]
.. clicmd:: ip prefix-list NAME seq NUMBER (permit|deny) PREFIX [le LEN] [ge LEN] .. clicmd:: ip prefix-list NAME seq NUMBER (permit|deny) PREFIX [le LEN] [ge LEN]
You can create *ip prefix-list* using above commands. You can create *ip prefix-list* using above commands.
@ -98,88 +94,63 @@ is defined, and no match is found, default deny is applied.
In the case of no le or ge command, the prefix length must match exactly the In the case of no le or ge command, the prefix length must match exactly the
length specified in the prefix list. length specified in the prefix list.
.. index:: ip prefix-list NAME
.. clicmd:: no ip prefix-list NAME
.. _ip-prefix-list-description: .. _ip-prefix-list-description:
ip prefix-list description ip prefix-list description
-------------------------- --------------------------
.. index:: ip prefix-list NAME description DESC
.. clicmd:: ip prefix-list NAME description DESC .. clicmd:: ip prefix-list NAME description DESC
Descriptions may be added to prefix lists. This command adds a Descriptions may be added to prefix lists. This command adds a
description to the prefix list. description to the prefix list.
.. index:: ip prefix-list NAME description [DESC]
.. clicmd:: no ip prefix-list NAME description [DESC]
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 ip prefix-list sequential number control
---------------------------------------- ----------------------------------------
.. index:: ip prefix-list sequence-number
.. clicmd:: ip prefix-list sequence-number .. clicmd:: ip prefix-list sequence-number
With this command, the IP prefix list sequential number is displayed. With this command, the IP prefix list sequential number is displayed.
This is the default behavior. This is the default behavior.
.. index:: ip prefix-list sequence-number
.. clicmd:: no ip prefix-list sequence-number
With this command, the IP prefix list sequential number is not
displayed.
.. _showing-ip-prefix-list: .. _showing-ip-prefix-list:
Showing ip prefix-list Showing ip prefix-list
---------------------- ----------------------
.. index:: show ip prefix-list
.. clicmd:: show ip prefix-list .. clicmd:: show ip prefix-list
Display all IP prefix lists. Display all IP prefix lists.
.. index:: show ip prefix-list NAME
.. clicmd:: show ip prefix-list NAME .. clicmd:: show ip prefix-list NAME
Show IP prefix list can be used with a prefix list name. Show IP prefix list can be used with a prefix list name.
.. index:: show ip prefix-list NAME seq NUM
.. clicmd:: show ip prefix-list NAME seq NUM .. clicmd:: show ip prefix-list NAME seq NUM
Show IP prefix list can be used with a prefix list name and sequential Show IP prefix list can be used with a prefix list name and sequential
number. number.
.. index:: show ip prefix-list NAME A.B.C.D/M
.. clicmd:: show ip prefix-list NAME A.B.C.D/M .. clicmd:: show ip prefix-list NAME A.B.C.D/M
If the command longer is used, all prefix lists with prefix lengths equal to If the command longer is used, all prefix lists with prefix lengths equal to
or longer than the specified length will be displayed. If the command first or longer than the specified length will be displayed. If the command first
match is used, the first prefix length match will be displayed. match is used, the first prefix length match will be displayed.
.. index:: show ip prefix-list NAME A.B.C.D/M longer
.. clicmd:: show ip prefix-list NAME A.B.C.D/M longer .. clicmd:: show ip prefix-list NAME A.B.C.D/M longer
.. index:: show ip prefix-list NAME A.B.C.D/M first-match
.. clicmd:: show ip prefix-list NAME A.B.C.D/M first-match .. clicmd:: show ip prefix-list NAME A.B.C.D/M first-match
.. index:: show ip prefix-list summary
.. clicmd:: show ip prefix-list summary .. clicmd:: show ip prefix-list summary
.. index:: show ip prefix-list summary NAME
.. clicmd:: show ip prefix-list summary NAME .. clicmd:: show ip prefix-list summary NAME
.. index:: show ip prefix-list detail
.. clicmd:: show ip prefix-list detail .. clicmd:: show ip prefix-list detail
.. index:: show ip prefix-list detail NAME
.. clicmd:: show ip prefix-list detail NAME .. clicmd:: show ip prefix-list detail NAME
Clear counter of ip prefix-list Clear counter of ip prefix-list
------------------------------- -------------------------------
.. index:: clear ip prefix-list [NAME [A.B.C.D/M]]
.. clicmd:: clear ip prefix-list [NAME [A.B.C.D/M]] .. clicmd:: clear ip prefix-list [NAME [A.B.C.D/M]]
Clears the counters of all IP prefix lists. Clear IP Prefix List can be used Clears the counters of all IP prefix lists. Clear IP Prefix List can be used

16
doc/user/flowspec.rst
View File

@ -123,10 +123,8 @@ As of today, it is only possible to configure Flowspec on the default VRF.
You can see Flowspec entries, by using one of the following show commands: You can see Flowspec entries, by using one of the following show commands:
.. index:: show bgp ipv4 flowspec [detail | A.B.C.D]
.. clicmd:: show bgp ipv4 flowspec [detail | A.B.C.D] .. clicmd:: show bgp ipv4 flowspec [detail | A.B.C.D]
.. index:: show bgp ipv6 flowspec [detail | A:B::C:D]
.. clicmd:: show bgp ipv6 flowspec [detail | A:B::C:D] .. clicmd:: show bgp ipv6 flowspec [detail | A:B::C:D]
Per-interface configuration Per-interface configuration
@ -141,8 +139,7 @@ twice the traffic, or slow down the traffic (filtering costs). To limit
Flowspec to one specific interface, use the following command, under Flowspec to one specific interface, use the following command, under
`flowspec address-family` node. `flowspec address-family` node.
.. index:: local-install <IFNAME | any> .. clicmd:: local-install <IFNAME | any>
.. clicmd:: [no] local-install <IFNAME | any>
By default, Flowspec is activated on all interfaces. Installing it to a named By default, Flowspec is activated on all interfaces. Installing it to a named
interface will result in allowing only this interface. Conversely, enabling any interface will result in allowing only this interface. Conversely, enabling any
@ -168,8 +165,7 @@ following:
- The first VRF with the matching Route Target will be selected to route traffic - The first VRF with the matching Route Target will be selected to route traffic
to. Use the following command under ipv4 unicast address-family node to. Use the following command under ipv4 unicast address-family node
.. index:: rt redirect import RTLIST... .. clicmd:: rt redirect import RTLIST...
.. clicmd:: [no] rt redirect import RTLIST...
In order to illustrate, if the Route Target configured in the Flowspec entry is In order to illustrate, if the Route Target configured in the Flowspec entry is
``E.F.G.H:II``, then a BGP VRF instance with the same Route Target will be set ``E.F.G.H:II``, then a BGP VRF instance with the same Route Target will be set
@ -223,7 +219,6 @@ Those command rely on the filtering contexts configured from BGP, and get the
statistics information retrieved from the underlying system. In other words, statistics information retrieved from the underlying system. In other words,
those statistics are retrieved from ``Netfilter``. those statistics are retrieved from ``Netfilter``.
.. index:: show pbr ipset IPSETNAME | iptable
.. clicmd:: show pbr ipset IPSETNAME | iptable .. clicmd:: show pbr ipset IPSETNAME | iptable
``IPSETNAME`` is the policy routing object name created by ``ipset``. About ``IPSETNAME`` is the policy routing object name created by ``ipset``. About
@ -235,21 +230,18 @@ match.
.. code-block:: frr .. code-block:: frr
.. index:: show ip route table TABLEID
.. clicmd:: show ip route table TABLEID .. clicmd:: show ip route table TABLEID
``TABLEID`` is the table number identifier referencing the non standard ``TABLEID`` is the table number identifier referencing the non standard
routing table used in this example. routing table used in this example.
.. index:: debug bgp flowspec .. clicmd:: debug bgp flowspec
.. clicmd:: [no] debug bgp flowspec
You can troubleshoot Flowspec, or BGP policy based routing. For instance, if You can troubleshoot Flowspec, or BGP policy based routing. For instance, if
you encounter some issues when decoding a Flowspec entry, you should enable you encounter some issues when decoding a Flowspec entry, you should enable
:clicmd:`debug bgp flowspec`. :clicmd:`debug bgp flowspec`.
.. index:: debug bgp pbr [error] .. clicmd:: debug bgp pbr [error]
.. clicmd:: [no] debug bgp pbr [error]
If you fail to apply the flowspec entry into *zebra*, there should be some If you fail to apply the flowspec entry into *zebra*, there should be some
relationship with policy routing mechanism. Here, relationship with policy routing mechanism. Here,

45
doc/user/installation.rst
View File

@ -1,16 +1,16 @@
.. index::
single: How to install FRR
single: Installing FRR
single: Building FRR
.. _installation: .. _installation:
Installation Installation
============ ============
.. index:: How to install FRR
.. index:: Installation
.. index:: Installing FRR
.. index:: Building the system
.. index:: Making FRR
This section covers the basics of building, installing and setting up FRR. This section covers the basics of building, installing and setting up FRR.
From Packages From Packages
------------- -------------
@ -55,14 +55,18 @@ is the release version.
In addition, release tarballs are published on the GitHub releases page In addition, release tarballs are published on the GitHub releases page
`here <https://github.com/FRRouting/frr/releases>`_. `here <https://github.com/FRRouting/frr/releases>`_.
Configuration
^^^^^^^^^^^^^
.. index:: Configuration options .. index::
.. index:: Options for configuring single: Configuration options
.. index:: Build options single: Options for configuring
.. index:: Distribution configuration single: Build options
.. index:: Options to `./configure` single: Distribution configuration
single: Options to `./configure`
.. _build-configuration:
Build Configuration
^^^^^^^^^^^^^^^^^^^
FRR has an excellent configure script which automatically detects most host FRR has an excellent configure script which automatically detects most host
configurations. There are several additional configure options to customize the configurations. There are several additional configure options to customize the
@ -420,14 +424,15 @@ The `sphinx` and `pytest` dependencies can be avoided by not building
documentation / not running ``make check``, but the CPython dependency is a documentation / not running ``make check``, but the CPython dependency is a
hard dependency of the FRR build process (for the `clippy` tool.) hard dependency of the FRR build process (for the `clippy` tool.)
.. index::
single: FRR Least-Privileges
single: FRR Privileges
.. _least-privilege-support: .. _least-privilege-support:
Least-Privilege Support Least-Privilege Support
""""""""""""""""""""""" """""""""""""""""""""""
.. index:: FRR Least-Privileges
.. index:: FRR Privileges
Additionally, you may configure zebra to drop its elevated privileges Additionally, you may configure zebra to drop its elevated privileges
shortly after startup and switch to another user. The configure script will shortly after startup and switch to another user. The configure script will
automatically try to configure this support. There are three configure automatically try to configure this support. There are three configure
@ -460,12 +465,14 @@ only Linux), FRR will retain only minimal capabilities required and will only
raise these capabilities for brief periods. On systems without libcap, FRR will 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. run as the user specified and only raise its UID to 0 for brief periods.
.. index::
pair: building; Linux
pair: configuration; Linux
Linux Notes Linux Notes
""""""""""" """""""""""
.. index:: Building on Linux boxes
.. index:: Linux configurations
There are several options available only to GNU/Linux systems. If you use There are several options available only to GNU/Linux systems. If you use
GNU/Linux, make sure that the current kernel configuration is what you want. GNU/Linux, make sure that the current kernel configuration is what you want.
FRR will run with any kernel configuration but some recommendations do exist. FRR will run with any kernel configuration but some recommendations do exist.

62
doc/user/ipv6.rst
View File

@ -17,17 +17,11 @@ no longer possible.
Router Advertisement Router Advertisement
==================== ====================
.. index:: ipv6 nd suppress-ra
.. clicmd:: no ipv6 nd suppress-ra
Send router advertisement messages.
.. index:: ipv6 nd suppress-ra
.. clicmd:: ipv6 nd suppress-ra .. clicmd:: ipv6 nd suppress-ra
Don't send router advertisement messages. Don't send router advertisement messages. The ``no`` form of this command
enables sending RA messages.
.. index:: ipv6 nd prefix ipv6prefix [valid-lifetime] [preferred-lifetime] [off-link] [no-autoconfig] [router-address]
.. clicmd:: ipv6 nd prefix ipv6prefix [valid-lifetime] [preferred-lifetime] [off-link] [no-autoconfig] [router-address] .. clicmd:: ipv6 nd prefix ipv6prefix [valid-lifetime] [preferred-lifetime] [off-link] [no-autoconfig] [router-address]
Configuring the IPv6 prefix to include in router advertisements. Several prefix Configuring the IPv6 prefix to include in router advertisements. Several prefix
@ -57,22 +51,19 @@ Router Advertisement
Default: not set, i.e. hosts do not assume a complete IP address is placed. Default: not set, i.e. hosts do not assume a complete IP address is placed.
.. index:: ipv6 nd ra-interval [(1-1800)] .. clicmd:: ipv6 nd ra-interval [(1-1800)]
.. clicmd:: [no] ipv6 nd ra-interval [(1-1800)]
The maximum time allowed between sending unsolicited multicast router The maximum time allowed between sending unsolicited multicast router
advertisements from the interface, in seconds. advertisements from the interface, in seconds.
Default: ``600`` Default: ``600``
.. index:: ipv6 nd ra-interval msec (70-1800000) .. clicmd:: ipv6 nd ra-interval [msec (70-1800000)]
.. clicmd:: [no] ipv6 nd ra-interval [msec (70-1800000)]
The maximum time allowed between sending unsolicited multicast router The maximum time allowed between sending unsolicited multicast router
advertisements from the interface, in milliseconds. advertisements from the interface, in milliseconds.
Default: ``600000`` Default: ``600000``
.. index:: ipv6 nd ra-fast-retrans .. clicmd:: ipv6 nd ra-fast-retrans
.. clicmd:: [no] ipv6 nd ra-fast-retrans
RFC4861 states that consecutive RA packets should be sent no more RFC4861 states that consecutive RA packets should be sent no more
frequently than three seconds apart. FRR by default allows faster frequently than three seconds apart. FRR by default allows faster
@ -83,8 +74,7 @@ Router Advertisement
and neighbor establishment. and neighbor establishment.
Default: enabled Default: enabled
.. index:: ipv6 nd ra-retrans-interval (0-4294967295) .. clicmd:: ipv6 nd ra-retrans-interval [(0-4294967295)]
.. clicmd:: [no] ipv6 nd ra-retrans-interval [(0-4294967295)]
The value to be placed in the retrans timer field of router advertisements The value to be placed in the retrans timer field of router advertisements
sent from the interface, in msec. Indicates the interval between router sent from the interface, in msec. Indicates the interval between router
@ -93,8 +83,7 @@ Router Advertisement
msec. msec.
Default: ``0`` Default: ``0``
.. index:: ipv6 nd ra-hop-limit (0-255) .. clicmd:: ipv6 nd ra-hop-limit [(0-255)]
.. clicmd:: [no] ipv6 nd ra-hop-limit [(0-255)]
The value to be placed in the hop count field of router advertisements sent The value to be placed in the hop count field of router advertisements sent
from the interface, in hops. Indicates the maximum diameter of the network. from the interface, in hops. Indicates the maximum diameter of the network.
@ -102,8 +91,7 @@ Router Advertisement
router. Must be between zero or 255 hops. router. Must be between zero or 255 hops.
Default: ``64`` Default: ``64``
.. index:: ipv6 nd ra-lifetime (0-9000) .. clicmd:: ipv6 nd ra-lifetime [(0-9000)]
.. clicmd:: [no] ipv6 nd ra-lifetime [(0-9000)]
The value to be placed in the Router Lifetime field of router advertisements The value to be placed in the Router Lifetime field of router advertisements
sent from the interface, in seconds. Indicates the usefulness of the router sent from the interface, in seconds. Indicates the usefulness of the router
@ -113,8 +101,7 @@ Router Advertisement
(or default) and 9000 seconds. (or default) and 9000 seconds.
Default: ``1800`` Default: ``1800``
.. index:: ipv6 nd reachable-time (1-3600000) .. clicmd:: ipv6 nd reachable-time [(1-3600000)]
.. clicmd:: [no] ipv6 nd reachable-time [(1-3600000)]
The value to be placed in the Reachable Time field in the Router The value to be placed in the Reachable Time field in the Router
Advertisement messages sent by the router, in milliseconds. The configured Advertisement messages sent by the router, in milliseconds. The configured
@ -122,8 +109,7 @@ Router Advertisement
means unspecified (by this router). means unspecified (by this router).
Default: ``0`` Default: ``0``
.. index:: ipv6 nd managed-config-flag .. clicmd:: ipv6 nd managed-config-flag
.. clicmd:: [no] ipv6 nd managed-config-flag
Set/unset flag in IPv6 router advertisements which indicates to hosts that Set/unset flag in IPv6 router advertisements which indicates to hosts that
they should use managed (stateful) protocol for addresses autoconfiguration they should use managed (stateful) protocol for addresses autoconfiguration
@ -131,33 +117,28 @@ Router Advertisement
autoconfiguration. autoconfiguration.
Default: not set Default: not set
.. index:: ipv6 nd other-config-flag .. clicmd:: ipv6 nd other-config-flag
.. clicmd:: [no] ipv6 nd other-config-flag
Set/unset flag in IPv6 router advertisements which indicates to hosts that Set/unset flag in IPv6 router advertisements which indicates to hosts that
they should use administered (stateful) protocol to obtain autoconfiguration they should use administered (stateful) protocol to obtain autoconfiguration
information other than addresses. information other than addresses.
Default: not set Default: not set
.. index:: ipv6 nd home-agent-config-flag .. clicmd:: ipv6 nd home-agent-config-flag
.. clicmd:: [no] ipv6 nd home-agent-config-flag
Set/unset flag in IPv6 router advertisements which indicates to hosts that Set/unset flag in IPv6 router advertisements which indicates to hosts that
the router acts as a Home Agent and includes a Home Agent Option. the router acts as a Home Agent and includes a Home Agent Option.
Default: not set Default: not set
.. index:: ipv6 nd home-agent-preference (0-65535)
.. index:: ipv6 nd home-agent-preference (0-65535) .. clicmd:: ipv6 nd home-agent-preference [(0-65535)]
.. clicmd:: [no] ipv6 nd home-agent-preference [(0-65535)]
The value to be placed in Home Agent Option, when Home Agent config flag is The value to be placed in Home Agent Option, when Home Agent config flag is
set, which indicates to hosts Home Agent preference. The default value of 0 set, which indicates to hosts Home Agent preference. The default value of 0
stands for the lowest preference possible. stands for the lowest preference possible.
Default: ``0`` Default: ``0``
.. index:: ipv6 nd home-agent-lifetime (0-65520) .. clicmd:: ipv6 nd home-agent-lifetime [(0-65520)]
.. clicmd:: [no] ipv6 nd home-agent-lifetime [(0-65520)]
The value to be placed in Home Agent Option, when Home Agent config flag is set, The value to be placed in Home Agent Option, when Home Agent config flag is set,
which indicates to hosts Home Agent Lifetime. The default value of 0 means to which indicates to hosts Home Agent Lifetime. The default value of 0 means to
@ -165,21 +146,18 @@ Router Advertisement
Default: ``0`` Default: ``0``
.. index:: ipv6 nd adv-interval-option .. clicmd:: ipv6 nd adv-interval-option
.. clicmd:: [no] ipv6 nd adv-interval-option
Include an Advertisement Interval option which indicates to hosts the maximum time, Include an Advertisement Interval option which indicates to hosts the maximum time,
in milliseconds, between successive unsolicited Router Advertisements. in milliseconds, between successive unsolicited Router Advertisements.
Default: not set Default: not set
.. index:: ipv6 nd router-preference (high|medium|low) .. clicmd:: ipv6 nd router-preference [(high|medium|low)]
.. clicmd:: [no] ipv6 nd router-preference [(high|medium|low)]
Set default router preference in IPv6 router advertisements per RFC4191. Set default router preference in IPv6 router advertisements per RFC4191.
Default: medium Default: medium
.. index:: ipv6 nd mtu (1-65535) .. clicmd:: ipv6 nd mtu [(1-65535)]
.. clicmd:: [no] ipv6 nd mtu [(1-65535)]
Include an MTU (type 5) option in each RA packet to assist the attached Include an MTU (type 5) option in each RA packet to assist the attached
hosts in proper interface configuration. The announced value is not verified hosts in proper interface configuration. The announced value is not verified
@ -187,8 +165,7 @@ Router Advertisement
Default: don't advertise any MTU option. Default: don't advertise any MTU option.
.. index:: ipv6 nd rdnss ipv6address [lifetime] .. clicmd:: ipv6 nd rdnss ipv6address [lifetime]
.. clicmd:: [no] ipv6 nd rdnss ipv6address [lifetime]
Recursive DNS server address to advertise using the RDNSS (type 25) option Recursive DNS server address to advertise using the RDNSS (type 25) option
described in RFC8106. Can be specified more than once to advertise multiple described in RFC8106. Can be specified more than once to advertise multiple
@ -205,8 +182,7 @@ Router Advertisement
Default: do not emit RDNSS option Default: do not emit RDNSS option
.. index:: ipv6 nd dnssl domain-name-suffix [lifetime] .. clicmd:: ipv6 nd dnssl domain-name-suffix [lifetime]
.. clicmd:: [no] ipv6 nd dnssl domain-name-suffix [lifetime]
Advertise DNS search list using the DNSSL (type 31) option described in Advertise DNS search list using the DNSSL (type 31) option described in
RFC8106. Specify more than once to advertise multiple domain name suffixes. RFC8106. Specify more than once to advertise multiple domain name suffixes.

339
doc/user/isisd.rst
View File

@ -33,51 +33,30 @@ ISIS router
To start the ISIS process you have to specify the ISIS router. As of this To start the ISIS process you have to specify the ISIS router. As of this
writing, *isisd* does not support multiple ISIS processes. writing, *isisd* does not support multiple ISIS processes.
.. index:: router isis WORD [vrf NAME] .. clicmd:: router isis WORD [vrf NAME]
.. clicmd:: [no] router isis WORD [vrf NAME]
Enable or disable the ISIS process by specifying the ISIS domain with Enable or disable the ISIS process by specifying the ISIS domain with
'WORD'. *isisd* does not yet support multiple ISIS processes but you must '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 specify the name of ISIS process. The ISIS process name 'WORD' is then used
for interface (see command :clicmd:`ip router isis WORD`). for interface (see command :clicmd:`ip router isis WORD`).
.. index:: net XX.XXXX. ... .XXX.XX
.. clicmd:: net XX.XXXX. ... .XXX.XX .. clicmd:: net XX.XXXX. ... .XXX.XX
.. index:: net XX.XXXX. ... .XXX.XX
.. clicmd:: no net XX.XXXX. ... .XXX.XX
Set/Unset network entity title (NET) provided in ISO format. Set/Unset network entity title (NET) provided in ISO format.
.. index:: hostname dynamic
.. clicmd:: hostname dynamic .. clicmd:: hostname dynamic
.. index:: hostname dynamic
.. clicmd:: no hostname dynamic
Enable support for dynamic hostname. Enable support for dynamic hostname.
.. index:: area-password [clear | md5] <password>
.. clicmd:: area-password [clear | md5] <password> .. clicmd:: area-password [clear | md5] <password>
.. index:: domain-password [clear | md5] <password>
.. clicmd:: domain-password [clear | md5] <password> .. clicmd:: domain-password [clear | md5] <password>
.. index:: area-password
.. clicmd:: no area-password
.. index:: domain-password
.. clicmd:: no domain-password
Configure the authentication password for an area, respectively a domain, as Configure the authentication password for an area, respectively a domain, as
clear text or md5 one. clear text or md5 one.
.. index:: attached-bit [receive ignore | send]
.. clicmd:: attached-bit [receive ignore | send] .. clicmd:: attached-bit [receive ignore | send]
.. index:: attached-bit
.. clicmd:: no attached-bit
Set attached bit for inter-area traffic: Set attached bit for inter-area traffic:
- receive - receive
@ -85,20 +64,12 @@ writing, *isisd* does not support multiple ISIS processes.
- send - send
If L1|L2 router, set attached bit in LSP sent to L1 router If L1|L2 router, set attached bit in LSP sent to L1 router
.. index:: log-adjacency-changes
.. clicmd:: log-adjacency-changes .. clicmd:: log-adjacency-changes
.. index:: log-adjacency-changes
.. clicmd:: no log-adjacency-changes
Log changes in adjacency state. Log changes in adjacency state.
.. index:: metric-style [narrow | transition | wide]
.. clicmd:: metric-style [narrow | transition | wide] .. clicmd:: metric-style [narrow | transition | wide]
.. index:: metric-style
.. clicmd:: no metric-style
Set old-style (ISO 10589) or new-style packet formats: Set old-style (ISO 10589) or new-style packet formats:
- narrow - narrow
@ -108,24 +79,15 @@ writing, *isisd* does not support multiple ISIS processes.
- wide - wide
Use new style of TLVs to carry wider metric Use new style of TLVs to carry wider metric
.. index:: set-overload-bit
.. clicmd:: set-overload-bit .. clicmd:: set-overload-bit
.. index:: set-overload-bit
.. clicmd:: no set-overload-bit
Set overload bit to avoid any transit traffic. Set overload bit to avoid any transit traffic.
.. index:: purge-originator
.. clicmd:: purge-originator .. clicmd:: purge-originator
.. index:: purge-originator
.. clicmd:: no purge-originator
Enable or disable :rfc:`6232` purge originator identification. Enable or disable :rfc:`6232` purge originator identification.
.. index:: lsp-mtu (128-4352) .. clicmd:: lsp-mtu (128-4352)
.. clicmd:: [no] lsp-mtu (128-4352)
Configure the maximum size of generated LSPs, in bytes. Configure the maximum size of generated LSPs, in bytes.
@ -135,57 +97,23 @@ writing, *isisd* does not support multiple ISIS processes.
ISIS Timer ISIS Timer
========== ==========
.. index:: lsp-gen-interval (1-120)
.. clicmd:: lsp-gen-interval (1-120)
.. index:: lsp-gen-interval [level-1 | level-2] (1-120)
.. clicmd:: lsp-gen-interval [level-1 | level-2] (1-120) .. clicmd:: lsp-gen-interval [level-1 | level-2] (1-120)
.. index:: lsp-gen-interval
.. clicmd:: no lsp-gen-interval
.. index:: lsp-gen-interval [level-1 | level-2]
.. clicmd:: no lsp-gen-interval [level-1 | level-2]
Set minimum interval in seconds between regenerating same LSP, Set minimum interval in seconds between regenerating same LSP,
globally, for an area (level-1) or a domain (level-2). globally, for an area (level-1) or a domain (level-2).
.. index:: lsp-refresh-interval [level-1 | level-2] (1-65235)
.. clicmd:: lsp-refresh-interval [level-1 | level-2] (1-65235) .. clicmd:: lsp-refresh-interval [level-1 | level-2] (1-65235)
.. index:: lsp-refresh-interval [level-1 | level-2]
.. clicmd:: no lsp-refresh-interval [level-1 | level-2]
Set LSP refresh interval in seconds, globally, for an area (level-1) or a Set LSP refresh interval in seconds, globally, for an area (level-1) or a
domain (level-2). domain (level-2).
.. index:: max-lsp-lifetime (360-65535)
.. clicmd:: max-lsp-lifetime (360-65535)
.. index:: max-lsp-lifetime [level-1 | level-2] (360-65535)
.. clicmd:: max-lsp-lifetime [level-1 | level-2] (360-65535) .. clicmd:: max-lsp-lifetime [level-1 | level-2] (360-65535)
.. index:: max-lsp-lifetime
.. clicmd:: no max-lsp-lifetime
.. index:: max-lsp-lifetime [level-1 | level-2]
.. clicmd:: no max-lsp-lifetime [level-1 | level-2]
Set LSP maximum LSP lifetime in seconds, globally, for an area (level-1) or Set LSP maximum LSP lifetime in seconds, globally, for an area (level-1) or
a domain (level-2). a domain (level-2).
.. index:: spf-interval (1-120)
.. clicmd:: spf-interval (1-120)
.. index:: spf-interval [level-1 | level-2] (1-120)
.. clicmd:: spf-interval [level-1 | level-2] (1-120) .. clicmd:: spf-interval [level-1 | level-2] (1-120)
.. index:: spf-interval
.. clicmd:: no spf-interval
.. index:: spf-interval [level-1 | level-2]
.. clicmd:: no spf-interval [level-1 | level-2]
Set minimum interval between consecutive SPF calculations in seconds. Set minimum interval between consecutive SPF calculations in seconds.
.. _isis-fast-reroute: .. _isis-fast-reroute:
@ -193,32 +121,24 @@ ISIS Timer
ISIS Fast-Reroute ISIS Fast-Reroute
================= =================
.. index:: spf prefix-priority [critical | high | medium] WORD
.. clicmd:: spf prefix-priority [critical | high | medium] WORD .. clicmd:: spf prefix-priority [critical | high | medium] WORD
.. index:: spf prefix-priority [critical | high | medium] WORD
.. clicmd:: no spf prefix-priority [critical | high | medium] [WORD]
Assign a priority to the prefixes that match the specified access-list. Assign a priority to the prefixes that match the specified access-list.
.. index:: fast-reroute priority-limit [critical | high | medium] [level-1 | level-2] .. clicmd:: fast-reroute priority-limit [critical | high | medium] [level-1 | level-2]
.. clicmd:: [no] fast-reroute priority-limit [critical | high | medium] [level-1 | level-2]
Limit LFA backup computation up to the specified prefix priority. Limit LFA backup computation up to the specified prefix priority.
.. index:: fast-reroute lfa tiebreaker [downstream | lowest-backup-metric | node-protecting] index (1-255) [level-1 | level-2] .. clicmd:: fast-reroute lfa tiebreaker [downstream | lowest-backup-metric | node-protecting] index (1-255) [level-1 | level-2]
.. clicmd:: [no] fast-reroute lfa tiebreaker [downstream | lowest-backup-metric | node-protecting] index (1-255) [level-1 | level-2]
Configure a tie-breaker for multiple LFA backups. Lower indexes are processed Configure a tie-breaker for multiple LFA backups. Lower indexes are
first. processed first.
.. index:: fast-reroute load-sharing disable [level-1 | level-2] .. clicmd:: fast-reroute load-sharing disable [level-1 | level-2]
.. clicmd:: [no] fast-reroute load-sharing disable [level-1 | level-2]
Disable load sharing across multiple LFA backups. Disable load sharing across multiple LFA backups.
.. index:: fast-reroute remote-lfa prefix-list WORD [level-1 | level-2] .. clicmd:: fast-reroute remote-lfa prefix-list [WORD] [level-1 | level-2]
.. clicmd:: [no] fast-reroute remote-lfa prefix-list [WORD] [level-1 | level-2]
Configure a prefix-list to select eligible PQ nodes (valid for all protected Configure a prefix-list to select eligible PQ nodes (valid for all protected
interfaces). interfaces).
@ -228,12 +148,8 @@ ISIS Fast-Reroute
ISIS region ISIS region
=========== ===========
.. index:: is-type [level-1 | level-1-2 | level-2-only]
.. clicmd:: is-type [level-1 | level-1-2 | level-2-only] .. clicmd:: is-type [level-1 | level-1-2 | level-2-only]
.. index:: is-type
.. clicmd:: no is-type
Define the ISIS router behavior: Define the ISIS router behavior:
- level-1 - level-1
@ -250,21 +166,15 @@ ISIS interface
.. _ip-router-isis-word: .. _ip-router-isis-word:
.. index:: ip router isis WORD [vrf NAME] .. clicmd:: <ip|ipv6> router isis WORD [vrf NAME]
.. index:: ipv6 router isis WORD [vrf NAME]
.. clicmd:: [no] <ip|ipv6> router isis WORD [vrf NAME]
Activate ISIS adjacency on this interface. Note that the name of ISIS 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 instance must be the same as the one used to configure the ISIS process (see
command :clicmd:`router isis WORD`). To enable IPv4, issue ``ip router isis command :clicmd:`router isis WORD`). To enable IPv4, issue ``ip router isis
WORD``; to enable IPv6, issue ``ipv6 router isis WORD``. WORD``; to enable IPv6, issue ``ipv6 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] .. clicmd:: isis circuit-type [level-1 | level-1-2 | level-2]
.. index:: isis circuit-type
.. clicmd:: no isis circuit-type
Configure circuit type for interface: Configure circuit type for interface:
- level-1 - level-1
@ -274,238 +184,126 @@ ISIS interface
- level-2-only - level-2-only
Level-2 only adjacencies are formed Level-2 only adjacencies are formed
.. index:: isis csnp-interval (1-600)
.. clicmd:: isis csnp-interval (1-600)
.. index:: isis csnp-interval (1-600) [level-1 | level-2]
.. clicmd:: isis csnp-interval (1-600) [level-1 | level-2] .. clicmd:: isis csnp-interval (1-600) [level-1 | level-2]
.. index:: isis csnp-interval
.. clicmd:: no isis csnp-interval
.. index:: isis csnp-interval [level-1 | level-2]
.. clicmd:: no isis csnp-interval [level-1 | level-2]
Set CSNP interval in seconds globally, for an area (level-1) or a domain Set CSNP interval in seconds globally, for an area (level-1) or a domain
(level-2). (level-2).
.. index:: isis hello padding
.. clicmd:: isis hello padding .. clicmd:: isis hello padding
Add padding to IS-IS hello packets. Add padding to IS-IS hello packets.
.. index:: isis hello-interval (1-600)
.. clicmd:: isis hello-interval (1-600)
.. index:: isis hello-interval (1-600) [level-1 | level-2]
.. clicmd:: isis hello-interval (1-600) [level-1 | level-2] .. clicmd:: isis hello-interval (1-600) [level-1 | level-2]
.. index:: isis hello-interval
.. clicmd:: no isis hello-interval
.. index:: isis hello-interval [level-1 | level-2]
.. clicmd:: no isis hello-interval [level-1 | level-2]
Set Hello interval in seconds globally, for an area (level-1) or a domain Set Hello interval in seconds globally, for an area (level-1) or a domain
(level-2). (level-2).
.. index:: isis hello-multiplier (2-100)
.. clicmd:: isis hello-multiplier (2-100)
.. index:: isis hello-multiplier (2-100) [level-1 | level-2]
.. clicmd:: isis hello-multiplier (2-100) [level-1 | level-2] .. clicmd:: isis hello-multiplier (2-100) [level-1 | level-2]
.. index:: isis hello-multiplier
.. clicmd:: no isis hello-multiplier
.. index:: isis hello-multiplier [level-1 | level-2]
.. clicmd:: no isis hello-multiplier [level-1 | level-2]
Set multiplier for Hello holding time globally, for an area (level-1) or a Set multiplier for Hello holding time globally, for an area (level-1) or a
domain (level-2). domain (level-2).
.. index:: isis metric [(0-255) | (0-16777215)]
.. clicmd:: isis metric [(0-255) | (0-16777215)]
.. index:: isis metric [(0-255) | (0-16777215)] [level-1 | level-2]
.. clicmd:: isis metric [(0-255) | (0-16777215)] [level-1 | level-2] .. clicmd:: isis metric [(0-255) | (0-16777215)] [level-1 | level-2]
.. index:: isis metric
.. clicmd:: no isis metric
.. index:: isis metric [level-1 | level-2]
.. clicmd:: no isis metric [level-1 | level-2]
Set default metric value globally, for an area (level-1) or a domain Set default metric value globally, for an area (level-1) or a domain
(level-2). Max value depend if metric support narrow or wide value (see (level-2). Max value depend if metric support narrow or wide value (see
command :clicmd:`metric-style [narrow | transition | wide]`). command :clicmd:`metric-style [narrow | transition | wide]`).
.. index:: isis network point-to-point
.. clicmd:: isis network point-to-point .. clicmd:: isis network point-to-point
.. index:: isis network point-to-point
.. clicmd:: no isis network point-to-point
Set network type to 'Point-to-Point' (broadcast by default). Set network type to 'Point-to-Point' (broadcast by default).
.. index:: isis passive
.. clicmd:: isis passive .. clicmd:: isis passive
.. index:: isis passive
.. clicmd:: no isis passive
Configure the passive mode for this interface. Configure the passive mode for this interface.
.. index:: isis password [clear | md5] <password>
.. clicmd:: isis password [clear | md5] <password> .. clicmd:: isis password [clear | md5] <password>
.. index:: isis password
.. clicmd:: no isis password
Configure the authentication password (clear or encoded text) for the Configure the authentication password (clear or encoded text) for the
interface. interface.
.. index:: isis priority (0-127)
.. clicmd:: isis priority (0-127)
.. index:: isis priority (0-127) [level-1 | level-2]
.. clicmd:: isis priority (0-127) [level-1 | level-2] .. clicmd:: isis priority (0-127) [level-1 | level-2]
.. index:: isis priority
.. clicmd:: no isis priority
.. index:: isis priority [level-1 | level-2]
.. clicmd:: no isis priority [level-1 | level-2]
Set priority for Designated Router election, globally, for the area Set priority for Designated Router election, globally, for the area
(level-1) or the domain (level-2). (level-1) or the domain (level-2).
.. index:: isis psnp-interval (1-120)
.. clicmd:: isis psnp-interval (1-120)
.. index:: isis psnp-interval (1-120) [level-1 | level-2]
.. clicmd:: isis psnp-interval (1-120) [level-1 | level-2] .. clicmd:: isis psnp-interval (1-120) [level-1 | level-2]
.. index:: isis psnp-interval
.. clicmd:: no isis psnp-interval
.. index:: isis psnp-interval [level-1 | level-2]
.. clicmd:: no isis psnp-interval [level-1 | level-2]
Set PSNP interval in seconds globally, for an area (level-1) or a domain Set PSNP interval in seconds globally, for an area (level-1) or a domain
(level-2). (level-2).
.. index:: isis three-way-handshake
.. clicmd:: isis three-way-handshake .. clicmd:: isis three-way-handshake
.. index:: isis three-way-handshake
.. clicmd:: no isis three-way-handshake
Enable or disable :rfc:`5303` Three-Way Handshake for P2P adjacencies. Enable or disable :rfc:`5303` Three-Way Handshake for P2P adjacencies.
Three-Way Handshake is enabled by default. Three-Way Handshake is enabled by default.
.. index:: isis fast-reroute lfa [level-1 | level-2] .. clicmd:: isis fast-reroute lfa [level-1 | level-2]
.. clicmd:: [no] isis fast-reroute lfa [level-1 | level-2]
Enable per-prefix LFA fast reroute link protection. Enable per-prefix LFA fast reroute link protection.
.. index:: isis fast-reroute lfa [level-1 | level-2] exclude interface IFNAME .. clicmd:: isis fast-reroute lfa [level-1 | level-2] exclude interface IFNAME
.. clicmd:: [no] isis fast-reroute lfa [level-1 | level-2] exclude interface IFNAME
Exclude an interface from the LFA backup nexthop computation. Exclude an interface from the LFA backup nexthop computation.
.. index:: isis fast-reroute ti-lfa [level-1|level-2] [node-protection] .. clicmd:: isis fast-reroute ti-lfa [level-1|level-2] [node-protection]
.. clicmd:: [no] isis fast-reroute ti-lfa [level-1|level-2] [node-protection]
Enable per-prefix TI-LFA fast reroute link or node protection. Enable per-prefix TI-LFA fast reroute link or node protection.
.. index:: isis fast-reroute remote-lfa tunnel mpls-ldp [level-1 | level-2] .. clicmd:: isis fast-reroute remote-lfa tunnel mpls-ldp [level-1 | level-2]
.. clicmd:: [no] isis fast-reroute remote-lfa tunnel mpls-ldp [level-1 | level-2]
Enable per-prefix Remote LFA fast reroute link protection. Note that other Enable per-prefix Remote LFA fast reroute link protection. Note that other
routers in the network need to be configured to accept LDP targeted hello routers in the network need to be configured to accept LDP targeted hello
messages in order for RLFA to work. messages in order for RLFA to work.
.. index:: isis fast-reroute remote-lfa maximum-metric (1-16777215) [level-1 | level-2] .. clicmd:: isis fast-reroute remote-lfa maximum-metric (1-16777215) [level-1 | level-2]
.. clicmd:: [no] isis fast-reroute remote-lfa maximum-metric (1-16777215) [level-1 | level-2]
Limit Remote LFA PQ node selection within the specified metric. Limit Remote LFA PQ node selection within the specified metric.
.. _showing-isis-information: .. _showing-isis-information:
Showing ISIS information Showing ISIS information
======================== ========================
.. index:: show isis summary
.. clicmd:: show isis summary .. clicmd:: show isis summary
Show summary information about ISIS. Show summary information about ISIS.
.. index:: show isis hostname
.. clicmd:: show isis hostname .. clicmd:: show isis hostname
Show information about ISIS node. Show information about ISIS node.
.. index:: show isis interface .. clicmd:: show isis interface [detail] [IFNAME]
.. clicmd:: show isis interface
.. index:: show isis interface detail
.. clicmd:: show isis interface detail
.. index:: show isis interface <interface name>
.. clicmd:: show isis interface <interface name>
Show state and configuration of ISIS specified interface, or all interfaces Show state and configuration of ISIS specified interface, or all interfaces
if no interface is given with or without details. if no interface is given with or without details.
.. index:: show isis neighbor .. clicmd:: show isis neighbor [detail] [SYSTEMID]
.. clicmd:: show isis neighbor
.. index:: show isis neighbor <System Id>
.. clicmd:: show isis neighbor <System Id>
.. index:: show isis neighbor detail
.. clicmd:: show isis neighbor detail
Show state and information of ISIS specified neighbor, or all neighbors if Show state and information of ISIS specified neighbor, or all neighbors if
no system id is given with or without details. no system id is given with or without details.
.. index:: show isis database .. clicmd:: show isis database [detail] [LSPID]
.. clicmd:: show isis database
.. index:: show isis database [detail]
.. clicmd:: show isis database [detail]
.. index:: show isis database <LSP id> [detail]
.. clicmd:: show isis database <LSP id> [detail]
.. index:: show isis database detail <LSP id>
.. clicmd:: show isis database detail <LSP id>
Show the ISIS database globally, for a specific LSP id without or with Show the ISIS database globally, for a specific LSP id without or with
details. details.
.. index:: show isis topology
.. clicmd:: show isis topology
.. index:: show isis topology [level-1|level-2]
.. clicmd:: show isis topology [level-1|level-2] .. clicmd:: show isis topology [level-1|level-2]
Show topology IS-IS paths to Intermediate Systems, globally, in area Show topology IS-IS paths to Intermediate Systems, globally, in area
(level-1) or domain (level-2). (level-1) or domain (level-2).
.. index:: show isis route [level-1|level-2] [prefix-sid|backup]
.. clicmd:: show isis route [level-1|level-2] [prefix-sid|backup] .. clicmd:: show isis route [level-1|level-2] [prefix-sid|backup]
Show the ISIS routing table, as determined by the most recent SPF Show the ISIS routing table, as determined by the most recent SPF
calculation. calculation.
.. index:: show isis fast-reroute summary [level-1|level-2]
.. clicmd:: show isis fast-reroute summary [level-1|level-2] .. clicmd:: show isis fast-reroute summary [level-1|level-2]
Show information about the number of prefixes having LFA protection, Show information about the number of prefixes having LFA protection,
and network-wide LFA coverage. and network-wide LFA coverage.
.. _isis-traffic-engineering: .. _isis-traffic-engineering:
Traffic Engineering Traffic Engineering
@ -513,35 +311,24 @@ Traffic Engineering
.. note:: .. note::
At this time, FRR offers partial support for some of the routing At this time, FRR offers partial support for some of the routing protocol
protocol extensions that can be used with MPLS-TE. FRR does not extensions that can be used with MPLS-TE. FRR does not currently support a
support a complete RSVP-TE solution currently. complete RSVP-TE solution.
.. index:: mpls-te on
.. clicmd:: mpls-te on .. clicmd:: mpls-te on
.. index:: mpls-te
.. clicmd:: no mpls-te
Enable Traffic Engineering LSP flooding. Enable Traffic Engineering LSP flooding.
.. index:: mpls-te router-address <A.B.C.D>
.. clicmd:: mpls-te router-address <A.B.C.D> .. clicmd:: mpls-te router-address <A.B.C.D>
.. index:: mpls-te router-address
.. clicmd:: no mpls-te router-address
Configure stable IP address for MPLS-TE. Configure stable IP address for MPLS-TE.
.. index:: show isis mpls-te interface
.. clicmd:: show isis mpls-te interface .. clicmd:: show isis mpls-te interface
.. index:: show isis mpls-te interface INTERFACE
.. clicmd:: show isis mpls-te interface INTERFACE .. clicmd:: show isis mpls-te interface INTERFACE
Show MPLS Traffic Engineering parameters for all or specified interface. Show MPLS Traffic Engineering parameters for all or specified interface.
.. index:: show isis mpls-te router
.. clicmd:: show isis mpls-te router .. clicmd:: show isis mpls-te router
Show Traffic Engineering router parameters. Show Traffic Engineering router parameters.
@ -550,6 +337,7 @@ Traffic Engineering
:ref:`ospf-traffic-engineering` :ref:`ospf-traffic-engineering`
.. _debugging-isis: .. _debugging-isis:
Segment Routing Segment Routing
@ -566,36 +354,30 @@ Known limitations:
- No support for SRLB - No support for SRLB
- Only one SRGB and default SPF Algorithm is supported - Only one SRGB and default SPF Algorithm is supported
.. index:: segment-routing on .. clicmd:: segment-routing on
.. clicmd:: [no] segment-routing on
Enable Segment Routing. Enable Segment Routing.
.. index:: segment-routing global-block (0-1048575) (0-1048575) .. clicmd:: segment-routing global-block (0-1048575) (0-1048575)
.. clicmd:: [no] segment-routing global-block (0-1048575) (0-1048575)
Set the Segment Routing Global Block i.e. the label range used by MPLS Set the Segment Routing Global Block i.e. the label range used by MPLS
to store label in the MPLS FIB for Prefix SID. Note that the block size to store label in the MPLS FIB for Prefix SID. Note that the block size
may not exceed 65535. may not exceed 65535.
.. index:: segment-routing local-block (0-1048575) (0-1048575) .. clicmd:: segment-routing local-block (0-1048575) (0-1048575)
.. clicmd:: [no] segment-routing local-block (0-1048575) (0-1048575)
Set the Segment Routing Local Block i.e. the label range used by MPLS Set the Segment Routing Local Block i.e. the label range used by MPLS
to store label in the MPLS FIB for Adjacency SID. Note that the block size to store label in the MPLS FIB for Adjacency SID. Note that the block size
may not exceed 65535. may not exceed 65535.
.. index:: segment-routing node-msd (1-16) .. clicmd:: segment-routing node-msd (1-16)
.. clicmd:: [no] segment-routing node-msd (1-16)
Set the Maximum Stack Depth supported by the router. The value depend of the Set the Maximum Stack Depth supported by the router. The value depend of the
MPLS dataplane. E.g. for Linux kernel, since version 4.13 the maximum value MPLS dataplane. E.g. for Linux kernel, since version 4.13 the maximum value
is 32. is 32.
.. index:: segment-routing prefix <A.B.C.D/M|X:X::X:X/M> <absolute (16-1048575)|index (0-65535)> [no-php-flag|explicit-null] [n-flag-clear] .. clicmd:: segment-routing prefix <A.B.C.D/M|X:X::X:X/M> <absolute (16-1048575)|index (0-65535) [no-php-flag|explicit-null] [n-flag-clear]
.. clicmd:: [no] segment-routing prefix <A.B.C.D/M|X:X::X:X/M> <absolute (16-1048575)|index (0-65535) [no-php-flag|explicit-null] [n-flag-clear]
Set the Segment Routing index or absolute label value for the specified
prefix. The 'no-php-flag' means NO Penultimate Hop Popping that allows SR prefix. The 'no-php-flag' means NO Penultimate Hop Popping that allows SR
node to request to its neighbor to not pop the label. The 'explicit-null' node to request to its neighbor to not pop the label. The 'explicit-null'
flag allows SR node to request to its neighbor to send IP packet with the flag allows SR node to request to its neighbor to send IP packet with the
@ -603,12 +385,10 @@ Known limitations:
clear the Node flag that is set by default for Prefix-SIDs associated to clear the Node flag that is set by default for Prefix-SIDs associated to
loopback addresses. This option is necessary to configure Anycast-SIDs. loopback addresses. This option is necessary to configure Anycast-SIDs.
.. index:: show isis segment-routing prefix-sids
.. clicmd:: show isis segment-routing prefix-sids .. clicmd:: show isis segment-routing prefix-sids
Show detailed information about all learned Segment Routing Prefix-SIDs. Show detailed information about all learned Segment Routing Prefix-SIDs.
.. index:: show isis segment-routing nodes
.. clicmd:: show isis segment-routing nodes .. clicmd:: show isis segment-routing nodes
Show detailed information about all learned Segment Routing Nodes. Show detailed information about all learned Segment Routing Nodes.
@ -616,120 +396,66 @@ Known limitations:
Debugging ISIS Debugging ISIS
============== ==============
.. index:: debug isis adj-packets
.. clicmd:: debug isis adj-packets .. clicmd:: debug isis adj-packets
.. index:: debug isis adj-packets
.. clicmd:: no debug isis adj-packets
IS-IS Adjacency related packets. IS-IS Adjacency related packets.
.. index:: debug isis checksum-errors
.. clicmd:: debug isis checksum-errors .. clicmd:: debug isis checksum-errors
.. index:: debug isis checksum-errors
.. clicmd:: no debug isis checksum-errors
IS-IS LSP checksum errors. IS-IS LSP checksum errors.
.. index:: debug isis events
.. clicmd:: debug isis events .. clicmd:: debug isis events
.. index:: debug isis events
.. clicmd:: no debug isis events
IS-IS Events. IS-IS Events.
.. index:: debug isis local-updates
.. clicmd:: debug isis local-updates .. clicmd:: debug isis local-updates
.. index:: debug isis local-updates
.. clicmd:: no debug isis local-updates
IS-IS local update packets. IS-IS local update packets.
.. index:: debug isis packet-dump
.. clicmd:: debug isis packet-dump .. clicmd:: debug isis packet-dump
.. index:: debug isis packet-dump
.. clicmd:: no debug isis packet-dump
IS-IS packet dump. IS-IS packet dump.
.. index:: debug isis protocol-errors
.. clicmd:: debug isis protocol-errors .. clicmd:: debug isis protocol-errors
.. index:: debug isis protocol-errors
.. clicmd:: no debug isis protocol-errors
IS-IS LSP protocol errors. IS-IS LSP protocol errors.
.. index:: debug isis route-events
.. clicmd:: debug isis route-events .. clicmd:: debug isis route-events
.. index:: debug isis route-events
.. clicmd:: no debug isis route-events
IS-IS Route related events. IS-IS Route related events.
.. index:: debug isis snp-packets
.. clicmd:: debug isis snp-packets .. clicmd:: debug isis snp-packets
.. index:: debug isis snp-packets
.. clicmd:: no debug isis snp-packets
IS-IS CSNP/PSNP packets. IS-IS CSNP/PSNP packets.
.. index:: debug isis spf-events
.. clicmd:: debug isis spf-events .. clicmd:: debug isis spf-events
.. index:: debug isis spf-statistics
.. clicmd:: debug isis spf-statistics .. clicmd:: debug isis spf-statistics
.. index:: debug isis spf-triggers
.. clicmd:: debug isis spf-triggers .. clicmd:: debug isis spf-triggers
.. index:: debug isis spf-events
.. clicmd:: no debug isis spf-events
.. index:: debug isis spf-statistics
.. clicmd:: no debug isis spf-statistics
.. index:: debug isis spf-triggers
.. clicmd:: no debug isis spf-triggers
IS-IS Shortest Path First Events, Timing and Statistic Data and triggering IS-IS Shortest Path First Events, Timing and Statistic Data and triggering
events. events.
.. index:: debug isis update-packets
.. clicmd:: debug isis update-packets .. clicmd:: debug isis update-packets
.. index:: debug isis update-packets
.. clicmd:: no debug isis update-packets
Update related packets. Update related packets.
.. index:: debug isis sr-events
.. clicmd:: debug isis sr-events .. clicmd:: debug isis sr-events
.. index:: debug isis sr-events
.. clicmd:: no debug isis sr-events
IS-IS Segment Routing events. IS-IS Segment Routing events.
.. index:: debug isis lfa
.. clicmd:: debug isis lfa .. clicmd:: debug isis lfa
.. index:: debug isis lfa
.. clicmd:: no debug isis lfa
IS-IS LFA events. IS-IS LFA events.
.. index:: show debugging isis
.. clicmd:: show debugging isis .. clicmd:: show debugging isis
Print which ISIS debug level is activate. Print which ISIS debug level is activate.
.. _isis-config-examples:
ISIS Configuration Examples ISIS Configuration Examples
=========================== ===========================
@ -843,6 +569,9 @@ A Segment Routing configuration, with IPv4, IPv6, SRGB and MSD configuration.
segment-routing prefix 2001:db8:1000::1/128 index 101 explicit-null segment-routing prefix 2001:db8:1000::1/128 index 101 explicit-null
! !
.. _isis-vrf-config-examples:
ISIS Vrf Configuration Examples ISIS Vrf Configuration Examples
=============================== ===============================
@ -860,5 +589,3 @@ A simple vrf example:
net 47.0023.0000.0000.0000.0000.0000.0000.1900.0004.00 net 47.0023.0000.0000.0000.0000.0000.0000.1900.0004.00
metric-style wide metric-style wide
is-type level-2-only is-type level-2-only

48
doc/user/ldpd.rst
View File

@ -97,53 +97,45 @@ implementation.
LDP Configuration LDP Configuration
=================== ===================
.. index:: mpls ldp .. clicmd:: mpls ldp
.. clicmd:: [no] mpls ldp
Enable or disable LDP daemon Enable or disable LDP daemon
.. index:: router-id A.B.C.D .. clicmd:: router-id A.B.C.D
.. clicmd:: [no] router-id A.B.C.D
The following command located under MPLS router node configures the MPLS The following command located under MPLS router node configures the MPLS
router-id of the local device. router-id of the local device.
.. index:: ordered-control .. clicmd:: ordered-control
.. clicmd:: [no] ordered-control
Configure LDP Ordered Label Distribution Control. Configure LDP Ordered Label Distribution Control.
.. index:: address-family [ipv4 | ipv6] .. clicmd:: address-family [ipv4 | ipv6]
.. clicmd:: [no] address-family [ipv4 | ipv6]
Configure LDP for IPv4 or IPv6 address-family. Located under MPLS route node, Configure LDP for IPv4 or IPv6 address-family. Located under MPLS route node,
this subnode permits configuring the LDP neighbors. this subnode permits configuring the LDP neighbors.
.. index:: interface IFACE .. clicmd:: interface IFACE
.. clicmd:: [no] interface IFACE
Located under MPLS address-family node, use this command to enable or disable Located under MPLS address-family node, use this command to enable or disable
LDP discovery per interface. IFACE stands for the interface name where LDP is LDP discovery per interface. IFACE stands for the interface name where LDP is
enabled. By default it is disabled. Once this command executed, the enabled. By default it is disabled. Once this command executed, the
address-family interface node is configured. address-family interface node is configured.
.. index:: discovery transport-address A.B.C.D | A:B::C:D .. clicmd:: discovery transport-address A.B.C.D | A:B::C:D
.. clicmd:: [no] discovery transport-address A.B.C.D | A:B::C:D
Located under mpls address-family interface node, use this command to set Located under mpls address-family interface node, use this command to set
the IPv4 or IPv6 transport-address used by the LDP protocol to talk on this the IPv4 or IPv6 transport-address used by the LDP protocol to talk on this
interface. interface.
.. index:: neighbor A.B.C.D password PASSWORD .. clicmd:: neighbor A.B.C.D password PASSWORD
.. clicmd:: [no] neighbor A.B.C.D password PASSWORD
The following command located under MPLS router node configures the router The following command located under MPLS router node configures the router
of a LDP device. This device, if found, will have to comply with the of a LDP device. This device, if found, will have to comply with the
configured password. PASSWORD is a clear text password wit its digest sent configured password. PASSWORD is a clear text password wit its digest sent
through the network. through the network.
.. index:: neighbor A.B.C.D holdtime HOLDTIME .. clicmd:: neighbor A.B.C.D holdtime HOLDTIME
.. clicmd:: [no] neighbor A.B.C.D holdtime HOLDTIME
The following command located under MPLS router node configures the holdtime The following command located under MPLS router node configures the holdtime
value in seconds of the LDP neighbor ID. Configuring it triggers a keepalive value in seconds of the LDP neighbor ID. Configuring it triggers a keepalive
@ -151,19 +143,16 @@ LDP Configuration
this time of non response, the LDP established session will be considered as this time of non response, the LDP established session will be considered as
set to down. By default, no holdtime is configured for the LDP devices. set to down. By default, no holdtime is configured for the LDP devices.
.. index:: discovery hello holdtime HOLDTIME .. clicmd:: discovery hello holdtime HOLDTIME
.. clicmd:: [no] discovery hello holdtime HOLDTIME
.. index:: discovery hello interval INTERVAL .. clicmd:: discovery hello interval INTERVAL
.. clicmd:: [no] discovery hello interval INTERVAL
INTERVAL value ranges from 1 to 65535 seconds. Default value is 5 seconds. INTERVAL value ranges from 1 to 65535 seconds. Default value is 5 seconds.
This is the value between each hello timer message sent. This is the value between each hello timer message sent.
HOLDTIME value ranges from 1 to 65535 seconds. Default value is 15 seconds. HOLDTIME value ranges from 1 to 65535 seconds. Default value is 15 seconds.
That value is added as a TLV in the LDP messages. That value is added as a TLV in the LDP messages.
.. index:: dual-stack transport-connection prefer ipv4 .. clicmd:: dual-stack transport-connection prefer ipv4
.. clicmd:: [no] dual-stack transport-connection prefer ipv4
When *ldpd* is configured for dual-stack operation, the transport connection When *ldpd* is configured for dual-stack operation, the transport connection
preference is IPv6 by default (as specified by :rfc:`7552`). On such preference is IPv6 by default (as specified by :rfc:`7552`). On such
@ -179,7 +168,6 @@ Show LDP Information
These commands dump various parts of *ldpd*. These commands dump various parts of *ldpd*.
.. index:: show mpls ldp neighbor [A.B.C.D]
.. clicmd:: show mpls ldp neighbor [A.B.C.D] .. clicmd:: show mpls ldp neighbor [A.B.C.D]
This command dumps the various neighbors discovered. Below example shows that This command dumps the various neighbors discovered. Below example shows that
@ -192,29 +180,22 @@ These commands dump various parts of *ldpd*.
ipv4 1.1.1.1 OPERATIONAL 1.1.1.1 00:01:37 ipv4 1.1.1.1 OPERATIONAL 1.1.1.1 00:01:37
west-vm# west-vm#
.. index:: show mpls ldp neighbor [A.B.C.D] capabilities
.. clicmd:: show mpls ldp neighbor [A.B.C.D] capabilities .. clicmd:: show mpls ldp neighbor [A.B.C.D] capabilities
.. index:: show mpls ldp neighbor [A.B.C.D] detail
.. clicmd:: show mpls ldp neighbor [A.B.C.D] detail .. clicmd:: show mpls ldp neighbor [A.B.C.D] detail
Above commands dump other neighbor information. Above commands dump other neighbor information.
.. index:: show mpls ldp discovery [detail]
.. clicmd:: show mpls ldp discovery [detail] .. clicmd:: show mpls ldp discovery [detail]
.. index:: show mpls ldp ipv4 discovery [detail]
.. clicmd:: show mpls ldp ipv4 discovery [detail] .. clicmd:: show mpls ldp ipv4 discovery [detail]
.. index:: show mpls ldp ipv6 discovery [detail]
.. clicmd:: show mpls ldp ipv6 discovery [detail] .. clicmd:: show mpls ldp ipv6 discovery [detail]
Above commands dump discovery information. Above commands dump discovery information.
.. index:: show mpls ldp ipv4 interface
.. clicmd:: show mpls ldp ipv4 interface .. clicmd:: show mpls ldp ipv4 interface
.. index:: show mpls ldp ipv6 interface
.. clicmd:: show mpls ldp ipv6 interface .. clicmd:: show mpls ldp ipv6 interface
Above command dumps the IPv4 or IPv6 interface per where LDP is enabled. Above command dumps the IPv4 or IPv6 interface per where LDP is enabled.
@ -228,7 +209,6 @@ These commands dump various parts of *ldpd*.
ipv4 eth3 ACTIVE 00:08:35 5/15 1 ipv4 eth3 ACTIVE 00:08:35 5/15 1
.. index:: show mpls ldp ipv4|ipv6 binding
.. clicmd:: show mpls ldp ipv4|ipv6 binding .. clicmd:: show mpls ldp ipv4|ipv6 binding
Above command dumps the binding obtained through MPLS exchanges with LDP. Above command dumps the binding obtained through MPLS exchanges with LDP.
@ -245,14 +225,12 @@ These commands dump various parts of *ldpd*.
ipv4 10.200.0.0/24 1.1.1.1 17 imp-null yes ipv4 10.200.0.0/24 1.1.1.1 17 imp-null yes
west-vm# west-vm#
LDP debugging commands LDP debugging commands
======================== ========================
.. index::
simple: debug mpls ldp KIND
simple: no debug mpls ldp KIND
.. clicmd:: [no] debug mpls ldp KIND .. clicmd:: debug mpls ldp KIND
Enable or disable debugging messages of a given kind. ``KIND`` can Enable or disable debugging messages of a given kind. ``KIND`` can
be one of: be one of:

15
doc/user/nhrpd.rst
View File

@ -77,7 +77,6 @@ command defines the GRE subnet):
Configuring NHRP Configuring NHRP
================ ================
.. index:: ip nhrp holdtime (1-65000)
.. clicmd:: ip nhrp holdtime (1-65000) .. clicmd:: ip nhrp holdtime (1-65000)
Holdtime is the number of seconds that have to pass before stopping to Holdtime is the number of seconds that have to pass before stopping to
@ -85,12 +84,10 @@ Configuring NHRP
registration requests are sent. By default registrations are sent every one registration requests are sent. By default registrations are sent every one
third of the holdtime. third of the holdtime.
.. index:: ip nhrp map A.B.C.D|X:X::X:X A.B.C.D|local
.. clicmd:: ip nhrp map A.B.C.D|X:X::X:X A.B.C.D|local .. clicmd:: ip nhrp map A.B.C.D|X:X::X:X A.B.C.D|local
Map an IP address of a station to the station's NBMA address. Map an IP address of a station to the station's NBMA address.
.. index:: ip nhrp network-id (1-4294967295)
.. clicmd:: ip nhrp network-id (1-4294967295) .. clicmd:: ip nhrp network-id (1-4294967295)
Enable NHRP on this interface and set the interface's network ID. The Enable NHRP on this interface and set the interface's network ID. The
@ -101,30 +98,25 @@ Configuring NHRP
different nodes do not need to match. When NHRP packets are received on an different nodes do not need to match. When NHRP packets are received on an
interface they are assigned to the local NHRP domain for that interface. interface they are assigned to the local NHRP domain for that interface.
.. index:: ip nhrp nhs A.B.C.D nbma A.B.C.D|FQDN
.. clicmd:: ip nhrp nhs A.B.C.D nbma A.B.C.D|FQDN .. clicmd:: ip nhrp nhs A.B.C.D nbma A.B.C.D|FQDN
Configure the Next Hop Server address and its NBMA address. Configure the Next Hop Server address and its NBMA address.
.. index:: ip nhrp nhs dynamic nbma A.B.C.D
.. clicmd:: ip nhrp nhs dynamic nbma A.B.C.D .. clicmd:: ip nhrp nhs dynamic nbma A.B.C.D
Configure the Next Hop Server to have a dynamic address and set its NBMA Configure the Next Hop Server to have a dynamic address and set its NBMA
address. address.
.. index:: ip nhrp registration no-unique
.. clicmd:: ip nhrp registration no-unique .. clicmd:: ip nhrp registration no-unique
Allow the client to not set the unique flag in the NHRP packets. This is Allow the client to not set the unique flag in the NHRP packets. This is
useful when a station has a dynamic IP address that could change over time. useful when a station has a dynamic IP address that could change over time.
.. index:: ip nhrp shortcut
.. clicmd:: ip nhrp shortcut .. clicmd:: ip nhrp shortcut
Enable shortcut (spoke-to-spoke) tunnels to allow NHC to talk to each others Enable shortcut (spoke-to-spoke) tunnels to allow NHC to talk to each others
directly after establishing a connection without going through the hub. directly after establishing a connection without going through the hub.
.. index:: ip nhrp mtu
.. clicmd:: ip nhrp mtu .. clicmd:: ip nhrp mtu
Configure NHRP advertised MTU. Configure NHRP advertised MTU.
@ -159,13 +151,11 @@ However, the above should be good in most cases.
This kernel NFLOG target's nflog-group is configured in global nhrp config This kernel NFLOG target's nflog-group is configured in global nhrp config
with: with:
.. index:: nhrp nflog-group (1-65535)
.. clicmd:: nhrp nflog-group (1-65535) .. clicmd:: nhrp nflog-group (1-65535)
To start sending these traffic notices out from hubs, use the nhrp To start sending these traffic notices out from hubs, use the nhrp
per-interface directive: per-interface directive:
.. index:: ip nhrp redirect
.. clicmd:: ip nhrp redirect .. clicmd:: ip nhrp redirect
This enable redirect replies on the NHS similar to ICMP redirects except this This enable redirect replies on the NHS similar to ICMP redirects except this
@ -195,7 +185,6 @@ https://gitlab.alpinelinux.org/alpine/aports/-/tree/master/main/strongswan
NHRP Events NHRP Events
=========== ===========
.. index:: nhrp event socket SOCKET
.. clicmd:: nhrp event socket SOCKET .. clicmd:: nhrp event socket SOCKET
Configure the Unix path for the event socket. Configure the Unix path for the event socket.
@ -205,22 +194,18 @@ NHRP Events
Show NHRP Show NHRP
========== ==========
.. index:: show [ip|ipv6] nhrp cache [json]
.. clicmd:: show [ip|ipv6] nhrp cache [json] .. clicmd:: show [ip|ipv6] nhrp cache [json]
Dump the cache entries. Dump the cache entries.
.. index:: show [ip|ipv6] nhrp opennhrp [json]
.. clicmd:: show [ip|ipv6] nhrp opennhrp [json] .. clicmd:: show [ip|ipv6] nhrp opennhrp [json]
Dump the cache entries with opennhrp format. Dump the cache entries with opennhrp format.
.. index:: show [ip|ipv6] nhrp nhs [json]
.. clicmd:: show [ip|ipv6] nhrp nhs [json] .. clicmd:: show [ip|ipv6] nhrp nhs [json]
Dump the hub context. Dump the hub context.
.. index:: show dmvpn [json]
.. clicmd:: show dmvpn [json] .. clicmd:: show dmvpn [json]
Dump the security contexts. Dump the security contexts.

49
doc/user/ospf6d.rst
View File

@ -12,28 +12,20 @@ described in :rfc:`2740`.
OSPF6 router OSPF6 router
============ ============
.. index:: router ospf6
.. clicmd:: router ospf6 .. clicmd:: router ospf6
.. index:: ospf6 router-id A.B.C.D
.. clicmd:: ospf6 router-id A.B.C.D .. clicmd:: ospf6 router-id A.B.C.D
Set router's Router-ID. Set router's Router-ID.
.. index:: interface IFNAME area (0-4294967295)
.. clicmd:: interface IFNAME area (0-4294967295) .. clicmd:: interface IFNAME area (0-4294967295)
.. index:: interface IFNAME area A.B.C.D
.. clicmd:: interface IFNAME area A.B.C.D .. clicmd:: interface IFNAME area A.B.C.D
Bind interface to specified area, and start sending OSPF packets. `area` can Bind interface to specified area, and start sending OSPF packets. `area` can
be specified as 0. be specified as 0.
.. index:: timers throttle spf DELAY INITIAL-HOLDTIME MAX-HOLDTIME .. clicmd:: timers throttle spf (0-600000) (0-600000) (0-600000)
.. clicmd:: timers throttle spf DELAY INITIAL-HOLDTIME MAX-HOLDTIME
.. index:: timers throttle spf
.. clicmd:: no timers throttle spf
This command sets the initial `delay`, the `initial-holdtime` This command sets the initial `delay`, the `initial-holdtime`
and the `maximum-holdtime` between when SPF is calculated and the and the `maximum-holdtime` between when SPF is calculated and the
@ -68,11 +60,8 @@ OSPF6 router
time an SPF-triggering event occurs within the hold-time of the previous time an SPF-triggering event occurs within the hold-time of the previous
SPF calculation. SPF calculation.
.. index:: auto-cost reference-bandwidth COST
.. clicmd:: auto-cost reference-bandwidth COST .. clicmd:: auto-cost reference-bandwidth COST
.. index:: auto-cost reference-bandwidth
.. clicmd:: no auto-cost reference-bandwidth
This sets the reference bandwidth for cost calculations, where this This sets the reference bandwidth for cost calculations, where this
bandwidth is considered equivalent to an OSPF cost of 1, specified in bandwidth is considered equivalent to an OSPF cost of 1, specified in
@ -83,12 +72,12 @@ OSPF6 router
This configuration setting MUST be consistent across all routers This configuration setting MUST be consistent across all routers
within the OSPF domain. within the OSPF domain.
.. index:: maximum-paths (1-64) .. clicmd:: maximum-paths (1-64)
.. clicmd::[no] maximum-paths (1-64)
Use this command to control the maximum number of parallel routes that Use this command to control the maximum number of parallel routes that
OSPFv3 can support. The default is 64. OSPFv3 can support. The default is 64.
.. _ospf6-area: .. _ospf6-area:
OSPF6 area OSPF6 area
@ -101,38 +90,31 @@ Area support for OSPFv3 is not yet implemented.
OSPF6 interface OSPF6 interface
=============== ===============
.. index:: ipv6 ospf6 cost COST
.. clicmd:: ipv6 ospf6 cost COST .. clicmd:: ipv6 ospf6 cost COST
Sets interface's output cost. Default value depends on the interface Sets interface's output cost. Default value depends on the interface
bandwidth and on the auto-cost reference bandwidth. bandwidth and on the auto-cost reference bandwidth.
.. index:: ipv6 ospf6 hello-interval HELLOINTERVAL
.. clicmd:: ipv6 ospf6 hello-interval HELLOINTERVAL .. clicmd:: ipv6 ospf6 hello-interval HELLOINTERVAL
Sets interface's Hello Interval. Default 10 Sets interface's Hello Interval. Default 10
.. index:: ipv6 ospf6 dead-interval DEADINTERVAL
.. clicmd:: ipv6 ospf6 dead-interval DEADINTERVAL .. clicmd:: ipv6 ospf6 dead-interval DEADINTERVAL
Sets interface's Router Dead Interval. Default value is 40. Sets interface's Router Dead Interval. Default value is 40.
.. index:: ipv6 ospf6 retransmit-interval RETRANSMITINTERVAL
.. clicmd:: ipv6 ospf6 retransmit-interval RETRANSMITINTERVAL .. clicmd:: ipv6 ospf6 retransmit-interval RETRANSMITINTERVAL
Sets interface's Rxmt Interval. Default value is 5. Sets interface's Rxmt Interval. Default value is 5.
.. index:: ipv6 ospf6 priority PRIORITY
.. clicmd:: ipv6 ospf6 priority PRIORITY .. clicmd:: ipv6 ospf6 priority PRIORITY
Sets interface's Router Priority. Default value is 1. Sets interface's Router Priority. Default value is 1.
.. index:: ipv6 ospf6 transmit-delay TRANSMITDELAY
.. clicmd:: ipv6 ospf6 transmit-delay TRANSMITDELAY .. clicmd:: ipv6 ospf6 transmit-delay TRANSMITDELAY
Sets interface's Inf-Trans-Delay. Default value is 1. Sets interface's Inf-Trans-Delay. Default value is 1.
.. index:: ipv6 ospf6 network (broadcast|point-to-point)
.. clicmd:: ipv6 ospf6 network (broadcast|point-to-point) .. clicmd:: ipv6 ospf6 network (broadcast|point-to-point)
Set explicitly network type for specified interface. Set explicitly network type for specified interface.
@ -142,7 +124,6 @@ OSPF6 route-map
Usage of *ospfd6*'s route-map support. Usage of *ospfd6*'s route-map support.
.. index:: set metric [+|-](0-4294967295)
.. clicmd:: set metric [+|-](0-4294967295) .. clicmd:: set metric [+|-](0-4294967295)
Set a metric for matched route when sending announcement. Use plus (+) sign Set a metric for matched route when sending announcement. Use plus (+) sign
@ -154,14 +135,9 @@ Usage of *ospfd6*'s route-map support.
Redistribute routes to OSPF6 Redistribute routes to OSPF6
============================ ============================
.. index:: redistribute static .. clicmd:: redistribute <babel|bgp|connected|isis|kernel|openfabric|ripng|sharp|static|table> [route-map WORD]
.. clicmd:: redistribute static
.. index:: redistribute connected Redistribute routes from other protocols into OSPFv3.
.. clicmd:: redistribute connected
.. index:: redistribute ripng
.. clicmd:: redistribute ripng
.. _showing-ospf6-information: .. _showing-ospf6-information:
@ -169,14 +145,12 @@ Redistribute routes to OSPF6
Showing OSPF6 information Showing OSPF6 information
========================= =========================
.. index:: show ipv6 ospf6 [INSTANCE_ID] [json]
.. clicmd:: show ipv6 ospf6 [INSTANCE_ID] [json] .. clicmd:: show ipv6 ospf6 [INSTANCE_ID] [json]
INSTANCE_ID is an optional OSPF instance ID. To see router ID and OSPF INSTANCE_ID is an optional OSPF instance ID. To see router ID and OSPF
instance ID, simply type "show ipv6 ospf6 <cr>". JSON output can be instance ID, simply type "show ipv6 ospf6 <cr>". JSON output can be
obtained by appending 'json' to the end of command. obtained by appending 'json' to the end of command.
.. index:: show ipv6 ospf6 database [<detail|dump|internal>] [json]
.. clicmd:: show ipv6 ospf6 database [<detail|dump|internal>] [json] .. clicmd:: show ipv6 ospf6 database [<detail|dump|internal>] [json]
This command shows LSAs present in the LSDB. There are three view options. This command shows LSAs present in the LSDB. There are three view options.
@ -184,14 +158,12 @@ Showing OSPF6 information
can be obtained by appending 'json' to the end of command. JSON option is can be obtained by appending 'json' to the end of command. JSON option is
not applicable with 'dump' option. not applicable with 'dump' option.
.. index:: show ipv6 ospf6 database <router|network|inter-prefix|inter-router|as-external|group-membership|type-7|link|intra-prefix> [json]
.. clicmd:: show ipv6 ospf6 database <router|network|inter-prefix|inter-router|as-external|group-membership|type-7|link|intra-prefix> [json] .. clicmd:: show ipv6 ospf6 database <router|network|inter-prefix|inter-router|as-external|group-membership|type-7|link|intra-prefix> [json]
These options filters out the LSA based on its type. The three views options These options filters out the LSA based on its type. The three views options
works here as well. JSON output can be obtained by appending 'json' to the works here as well. JSON output can be obtained by appending 'json' to the
end of command. end of command.
.. index:: show ipv6 ospf6 database adv-router A.B.C.D linkstate-id A.B.C.D [json]
.. clicmd:: show ipv6 ospf6 database adv-router A.B.C.D linkstate-id A.B.C.D [json] .. clicmd:: show ipv6 ospf6 database adv-router A.B.C.D linkstate-id A.B.C.D [json]
The LSAs additinally can also be filtered with the linkstate-id and The LSAs additinally can also be filtered with the linkstate-id and
@ -199,54 +171,45 @@ Showing OSPF6 information
this command as well and visa-versa. JSON output can be obtained by this command as well and visa-versa. JSON output can be obtained by
appending 'json' to the end of command. appending 'json' to the end of command.
.. index:: show ipv6 ospf6 database self-originated [json]
.. clicmd:: show ipv6 ospf6 database self-originated [json] .. clicmd:: show ipv6 ospf6 database self-originated [json]
This command is used to filter the LSAs which are originated by the present This command is used to filter the LSAs which are originated by the present
router. All the other filters are applicable here as well. router. All the other filters are applicable here as well.
.. index:: show ipv6 ospf6 interface [json]
.. clicmd:: show ipv6 ospf6 interface [json] .. clicmd:: show ipv6 ospf6 interface [json]
To see OSPF interface configuration like costs. JSON output can be To see OSPF interface configuration like costs. JSON output can be
obtained by appending "json" in the end. obtained by appending "json" in the end.
.. index:: show ipv6 ospf6 neighbor [json]
.. clicmd:: show ipv6 ospf6 neighbor [json] .. clicmd:: show ipv6 ospf6 neighbor [json]
Shows state and chosen (Backup) DR of neighbor. JSON output can be Shows state and chosen (Backup) DR of neighbor. JSON output can be
obtained by appending 'json' at the end. obtained by appending 'json' at the end.
.. index:: show ipv6 ospf6 interface traffic [json]
.. clicmd:: show ipv6 ospf6 interface traffic [json] .. clicmd:: show ipv6 ospf6 interface traffic [json]
Shows counts of different packets that have been recieved and transmitted Shows counts of different packets that have been recieved and transmitted
by the interfaces. JSON output can be obtained by appending "json" at the by the interfaces. JSON output can be obtained by appending "json" at the
end. end.
.. index:: show ipv6 ospf6 request-list A.B.C.D
.. clicmd:: show ipv6 ospf6 request-list A.B.C.D .. clicmd:: show ipv6 ospf6 request-list A.B.C.D
Shows requestlist of neighbor. Shows requestlist of neighbor.
.. index:: show ipv6 route ospf6
.. clicmd:: show ipv6 route ospf6 .. clicmd:: show ipv6 route ospf6
This command shows internal routing table. This command shows internal routing table.
.. index:: show ipv6 ospf6 zebra [json]
.. clicmd:: show ipv6 ospf6 zebra [json] .. clicmd:: show ipv6 ospf6 zebra [json]
Shows state about what is being redistributed between zebra and OSPF6. Shows state about what is being redistributed between zebra and OSPF6.
JSON output can be obtained by appending "json" at the end. JSON output can be obtained by appending "json" at the end.
.. index:: show ipv6 ospf6 redistribute [json]
.. clicmd:: show ipv6 ospf6 redistribute [json] .. clicmd:: show ipv6 ospf6 redistribute [json]
Shows the routes which are redistributed by the router. JSON output can Shows the routes which are redistributed by the router. JSON output can
be obtained by appending 'json' at the end. be obtained by appending 'json' at the end.
.. index:: show ipv6 ospf6 route [<intra-area|inter-area|external-1|external-2|X:X::X:X|X:X::X:X/M|detail|summary>] [json]
.. clicmd:: show ipv6 ospf6 route [<intra-area|inter-area|external-1|external-2|X:X::X:X|X:X::X:X/M|detail|summary>] [json] .. clicmd:: show ipv6 ospf6 route [<intra-area|inter-area|external-1|external-2|X:X::X:X|X:X::X:X/M|detail|summary>] [json]
This command displays the ospfv3 routing table as determined by the most This command displays the ospfv3 routing table as determined by the most
@ -255,13 +218,11 @@ Showing OSPF6 information
and summary. JSON output can be obtained by appending 'json' to the end of and summary. JSON output can be obtained by appending 'json' to the end of
command. command.
.. index:: show ipv6 ospf6 route X:X::X:X/M match [detail] [json]
.. clicmd:: show ipv6 ospf6 route X:X::X:X/M match [detail] [json] .. clicmd:: show ipv6 ospf6 route X:X::X:X/M match [detail] [json]
The additional match option will match the given address to the destination The additional match option will match the given address to the destination
of the routes, and return the result accordingly. of the routes, and return the result accordingly.
.. index:: show ipv6 ospf6 interface [IFNAME] prefix [detail|<X:X::X:X|X:X::X:X/M> [<match|detail>]] [json]
.. clicmd:: show ipv6 ospf6 interface [IFNAME] prefix [detail|<X:X::X:X|X:X::X:X/M> [<match|detail>]] [json] .. clicmd:: show ipv6 ospf6 interface [IFNAME] prefix [detail|<X:X::X:X|X:X::X:X/M> [<match|detail>]] [json]
This command shows the prefixes present in the interface routing table. This command shows the prefixes present in the interface routing table.

34
doc/user/ospf_fundamentals.rst
View File

@ -3,8 +3,10 @@
OSPF Fundamentals OSPF Fundamentals
================= =================
.. index:: Link-state routing protocol .. index::
.. index:: Distance-vector routing protocol pair: Link-state routing protocol; OSPF
pair: Distance-vector routing protocol; OSPF
:abbr:`OSPF` is, mostly, a link-state routing protocol. In contrast to :abbr:`OSPF` is, mostly, a link-state routing protocol. In contrast to
:term:`distance-vector` protocols, such as :abbr:`RIP` or :abbr:`BGP`, where :term:`distance-vector` protocols, such as :abbr:`RIP` or :abbr:`BGP`, where
@ -12,10 +14,12 @@ routers describe available `paths` (i.e. routes) to each other, in
:term:`link-state` protocols routers instead describe the state of their links :term:`link-state` protocols routers instead describe the state of their links
to their immediate neighbouring routers. to their immediate neighbouring routers.
.. index:: Link State Announcement .. index::
.. index:: Link State Advertisement single: Link State Announcement
.. index:: LSA flooding single: Link State Advertisement
.. index:: Link State Database single: LSA flooding
single: Link State Database
Each router describes their link-state information in a message known as an Each router describes their link-state information in a message known as an
:abbr:`LSA (Link State Advertisement)`, which is then propagated through to all :abbr:`LSA (Link State Advertisement)`, which is then propagated through to all
@ -27,7 +31,8 @@ metric, by using an algorithm such as
`Edsger Dijkstra's <http://www.cs.utexas.edu/users/EWD/>`_ `Edsger Dijkstra's <http://www.cs.utexas.edu/users/EWD/>`_
:abbr:`SPF (Shortest Path First)` algorithm. :abbr:`SPF (Shortest Path First)` algorithm.
.. index:: Link-state routing protocol advantages .. index::
pair: Link-state routing protocol; advantages
By describing connectivity of a network in this way, in terms of By describing connectivity of a network in this way, in terms of
routers and links rather than in terms of the paths through a network, routers and links rather than in terms of the paths through a network,
@ -39,7 +44,8 @@ reconverge on the best paths through the network. In contrast, distance
vector protocols can require a progression of different path update vector protocols can require a progression of different path update
messages from a series of different routers in order to converge. messages from a series of different routers in order to converge.
.. index:: Link-state routing protocol disadvantages .. index::
pair: Link-state routing protocol; disadvantages
The disadvantage to a link-state protocol is that the process of The disadvantage to a link-state protocol is that the process of
computing the best paths can be relatively intensive when compared to computing the best paths can be relatively intensive when compared to
@ -64,7 +70,8 @@ will nearly all be covered in greater detail further on. They may be
broadly classed as: broadly classed as:
.. index:: OSPF Hello Protocol .. index::
pair: Hello protocol; OSPF
The Hello Protocol The Hello Protocol
^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^
@ -86,7 +93,10 @@ sharing a link, for example:
The Hello protocol is comparatively trivial and will not be explored in more The Hello protocol is comparatively trivial and will not be explored in more
detail. detail.
.. index:: OSPF LSA overview
.. index::
pair: LSA; OSPF
.. _ospf-lsas: .. _ospf-lsas:
LSAs LSAs
@ -120,7 +130,9 @@ OSPF defines several related mechanisms, used to manage synchronisation of
:abbr:`LSDB` s between neighbours as neighbours form adjacencies and the :abbr:`LSDB` s between neighbours as neighbours form adjacencies and the
propagation, or `flooding` of new or updated :abbr:`LSA` s. propagation, or `flooding` of new or updated :abbr:`LSA` s.
.. index:: OSPF Areas overview
.. index::
pair: Area; OSPF
.. _ospf-areas: .. _ospf-areas:

345
doc/user/ospfd.rst
View File

File diff suppressed because it is too large Load Diff

33
doc/user/overview.rst
View File

@ -62,9 +62,8 @@ Feature support varies by platform; see the :ref:`feature-matrix`.
System Architecture System Architecture
------------------- -------------------
.. index:: System architecture .. index::
.. index:: Software architecture pair: architecture; FRR
.. index:: Software internals
Traditional routing software is made as a one process program which provides Traditional routing software is made as a one process program which provides
all of the routing protocol functionalities. FRR takes a different approach. all of the routing protocol functionalities. FRR takes a different approach.
@ -114,15 +113,15 @@ data models. When this work is completed, FRR will be a fully programmable
routing stack. routing stack.
.. index::
pair: platforms; FRR
pair: operating systems; FRR
.. _supported-platforms: .. _supported-platforms:
Supported Platforms Supported Platforms
------------------- -------------------
.. index:: Supported platforms
.. index:: FRR on other systems
.. index:: Compatibility with other systems
.. index:: Operating systems that support FRR
Currently FRR supports GNU/Linux and BSD. Porting FRR to other platforms is not Currently FRR supports GNU/Linux and BSD. Porting FRR to other platforms is not
too difficult as platform dependent code should be mostly limited to the too difficult as platform dependent code should be mostly limited to the
@ -149,11 +148,9 @@ Recent versions of the following compilers are well tested:
.. _unsupported-platforms: .. _unsupported-platforms:
UnSupported Platforms Unsupported Platforms
--------------------- ---------------------
.. index:: UnSupported platforms
In General if the platform you are attempting to use is not listed above then In General if the platform you are attempting to use is not listed above then
FRR does not support being run on that platform. The only caveat here is that FRR does not support being run on that platform. The only caveat here is that
version 7.5 and before Solaris was supported in a limited fashion. version 7.5 and before Solaris was supported in a limited fashion.
@ -264,6 +261,10 @@ Known Kernel Issues
especially becomes apparent if the route is being transformed from one ECMP especially becomes apparent if the route is being transformed from one ECMP
path to another. path to another.
.. index::
pair: rfcs; FRR
.. _supported-rfcs: .. _supported-rfcs:
Supported RFCs Supported RFCs
@ -439,14 +440,15 @@ SNMP
- :rfc:`2741` - :rfc:`2741`
:t:`Agent Extensibility (AgentX) Protocol. M. Daniele, B. Wijnen. January 2000.` :t:`Agent Extensibility (AgentX) Protocol. M. Daniele, B. Wijnen. January 2000.`
.. index::
pair: mailing lists; contact
.. _mailing-lists:
Mailing Lists Mailing Lists
============= =============
.. index:: How to get in touch with FRR
.. index:: Contact information
.. index:: Mailing lists
Italicized lists are private. Italicized lists are private.
+--------------------------------+------------------------------+ +--------------------------------+------------------------------+
@ -471,6 +473,7 @@ results of such discussions are reflected in updates, as appropriate, to code
changes, updates to the Development list and either this file or information changes, updates to the Development list and either this file or information
posted at `FRR`_. posted at `FRR`_.
Bug Reports Bug Reports
=========== ===========

74
doc/user/pathd.rst
View File

@ -105,72 +105,59 @@ Example:
Configuration Commands Configuration Commands
---------------------- ----------------------
.. index:: segment-routing
.. clicmd:: segment-routing .. clicmd:: segment-routing
Configure segment routing. Configure segment routing.
.. index:: traffic-eng
.. clicmd:: traffic-eng .. clicmd:: traffic-eng
Configure segment routing traffic engineering. Configure segment routing traffic engineering.
.. index:: segment-list NAME .. clicmd:: segment-list NAME
.. clicmd:: [no] segment-list NAME
Delete or start a segment list definition. Delete or start a segment list definition.
.. clicmd:: index INDEX mpls label LABEL [nai node ADDRESS]
.. index:: index INDEX mpls label LABEL [nai node ADDRESS]
.. clicmd:: [no] index INDEX mpls label LABEL [nai node ADDRESS]
Delete or specify a segment in a segment list definition. Delete or specify a segment in a segment list definition.
.. index:: policy color COLOR endpoint ENDPOINT .. clicmd:: policy color COLOR endpoint ENDPOINT
.. clicmd:: [no] policy color COLOR endpoint ENDPOINT
Delete or start a policy definition. Delete or start a policy definition.
.. index:: name NAME
.. clicmd:: name NAME .. clicmd:: name NAME
Specify the policy name. Specify the policy name.
.. index:: binding-sid LABEL
.. clicmd:: binding-sid LABEL .. clicmd:: binding-sid LABEL
Specify the policy SID. Specify the policy SID.
.. index:: candidate-path preference PREFERENCE name NAME explicit segment-list SEGMENT-LIST-NAME .. clicmd:: candidate-path preference PREFERENCE name NAME explicit segment-list SEGMENT-LIST-NAME
.. clicmd:: [no] candidate-path preference PREFERENCE name NAME explicit segment-list SEGMENT-LIST-NAME
Delete or define an explicit candidate path. Delete or define an explicit candidate path.
.. index:: candidate-path preference PREFERENCE name NAME dynamic .. clicmd:: candidate-path preference PREFERENCE name NAME dynamic
.. clicmd:: [no] candidate-path preference PREFERENCE name NAME dynamic
Delete or start a dynamic candidate path definition. Delete or start a dynamic candidate path definition.
.. index:: affinity {exclude-any|include-any|include-all} BITPATTERN .. clicmd:: affinity {exclude-any|include-any|include-all} BITPATTERN
.. clicmd:: [no] affinity {exclude-any|include-any|include-all} BITPATTERN
Delete or specify an affinity constraint for a dynamic candidate path. Delete or specify an affinity constraint for a dynamic candidate path.
.. index:: bandwidth BANDWIDTH [required] .. clicmd:: bandwidth BANDWIDTH [required]
.. clicmd:: [no] bandwidth BANDWIDTH [required]
Delete or specify a bandwidth constraint for a dynamic candidate path. Delete or specify a bandwidth constraint for a dynamic candidate path.
.. index:: metric [bound] METRIC VALUE [required] .. clicmd:: metric [bound] METRIC VALUE [required]
.. clicmd:: [no] metric [bound] METRIC VALUE [required]
Delete or specify a metric constraint for a dynamic candidate path. Delete or specify a metric constraint for a dynamic candidate path.
@ -198,8 +185,7 @@ Configuration Commands
- bnc: Border Node Count metric - bnc: Border Node Count metric
.. index:: objective-function OBJFUN1 [required] .. clicmd:: objective-function OBJFUN1 [required]
.. clicmd:: [no] objective-function OBJFUN1 [required]
Delete or specify a PCEP objective function constraint for a dynamic Delete or specify a PCEP objective function constraint for a dynamic
candidate path. candidate path.
@ -224,8 +210,7 @@ Configuration Commands
- msn: Minimize the number of Shared Nodes [RFC8800] - msn: Minimize the number of Shared Nodes [RFC8800]
.. index:: debug pathd pcep [basic|path|message|pceplib] .. clicmd:: debug pathd pcep [basic|path|message|pceplib]
.. clicmd:: [no] debug pathd pcep [basic|path|message|pceplib]
Enable or disable debugging for the pcep module: Enable or disable debugging for the pcep module:
@ -235,33 +220,28 @@ Configuration Commands
- pceplib: Enable pceplib logging - pceplib: Enable pceplib logging
.. index:: pcep
.. clicmd:: pcep .. clicmd:: pcep
Configure PCEP support. Configure PCEP support.
.. index:: cep-config NAME .. clicmd:: pce-config NAME
.. clicmd:: [no] pce-config NAME
Define a shared PCE configuration that can be used in multiple PCE Define a shared PCE configuration that can be used in multiple PCE
declarations. declarations.
.. index:: pce NAME .. clicmd:: pce NAME
.. clicmd:: [no] pce NAME
Define or delete a PCE definition. Define or delete a PCE definition.
.. index:: config WORD
.. clicmd:: config WORD .. clicmd:: config WORD
Select a shared configuration. If not defined, the default Select a shared configuration. If not defined, the default
configuration will be used. configuration will be used.
.. index:: address <ip A.B.C.D | ipv6 X:X::X:X> [port (1024-65535)]
.. clicmd:: address <ip A.B.C.D | ipv6 X:X::X:X> [port (1024-65535)] .. clicmd:: address <ip A.B.C.D | ipv6 X:X::X:X> [port (1024-65535)]
Define the address and port of the PCE. Define the address and port of the PCE.
@ -271,7 +251,6 @@ Configuration Commands
This should be specified in the PCC peer definition. This should be specified in the PCC peer definition.
.. index:: source-address [ip A.B.C.D | ipv6 X:X::X:X] [port PORT]
.. clicmd:: source-address [ip A.B.C.D | ipv6 X:X::X:X] [port PORT] .. clicmd:: source-address [ip A.B.C.D | ipv6 X:X::X:X] [port PORT]
Define the address and/or port of the PCC as seen by the PCE. Define the address and/or port of the PCC as seen by the PCE.
@ -284,7 +263,6 @@ Configuration Commands
configuration group. configuration group.
.. index:: tcp-md5-auth WORD
.. clicmd:: tcp-md5-auth WORD .. clicmd:: tcp-md5-auth WORD
Enable TCP MD5 security with the given secret. Enable TCP MD5 security with the given secret.
@ -293,7 +271,6 @@ Configuration Commands
configuration group. configuration group.
.. index:: sr-draft07
.. clicmd:: sr-draft07 .. clicmd:: sr-draft07
Specify if a PCE only support segment routing draft 7, this flag will limit Specify if a PCE only support segment routing draft 7, this flag will limit
@ -303,7 +280,6 @@ Configuration Commands
configuration group. configuration group.
.. index:: pce-initiated
.. clicmd:: pce-initiated .. clicmd:: pce-initiated
Specify if PCE-initiated LSP should be allowed for this PCE. Specify if PCE-initiated LSP should be allowed for this PCE.
@ -312,7 +288,6 @@ Configuration Commands
configuration group. configuration group.
.. index:: timer [keep-alive (1-63)] [min-peer-keep-alive (1-255)] [max-peer-keep-alive (1-255)] [dead-timer (4-255)] [min-peer-dead-timer (4-255)] [max-peer-dead-timer (4-255)] [pcep-request (1-120)] [session-timeout-interval (1-120)] [delegation-timeout (1-60)]
.. clicmd:: timer [keep-alive (1-63)] [min-peer-keep-alive (1-255)] [max-peer-keep-alive (1-255)] [dead-timer (4-255)] [min-peer-dead-timer (4-255)] [max-peer-dead-timer (4-255)] [pcep-request (1-120)] [session-timeout-interval (1-120)] [delegation-timeout (1-60)] .. clicmd:: timer [keep-alive (1-63)] [min-peer-keep-alive (1-255)] [max-peer-keep-alive (1-255)] [dead-timer (4-255)] [min-peer-dead-timer (4-255)] [max-peer-dead-timer (4-255)] [pcep-request (1-120)] [session-timeout-interval (1-120)] [delegation-timeout (1-60)]
Specify the PCEP timers. Specify the PCEP timers.
@ -321,20 +296,17 @@ Configuration Commands
configuration group. configuration group.
.. index:: pcc .. clicmd:: pcc
.. clicmd:: [no] pcc
Disable or start the definition of a PCC. Disable or start the definition of a PCC.
.. index:: msd (1-32)
.. clicmd:: msd (1-32) .. clicmd:: msd (1-32)
Specify the maximum SID depth in a PCC definition. Specify the maximum SID depth in a PCC definition.
.. index:: peer WORD [precedence (1-255)] .. clicmd:: peer WORD [precedence (1-255)]
.. clicmd:: [no] peer WORD [precedence (1-255)]
Specify a peer and its precedence in a PCC definition. Specify a peer and its precedence in a PCC definition.
@ -342,7 +314,6 @@ Configuration Commands
Introspection Commands Introspection Commands
---------------------- ----------------------
.. index:: show sr-te policy [detail]
.. clicmd:: show sr-te policy [detail] .. clicmd:: show sr-te policy [detail]
Display the segment routing policies. Display the segment routing policies.
@ -368,38 +339,22 @@ The asterisk (*) marks the best, e.g. active, candidate path. Note that for segm
retrieved via PCEP a random number based name is generated. retrieved via PCEP a random number based name is generated.
.. index:: show debugging pathd
.. clicmd:: show debugging pathd
Display the current status of the pathd debugging.
.. index:: show debugging pathd-pcep
.. clicmd:: show debugging pathd-pcep
Display the current status of the pcep module debugging.
.. index:: show sr-te pcep counters
.. clicmd:: show sr-te pcep counters .. clicmd:: show sr-te pcep counters
Display the counters from pceplib. Display the counters from pceplib.
.. index:: show sr-te pcep pce-config [NAME]
.. clicmd:: show sr-te pcep pce-config [NAME] .. clicmd:: show sr-te pcep pce-config [NAME]
Display a shared configuration. if no name is specified, the default Display a shared configuration. if no name is specified, the default
configuration will be displayed. configuration will be displayed.
.. index:: show sr-te pcep pcc
.. clicmd:: show sr-te pcep pcc .. clicmd:: show sr-te pcep pcc
Display PCC information. Display PCC information.
.. index:: show sr-te pcep session [NAME]
.. clicmd:: show sr-te pcep session [NAME] .. clicmd:: show sr-te pcep session [NAME]
Display the information of a PCEP session, if not name is specified all the Display the information of a PCEP session, if not name is specified all the
@ -409,7 +364,6 @@ retrieved via PCEP a random number based name is generated.
Utility Commands Utility Commands
---------------- ----------------
.. index:: clear sr-te pcep session [NAME]
.. clicmd:: clear sr-te pcep session [NAME] .. clicmd:: clear sr-te pcep session [NAME]
Reset the pcep session by disconnecting from the PCE and performing the Reset the pcep session by disconnecting from the PCE and performing the

11
doc/user/pbr.rst
View File

@ -45,7 +45,7 @@ listing of ECMP nexthops used to forward packets for when a pbr-map is matched.
are used to are allowed here. The syntax was intentionally kept the same as are used to are allowed here. The syntax was intentionally kept the same as
creating nexthops as you would for static routes. creating nexthops as you would for static routes.
.. clicmd:: [no] pbr table range (10000-4294966272) (10000-4294966272) .. clicmd:: pbr table range (10000-4294966272) (10000-4294966272)
Set or unset the range used to assign numeric table ID's to new Set or unset the range used to assign numeric table ID's to new
nexthop-group tables. Existing tables will not be modified to fit in this nexthop-group tables. Existing tables will not be modified to fit in this
@ -220,6 +220,10 @@ end destination.
| installedInternally | Do we think this group is installed? | Integer | | installedInternally | Do we think this group is installed? | Integer |
+---------------------+--------------------------------------+---------+ +---------------------+--------------------------------------+---------+
.. index::
pair: policy; PBR
.. _pbr-policy: .. _pbr-policy:
PBR Policy PBR Policy
@ -229,7 +233,6 @@ After you have specified a PBR map, in order for it to be turned on, you must
apply the PBR map to an interface. This policy application to an interface apply the PBR map to an interface. This policy application to an interface
causes the policy to be installed into the kernel. causes the policy to be installed into the kernel.
.. index:: pbr-policy
.. clicmd:: pbr-policy NAME .. clicmd:: pbr-policy NAME
This command is available under interface sub-mode. This turns This command is available under interface sub-mode. This turns
@ -263,12 +266,10 @@ causes the policy to be installed into the kernel.
PBR Debugs PBR Debugs
=========== ===========
.. index:: debug pbr
.. clicmd:: debug pbr events|map|nht|zebra .. clicmd:: debug pbr events|map|nht|zebra
Debug pbr in pbrd daemon. You specify what types of debugs to turn on. Debug pbr in pbrd daemon. You specify what types of debugs to turn on.
.. index:: debug zebra pbr
.. clicmd:: debug zebra pbr .. clicmd:: debug zebra pbr
Debug pbr in zebra daemon. Debug pbr in zebra daemon.
@ -281,12 +282,10 @@ PBR Details
Under the covers a PBR map is translated into two separate constructs in the Under the covers a PBR map is translated into two separate constructs in the
Linux kernel. Linux kernel.
.. index:: PBR Rules
The PBR map specified creates a `ip rule ...` that is inserted into the Linux The PBR map specified creates a `ip rule ...` that is inserted into the Linux
kernel that points to a table to use for forwarding once the rule matches. kernel that points to a table to use for forwarding once the rule matches.
.. index:: PBR Tables
The creation of a nexthop or nexthop-group is translated to a default route in a The creation of a nexthop or nexthop-group is translated to a default route in a
table with the nexthops specified as the nexthops for the default route. table with the nexthops specified as the nexthops for the default route.

140
doc/user/pim.rst
View File

@ -56,7 +56,6 @@ Certain signals have special meanings to *pimd*.
*pimd* invocation options. Common options that can be specified *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 .. clicmd:: ip pim rp A.B.C.D A.B.C.D/M
In order to use pim, it is necessary to configure a RP for join messages to In order to use pim, it is necessary to configure a RP for join messages to
@ -66,7 +65,6 @@ Certain signals have special meanings to *pimd*.
prefix of group ranges covered. This command is vrf aware, to configure for prefix of group ranges covered. This command is vrf aware, to configure for
a vrf, enter the vrf submode. a vrf, enter the vrf submode.
.. index:: ip pim register-accept-list PLIST
.. clicmd:: ip pim register-accept-list PLIST .. clicmd:: ip pim register-accept-list PLIST
When pim receives a register packet the source of the packet will be compared When pim receives a register packet the source of the packet will be compared
@ -74,14 +72,12 @@ Certain signals have special meanings to *pimd*.
processing continues. If a deny is returned for the source address of the processing continues. If a deny is returned for the source address of the
register packet a register stop message is sent to the source. register packet a register stop message is sent to the source.
.. index:: ip pim spt-switchover infinity-and-beyond
.. clicmd:: ip pim spt-switchover infinity-and-beyond .. clicmd:: ip pim spt-switchover infinity-and-beyond
On the last hop router if it is desired to not switch over to the SPT tree. On the last hop router if it is desired to not switch over to the SPT tree.
Configure this command. This command is vrf aware, to configure for a vrf, Configure this command. This command is vrf aware, to configure for a vrf,
enter the vrf submode. enter the vrf submode.
.. index:: ip pim ecmp
.. clicmd:: ip pim ecmp .. clicmd:: ip pim ecmp
If pim has the a choice of ECMP nexthops for a particular RPF, pim will If pim has the a choice of ECMP nexthops for a particular RPF, pim will
@ -89,7 +85,6 @@ Certain signals have special meanings to *pimd*.
not specified then the first nexthop found will be used. This command is vrf not specified then the first nexthop found will be used. This command is vrf
aware, to configure for a vrf, enter the vrf submode. aware, to configure for a vrf, enter the vrf submode.
.. index:: ip pim ecmp rebalance
.. clicmd:: ip pim ecmp rebalance .. clicmd:: ip pim ecmp rebalance
If pim is using ECMP and an interface goes down, cause pim to rebalance all If pim is using ECMP and an interface goes down, cause pim to rebalance all
@ -98,14 +93,12 @@ Certain signals have special meanings to *pimd*.
down. This command is vrf aware, to configure for a vrf, enter the vrf down. This command is vrf aware, to configure for a vrf, enter the vrf
submode. submode.
.. index:: ip pim join-prune-interval (60-600)
.. clicmd:: ip pim join-prune-interval (60-600) .. clicmd:: ip pim join-prune-interval (60-600)
Modify the join/prune interval that pim uses to the new value. Time is Modify the join/prune interval that pim uses to the new value. Time is
specified in seconds. This command is vrf aware, to configure for a vrf, specified in seconds. This command is vrf aware, to configure for a vrf,
enter the vrf submode. enter the vrf submode.
.. index:: ip pim keep-alive-timer (31-60000)
.. clicmd:: ip pim keep-alive-timer (31-60000) .. clicmd:: ip pim keep-alive-timer (31-60000)
Modify the time out value for a S,G flow from 31-60000 seconds. 31 seconds Modify the time out value for a S,G flow from 31-60000 seconds. 31 seconds
@ -113,7 +106,6 @@ Certain signals have special meanings to *pimd*.
flowing in better than 30 second chunks. This command is vrf aware, to flowing in better than 30 second chunks. This command is vrf aware, to
configure for a vrf, enter the vrf submode. configure for a vrf, enter the vrf submode.
.. index:: ip pim packets (1-100)
.. clicmd:: ip pim packets (1-100) .. clicmd:: ip pim packets (1-100)
When processing packets from a neighbor process the number of packets When processing packets from a neighbor process the number of packets
@ -122,14 +114,12 @@ Certain signals have special meanings to *pimd*.
a large number of pim control packets flowing. This command is vrf aware, to a large number of pim control packets flowing. This command is vrf aware, to
configure for a vrf, enter the vrf submode. configure for a vrf, enter the vrf submode.
.. index:: ip pim register-suppress-time (5-60000)
.. clicmd:: ip pim register-suppress-time (5-60000) .. clicmd:: ip pim register-suppress-time (5-60000)
Modify the time that pim will register suppress a FHR will send register Modify the time that pim will register suppress a FHR will send register
notifications to the kernel. This command is vrf aware, to configure for a notifications to the kernel. This command is vrf aware, to configure for a
vrf, enter the vrf submode. vrf, enter the vrf submode.
.. index:: ip pim send-v6-secondary
.. clicmd:: ip pim send-v6-secondary .. clicmd:: ip pim send-v6-secondary
When sending pim hello packets tell pim to send any v6 secondary addresses When sending pim hello packets tell pim to send any v6 secondary addresses
@ -137,14 +127,12 @@ Certain signals have special meanings to *pimd*.
in it's decision for RPF lookup. This command is vrf aware, to configure for in it's decision for RPF lookup. This command is vrf aware, to configure for
a vrf, enter the vrf submode. a vrf, enter the vrf submode.
.. index:: ip pim ssm prefix-list WORD
.. clicmd:: ip pim ssm prefix-list WORD .. clicmd:: ip pim ssm prefix-list WORD
Specify a range of group addresses via a prefix-list that forces pim to Specify a range of group addresses via a prefix-list that forces pim to
never do SM over. This command is vrf aware, to configure for a vrf, enter never do SM over. This command is vrf aware, to configure for a vrf, enter
the vrf submode. the vrf submode.
.. index:: ip multicast rpf-lookup-mode WORD
.. clicmd:: ip multicast rpf-lookup-mode WORD .. clicmd:: ip multicast rpf-lookup-mode WORD
Modify how PIM does RPF lookups in the zebra routing table. You can use Modify how PIM does RPF lookups in the zebra routing table. You can use
@ -166,32 +154,27 @@ Certain signals have special meanings to *pimd*.
urib-only urib-only
Lookup in the Unicast Rib only. Lookup in the Unicast Rib only.
.. index:: ip msdp mesh-group [WORD] .. clicmd:: ip msdp mesh-group [WORD]
.. clicmd:: [no] ip msdp mesh-group [WORD]
Create or Delete a multicast source discovery protocol mesh-group using Create or Delete a multicast source discovery protocol mesh-group using
[WORD] as the group name. [WORD] as the group name.
.. index:: ip msdp mesh-group WORD member A.B.C.D .. clicmd:: ip msdp mesh-group WORD member A.B.C.D
.. clicmd:: [no] ip msdp mesh-group WORD member A.B.C.D
Attach or Delete A.B.C.D to the MSDP mesh group WORD specified. Attach or Delete A.B.C.D to the MSDP mesh group WORD specified.
.. index:: ip msdp mesh-group WORD source A.B.C.D .. clicmd:: ip msdp mesh-group WORD source A.B.C.D
.. clicmd:: [no] ip msdp mesh-group WORD source A.B.C.D
For the address specified A.B.C.D use that as the source address for For the address specified A.B.C.D use that as the source address for
mesh group packets being sent. mesh group packets being sent.
.. index:: ip igmp generate-query-once [version (2-3)]
.. clicmd:: ip igmp generate-query-once [version (2-3)] .. clicmd:: ip igmp generate-query-once [version (2-3)]
Generate IGMP query (v2/v3) on user requirement. This will not depend on Generate IGMP query (v2/v3) on user requirement. This will not depend on
the existing IGMP general query timer.If no version is provided in the cli, the existing IGMP general query timer.If no version is provided in the cli,
it will be considered as default v2 query.This is a hidden command. it will be considered as default v2 query.This is a hidden command.
.. index:: ip igmp watermark-warn (10-60000) .. clicmd:: ip igmp watermark-warn (10-60000)
.. clicmd:: [no] ip igmp watermark-warn (10-60000)
Configure watermark warning generation for an igmp group limit. Generates Configure watermark warning generation for an igmp group limit. Generates
warning once the configured group limit is reached while adding new groups. warning once the configured group limit is reached while adding new groups.
@ -207,44 +190,33 @@ PIM interface commands allow you to configure an interface as either a Receiver
or a interface that you would like to form pim neighbors on. If the interface or a interface that you would like to form pim neighbors on. If the interface
is in a vrf, enter the interface command with the vrf keyword at the end. is in a vrf, enter the interface command with the vrf keyword at the end.
.. index:: ip pim active-active
.. clicmd:: ip pim active-active .. clicmd:: ip pim active-active
Turn on pim active-active configuration for a Vxlan interface. This Turn on pim active-active configuration for a Vxlan interface. This
command will not do anything if you do not have the underlying ability command will not do anything if you do not have the underlying ability
of a mlag implementation. of a mlag implementation.
.. index:: ip pim bfd
.. clicmd:: ip pim bfd
Turns on BFD support for PIM for this interface.
.. index:: ip pim bsm
.. clicmd:: ip pim bsm .. clicmd:: ip pim bsm
Tell pim that we would like to use this interface to process bootstrap Tell pim that we would like to use this interface to process bootstrap
messages. This is enabled by default. 'no' form of this command is used to messages. This is enabled by default. 'no' form of this command is used to
restrict bsm messages on this interface. restrict bsm messages on this interface.
.. index:: ip pim unicast-bsm
.. clicmd:: ip pim unicast-bsm .. clicmd:: ip pim unicast-bsm
Tell pim that we would like to allow interface to process unicast bootstrap Tell pim that we would like to allow interface to process unicast bootstrap
messages. This is enabled by default. 'no' form of this command is used to messages. This is enabled by default. 'no' form of this command is used to
restrict processing of unicast bsm messages on this interface. restrict processing of unicast bsm messages on this interface.
.. index:: ip pim drpriority (1-4294967295)
.. clicmd:: ip pim drpriority (1-4294967295) .. clicmd:: ip pim drpriority (1-4294967295)
Set the DR Priority for the interface. This command is useful to allow the Set the DR Priority for the interface. This command is useful to allow the
user to influence what node becomes the DR for a lan segment. user to influence what node becomes the DR for a lan segment.
.. index:: ip pim hello (1-180) (1-180)
.. clicmd:: ip pim hello (1-180) (1-180) .. clicmd:: ip pim hello (1-180) (1-180)
Set the pim hello and hold interval for a interface. Set the pim hello and hold interval for a interface.
.. index:: ip pim
.. clicmd:: ip pim .. clicmd:: ip pim
Tell pim that we would like to use this interface to form pim neighbors Tell pim that we would like to use this interface to form pim neighbors
@ -252,67 +224,63 @@ is in a vrf, enter the interface command with the vrf keyword at the end.
reports on the interface. Refer to the next `ip igmp` command for IGMP reports on the interface. Refer to the next `ip igmp` command for IGMP
management. management.
.. index:: ip pim use-source A.B.C.D .. clicmd:: ip pim use-source A.B.C.D
.. clicmd:: [no] ip pim use-source A.B.C.D
If you have multiple addresses configured on a particular interface If you have multiple addresses configured on a particular interface
and would like pim to use a specific source address associated with and would like pim to use a specific source address associated with
that interface. that interface.
.. index:: ip igmp
.. clicmd:: ip igmp .. clicmd:: ip igmp
Tell pim to receive IGMP reports and Query on this interface. The default Tell pim to receive IGMP reports and Query on this interface. The default
version is v3. This command is useful on a LHR. version is v3. This command is useful on a LHR.
.. index:: ip igmp join A.B.C.D [A.B.C.D]
.. clicmd:: ip igmp join A.B.C.D [A.B.C.D] .. clicmd:: ip igmp join A.B.C.D [A.B.C.D]
Join multicast group or source-group on an interface. Join multicast group or source-group on an interface.
.. index:: ip igmp query-interval (1-1800)
.. clicmd:: ip igmp query-interval (1-1800) .. clicmd:: ip igmp query-interval (1-1800)
Set the IGMP query interval that PIM will use. Set the IGMP query interval that PIM will use.
.. index:: ip igmp query-max-response-time (10-250)
.. clicmd:: ip igmp query-max-response-time (10-250) .. clicmd:: ip igmp query-max-response-time (10-250)
Set the IGMP query response timeout value. If an report is not returned in Set the IGMP query response timeout value. If an report is not returned in
the specified time we will assume the S,G or \*,G has timed out. the specified time we will assume the S,G or \*,G has timed out.
.. index:: ip igmp version (2-3)
.. clicmd:: ip igmp version (2-3) .. clicmd:: ip igmp version (2-3)
Set the IGMP version used on this interface. The default value is 3. Set the IGMP version used on this interface. The default value is 3.
.. index:: ip multicast boundary oil WORD
.. clicmd:: ip multicast boundary oil WORD .. clicmd:: ip multicast boundary oil WORD
Set a pim multicast boundary, based upon the WORD prefix-list. If a pim join Set a pim multicast boundary, based upon the WORD prefix-list. If a pim join
or IGMP report is received on this interface and the Group is denied by the or IGMP report is received on this interface and the Group is denied by the
prefix-list, PIM will ignore the join or report. prefix-list, PIM will ignore the join or report.
.. index:: ip igmp last-member-query-count (1-7)
.. clicmd:: ip igmp last-member-query-count (1-7) .. clicmd:: ip igmp last-member-query-count (1-7)
Set the IGMP last member query count. The default value is 2. 'no' form of Set the IGMP last member query count. The default value is 2. 'no' form of
this command is used to to configure back to the default value. this command is used to to configure back to the default value.
.. index:: ip igmp last-member-query-interval (1-255)
.. clicmd:: ip igmp last-member-query-interval (1-255) .. clicmd:: ip igmp last-member-query-interval (1-255)
Set the IGMP last member query interval in deciseconds. The default value is Set the IGMP last member query interval in deciseconds. The default value is
10 deciseconds. 'no' form of this command is used to to configure back to the 10 deciseconds. 'no' form of this command is used to to configure back to the
default value. default value.
.. index:: ip mroute INTERFACE A.B.C.D [A.B.C.D]
.. clicmd:: ip mroute INTERFACE A.B.C.D [A.B.C.D] .. clicmd:: ip mroute INTERFACE A.B.C.D [A.B.C.D]
Set a static multicast route for a traffic coming on the current interface to Set a static multicast route for a traffic coming on the current interface to
be forwarded on the given interface if the traffic matches the group address be forwarded on the given interface if the traffic matches the group address
and optionally the source address. and optionally the source address.
.. seealso::
:ref:`bfd-pim-peer-config`
.. _pim-multicast-rib-insertion: .. _pim-multicast-rib-insertion:
PIM Multicast RIB insertion: PIM Multicast RIB insertion:
@ -325,13 +293,11 @@ into the kernel *or* for normal rib processing. As such it is
possible to create weird states with these commands. Use with possible to create weird states with these commands. Use with
caution. Most of the time this will not be necessary. caution. Most of the time this will not be necessary.
.. index:: ip mroute A.B.C.D/M A.B.C.D (1-255)
.. clicmd:: ip mroute A.B.C.D/M A.B.C.D (1-255) .. clicmd:: ip mroute A.B.C.D/M A.B.C.D (1-255)
Insert into the Multicast Rib Route A.B.C.D/M with specified nexthop. The Insert into the Multicast Rib Route A.B.C.D/M with specified nexthop. The
distance can be specified as well if desired. distance can be specified as well if desired.
.. index:: ip mroute A.B.C.D/M INTERFACE (1-255)
.. clicmd:: ip mroute A.B.C.D/M INTERFACE (1-255) .. clicmd:: ip mroute A.B.C.D/M INTERFACE (1-255)
Insert into the Multicast Rib Route A.B.C.D/M using the specified INTERFACE. Insert into the Multicast Rib Route A.B.C.D/M using the specified INTERFACE.
@ -342,34 +308,25 @@ caution. Most of the time this will not be necessary.
Multicast Source Discovery Protocol (MSDP) Configuration Multicast Source Discovery Protocol (MSDP) Configuration
======================================================== ========================================================
.. index:: ip msdp mesh-group [WORD] member A.B.C.D
.. clicmd:: ip msdp mesh-group [WORD] member A.B.C.D .. clicmd:: ip msdp mesh-group [WORD] member A.B.C.D
Include a MSDP peer as a member of a MSDP mesh-group. Include a MSDP peer as a member of a MSDP mesh-group.
.. index:: ip msdp mesh-group [WORD] source A.B.C.D
.. clicmd:: ip msdp mesh-group [WORD] source A.B.C.D .. clicmd:: ip msdp mesh-group [WORD] source A.B.C.D
Create a MSDP mesh-group, defining a name for it and an associated local source Create a MSDP mesh-group, defining a name for it and an associated local source
address. address.
.. index:: ip msdp peer A.B.C.D source A.B.C.D
.. clicmd:: ip msdp peer A.B.C.D source A.B.C.D .. clicmd:: ip msdp peer A.B.C.D source A.B.C.D
Establish a MSDP connection with a peer. Establish a MSDP connection with a peer.
.. index:: ip msdp mesh-group [WORD] member A.B.C.D
.. clicmd:: no ip msdp mesh-group [WORD] member A.B.C.D
Remove a MSDP peer member from a MSDP mesh-group. Remove a MSDP peer member from a MSDP mesh-group.
.. index:: ip msdp mesh-group [WORD] source A.B.C.D
.. clicmd:: no ip msdp mesh-group [WORD] source A.B.C.D
Delete a MSDP mesh-group. Delete a MSDP mesh-group.
.. index:: ip msdp peer A.B.C.D
.. clicmd:: no ip msdp peer A.B.C.D
Delete a MSDP peer connection. Delete a MSDP peer connection.
@ -384,48 +341,39 @@ vrf is specified then the default vrf is assumed. Finally the special keyword
'all' allows you to look at all vrfs for the command. Naming a vrf 'all' will 'all' allows you to look at all vrfs for the command. Naming a vrf 'all' will
cause great confusion. cause great confusion.
.. index:: show ip igmp interface
.. clicmd:: show ip igmp interface .. clicmd:: show ip igmp interface
Display IGMP interface information. Display IGMP interface information.
.. index:: show ip igmp [vrf NAME] join [json]
.. clicmd:: show ip igmp [vrf NAME] join [json] .. clicmd:: show ip igmp [vrf NAME] join [json]
Display IGMP static join information for a specific vrf. Display IGMP static join information for a specific vrf.
If "vrf all" is provided, it displays information for all the vrfs present. If "vrf all" is provided, it displays information for all the vrfs present.
.. index:: show ip igmp groups
.. clicmd:: show ip igmp groups .. clicmd:: show ip igmp groups
Display IGMP groups information. Display IGMP groups information.
.. index:: show ip igmp groups retransmissions
.. clicmd:: show ip igmp groups retransmissions .. clicmd:: show ip igmp groups retransmissions
Display IGMP group retransmission information. Display IGMP group retransmission information.
.. index:: show ip igmp sources
.. clicmd:: show ip igmp sources .. clicmd:: show ip igmp sources
Display IGMP sources information. Display IGMP sources information.
.. index:: show ip igmp sources retransmissions
.. clicmd:: show ip igmp sources retransmissions .. clicmd:: show ip igmp sources retransmissions
Display IGMP source retransmission information. Display IGMP source retransmission information.
.. index:: show ip igmp statistics
.. clicmd:: show ip igmp statistics .. clicmd:: show ip igmp statistics
Display IGMP statistics information. Display IGMP statistics information.
.. index:: show ip multicast
.. clicmd:: show ip multicast .. clicmd:: show ip multicast
Display various information about the interfaces used in this pim instance. Display various information about the interfaces used in this pim instance.
.. index:: show ip mroute [vrf NAME] [A.B.C.D [A.B.C.D]] [fill] [json]
.. clicmd:: show ip mroute [vrf NAME] [A.B.C.D [A.B.C.D]] [fill] [json] .. clicmd:: show ip mroute [vrf NAME] [A.B.C.D [A.B.C.D]] [fill] [json]
Display information about installed into the kernel S,G mroutes. If Display information about installed into the kernel S,G mroutes. If
@ -434,200 +382,167 @@ cause great confusion.
Source Group. The keyword `fill` says to fill in all assumed data Source Group. The keyword `fill` says to fill in all assumed data
for test/data gathering purposes. for test/data gathering purposes.
.. index:: show ip mroute [vrf NAME] count [json]
.. clicmd:: show ip mroute [vrf NAME] count [json] .. clicmd:: show ip mroute [vrf NAME] count [json]
Display information about installed into the kernel S,G mroutes and in Display information about installed into the kernel S,G mroutes and in
addition display data about packet flow for the mroutes for a specific addition display data about packet flow for the mroutes for a specific
vrf. vrf.
.. index:: show ip mroute vrf all count [json]
.. clicmd:: show ip mroute vrf all count [json] .. clicmd:: show ip mroute vrf all count [json]
Display information about installed into the kernel S,G mroutes and in Display information about installed into the kernel S,G mroutes and in
addition display data about packet flow for the mroutes for all vrfs. addition display data about packet flow for the mroutes for all vrfs.
.. index:: show ip mroute [vrf NAME] summary [json]
.. clicmd:: show ip mroute [vrf NAME] summary [json] .. clicmd:: show ip mroute [vrf NAME] summary [json]
Display total number of S,G mroutes and number of S,G mroutes installed Display total number of S,G mroutes and number of S,G mroutes installed
into the kernel for a specific vrf. into the kernel for a specific vrf.
.. index:: show ip mroute vrf all summary [json]
.. clicmd:: show ip mroute vrf all summary [json] .. clicmd:: show ip mroute vrf all summary [json]
Display total number of S,G mroutes and number of S,G mroutes Display total number of S,G mroutes and number of S,G mroutes
installed into the kernel for all vrfs. installed into the kernel for all vrfs.
.. index:: show ip msdp mesh-group
.. clicmd:: show ip msdp mesh-group .. clicmd:: show ip msdp mesh-group
Display the configured mesh-groups, the local address associated with each Display the configured mesh-groups, the local address associated with each
mesh-group, the peer members included in each mesh-group, and their status. mesh-group, the peer members included in each mesh-group, and their status.
.. index:: show ip msdp peer
.. clicmd:: show ip msdp peer .. clicmd:: show ip msdp peer
Display information about the MSDP peers. That includes the peer address, Display information about the MSDP peers. That includes the peer address,
the local address used to establish the connection to the peer, the the local address used to establish the connection to the peer, the
connection status, and the number of active sources. connection status, and the number of active sources.
.. index:: show ip pim assert
.. clicmd:: show ip pim assert .. clicmd:: show ip pim assert
Display information about asserts in the PIM system for S,G mroutes. Display information about asserts in the PIM system for S,G mroutes.
.. index:: show ip pim assert-internal
.. clicmd:: show ip pim assert-internal .. clicmd:: show ip pim assert-internal
Display internal assert state for S,G mroutes Display internal assert state for S,G mroutes
.. index:: show ip pim assert-metric
.. clicmd:: show ip pim assert-metric .. clicmd:: show ip pim assert-metric
Display metric information about assert state for S,G mroutes Display metric information about assert state for S,G mroutes
.. index:: show ip pim assert-winner-metric
.. clicmd:: show ip pim assert-winner-metric .. clicmd:: show ip pim assert-winner-metric
Display winner metric for assert state for S,G mroutes Display winner metric for assert state for S,G mroutes
.. index:: show ip pim group-type
.. clicmd:: show ip pim group-type .. clicmd:: show ip pim group-type
Display SSM group ranges. Display SSM group ranges.
.. index:: show ip pim interface
.. clicmd:: show ip pim interface .. clicmd:: show ip pim interface
Display information about interfaces PIM is using. Display information about interfaces PIM is using.
.. index:: show ip pim mlag [vrf NAME] interface [detail|WORD] [json]
.. clicmd:: show ip pim mlag [vrf NAME|all] interface [detail|WORD] [json] .. clicmd:: show ip pim mlag [vrf NAME|all] interface [detail|WORD] [json]
Display mlag interface information. Display mlag interface information.
.. index:: show ip pim [vrf NAME] join [A.B.C.D [A.B.C.D]] [json]
.. clicmd:: show ip pim join .. clicmd:: show ip pim join
Display information about PIM joins received. If one address is specified Display information about PIM joins received. If one address is specified
then we assume it is the Group we are interested in displaying data on. then we assume it is the Group we are interested in displaying data on.
If the second address is specified then it is Source Group. If the second address is specified then it is Source Group.
.. index:: show ip pim local-membership
.. clicmd:: show ip pim local-membership .. clicmd:: show ip pim local-membership
Display information about PIM interface local-membership. Display information about PIM interface local-membership.
.. index:: show ip pim mlag summary [json]
.. clicmd:: show ip pim mlag summary [json] .. clicmd:: show ip pim mlag summary [json]
Display mlag information state that PIM is keeping track of. Display mlag information state that PIM is keeping track of.
.. index:: show ip pim neighbor
.. clicmd:: show ip pim neighbor .. clicmd:: show ip pim neighbor
Display information about PIM neighbors. Display information about PIM neighbors.
.. index:: show ip pim nexthop
.. clicmd:: show ip pim nexthop .. clicmd:: show ip pim nexthop
Display information about pim nexthops that are being used. Display information about pim nexthops that are being used.
.. index:: show ip pim nexthop-lookup
.. clicmd:: show ip pim nexthop-lookup .. clicmd:: show ip pim nexthop-lookup
Display information about a S,G pair and how the RPF would be chosen. This Display information about a S,G pair and how the RPF would be chosen. This
is especially useful if there are ECMP's available from the RPF lookup. is especially useful if there are ECMP's available from the RPF lookup.
.. index:: show ip pim rp-info
.. clicmd:: show ip pim rp-info .. clicmd:: show ip pim rp-info
Display information about RP's that are configured on this router. Display information about RP's that are configured on this router.
.. index:: show ip pim rpf
.. clicmd:: show ip pim rpf .. clicmd:: show ip pim rpf
Display information about currently being used S,G's and their RPF lookup Display information about currently being used S,G's and their RPF lookup
information. Additionally display some statistics about what has been information. Additionally display some statistics about what has been
happening on the router. happening on the router.
.. index:: show ip pim secondary
.. clicmd:: show ip pim secondary .. clicmd:: show ip pim secondary
Display information about an interface and all the secondary addresses Display information about an interface and all the secondary addresses
associated with it. associated with it.
.. index:: show ip pim state
.. clicmd:: show ip pim state .. clicmd:: show ip pim state
Display information about known S,G's and incoming interface as well as the Display information about known S,G's and incoming interface as well as the
OIL and how they were chosen. OIL and how they were chosen.
.. index:: show ip pim [vrf NAME] upstream [A.B.C.D [A.B.C.D]] [json] .. clicmd:: show ip pim [vrf NAME] upstream [A.B.C.D [A.B.C.D]] [json]
.. clicmd:: show ip pim upstream
Display upstream information about a S,G mroute. Allow the user to Display upstream information about a S,G mroute. Allow the user to
specify sub Source and Groups that we are only interested in. specify sub Source and Groups that we are only interested in.
.. index:: show ip pim upstream-join-desired
.. clicmd:: show ip pim upstream-join-desired .. clicmd:: show ip pim upstream-join-desired
Display upstream information for S,G's and if we desire to Display upstream information for S,G's and if we desire to
join the multicast tree join the multicast tree
.. index:: show ip pim upstream-rpf
.. clicmd:: show ip pim upstream-rpf .. clicmd:: show ip pim upstream-rpf
Display upstream information for S,G's and the RPF data associated with them. Display upstream information for S,G's and the RPF data associated with them.
.. index:: show ip pim [vrf NAME] mlag upstream [A.B.C.D [A.B.C.D]] [json] .. clicmd:: show ip pim [vrf NAME] mlag upstream [A.B.C.D [A.B.C.D]] [json]
.. clicmd:: show ip pim mlag upstream
Display upstream entries that are synced across MLAG switches. Display upstream entries that are synced across MLAG switches.
Allow the user to specify sub Source and Groups address filters. Allow the user to specify sub Source and Groups address filters.
.. index:: show ip pim mlag summary
.. clicmd:: show ip pim mlag summary .. clicmd:: show ip pim mlag summary
Display PIM MLAG (multi-chassis link aggregation) session status and Display PIM MLAG (multi-chassis link aggregation) session status and
control message statistics. control message statistics.
.. index:: show ip pim bsr
.. clicmd:: show ip pim bsr .. clicmd:: show ip pim bsr
Display current bsr, its uptime and last received bsm age. Display current bsr, its uptime and last received bsm age.
.. index:: show ip pim bsrp-info
.. clicmd:: show ip pim bsrp-info .. clicmd:: show ip pim bsrp-info
Display group-to-rp mappings received from E-BSR. Display group-to-rp mappings received from E-BSR.
.. index:: show ip pim bsm-database
.. clicmd:: show ip pim bsm-database .. clicmd:: show ip pim bsm-database
Display all fragments ofstored bootstrap message in user readable format. Display all fragments ofstored bootstrap message in user readable format.
.. index:: show ip rpf
.. clicmd:: show ip rpf
Display the multicast RIB created in zebra.
.. index:: mtrace A.B.C.D [A.B.C.D]
.. clicmd:: mtrace A.B.C.D [A.B.C.D] .. clicmd:: mtrace A.B.C.D [A.B.C.D]
Display multicast traceroute towards source, optionally for particular group. Display multicast traceroute towards source, optionally for particular group.
.. index:: show ip multicast count [vrf NAME] [json]
.. clicmd:: show ip multicast count [vrf NAME] [json] .. clicmd:: show ip multicast count [vrf NAME] [json]
Display multicast data packets count per interface for a vrf. Display multicast data packets count per interface for a vrf.
.. index:: show ip multicast count vrf all [json]
.. clicmd:: show ip multicast count vrf all [json] .. clicmd:: show ip multicast count vrf all [json]
Display multicast data packets count per interface for all vrf. Display multicast data packets count per interface for all vrf.
.. seealso::
:ref:`multicast-rib-commands`
PIM Debug Commands PIM Debug Commands
================== ==================
@ -637,56 +552,46 @@ configure CLI mode. If you specify debug commands in the configuration cli
mode, the debug commands can be persistent across restarts of the FRR pimd if mode, the debug commands can be persistent across restarts of the FRR pimd if
the config was written out. the config was written out.
.. index:: debug igmp
.. clicmd:: debug igmp .. clicmd:: debug igmp
This turns on debugging for IGMP protocol activity. This turns on debugging for IGMP protocol activity.
.. index:: debug mtrace
.. clicmd:: debug mtrace .. clicmd:: debug mtrace
This turns on debugging for mtrace protocol activity. This turns on debugging for mtrace protocol activity.
.. index:: debug mroute
.. clicmd:: debug mroute .. clicmd:: debug mroute
This turns on debugging for PIM interaction with kernel MFC cache. This turns on debugging for PIM interaction with kernel MFC cache.
.. index:: debug pim events
.. clicmd:: debug pim events .. clicmd:: debug pim events
This turns on debugging for PIM system events. Especially timers. This turns on debugging for PIM system events. Especially timers.
.. index:: debug pim nht
.. clicmd:: debug pim nht .. clicmd:: debug pim nht
This turns on debugging for PIM nexthop tracking. It will display This turns on debugging for PIM nexthop tracking. It will display
information about RPF lookups and information about when a nexthop changes. information about RPF lookups and information about when a nexthop changes.
.. index:: debug pim packet-dump
.. clicmd:: debug pim packet-dump .. clicmd:: debug pim packet-dump
This turns on an extraordinary amount of data. Each pim packet sent and This turns on an extraordinary amount of data. Each pim packet sent and
received is dumped for debugging purposes. This should be considered a received is dumped for debugging purposes. This should be considered a
developer only command. developer only command.
.. index:: debug pim packets
.. clicmd:: debug pim packets .. clicmd:: debug pim packets
This turns on information about packet generation for sending and about This turns on information about packet generation for sending and about
packet handling from a received packet. packet handling from a received packet.
.. index:: debug pim trace
.. clicmd:: debug pim trace .. clicmd:: debug pim trace
This traces pim code and how it is running. This traces pim code and how it is running.
.. index:: debug pim bsm
.. clicmd:: debug pim bsm .. clicmd:: debug pim bsm
This turns on debugging for BSR message processing. This turns on debugging for BSR message processing.
.. index:: debug pim zebra
.. clicmd:: debug pim zebra .. clicmd:: debug pim zebra
This gathers data about events from zebra that come up through the ZAPI. This gathers data about events from zebra that come up through the ZAPI.
@ -695,39 +600,32 @@ PIM Clear Commands
================== ==================
Clear commands reset various variables. Clear commands reset various variables.
.. index:: clear ip interfaces
.. clicmd:: clear ip interfaces .. clicmd:: clear ip interfaces
Reset interfaces. Reset interfaces.
.. index:: clear ip igmp interfaces
.. clicmd:: clear ip igmp interfaces .. clicmd:: clear ip igmp interfaces
Reset IGMP interfaces. Reset IGMP interfaces.
.. index:: clear ip mroute
.. clicmd:: clear ip mroute .. clicmd:: clear ip mroute
Reset multicast routes. Reset multicast routes.
.. index:: clear ip mroute [vrf NAME] count
.. clicmd:: clear ip mroute [vrf NAME] count .. clicmd:: clear ip mroute [vrf NAME] count
When this command is issued, reset the counts of data shown for When this command is issued, reset the counts of data shown for
packet count, byte count and wrong interface to 0 and start count packet count, byte count and wrong interface to 0 and start count
up from this spot. up from this spot.
.. index:: clear ip pim interfaces
.. clicmd:: clear ip pim interfaces .. clicmd:: clear ip pim interfaces
Reset PIM interfaces. Reset PIM interfaces.
.. index:: clear ip pim oil
.. clicmd:: clear ip pim oil .. clicmd:: clear ip pim oil
Rescan PIM OIL (output interface list). Rescan PIM OIL (output interface list).
.. index:: clear ip pim [vrf NAME] bsr-data
.. clicmd:: clear ip pim [vrf NAME] bsr-data .. clicmd:: clear ip pim [vrf NAME] bsr-data
This command will clear the BSM scope data struct. This command also This command will clear the BSM scope data struct. This command also

156
doc/user/ripd.rst
View File

@ -87,23 +87,17 @@ multipath routing.
RIP Configuration RIP Configuration
================= =================
.. index:: router rip
.. clicmd:: router rip .. clicmd:: router rip
The `router rip` command is necessary to enable RIP. To disable RIP, use the The `router rip` command is necessary to enable RIP. To disable RIP, use the
`no router rip` command. RIP must be enabled before carrying out any of the `no router rip` command. RIP must be enabled before carrying out any of the
RIP commands. RIP commands.
.. index:: router rip
.. clicmd:: no router rip
Disable RIP. Disable RIP.
.. index:: network NETWORK
.. clicmd:: network NETWORK .. clicmd:: network NETWORK
.. index:: network NETWORK
.. clicmd:: no network NETWORK
Set the RIP enable interface by NETWORK. The interfaces which have addresses Set the RIP enable interface by NETWORK. The interfaces which have addresses
matching with NETWORK are enabled. matching with NETWORK are enabled.
@ -114,22 +108,16 @@ RIP Configuration
10.0.0.0 to 10.0.0.255 being enabled for RIP. The `no network` command will 10.0.0.0 to 10.0.0.255 being enabled for RIP. The `no network` command will
disable RIP for the specified network. disable RIP for the specified network.
.. index:: network IFNAME
.. clicmd:: network IFNAME .. clicmd:: network IFNAME
.. index:: network IFNAME
.. clicmd:: no network IFNAME
Set a RIP enabled interface by IFNAME. Both the sending and Set a RIP enabled interface by IFNAME. Both the sending and
receiving of RIP packets will be enabled on the port specified in the receiving of RIP packets will be enabled on the port specified in the
`network ifname` command. The `no network ifname` command will disable `network ifname` command. The `no network ifname` command will disable
RIP on the specified interface. RIP on the specified interface.
.. index:: neighbor A.B.C.D
.. clicmd:: neighbor A.B.C.D .. clicmd:: neighbor A.B.C.D
.. index:: neighbor A.B.C.D
.. clicmd:: no neighbor A.B.C.D
Specify RIP neighbor. When a neighbor doesn't understand multicast, this Specify RIP neighbor. When a neighbor doesn't understand multicast, this
command is used to specify neighbors. In some cases, not all routers will be command is used to specify neighbors. In some cases, not all routers will be
@ -152,11 +140,8 @@ RIP Configuration
! !
.. index:: passive-interface (IFNAME|default)
.. clicmd:: passive-interface (IFNAME|default) .. clicmd:: passive-interface (IFNAME|default)
.. index:: passive-interface IFNAME
.. clicmd:: no passive-interface IFNAME
This command sets the specified interface to passive mode. On passive mode This command sets the specified interface to passive mode. On passive mode
interface, all receiving packets are processed as normal and ripd does not interface, all receiving packets are processed as normal and ripd does not
@ -166,11 +151,8 @@ RIP Configuration
The default is to be passive on all interfaces. The default is to be passive on all interfaces.
.. index:: ip split-horizon
.. clicmd:: ip split-horizon .. clicmd:: ip split-horizon
.. index:: ip split-horizon
.. clicmd:: no ip split-horizon
Control split-horizon on the interface. Default is `ip split-horizon`. If Control split-horizon on the interface. Default is `ip split-horizon`. If
you don't perform split-horizon on the interface, please specify `no ip you don't perform split-horizon on the interface, please specify `no ip
@ -192,7 +174,6 @@ 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 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 .. clicmd:: version VERSION
Set RIP version to accept for reads and send. ``VERSION`` can be either 1 or Set RIP version to accept for reads and send. ``VERSION`` can be either 1 or
@ -203,12 +184,6 @@ discussion on the security implications of RIPv1 see :ref:`rip-authentication`.
Default: Send Version 2, and accept either version. Default: Send Version 2, and accept either version.
.. index:: version
.. clicmd:: no version
Reset the global version setting back to the default.
.. index:: ip rip send version VERSION
.. clicmd:: ip rip send version VERSION .. clicmd:: ip rip send version VERSION
VERSION can be ``1``, ``2``, or ``1 2``. VERSION can be ``1``, ``2``, or ``1 2``.
@ -221,7 +196,6 @@ discussion on the security implications of RIPv1 see :ref:`rip-authentication`.
Default: Send packets according to the global version (version 2) Default: Send packets according to the global version (version 2)
.. index:: ip rip receive version VERSION
.. clicmd:: ip rip receive version VERSION .. clicmd:: ip rip receive version VERSION
VERSION can be ``1``, ``2``, or ``1 2``. VERSION can be ``1``, ``2``, or ``1 2``.
@ -232,98 +206,22 @@ discussion on the security implications of RIPv1 see :ref:`rip-authentication`.
Default: Accept packets according to the global setting (both 1 and 2). 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 How to Announce RIP route
========================= =========================
.. index:: redistribute kernel .. clicmd:: redistribute <babel|bgp|connected|eigrp|isis|kernel|openfabric|ospf|sharp|static|table> [metric (0-16)] [route-map WORD]
.. clicmd:: redistribute kernel
.. index:: redistribute kernel metric (0-16) Redistribute routes from other sources into RIP.
.. clicmd:: redistribute kernel metric (0-16)
.. index:: redistribute kernel route-map ROUTE-MAP
.. clicmd:: redistribute kernel route-map ROUTE-MAP
.. index:: redistribute kernel
.. clicmd:: no redistribute kernel
`redistribute kernel` redistributes routing information from kernel route
entries into the RIP tables. `no redistribute kernel` disables the routes.
.. index:: redistribute static
.. clicmd:: redistribute static
.. index:: redistribute static metric (0-16)
.. clicmd:: redistribute static metric (0-16)
.. index:: redistribute static route-map ROUTE-MAP
.. clicmd:: redistribute static route-map ROUTE-MAP
.. index:: redistribute static
.. clicmd:: no redistribute static
`redistribute static` redistributes routing information from static route
entries into the RIP tables. `no redistribute static` disables the routes.
.. index:: redistribute connected
.. clicmd:: redistribute connected
.. index:: redistribute connected metric (0-16)
.. clicmd:: redistribute connected metric (0-16)
.. index:: redistribute connected route-map ROUTE-MAP
.. clicmd:: redistribute connected route-map ROUTE-MAP
.. index:: redistribute connected
.. clicmd:: no redistribute connected
Redistribute connected routes into the RIP tables. `no redistribute
connected` disables the connected routes in the RIP tables. This command
redistribute connected of the interface which RIP disabled. The connected
route on RIP enabled interface is announced by default.
.. index:: redistribute ospf
.. clicmd:: redistribute ospf
.. index:: redistribute ospf metric (0-16)
.. clicmd:: redistribute ospf metric (0-16)
.. index:: redistribute ospf route-map ROUTE-MAP
.. clicmd:: redistribute ospf route-map ROUTE-MAP
.. index:: redistribute ospf
.. clicmd:: no redistribute ospf
`redistribute ospf` redistributes routing information from ospf route
entries into the RIP tables. `no redistribute ospf` disables the routes.
.. index:: redistribute bgp
.. clicmd:: redistribute bgp
.. index:: redistribute bgp metric (0-16)
.. clicmd:: redistribute bgp metric (0-16)
.. index:: redistribute bgp route-map ROUTE-MAP
.. clicmd:: redistribute bgp route-map ROUTE-MAP
.. index:: redistribute bgp
.. clicmd:: no redistribute bgp
`redistribute bgp` redistributes routing information from bgp route entries
into the RIP tables. `no redistribute bgp` disables the routes.
If you want to specify RIP only static routes: If you want to specify RIP only static routes:
.. index:: default-information originate
.. clicmd:: default-information originate .. clicmd:: default-information originate
.. index:: route A.B.C.D/M
.. clicmd:: route A.B.C.D/M .. clicmd:: route A.B.C.D/M
.. index:: route A.B.C.D/M
.. clicmd:: no route A.B.C.D/M
This command is specific to FRR. The `route` command makes a static route This command is specific to FRR. The `route` command makes a static route
only inside RIP. This command should be used only by advanced users who are only inside RIP. This command should be used only by advanced users who are
@ -338,7 +236,6 @@ Filtering RIP Routes
RIP routes can be filtered by a distribute-list. RIP routes can be filtered by a distribute-list.
.. index:: distribute-list ACCESS_LIST DIRECT IFNAME
.. clicmd:: distribute-list ACCESS_LIST DIRECT IFNAME .. clicmd:: distribute-list ACCESS_LIST DIRECT IFNAME
You can apply access lists to the interface with a `distribute-list` command. You can apply access lists to the interface with a `distribute-list` command.
@ -364,7 +261,6 @@ RIP routes can be filtered by a distribute-list.
`distribute-list` can be applied to both incoming and outgoing data. `distribute-list` can be applied to both incoming and outgoing data.
.. index:: distribute-list prefix PREFIX_LIST (in|out) IFNAME
.. clicmd:: distribute-list prefix PREFIX_LIST (in|out) IFNAME .. clicmd:: distribute-list prefix PREFIX_LIST (in|out) IFNAME
You can apply prefix lists to the interface with a `distribute-list` You can apply prefix lists to the interface with a `distribute-list`
@ -381,11 +277,8 @@ RIP metric is a value for distance for the network. Usually
*ripd* increment the metric when the network information is *ripd* increment the metric when the network information is
received. Redistributed routes' metric is set to 1. received. Redistributed routes' metric is set to 1.
.. index:: default-metric (1-16)
.. clicmd:: default-metric (1-16) .. clicmd:: default-metric (1-16)
.. index:: default-metric (1-16)
.. clicmd:: no default-metric (1-16)
This command modifies the default metric value for redistributed routes. This command modifies the default metric value for redistributed routes.
The default value is 1. This command does not affect connected route even if The default value is 1. This command does not affect connected route even if
@ -393,10 +286,8 @@ received. Redistributed routes' metric is set to 1.
metric value, please use ``redistribute connected metric`` or *route-map*. metric value, please use ``redistribute connected metric`` or *route-map*.
*offset-list* also affects connected routes. *offset-list* also affects connected routes.
.. index:: offset-list ACCESS-LIST (in|out)
.. clicmd:: offset-list ACCESS-LIST (in|out) .. clicmd:: offset-list ACCESS-LIST (in|out)
.. index:: offset-list ACCESS-LIST (in|out) IFNAME
.. clicmd:: offset-list ACCESS-LIST (in|out) IFNAME .. clicmd:: offset-list ACCESS-LIST (in|out) IFNAME
@ -407,28 +298,19 @@ RIP distance
Distance value is used in zebra daemon. Default RIP distance is 120. Distance value is used in zebra daemon. Default RIP distance is 120.
.. index:: distance (1-255)
.. clicmd:: distance (1-255) .. clicmd:: distance (1-255)
.. index:: distance (1-255)
.. clicmd:: no distance (1-255)
Set default RIP distance to specified value. Set default RIP distance to specified value.
.. index:: distance (1-255) A.B.C.D/M
.. clicmd:: distance (1-255) A.B.C.D/M .. clicmd:: distance (1-255) A.B.C.D/M
.. index:: distance (1-255) A.B.C.D/M
.. clicmd:: no distance (1-255) A.B.C.D/M
Set default RIP distance to specified value when the route's source IP Set default RIP distance to specified value when the route's source IP
address matches the specified prefix. address matches the specified prefix.
.. index:: distance (1-255) A.B.C.D/M ACCESS-LIST
.. clicmd:: distance (1-255) A.B.C.D/M ACCESS-LIST .. clicmd:: distance (1-255) A.B.C.D/M ACCESS-LIST
.. index:: distance (1-255) A.B.C.D/M ACCESS-LIST
.. clicmd:: no distance (1-255) A.B.C.D/M ACCESS-LIST
Set default RIP distance to specified value when the route's source IP Set default RIP distance to specified value when the route's source IP
address matches the specified prefix and the specified access-list. address matches the specified prefix and the specified access-list.
@ -459,7 +341,6 @@ 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. functionality.
.. index:: match interface WORD
.. clicmd:: match interface WORD .. clicmd:: match interface WORD
This command match to incoming interface. Notation of this match is This command match to incoming interface. Notation of this match is
@ -471,37 +352,30 @@ functionality.
sends to different interfaces must be different. Maybe it'd be better to sends to different interfaces must be different. Maybe it'd be better to
made new matches - say "match interface-out NAME" or something like that. made new matches - say "match interface-out NAME" or something like that.
.. index:: match ip address WORD
.. clicmd:: match ip address WORD .. clicmd:: match ip address WORD
.. index:: match ip address prefix-list WORD
.. clicmd:: match ip address prefix-list WORD .. clicmd:: match ip address prefix-list WORD
Match if route destination is permitted by access-list. Match if route destination is permitted by access-list.
.. index:: match ip next-hop WORD
.. clicmd:: match ip next-hop WORD .. clicmd:: match ip next-hop WORD
.. index:: match ip next-hop prefix-list WORD
.. clicmd:: match ip next-hop prefix-list WORD .. clicmd:: match ip next-hop prefix-list WORD
Match if route next-hop (meaning next-hop listed in the rip route-table as Match if route next-hop (meaning next-hop listed in the rip route-table as
displayed by "show ip rip") is permitted by access-list. displayed by "show ip rip") is permitted by access-list.
.. index:: match metric (0-4294967295)
.. clicmd:: match metric (0-4294967295) .. clicmd:: match metric (0-4294967295)
This command match to the metric value of RIP updates. For other protocol This command match to the metric value of RIP updates. For other protocol
compatibility metric range is shown as (0-4294967295). But for RIP protocol compatibility metric range is shown as (0-4294967295). But for RIP protocol
only the value range (0-16) make sense. only the value range (0-16) make sense.
.. index:: set ip next-hop A.B.C.D
.. clicmd:: set ip next-hop A.B.C.D .. clicmd:: set ip next-hop A.B.C.D
This command set next hop value in RIPv2 protocol. This command does not This command set next hop value in RIPv2 protocol. This command does not
affect RIPv1 because there is no next hop field in the packet. affect RIPv1 because there is no next hop field in the packet.
.. index:: set metric (0-4294967295)
.. clicmd:: set metric (0-4294967295) .. clicmd:: set metric (0-4294967295)
Set a metric for matched route when sending announcement. The metric value Set a metric for matched route when sending announcement. The metric value
@ -536,36 +410,24 @@ on the internet, via RIPv1.
To prevent such unauthenticated querying of routes disable 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 .. clicmd:: ip rip authentication mode md5
.. index:: ip rip authentication mode md5
.. clicmd:: no ip rip authentication mode md5
Set the interface with RIPv2 MD5 authentication. Set the interface with RIPv2 MD5 authentication.
.. index:: ip rip authentication mode text
.. clicmd:: ip rip authentication mode text .. clicmd:: ip rip authentication mode text
.. index:: ip rip authentication mode text
.. clicmd:: no ip rip authentication mode text
Set the interface with RIPv2 simple password authentication. Set the interface with RIPv2 simple password authentication.
.. index:: ip rip authentication string STRING
.. clicmd:: ip rip authentication string STRING .. clicmd:: ip rip authentication string STRING
.. index:: ip rip authentication string STRING
.. clicmd:: no ip rip authentication string STRING
RIP version 2 has simple text authentication. This command sets RIP version 2 has simple text authentication. This command sets
authentication string. The string must be shorter than 16 characters. authentication string. The string must be shorter than 16 characters.
.. index:: ip rip authentication key-chain KEY-CHAIN
.. clicmd:: ip rip authentication key-chain KEY-CHAIN .. clicmd:: ip rip authentication key-chain KEY-CHAIN
.. index:: ip rip authentication key-chain KEY-CHAIN
.. clicmd:: no ip rip authentication key-chain KEY-CHAIN
Specify Keyed MD5 chain. Specify Keyed MD5 chain.
@ -587,7 +449,6 @@ To prevent such unauthenticated querying of routes disable RIPv1,
RIP Timers RIP Timers
========== ==========
.. index:: timers basic UPDATE TIMEOUT GARBAGE
.. clicmd:: timers basic UPDATE TIMEOUT GARBAGE .. clicmd:: timers basic UPDATE TIMEOUT GARBAGE
@ -610,11 +471,6 @@ RIP Timers
The ``timers basic`` command allows the the default values of the timers The ``timers basic`` command allows the the default values of the timers
listed above to be changed. listed above to be changed.
.. index:: timers basic
.. clicmd:: no timers basic
The `no timers basic` command will reset the timers to the default settings
listed above.
.. _show-rip-information: .. _show-rip-information:
@ -623,7 +479,6 @@ Show RIP Information
To display RIP routes. To display RIP routes.
.. index:: show ip rip
.. clicmd:: show ip rip .. clicmd:: show ip rip
Show RIP routes. Show RIP routes.
@ -633,7 +488,6 @@ through RIP, this command will display the time the packet was sent and
the tag information. This command will also display this information the tag information. This command will also display this information
for routes redistributed into RIP. for routes redistributed into RIP.
.. index:: show ip rip status
.. clicmd:: show ip rip status .. clicmd:: show ip rip status
The command displays current RIP status. It includes RIP timer, The command displays current RIP status. It includes RIP timer,
@ -665,26 +519,22 @@ RIP Debug Commands
Debug for RIP protocol. Debug for RIP protocol.
.. index:: debug rip events
.. clicmd:: debug rip events .. clicmd:: debug rip events
Shows RIP events. Sending and receiving packets, timers, and changes in Shows RIP events. Sending and receiving packets, timers, and changes in
interfaces are events shown with *ripd*. interfaces are events shown with *ripd*.
.. index:: debug rip packet
.. clicmd:: debug rip packet .. clicmd:: debug rip packet
Shows display detailed information about the RIP packets. The origin and Shows display detailed information about the RIP packets. The origin and
port number of the packet as well as a packet dump is shown. port number of the packet as well as a packet dump is shown.
.. index:: debug rip zebra
.. clicmd:: debug rip zebra .. clicmd:: debug rip zebra
This command will show the communication between *ripd* and *zebra*. The This command will show the communication between *ripd* and *zebra*. The
main information will include addition and deletion of paths to the kernel main information will include addition and deletion of paths to the kernel
and the sending and receiving of interface information. and the sending and receiving of interface information.
.. index:: show debugging rip
.. clicmd:: show debugging rip .. clicmd:: show debugging rip
Shows all information currently set for ripd debug. Shows all information currently set for ripd debug.

16
doc/user/ripngd.rst
View File

@ -22,62 +22,46 @@ ripngd Configuration
Currently ripngd supports the following commands: Currently ripngd supports the following commands:
.. index:: router ripng
.. clicmd:: router ripng .. clicmd:: router ripng
Enable RIPng. Enable RIPng.
.. index:: flush_timer TIME
.. clicmd:: flush_timer TIME .. clicmd:: flush_timer TIME
Set flush timer. Set flush timer.
.. index:: network NETWORK
.. clicmd:: network NETWORK .. clicmd:: network NETWORK
Set RIPng enabled interface by NETWORK. Set RIPng enabled interface by NETWORK.
.. index:: network IFNAME
.. clicmd:: network IFNAME .. clicmd:: network IFNAME
Set RIPng enabled interface by IFNAME. Set RIPng enabled interface by IFNAME.
.. index:: route NETWORK
.. clicmd:: route NETWORK .. clicmd:: route NETWORK
Set RIPng static routing announcement of NETWORK. Set RIPng static routing announcement of NETWORK.
.. index:: router zebra
.. clicmd:: router zebra
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 ripngd Terminal Mode Commands
============================= =============================
.. index:: show ip ripng
.. clicmd:: show ip ripng .. clicmd:: show ip ripng
.. index:: show debugging ripng
.. clicmd:: show debugging ripng .. clicmd:: show debugging ripng
.. index:: debug ripng events
.. clicmd:: debug ripng events .. clicmd:: debug ripng events
.. index:: debug ripng packet
.. clicmd:: debug ripng packet .. clicmd:: debug ripng packet
.. index:: debug ripng zebra
.. clicmd:: debug ripng zebra .. clicmd:: debug ripng zebra
ripngd Filtering Commands ripngd Filtering Commands
========================= =========================
.. index:: distribute-list ACCESS_LIST (in|out) IFNAME
.. clicmd:: distribute-list ACCESS_LIST (in|out) IFNAME .. clicmd:: distribute-list ACCESS_LIST (in|out) IFNAME
You can apply an access-list to the interface using the `distribute-list` You can apply an access-list to the interface using the `distribute-list`

57
doc/user/routemap.rst
View File

@ -90,7 +90,6 @@ cont
.. _route-map-show-command: .. _route-map-show-command:
.. index:: show route-map [WORD]
.. clicmd:: show route-map [WORD] .. clicmd:: show route-map [WORD]
Display data about each daemons knowledge of individual route-maps. Display data about each daemons knowledge of individual route-maps.
@ -98,7 +97,6 @@ cont
.. _route-map-clear-counter-command: .. _route-map-clear-counter-command:
.. index:: clear route-map counter [WORD]
.. clicmd:: clear route-map counter [WORD] .. clicmd:: clear route-map counter [WORD]
Clear counters that are being stored about the route-map utilization Clear counters that are being stored about the route-map utilization
@ -110,7 +108,6 @@ cont
Route Map Command Route Map Command
================= =================
.. index:: route-map ROUTE-MAP-NAME (permit|deny) ORDER
.. clicmd:: route-map ROUTE-MAP-NAME (permit|deny) ORDER .. clicmd:: route-map ROUTE-MAP-NAME (permit|deny) ORDER
Configure the `order`'th entry in `route-map-name` with ``Match Policy`` of Configure the `order`'th entry in `route-map-name` with ``Match Policy`` of
@ -121,98 +118,80 @@ Route Map Command
Route Map Match Command Route Map Match Command
======================= =======================
.. index:: match ip address ACCESS_LIST
.. clicmd:: match ip address ACCESS_LIST .. clicmd:: match ip address ACCESS_LIST
Matches the specified `access_list` Matches the specified `access_list`
.. index:: match ip address prefix-list PREFIX_LIST
.. clicmd:: match ip address prefix-list PREFIX_LIST .. clicmd:: match ip address prefix-list PREFIX_LIST
Matches the specified `PREFIX_LIST` Matches the specified `PREFIX_LIST`
.. index:: match ip address prefix-len 0-32
.. clicmd:: match ip address prefix-len 0-32 .. clicmd:: match ip address prefix-len 0-32
Matches the specified `prefix-len`. This is a Zebra specific command. Matches the specified `prefix-len`. This is a Zebra specific command.
.. index:: match ipv6 address ACCESS_LIST
.. clicmd:: match ipv6 address ACCESS_LIST .. clicmd:: match ipv6 address ACCESS_LIST
Matches the specified `access_list` Matches the specified `access_list`
.. index:: match ipv6 address prefix-list PREFIX_LIST
.. clicmd:: match ipv6 address prefix-list PREFIX_LIST .. clicmd:: match ipv6 address prefix-list PREFIX_LIST
Matches the specified `PREFIX_LIST` Matches the specified `PREFIX_LIST`
.. index:: match ipv6 address prefix-len 0-128
.. clicmd:: match ipv6 address prefix-len 0-128 .. clicmd:: match ipv6 address prefix-len 0-128
Matches the specified `prefix-len`. This is a Zebra specific command. Matches the specified `prefix-len`. This is a Zebra specific command.
.. index:: match ip next-hop address IPV4_ADDR
.. clicmd:: match ip next-hop address IPV4_ADDR .. clicmd:: match ip next-hop address IPV4_ADDR
This is a BGP specific match command. Matches the specified `ipv4_addr`. This is a BGP specific match command. Matches the specified `ipv4_addr`.
.. index:: match ipv6 next-hop IPV6_ADDR
.. clicmd:: match ipv6 next-hop IPV6_ADDR .. clicmd:: match ipv6 next-hop IPV6_ADDR
This is a BGP specific match command. Matches the specified `ipv6_addr`. This is a BGP specific match command. Matches the specified `ipv6_addr`.
.. index:: match as-path AS_PATH
.. clicmd:: match as-path AS_PATH .. clicmd:: match as-path AS_PATH
Matches the specified `as_path`. Matches the specified `as_path`.
.. index:: match metric METRIC
.. clicmd:: match metric METRIC .. clicmd:: match metric METRIC
Matches the specified `metric`. Matches the specified `metric`.
.. index:: match tag TAG
.. clicmd:: match tag TAG .. clicmd:: match tag TAG
Matches the specified tag value associated with the route. This tag value Matches the specified tag value associated with the route. This tag value
can be in the range of (1-4294967295). can be in the range of (1-4294967295).
.. index:: match local-preference METRIC
.. clicmd:: match local-preference METRIC .. clicmd:: match local-preference METRIC
Matches the specified `local-preference`. Matches the specified `local-preference`.
.. index:: match community COMMUNITY_LIST
.. clicmd:: match community COMMUNITY_LIST .. clicmd:: match community COMMUNITY_LIST
Matches the specified `community_list` Matches the specified `community_list`
.. index:: match peer IPV4_ADDR
.. clicmd:: match peer IPV4_ADDR .. clicmd:: match peer IPV4_ADDR
This is a BGP specific match command. Matches the peer ip address This is a BGP specific match command. Matches the peer ip address
if the neighbor was specified in this manner. if the neighbor was specified in this manner.
.. index:: match peer IPV6_ADDR
.. clicmd:: match peer IPV6_ADDR .. clicmd:: match peer IPV6_ADDR
This is a BGP specific match command. Matches the peer ipv6 This is a BGP specific match command. Matches the peer ipv6
address if the neighbor was specified in this manner. address if the neighbor was specified in this manner.
.. index:: match peer INTERFACE_NAME
.. clicmd:: match peer INTERFACE_NAME .. clicmd:: match peer INTERFACE_NAME
This is a BGP specific match command. Matches the peer This is a BGP specific match command. Matches the peer
interface name specified if the neighbor was specified interface name specified if the neighbor was specified
in this manner. in this manner.
.. index:: match source-protocol PROTOCOL_NAME
.. clicmd:: match source-protocol PROTOCOL_NAME .. clicmd:: match source-protocol PROTOCOL_NAME
This is a ZEBRA specific match command. Matches the This is a ZEBRA specific match command. Matches the
originating protocol specified. originating protocol specified.
.. index:: match source-instance NUMBER
.. clicmd:: match source-instance NUMBER .. clicmd:: match source-instance NUMBER
This is a ZEBRA specific match command. The number is a range from (0-255). This is a ZEBRA specific match command. The number is a range from (0-255).
@ -225,7 +204,6 @@ Route Map Set Command
.. program:: configure .. program:: configure
.. index:: set tag TAG
.. clicmd:: set tag TAG .. clicmd:: set tag TAG
Set a tag on the matched route. This tag value can be from (1-4294967295). Set a tag on the matched route. This tag value can be from (1-4294967295).
@ -233,13 +211,11 @@ Route Map Set Command
configure option. Tag values from (1-255) are sent to the Linux kernel as a configure option. Tag values from (1-255) are sent to the Linux kernel as a
realm value. Then route policy can be applied. See the tc man page. realm value. Then route policy can be applied. See the tc man page.
.. index:: set ip next-hop IPV4_ADDRESS
.. clicmd:: set ip next-hop IPV4_ADDRESS .. clicmd:: set ip next-hop IPV4_ADDRESS
Set the BGP nexthop address to the specified IPV4_ADDRESS. For both Set the BGP nexthop address to the specified IPV4_ADDRESS. For both
incoming and outgoing route-maps. incoming and outgoing route-maps.
.. index:: set ip next-hop peer-address
.. clicmd:: set ip next-hop peer-address .. clicmd:: set ip next-hop peer-address
Set the BGP nexthop address to the address of the peer. For an incoming Set the BGP nexthop address to the address of the peer. For an incoming
@ -247,13 +223,11 @@ Route Map Set Command
route-map this means the ip address of our self is used to establish the route-map this means the ip address of our self is used to establish the
peering with our neighbor. peering with our neighbor.
.. index:: set ip next-hop unchanged
.. clicmd:: set ip next-hop unchanged .. clicmd:: set ip next-hop unchanged
Set the route-map as unchanged. Pass the route-map through without Set the route-map as unchanged. Pass the route-map through without
changing it's value. changing it's value.
.. index:: set ipv6 next-hop peer-address
.. clicmd:: set ipv6 next-hop peer-address .. clicmd:: set ipv6 next-hop peer-address
Set the BGP nexthop address to the address of the peer. For an incoming Set the BGP nexthop address to the address of the peer. For an incoming
@ -261,121 +235,104 @@ Route Map Set Command
route-map this means the ip address of our self is used to establish the route-map this means the ip address of our self is used to establish the
peering with our neighbor. peering with our neighbor.
.. index:: set ipv6 next-hop prefer-global
.. clicmd:: set ipv6 next-hop prefer-global .. clicmd:: set ipv6 next-hop prefer-global
For Incoming and Import Route-maps if we receive a v6 global and v6 LL For Incoming and Import Route-maps if we receive a v6 global and v6 LL
address for the route, then prefer to use the global address as the nexthop. address for the route, then prefer to use the global address as the nexthop.
.. index:: set ipv6 next-hop global IPV6_ADDRESS
.. clicmd:: set ipv6 next-hop global IPV6_ADDRESS .. clicmd:: set ipv6 next-hop global IPV6_ADDRESS
Set the next-hop to the specified IPV6_ADDRESS for both incoming and Set the next-hop to the specified IPV6_ADDRESS for both incoming and
outgoing route-maps. outgoing route-maps.
.. index:: set local-preference LOCAL_PREF
.. clicmd:: set local-preference LOCAL_PREF .. clicmd:: set local-preference LOCAL_PREF
Set the BGP local preference to `local_pref`. Set the BGP local preference to `local_pref`.
.. index:: set local-preference +LOCAL_PREF
.. clicmd:: set local-preference +LOCAL_PREF .. clicmd:: set local-preference +LOCAL_PREF
Add the BGP local preference to an existing `local_pref`. Add the BGP local preference to an existing `local_pref`.
.. index:: set local-preference -LOCAL_PREF
.. clicmd:: set local-preference -LOCAL_PREF .. clicmd:: set local-preference -LOCAL_PREF
Subtract the BGP local preference from an existing `local_pref`. Subtract the BGP local preference from an existing `local_pref`.
.. index:: set distance DISTANCE .. clicmd:: set distance DISTANCE
.. clicmd:: [no] set distance DISTANCE
Set the Administrative distance to DISTANCE to use for the route. Set the Administrative distance to DISTANCE to use for the route.
This is only locally significant and will not be dispersed to peers. This is only locally significant and will not be dispersed to peers.
.. index:: set weight WEIGHT
.. clicmd:: set weight WEIGHT .. clicmd:: set weight WEIGHT
Set the route's weight. Set the route's weight.
.. index:: set metric <[+|-](1-4294967295)|rtt|+rtt|-rtt> .. clicmd:: set metric <[+|-](1-4294967295)|rtt|+rtt|-rtt>
.. clicmd:: [no] set metric <[+|-](1-4294967295)|rtt|+rtt|-rtt>
Set the BGP attribute MED to a specific value. Use `+`/`-` to add or subtract Set the BGP attribute MED to a specific value. Use `+`/`-` to add or subtract
the specified value to/from the MED. Use `rtt` to set the MED to the round the specified value to/from the MED. Use `rtt` to set the MED to the round
trip time or `+rtt`/`-rtt` to add/subtract the round trip time to/from the trip time or `+rtt`/`-rtt` to add/subtract the round trip time to/from the
MED. MED.
.. index:: set as-path prepend AS_PATH
.. clicmd:: set as-path prepend AS_PATH .. clicmd:: set as-path prepend AS_PATH
Set the BGP AS path to prepend. Set the BGP AS path to prepend.
.. index:: set community COMMUNITY
.. clicmd:: set community COMMUNITY .. clicmd:: set community COMMUNITY
Set the BGP community attribute. Set the BGP community attribute.
.. index:: set ipv6 next-hop local IPV6_ADDRESS
.. clicmd:: set ipv6 next-hop local IPV6_ADDRESS .. clicmd:: set ipv6 next-hop local IPV6_ADDRESS
Set the BGP-4+ link local IPv6 nexthop address. Set the BGP-4+ link local IPv6 nexthop address.
.. index:: set origin ORIGIN <egp|igp|incomplete>
.. clicmd:: set origin ORIGIN <egp|igp|incomplete> .. clicmd:: set origin ORIGIN <egp|igp|incomplete>
Set BGP route origin. Set BGP route origin.
.. index:: set table (1-4294967295)
.. clicmd:: set table (1-4294967295) .. clicmd:: set table (1-4294967295)
Set the BGP table to a given table identifier Set the BGP table to a given table identifier
.. index:: set sr-te color (1-4294967295)
.. clicmd:: set sr-te color (1-4294967295) .. clicmd:: set sr-te color (1-4294967295)
Set the color of a SR-TE Policy to be applied to a learned route. The SR-TE Set the color of a SR-TE Policy to be applied to a learned route. The SR-TE
Policy is uniquely determined by the color and the BGP nexthop. Policy is uniquely determined by the color and the BGP nexthop.
.. _route-map-call-command: .. _route-map-call-command:
Route Map Call Command Route Map Call Command
====================== ======================
.. index:: call NAME
.. clicmd:: call NAME .. clicmd:: call NAME
Call route-map `name`. If it returns deny, deny the route and Call route-map `name`. If it returns deny, deny the route and
finish processing the route-map. finish processing the route-map.
.. _route-map-exit-action-command: .. _route-map-exit-action-command:
Route Map Exit Action Command Route Map Exit Action Command
============================= =============================
.. index:: on-match next
.. clicmd:: on-match next .. clicmd:: on-match next
.. index:: continue
.. clicmd:: continue .. clicmd:: continue
Proceed on to the next entry in the route-map. Proceed on to the next entry in the route-map.
.. index:: on-match goto N
.. clicmd:: on-match goto N .. clicmd:: on-match goto N
.. index:: continue N
.. clicmd:: continue N .. clicmd:: continue N
Proceed processing the route-map at the first entry whose order is >= N Proceed processing the route-map at the first entry whose order is >= N
.. _route-map-optimization-command: .. _route-map-optimization-command:
Route Map Optimization Command Route Map Optimization Command
============================== ==============================
.. index:: route-map optimization
.. clicmd:: route-map optimization .. clicmd:: route-map optimization
Enable route-map processing optimization. The optimization is Enable route-map processing optimization. The optimization is
@ -387,10 +344,6 @@ Route Map Optimization Command
of all the prefixes in all the prefix-lists that are included in the of all the prefixes in all the prefix-lists that are included in the
match rule of all the sequences of a route-map. match rule of all the sequences of a route-map.
.. index:: route-map optimization
.. clicmd:: no route-map optimization
Disable the route-map processing optimization.
Route Map Examples Route Map Examples
================== ==================

6
doc/user/routeserver.rst
View File

@ -163,13 +163,10 @@ Commands for configuring a Route Server
Now we will describe the commands that have been added to frr Now we will describe the commands that have been added to frr
in order to support the route server features. in order to support the route server features.
.. index:: neighbor PEER-GROUP route-server-client
.. clicmd:: neighbor PEER-GROUP route-server-client .. clicmd:: neighbor PEER-GROUP route-server-client
.. index:: neighbor A.B.C.D route-server-client
.. clicmd:: neighbor A.B.C.D route-server-client .. clicmd:: neighbor A.B.C.D route-server-client
.. index:: neighbor X:X::X:X route-server-client
.. clicmd:: neighbor X:X::X:X route-server-client .. clicmd:: neighbor X:X::X:X route-server-client
This command configures the peer given by `peer`, `A.B.C.D` or `X:X::X:X` as This command configures the peer given by `peer`, `A.B.C.D` or `X:X::X:X` as
@ -186,14 +183,12 @@ in order to support the route server features.
that moment, every announcement received by the route server will be also that moment, every announcement received by the route server will be also
considered for the new Loc-RIB. considered for the new Loc-RIB.
.. index:: neigbor A.B.C.D|X.X::X.X|peer-group route-map WORD import|export
.. clicmd:: neigbor A.B.C.D|X.X::X.X|peer-group route-map WORD import|export .. clicmd:: neigbor A.B.C.D|X.X::X.X|peer-group route-map WORD import|export
This set of commands can be used to specify the route-map that represents This set of commands can be used to specify the route-map that represents
the Import or Export policy of a peer which is configured as a RS-client the Import or Export policy of a peer which is configured as a RS-client
(with the previous command). (with the previous command).
.. index:: match peer A.B.C.D|X:X::X:X
.. clicmd:: match peer A.B.C.D|X:X::X:X .. clicmd:: match peer A.B.C.D|X:X::X:X
This is a new *match* statement for use in route-maps, enabling them to This is a new *match* statement for use in route-maps, enabling them to
@ -210,7 +205,6 @@ in order to support the route server features.
announce is going to be inserted (how the same export policy is applied announce is going to be inserted (how the same export policy is applied
before different Loc-RIBs is shown in :ref:`fig-rs-processing`.). before different Loc-RIBs is shown in :ref:`fig-rs-processing`.).
.. index:: call WORD
.. clicmd:: call WORD .. clicmd:: call WORD
This command (also used inside a route-map) jumps into a different This command (also used inside a route-map) jumps into a different

18
doc/user/rpki.rst
View File

@ -54,7 +54,6 @@ In a nutshell, the current implementation provides the following features
Enabling RPKI Enabling RPKI
------------- -------------
.. index:: rpki
.. clicmd:: rpki .. clicmd:: rpki
This command enables the RPKI configuration mode. Most commands that start This command enables the RPKI configuration mode. Most commands that start
@ -67,7 +66,6 @@ Enabling RPKI
to configure at least one reachable cache server. See section to configure at least one reachable cache server. See section
:ref:`configuring-rpki-rtr-cache-servers` for configuring a cache server. :ref:`configuring-rpki-rtr-cache-servers` for configuring a cache server.
.. index:: RPKI and daemons
When first installing FRR with RPKI support from the pre-packaged binaries. When first installing FRR with RPKI support from the pre-packaged binaries.
Remember to add ``-M rpki`` to the variable ``bgpd_options`` in Remember to add ``-M rpki`` to the variable ``bgpd_options`` in
@ -101,11 +99,8 @@ Configuring RPKI/RTR Cache Servers
The following commands are independent of a specific cache server. The following commands are independent of a specific cache server.
.. index:: rpki polling_period (1-3600)
.. clicmd:: rpki polling_period (1-3600) .. clicmd:: rpki polling_period (1-3600)
.. index:: rpki polling_period
.. clicmd:: no rpki polling_period
Set the number of seconds the router waits until the router asks the cache Set the number of seconds the router waits until the router asks the cache
again for updated data. again for updated data.
@ -114,11 +109,8 @@ The following commands are independent of a specific cache server.
The following commands configure one or multiple cache servers. The following commands configure one or multiple cache servers.
.. index:: rpki cache (A.B.C.D|WORD) PORT [SSH_USERNAME] [SSH_PRIVKEY_PATH] [SSH_PUBKEY_PATH] [KNOWN_HOSTS_PATH] PREFERENCE
.. clicmd:: rpki cache (A.B.C.D|WORD) PORT [SSH_USERNAME] [SSH_PRIVKEY_PATH] [SSH_PUBKEY_PATH] [KNOWN_HOSTS_PATH] PREFERENCE .. clicmd:: rpki cache (A.B.C.D|WORD) PORT [SSH_USERNAME] [SSH_PRIVKEY_PATH] [SSH_PUBKEY_PATH] [KNOWN_HOSTS_PATH] PREFERENCE
.. index:: rpki cache (A.B.C.D|WORD) [PORT] PREFERENCE
.. clicmd:: no rpki cache (A.B.C.D|WORD) [PORT] PREFERENCE
Add a cache server to the socket. By default, the connection between router Add a cache server to the socket. By default, the connection between router
and cache server is based on plain TCP. Protecting the connection between and cache server is based on plain TCP. Protecting the connection between
@ -154,11 +146,8 @@ The following commands are independent of a specific cache server.
Validating BGP Updates Validating BGP Updates
---------------------- ----------------------
.. index:: match rpki notfound|invalid|valid
.. clicmd:: match rpki notfound|invalid|valid .. clicmd:: match rpki notfound|invalid|valid
.. index:: match rpki notfound|invalid|valid
.. clicmd:: no match rpki notfound|invalid|valid
Create a clause for a route map to match prefixes with the specified RPKI Create a clause for a route map to match prefixes with the specified RPKI
state. state.
@ -187,11 +176,8 @@ Validating BGP Updates
Debugging Debugging
--------- ---------
.. index:: debug rpki
.. clicmd:: debug rpki .. clicmd:: debug rpki
.. index:: debug rpki
.. clicmd:: no debug rpki
Enable or disable debugging output for RPKI. Enable or disable debugging output for RPKI.
@ -200,26 +186,22 @@ Debugging
Displaying RPKI Displaying RPKI
--------------- ---------------
.. index:: show rpki prefix <A.B.C.D/M|X:X::X:X/M> [(1-4294967295)]
.. clicmd:: show rpki prefix <A.B.C.D/M|X:X::X:X/M> [(1-4294967295)] .. clicmd:: show rpki prefix <A.B.C.D/M|X:X::X:X/M> [(1-4294967295)]
Display validated prefixes received from the cache servers filtered Display validated prefixes received from the cache servers filtered
by the specified prefix. by the specified prefix.
.. index:: show rpki as-number ASN
.. clicmd:: show rpki as-number ASN .. clicmd:: show rpki as-number ASN
Display validated prefixes received from the cache servers filtered Display validated prefixes received from the cache servers filtered
by ASN. by ASN.
.. index:: show rpki prefix-table
.. clicmd:: show rpki prefix-table .. clicmd:: show rpki prefix-table
Display all validated prefix to origin AS mappings/records which have been 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, received from the cache servers and stored in the router. Based on this data,
the router validates BGP Updates. the router validates BGP Updates.
.. index:: show rpki cache-connection
.. clicmd:: show rpki cache-connection .. clicmd:: show rpki cache-connection
Display all configured cache servers, whether active or not. Display all configured cache servers, whether active or not.

16
doc/user/sharp.rst
View File

@ -32,7 +32,6 @@ Using SHARP
All sharp commands are under the enable node and preceded by the ``sharp`` All sharp commands are under the enable node and preceded by the ``sharp``
keyword. At present, no sharp commands will be preserved in the config. keyword. At present, no sharp commands will be preserved in the config.
.. index:: sharp install
.. clicmd:: sharp install routes A.B.C.D <nexthop <E.F.G.H|X:X::X:X>|nexthop-group NAME> (1-1000000) [instance (0-255)] [repeat (2-1000)] [opaque WORD] .. clicmd:: sharp install routes A.B.C.D <nexthop <E.F.G.H|X:X::X:X>|nexthop-group NAME> (1-1000000) [instance (0-255)] [repeat (2-1000)] [opaque WORD]
Install up to 1,000,000 (one million) /32 routes starting at ``A.B.C.D`` Install up to 1,000,000 (one million) /32 routes starting at ``A.B.C.D``
@ -49,7 +48,6 @@ keyword. At present, no sharp commands will be preserved in the config.
number of times specified. If the keyword opaque is specified then the number of times specified. If the keyword opaque is specified then the
next word is sent down to zebra as part of the route installation. next word is sent down to zebra as part of the route installation.
.. index:: sharp remove
.. clicmd:: sharp remove routes A.B.C.D (1-1000000) .. clicmd:: sharp remove routes A.B.C.D (1-1000000)
Remove up to 1,000,000 (one million) /32 routes starting at ``A.B.C.D``. The Remove up to 1,000,000 (one million) /32 routes starting at ``A.B.C.D``. The
@ -57,7 +55,6 @@ keyword. At present, no sharp commands will be preserved in the config.
log and when all routes have been successfully deleted the debug log will be log and when all routes have been successfully deleted the debug log will be
updated with this information as well. updated with this information as well.
.. index:: sharp data route
.. clicmd:: sharp data route .. clicmd:: sharp data route
Allow end user doing route install and deletion to get timing information Allow end user doing route install and deletion to get timing information
@ -65,14 +62,12 @@ keyword. At present, no sharp commands will be preserved in the config.
is informational only and you should look at sharp_vty.c for explanation is informational only and you should look at sharp_vty.c for explanation
of the output as that it may change. of the output as that it may change.
.. index:: sharp label
.. clicmd:: sharp label <ipv4|ipv6> vrf NAME label (0-1000000) .. clicmd:: sharp label <ipv4|ipv6> vrf NAME label (0-1000000)
Install a label into the kernel that causes the specified vrf NAME table to 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. be used for pop and forward operations when the specified label is seen.
.. index:: sharp watch .. clicmd:: sharp watch <nexthop <A.B.C.D|X:X::X:X>|import <A.B.C.D/M:X:X::X:X/M> [connected]
.. clicmd:: [no] 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 Instruct zebra to monitor and notify sharp when the specified nexthop is
changed. The notification from zebra is written into the debug log. changed. The notification from zebra is written into the debug log.
@ -83,13 +78,11 @@ keyword. At present, no sharp commands will be preserved in the config.
for the import keyword connected means exact match. The no form of for the import keyword connected means exact match. The no form of
the command obviously turns this watching off. the command obviously turns this watching off.
.. index:: sharp data nexthop
.. clicmd:: sharp data nexthop .. clicmd:: sharp data nexthop
Allow end user to dump associated data with the nexthop tracking that Allow end user to dump associated data with the nexthop tracking that
may have been turned on. may have been turned on.
.. index:: sharp lsp
.. clicmd:: sharp lsp [update] (0-100000) nexthop-group NAME [prefix A.B.C.D/M TYPE [instance (0-255)]] .. clicmd:: sharp lsp [update] (0-100000) nexthop-group NAME [prefix A.B.C.D/M TYPE [instance (0-255)]]
Install an LSP using the specified in-label, with nexthops as Install an LSP using the specified in-label, with nexthops as
@ -98,7 +91,6 @@ keyword. At present, no sharp commands will be preserved in the config.
If ``prefix`` is specified, an existing route with type ``TYPE`` If ``prefix`` is specified, an existing route with type ``TYPE``
(and optional ``instance`` id) will be updated to use the LSP. (and optional ``instance`` id) will be updated to use the LSP.
.. index:: sharp remove lsp
.. clicmd:: sharp remove lsp (0-100000) nexthop-group NAME [prefix A.B.C.D/M TYPE [instance (0-255)]] .. clicmd:: sharp remove lsp (0-100000) nexthop-group NAME [prefix A.B.C.D/M TYPE [instance (0-255)]]
Remove a SHARPD LSP that uses the specified in-label, where the Remove a SHARPD LSP that uses the specified in-label, where the
@ -106,13 +98,11 @@ keyword. At present, no sharp commands will be preserved in the config.
specified, remove label bindings from the route of type ``TYPE`` specified, remove label bindings from the route of type ``TYPE``
also. also.
.. index:: sharp send opaque
.. clicmd:: sharp send opaque type (1-255) (1-1000) .. clicmd:: sharp send opaque type (1-255) (1-1000)
Send opaque ZAPI messages with subtype ``type``. Sharpd will send Send opaque ZAPI messages with subtype ``type``. Sharpd will send
a stream of messages if the count is greater than one. a stream of messages if the count is greater than one.
.. index:: sharp send opaque unicast
.. clicmd:: sharp send opaque unicast type (1-255) $proto_str [{instance (0-1000) | session (1-1000)}] (1-1000) .. clicmd:: sharp send opaque unicast type (1-255) $proto_str [{instance (0-1000) | session (1-1000)}] (1-1000)
Send unicast opaque ZAPI messages with subtype ``type``. The Send unicast opaque ZAPI messages with subtype ``type``. The
@ -120,7 +110,6 @@ keyword. At present, no sharp commands will be preserved in the config.
client. Sharpd will send a stream of messages if the count is client. Sharpd will send a stream of messages if the count is
greater than one. greater than one.
.. index:: sharp send opaque reg unreg
.. clicmd:: sharp send opaque <reg | unreg> $proto_str [{instance (0-1000) | session (1-1000)}] type (1-1000) .. clicmd:: sharp send opaque <reg | unreg> $proto_str [{instance (0-1000) | session (1-1000)}] type (1-1000)
Send opaque ZAPI registration and unregistration messages for a Send opaque ZAPI registration and unregistration messages for a
@ -128,19 +117,16 @@ keyword. At present, no sharp commands will be preserved in the config.
name, and can include optional zapi ``instance`` and ``session`` name, and can include optional zapi ``instance`` and ``session``
values. values.
.. index:: sharp create session
.. clicmd:: sharp create session (1-1024) .. clicmd:: sharp create session (1-1024)
Create an additional zapi client session for testing, using the Create an additional zapi client session for testing, using the
specified session id. specified session id.
.. index:: sharp remove session
.. clicmd:: sharp remove session (1-1024) .. clicmd:: sharp remove session (1-1024)
Remove a test zapi client session that was created with the Remove a test zapi client session that was created with the
specified session id. specified session id.
.. index:: sharp neigh discover
.. clicmd:: sharp neigh discover [vrf NAME] <A.B.C.D|X:X::X:X> IFNAME .. clicmd:: sharp neigh discover [vrf NAME] <A.B.C.D|X:X::X:X> IFNAME
Send an ARP/NDP request to trigger the addition of a neighbor in the ARP Send an ARP/NDP request to trigger the addition of a neighbor in the ARP

3
doc/user/snmp.rst
View File

@ -130,10 +130,7 @@ need to configure FRR to use another transport, you can configure it through
Here is the syntax for using AgentX: Here is the syntax for using AgentX:
.. index:: agentx
.. clicmd:: agentx .. clicmd:: agentx
.. index:: agentx
.. clicmd:: no agentx
.. include:: snmptrap.rst .. include:: snmptrap.rst

2
doc/user/static.rst
View File

@ -35,10 +35,8 @@ Static Route Commands
Static routing is a very fundamental feature of routing technology. It defines Static routing is a very fundamental feature of routing technology. It defines
a static prefix and gateway. a static prefix and gateway.
.. index:: ip route NETWORK GATEWAY table TABLENO nexthop-vrf VRFNAME DISTANCE vrf VRFNAME
.. clicmd:: ip route NETWORK GATEWAY table TABLENO nexthop-vrf VRFNAME DISTANCE vrf VRFNAME .. clicmd:: ip route NETWORK GATEWAY table TABLENO nexthop-vrf VRFNAME DISTANCE vrf VRFNAME
.. index:: ipv6 route NETWORK from SRCPREFIX GATEWAY table TABLENO nexthop-vrf VRFNAME DISTANCE vrf VRFNAME
.. clicmd:: ipv6 route NETWORK from SRCPREFIX GATEWAY table TABLENO nexthop-vrf VRFNAME DISTANCE vrf VRFNAME .. clicmd:: ipv6 route NETWORK from SRCPREFIX GATEWAY table TABLENO nexthop-vrf VRFNAME DISTANCE vrf VRFNAME
NETWORK is destination prefix with a valid v4 or v6 network based upon NETWORK is destination prefix with a valid v4 or v6 network based upon

58
doc/user/vnc.rst
View File

@ -110,7 +110,6 @@ These are the statements that can appear between ``vnc defaults`` and
- :clicmd:`export bgp|zebra route-map MAP-NAME` - :clicmd:`export bgp|zebra route-map MAP-NAME`
- :clicmd:`export bgp|zebra no route-map` - :clicmd:`export bgp|zebra no route-map`
.. index:: exit-vnc
.. clicmd:: exit-vnc .. clicmd:: exit-vnc
Exit VNC configuration mode. Exit VNC configuration mode.
@ -136,7 +135,6 @@ Defaults section.
**At least one `nve-group` is mandatory for useful VNC operation.** **At least one `nve-group` is mandatory for useful VNC operation.**
.. index:: vnc nve-group NAME
.. clicmd:: vnc nve-group NAME .. clicmd:: vnc nve-group NAME
Enter VNC configuration mode for defining the NVE group `name`. Enter VNC configuration mode for defining the NVE group `name`.
@ -149,14 +147,8 @@ Defaults section.
exit-vnc exit-vnc
.. index:: vnc nve-group NAME
.. clicmd:: no vnc nve-group NAME
Delete the NVE group named `name`.
The following statements are valid in an NVE group definition: The following statements are valid in an NVE group definition:
.. index:: l2rd NVE-ID-VALUE
.. clicmd:: l2rd NVE-ID-VALUE .. clicmd:: l2rd NVE-ID-VALUE
Set the value used to distinguish NVEs connected to the same physical Set the value used to distinguish NVEs connected to the same physical
@ -166,7 +158,6 @@ Defaults section.
1-255, or it may be specified as `auto:vn`, which means to use the 1-255, or it may be specified as `auto:vn`, which means to use the
least-significant octet of the originating NVE's VN address. least-significant octet of the originating NVE's VN address.
.. index:: prefix vn|un A.B.C.D/M|X:X::X:X/M
.. clicmd:: prefix vn|un A.B.C.D/M|X:X::X:X/M .. clicmd:: prefix vn|un A.B.C.D/M|X:X::X:X/M
Specify the matching prefix for this NVE group by either virtual-network Specify the matching prefix for this NVE group by either virtual-network
@ -178,7 +169,6 @@ Defaults section.
These prefixes are used only for determining assignments of NVEs to NVE These prefixes are used only for determining assignments of NVEs to NVE
Groups. Groups.
.. index:: rd ROUTE-DISTINGUISHER
.. clicmd:: rd ROUTE-DISTINGUISHER .. clicmd:: rd ROUTE-DISTINGUISHER
Specify the route distinguisher for routes advertised via BGP Specify the route distinguisher for routes advertised via BGP
@ -202,7 +192,6 @@ Defaults section.
`route-distinguisher` is configured, then the advertised RD is set to `route-distinguisher` is configured, then the advertised RD is set to
``two-byte-autonomous-system-number=0:four-byte-integer=0``. ``two-byte-autonomous-system-number=0:four-byte-integer=0``.
.. index:: response-lifetime LIFETIME|infinite
.. clicmd:: response-lifetime LIFETIME|infinite .. clicmd:: response-lifetime LIFETIME|infinite
Specify the response lifetime, in seconds, to be included in RFP response Specify the response lifetime, in seconds, to be included in RFP response
@ -218,13 +207,10 @@ Defaults section.
`response-lifetime` is configured, the value 3600 will be used. The maximum `response-lifetime` is configured, the value 3600 will be used. The maximum
response lifetime is 2147483647. response lifetime is 2147483647.
.. index:: rt export RT-LIST
.. clicmd:: rt export RT-LIST .. clicmd:: rt export RT-LIST
.. index:: rt import RT-LIST
.. clicmd:: rt import RT-LIST .. clicmd:: rt import RT-LIST
.. index:: rt both RT-LIST
.. clicmd:: rt both RT-LIST .. clicmd:: rt both RT-LIST
Specify route target import and export lists. `rt-list` is a Specify route target import and export lists. `rt-list` is a
@ -258,7 +244,6 @@ Defaults section.
simultaneously, and is equivalent to `rt export `rt-list`` followed by simultaneously, and is equivalent to `rt export `rt-list`` followed by
`rt import `rt-list``. `rt import `rt-list``.
.. index:: export bgp|zebra route-map MAP-NAME
.. clicmd:: export bgp|zebra route-map MAP-NAME .. clicmd:: export bgp|zebra route-map MAP-NAME
Specify that the named route-map should be applied to routes being exported Specify that the named route-map should be applied to routes being exported
@ -266,7 +251,6 @@ Defaults section.
:ref:`configuring-export-of-routes-to-other-routing-protocols`. This item :ref:`configuring-export-of-routes-to-other-routing-protocols`. This item
is optional. is optional.
.. index:: export bgp|zebra no route-map
.. clicmd:: export bgp|zebra no route-map .. clicmd:: export bgp|zebra no route-map
Specify that no route-map should be applied to routes being exported to bgp Specify that no route-map should be applied to routes being exported to bgp
@ -274,7 +258,6 @@ Defaults section.
:ref:`configuring-export-of-routes-to-other-routing-protocols`. This item :ref:`configuring-export-of-routes-to-other-routing-protocols`. This item
is optional. is optional.
.. index:: export bgp|zebra ipv4|ipv6 prefix-list LIST-NAME
.. clicmd:: export bgp|zebra ipv4|ipv6 prefix-list LIST-NAME .. clicmd:: export bgp|zebra ipv4|ipv6 prefix-list LIST-NAME
Specify that the named prefix-list filter should be applied to routes being Specify that the named prefix-list filter should be applied to routes being
@ -283,7 +266,6 @@ Defaults section.
:ref:`configuring-export-of-routes-to-other-routing-protocols`. This item :ref:`configuring-export-of-routes-to-other-routing-protocols`. This item
is optional. is optional.
.. index:: export bgp|zebra no ipv4|ipv6 prefix-list
.. clicmd:: export bgp|zebra no ipv4|ipv6 prefix-list .. clicmd:: export bgp|zebra no ipv4|ipv6 prefix-list
Specify that no prefix-list filter should be applied to routes being Specify that no prefix-list filter should be applied to routes being
@ -309,7 +291,6 @@ Note that a corresponding NVE group configuration must be present, and that
other NVE associated configuration information, notably RD, is not impacted by other NVE associated configuration information, notably RD, is not impacted by
L2 Group Configuration. L2 Group Configuration.
.. index:: vnc l2-group NAME
.. clicmd:: vnc l2-group NAME .. clicmd:: vnc l2-group NAME
Enter VNC configuration mode for defining the L2 group `name`. Enter VNC configuration mode for defining the L2 group `name`.
@ -322,35 +303,26 @@ L2 Group Configuration.
exit-vnc exit-vnc
.. index:: vnc l2-group NAME
.. clicmd:: no vnc l2-group NAME
Delete the L2 group named `name`. Delete the L2 group named `name`.
The following statements are valid in a L2 group definition: The following statements are valid in a L2 group definition:
.. index:: logical-network-id VALUE
.. clicmd:: logical-network-id VALUE .. clicmd:: logical-network-id VALUE
Define the Logical Network Identifier with a value in the range of Define the Logical Network Identifier with a value in the range of
0-4294967295 that identifies the logical Ethernet segment. 0-4294967295 that identifies the logical Ethernet segment.
.. index:: labels LABEL-LIST
.. clicmd:: labels LABEL-LIST .. clicmd:: labels LABEL-LIST
.. index:: labels LABEL-LIST
.. clicmd:: no labels LABEL-LIST
Add or remove labels associated with the group. `label-list` is a Add or remove labels associated with the group. `label-list` is a
space separated list of label values in the range of 0-1048575. space separated list of label values in the range of 0-1048575.
.. index:: rt import RT-TARGET
.. clicmd:: rt import RT-TARGET .. clicmd:: rt import RT-TARGET
.. index:: rt export RT-TARGET
.. clicmd:: rt export RT-TARGET .. clicmd:: rt export RT-TARGET
.. index:: rt both RT-TARGET
.. clicmd:: rt both RT-TARGET .. clicmd:: rt both RT-TARGET
Specify the route target import and export value associated with the group. Specify the route target import and export value associated with the group.
@ -484,14 +456,10 @@ There is currently no policy (prefix-list or route-map) support for
Redistribution Command Syntax Redistribution Command Syntax
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. index:: vnc redistribute ipv4|ipv6 bgp|bgp-direct|ipv6 bgp-direct-to-nve-groups|connected|kernel|ospf|rip|static
.. clicmd:: vnc redistribute ipv4|ipv6 bgp|bgp-direct|ipv6 bgp-direct-to-nve-groups|connected|kernel|ospf|rip|static .. clicmd:: vnc redistribute ipv4|ipv6 bgp|bgp-direct|ipv6 bgp-direct-to-nve-groups|connected|kernel|ospf|rip|static
.. index:: vnc redistribute ipv4|ipv6 bgp-direct-to-nve-groups view VIEWNAME
.. clicmd:: vnc redistribute ipv4|ipv6 bgp-direct-to-nve-groups view VIEWNAME .. clicmd:: vnc redistribute ipv4|ipv6 bgp-direct-to-nve-groups view VIEWNAME
.. index:: vnc redistribute ipv4|ipv6 bgp|bgp-direct|bgp-direct-to-nve-groups|connected|kernel|ospf|rip|static
.. clicmd:: no vnc redistribute ipv4|ipv6 bgp|bgp-direct|bgp-direct-to-nve-groups|connected|kernel|ospf|rip|static
Import (or do not import) prefixes from another routing protocols. Specify Import (or do not import) prefixes from another routing protocols. Specify
both the address family to import (`ipv4` or `ipv6`) and the protocol both the address family to import (`ipv4` or `ipv6`) and the protocol
@ -502,17 +470,13 @@ Redistribution Command Syntax
Prefixes from all other protocols (including `bgp`) are imported via the Prefixes from all other protocols (including `bgp`) are imported via the
`zebra` kernel routing process. `zebra` kernel routing process.
.. index:: vnc redistribute mode plain|nve-group|resolve-nve
.. clicmd:: vnc redistribute mode plain|nve-group|resolve-nve .. clicmd:: vnc redistribute mode plain|nve-group|resolve-nve
Redistribute routes from other protocols into VNC using the specified mode. Redistribute routes from other protocols into VNC using the specified mode.
Not all combinations of modes and protocols are supported. Not all combinations of modes and protocols are supported.
.. index:: vnc redistribute nve-group GROUP-NAME
.. clicmd:: vnc redistribute nve-group GROUP-NAME .. clicmd:: vnc redistribute nve-group GROUP-NAME
.. index:: vnc redistribute nve-group GROUP-NAME
.. clicmd:: no vnc redistribute nve-group GROUP-NAME
When using `nve-group` mode, assign (or do not assign) the NVE group When using `nve-group` mode, assign (or do not assign) the NVE group
`group-name` to routes redistributed from another routing protocol. `group-name` to routes redistributed from another routing protocol.
@ -522,7 +486,6 @@ Redistribution Command Syntax
prefix must be specified as a full-length (/32 for IPv4, /128 for IPv6) prefix must be specified as a full-length (/32 for IPv4, /128 for IPv6)
prefix. prefix.
.. index:: vnc redistribute lifetime LIFETIME|infinite
.. clicmd:: vnc redistribute lifetime LIFETIME|infinite .. clicmd:: vnc redistribute lifetime LIFETIME|infinite
Assign a registration lifetime, either `lifetime` seconds or `infinite`, to Assign a registration lifetime, either `lifetime` seconds or `infinite`, to
@ -530,7 +493,6 @@ Redistribution Command Syntax
received via RFP registration messages from an NVE. `lifetime` can be any received via RFP registration messages from an NVE. `lifetime` can be any
integer between 1 and 4294967295, inclusive. integer between 1 and 4294967295, inclusive.
.. index:: vnc redistribute resolve-nve roo-ec-local-admin 0-65536
.. clicmd:: vnc redistribute resolve-nve roo-ec-local-admin 0-65536 .. clicmd:: vnc redistribute resolve-nve roo-ec-local-admin 0-65536
Assign a value to the local-administrator subfield used in the Assign a value to the local-administrator subfield used in the
@ -545,25 +507,21 @@ specified outside the context of an nve-group, then they apply only for
redistribution modes `plain` and `resolve-nve`, and then only for routes redistribution modes `plain` and `resolve-nve`, and then only for routes
being redistributed from `bgp-direct`. being redistributed from `bgp-direct`.
.. index:: vnc redistribute bgp-direct (ipv4|ipv6) prefix-list LIST-NAME
.. clicmd:: vnc redistribute bgp-direct (ipv4|ipv6) prefix-list LIST-NAME .. clicmd:: vnc redistribute bgp-direct (ipv4|ipv6) prefix-list LIST-NAME
When redistributing `bgp-direct` routes, When redistributing `bgp-direct` routes,
specifies that the named prefix-list should be applied. specifies that the named prefix-list should be applied.
.. index:: vnc redistribute bgp-direct no (ipv4|ipv6) prefix-list
.. clicmd:: vnc redistribute bgp-direct no (ipv4|ipv6) prefix-list .. clicmd:: vnc redistribute bgp-direct no (ipv4|ipv6) prefix-list
When redistributing `bgp-direct` routes, When redistributing `bgp-direct` routes,
specifies that no prefix-list should be applied. specifies that no prefix-list should be applied.
.. index:: vnc redistribute bgp-direct route-map MAP-NAME
.. clicmd:: vnc redistribute bgp-direct route-map MAP-NAME .. clicmd:: vnc redistribute bgp-direct route-map MAP-NAME
When redistributing `bgp-direct` routes, When redistributing `bgp-direct` routes,
specifies that the named route-map should be applied. specifies that the named route-map should be applied.
.. index:: vnc redistribute bgp-direct no route-map
.. clicmd:: vnc redistribute bgp-direct no route-map .. clicmd:: vnc redistribute bgp-direct no route-map
When redistributing `bgp-direct` routes, When redistributing `bgp-direct` routes,
@ -582,7 +540,6 @@ downstream protocol must also be configured to import the routes. For example,
when VNC routes are exported to unicast BGP, the BGP configuration must include when VNC routes are exported to unicast BGP, the BGP configuration must include
a corresponding `redistribute vnc-direct` statement. a corresponding `redistribute vnc-direct` statement.
.. index:: export bgp|zebra mode none|group-nve|registering-nve|ce
.. clicmd:: export bgp|zebra mode none|group-nve|registering-nve|ce .. clicmd:: export bgp|zebra mode none|group-nve|registering-nve|ce
Specify how routes should be exported to bgp or zebra. If the mode is Specify how routes should be exported to bgp or zebra. If the mode is
@ -600,10 +557,8 @@ a corresponding `redistribute vnc-direct` statement.
The default for both bgp and zebra is mode `none`. The default for both bgp and zebra is mode `none`.
.. index:: vnc export bgp|zebra group-nve group GROUP-NAME
.. clicmd:: vnc export bgp|zebra group-nve group GROUP-NAME .. clicmd:: vnc export bgp|zebra group-nve group GROUP-NAME
.. index:: vnc export bgp|zebra group-nve no group GROUP-NAME
.. clicmd:: vnc export bgp|zebra group-nve no group GROUP-NAME .. clicmd:: vnc export bgp|zebra group-nve no group GROUP-NAME
When export mode is `group-nve`, export (or do not export) prefixes from the When export mode is `group-nve`, export (or do not export) prefixes from the
@ -702,14 +657,12 @@ manually and dynamically added information.
`local-next-hop` parameter is used to delete specific local nexthop `local-next-hop` parameter is used to delete specific local nexthop
information. information.
.. index:: clear vnc mac (\\*|xx:xx:xx:xx:xx:xx) virtual-network-identifier (\\*|(1-4294967295)) (\\*|[(vn|un) (A.B.C.D|X:X::X:X|\\*) [(un|vn) (A.B.C.D|X:X::X:X|\*)] [prefix (\\*|A.B.C.D/M|X:X::X:X/M)])
.. clicmd:: clear vnc mac (\*|xx:xx:xx:xx:xx:xx) virtual-network-identifier (\*|(1-4294967295)) (\*|[(vn|un) (A.B.C.D|X:X::X:X|\*) [(un|vn) (A.B.C.D|X:X::X:X|\*)] [prefix (\*|A.B.C.D/M|X:X::X:X/M)]) .. clicmd:: clear vnc mac (\*|xx:xx:xx:xx:xx:xx) virtual-network-identifier (\*|(1-4294967295)) (\*|[(vn|un) (A.B.C.D|X:X::X:X|\*) [(un|vn) (A.B.C.D|X:X::X:X|\*)] [prefix (\*|A.B.C.D/M|X:X::X:X/M)])
Delete mac forwarding information. Any or all of these parameters may be Delete mac forwarding information. Any or all of these parameters may be
wildcarded to (potentially) match more than one registration. The default wildcarded to (potentially) match more than one registration. The default
value for the `prefix` parameter is the wildcard value `*`. value for the `prefix` parameter is the wildcard value `*`.
.. index:: clear vnc nve (\*|((vn|un) (A.B.C.D|X:X::X:X) [(un|vn) (A.B.C.D|X:X::X:X)]))
.. clicmd:: clear vnc nve (\*|((vn|un) (A.B.C.D|X:X::X:X) [(un|vn) (A.B.C.D|X:X::X:X)])) .. clicmd:: clear vnc nve (\*|((vn|un) (A.B.C.D|X:X::X:X) [(un|vn) (A.B.C.D|X:X::X:X)]))
Delete prefixes associated with the NVE specified by the given VN and UN Delete prefixes associated with the NVE specified by the given VN and UN
@ -729,24 +682,20 @@ running-configuration` command when in `enable` mode.
The following commands are used to clear and display Virtual Network Control The following commands are used to clear and display Virtual Network Control
related information: related information:
.. index:: clear vnc counters
.. clicmd:: clear vnc counters .. clicmd:: clear vnc counters
Reset the counter values stored by the NVA. Counter Reset the counter values stored by the NVA. Counter
values can be seen using the `show vnc` commands listed above. This values can be seen using the `show vnc` commands listed above. This
command is only available in `enable` mode. command is only available in `enable` mode.
.. index:: show vnc summary
.. clicmd:: show vnc summary .. clicmd:: show vnc summary
Print counter values and other general information Print counter values and other general information
about the NVA. Counter values can be reset about the NVA. Counter values can be reset
using the `clear vnc counters` command listed below. using the `clear vnc counters` command listed below.
.. index:: show vnc nves
.. clicmd:: show vnc nves .. clicmd:: show vnc nves
.. index:: show vnc nves vn|un ADDRESS
.. clicmd:: show vnc nves vn|un ADDRESS .. clicmd:: show vnc nves vn|un ADDRESS
Display the NVA's current clients. Specifying `address` limits the output to Display the NVA's current clients. Specifying `address` limits the output to
@ -754,10 +703,8 @@ related information:
communicated with the NVE, per-NVE summary counters and each NVE's addresses communicated with the NVE, per-NVE summary counters and each NVE's addresses
will be displayed. will be displayed.
.. index:: show vnc queries
.. clicmd:: show vnc queries .. clicmd:: show vnc queries
.. index:: show vnc queries PREFIX
.. clicmd:: show vnc queries PREFIX .. clicmd:: show vnc queries PREFIX
Display active Query information. Queries remain valid for the default Display active Query information. Queries remain valid for the default
@ -768,10 +715,8 @@ related information:
Query information is provided for each querying NVE, and includes the Query Query information is provided for each querying NVE, and includes the Query
Target and the time remaining before the information is removed. Target and the time remaining before the information is removed.
.. index:: show vnc registrations [all|local|remote|holddown|imported]
.. clicmd:: show vnc registrations [all|local|remote|holddown|imported] .. clicmd:: show vnc registrations [all|local|remote|holddown|imported]
.. index:: show vnc registrations [all|local|remote|holddown|imported] PREFIX
.. clicmd:: show vnc registrations [all|local|remote|holddown|imported] PREFIX .. clicmd:: show vnc registrations [all|local|remote|holddown|imported] PREFIX
Display local, remote, holddown, and/or imported registration information. Display local, remote, holddown, and/or imported registration information.
@ -791,10 +736,8 @@ related information:
registrations, the amount of time remaining before the information is registrations, the amount of time remaining before the information is
removed. removed.
.. index:: show vnc responses [active|removed]
.. clicmd:: show vnc responses [active|removed] .. clicmd:: show vnc responses [active|removed]
.. index:: show vnc responses [active|removed] PREFIX
.. clicmd:: show vnc responses [active|removed] PREFIX .. clicmd:: show vnc responses [active|removed] PREFIX
Display all, active and/or removed response information which are Display all, active and/or removed response information which are
@ -811,7 +754,6 @@ related information:
the administrative cost, the provided response lifetime and the time the administrative cost, the provided response lifetime and the time
remaining before the information is to be removed or will become inactive. remaining before the information is to be removed or will become inactive.
.. index:: show memory vnc
.. clicmd:: show memory vnc .. clicmd:: show memory vnc
Print the number of memory items allocated by the NVA. Print the number of memory items allocated by the NVA.

31
doc/user/vrrp.rst
View File

@ -358,30 +358,26 @@ using VRRPv2.
All interface configuration commands are documented below. All interface configuration commands are documented below.
.. index:: vrrp (1-255) [version (2-3)] .. clicmd:: vrrp (1-255) [version (2-3)]
.. clicmd:: [no] vrrp (1-255) [version (2-3)]
Create a VRRP router with the specified VRID on the interface. Optionally Create a VRRP router with the specified VRID on the interface. Optionally
specify the protocol version. If the protocol version is not specified, the specify the protocol version. If the protocol version is not specified, the
default is VRRPv3. default is VRRPv3.
.. index:: vrrp (1-255) advertisement-interval (10-40950) .. clicmd:: vrrp (1-255) advertisement-interval (10-40950)
.. clicmd:: [no] vrrp (1-255) advertisement-interval (10-40950)
Set the advertisement interval. This is the interval at which VRRP Set the advertisement interval. This is the interval at which VRRP
advertisements will be sent. Values are given in milliseconds, but must be advertisements will be sent. Values are given in milliseconds, but must be
multiples of 10, as VRRP itself uses centiseconds. multiples of 10, as VRRP itself uses centiseconds.
.. index:: vrrp (1-255) ip A.B.C.D .. clicmd:: vrrp (1-255) ip A.B.C.D
.. clicmd:: [no] vrrp (1-255) ip A.B.C.D
Add an IPv4 address to the router. This address must already be configured Add an IPv4 address to the router. This address must already be configured
on the appropriate macvlan device. Adding an IP address to the router will on the appropriate macvlan device. Adding an IP address to the router will
implicitly activate the router; see :clicmd:`[no] vrrp (1-255) shutdown` to implicitly activate the router; see :clicmd:`[no] vrrp (1-255) shutdown` to
override this behavior. override this behavior.
.. index:: vrrp (1-255) ipv6 X:X::X:X .. clicmd:: vrrp (1-255) ipv6 X:X::X:X
.. clicmd:: [no] vrrp (1-255) ipv6 X:X::X:X
Add an IPv6 address to the router. This address must already be configured Add an IPv6 address to the router. This address must already be configured
on the appropriate macvlan device. Adding an IP address to the router will on the appropriate macvlan device. Adding an IP address to the router will
@ -391,23 +387,20 @@ All interface configuration commands are documented below.
This command will fail if the protocol version is set to VRRPv2, as VRRPv2 This command will fail if the protocol version is set to VRRPv2, as VRRPv2
does not support IPv6. does not support IPv6.
.. index:: vrrp (1-255) preempt .. clicmd:: vrrp (1-255) preempt
.. clicmd:: [no] vrrp (1-255) preempt
Toggle preempt mode. When enabled, preemption allows Backup routers with Toggle preempt mode. When enabled, preemption allows Backup routers with
higher priority to take over Master status from the existing Master. Enabled higher priority to take over Master status from the existing Master. Enabled
by default. by default.
.. index:: vrrp (1-255) priority (1-254) .. clicmd:: vrrp (1-255) priority (1-254)
.. clicmd:: [no] vrrp (1-255) priority (1-254)
Set the router priority. The router with the highest priority is elected as Set the router priority. The router with the highest priority is elected as
the Master. If all routers in the VRRP virtual router are configured with the Master. If all routers in the VRRP virtual router are configured with
the same priority, the router with the highest primary IP address is elected the same priority, the router with the highest primary IP address is elected
as the Master. Priority value 255 is reserved for the acting Master router. as the Master. Priority value 255 is reserved for the acting Master router.
.. index:: vrrp (1-255) shutdown .. clicmd:: vrrp (1-255) shutdown
.. clicmd:: [no] vrrp (1-255) shutdown
Place the router into administrative shutdown. VRRP will not activate for Place the router into administrative shutdown. VRRP will not activate for
this router until this command is removed with the ``no`` form. this router until this command is removed with the ``no`` form.
@ -419,7 +412,6 @@ Global Configuration
Show commands, global defaults and debugging configuration commands. Show commands, global defaults and debugging configuration commands.
.. index:: show vrrp [interface INTERFACE] [(1-255)] [json]
.. clicmd:: show vrrp [interface INTERFACE] [(1-255)] [json] .. clicmd:: show vrrp [interface INTERFACE] [(1-255)] [json]
Shows VRRP status for some or all configured VRRP routers. Specifying an Shows VRRP status for some or all configured VRRP routers. Specifying an
@ -427,8 +419,7 @@ Show commands, global defaults and debugging configuration commands.
VRID will only show routers with that VRID. Specifying ``json`` will dump VRID will only show routers with that VRID. Specifying ``json`` will dump
each router state in a JSON array. each router state in a JSON array.
.. index:: debug vrrp [{protocol|autoconfigure|packets|sockets|ndisc|arp|zebra}] .. clicmd:: debug vrrp [{protocol|autoconfigure|packets|sockets|ndisc|arp|zebra}]
.. clicmd:: [no] debug vrrp [{protocol|autoconfigure|packets|sockets|ndisc|arp|zebra}]
Toggle debugging logs for VRRP components. Toggle debugging logs for VRRP components.
If no component is specified, debugging for all components are turned on/off. If no component is specified, debugging for all components are turned on/off.
@ -457,8 +448,7 @@ Show commands, global defaults and debugging configuration commands.
zebra zebra
Logs communications with Zebra. Logs communications with Zebra.
.. index:: vrrp default <advertisement-interval (1-4096)|preempt|priority (1-254)|shutdown> .. clicmd:: vrrp default <advertisement-interval (1-4096)|preempt|priority (1-254)|shutdown>
.. clicmd:: [no] vrrp default <advertisement-interval (1-4096)|preempt|priority (1-254)|shutdown>
Configure defaults for new VRRP routers. These values will not affect Configure defaults for new VRRP routers. These values will not affect
already configured VRRP routers, but will be applied to newly configured already configured VRRP routers, but will be applied to newly configured
@ -480,8 +470,7 @@ After configuring the interfaces as described in
:ref:`vrrp-system-configuration`, and configuring any defaults you may want, :ref:`vrrp-system-configuration`, and configuring any defaults you may want,
execute the following command: execute the following command:
.. index:: vrrp autoconfigure [version (2-3)] .. clicmd:: vrrp autoconfigure [version (2-3)]
.. clicmd:: [no] vrrp autoconfigure [version (2-3)]
Generates VRRP configuration based on the interface configuration on the Generates VRRP configuration based on the interface configuration on the
base system. If the protocol version is not specified, the default is VRRPv3. base system. If the protocol version is not specified, the default is VRRPv3.

9
doc/user/vtysh.rst
View File

@ -22,7 +22,6 @@ administrator with an external editor.
have effect for vtysh) need to be manually updated in :file:`vtysh.conf`. have effect for vtysh) need to be manually updated in :file:`vtysh.conf`.
.. index:: copy FILENAME running-config
.. clicmd:: copy FILENAME running-config .. clicmd:: copy FILENAME running-config
Process and load a configuration file manually; each line in the Process and load a configuration file manually; each line in the
@ -52,8 +51,7 @@ and the :clicmd:`terminal paginate` command:
This variable should be set by the user according to their preferences, This variable should be set by the user according to their preferences,
in their :file:`~/.profile` file. in their :file:`~/.profile` file.
.. index:: terminal paginate .. clicmd:: terminal paginate
.. clicmd:: [no] terminal paginate
Enables/disables vtysh output pagination. This command is intended to Enables/disables vtysh output pagination. This command is intended to
be placed in :file:`vtysh.conf` to set a system-wide default. If this be placed in :file:`vtysh.conf` to set a system-wide default. If this
@ -100,7 +98,6 @@ could be made SGID (set group ID) to the |INSTALL_VTY_GROUP| group.
No security guarantees are made for this configuration. No security guarantees are made for this configuration.
.. index:: username USERNAME nopassword
.. clicmd:: username USERNAME nopassword .. clicmd:: username USERNAME nopassword
If PAM support is enabled at build-time, this command allows disabling the If PAM support is enabled at build-time, this command allows disabling the
@ -162,11 +159,8 @@ it can lead to /all/ of your daemons being unable to start up. Per daemon files
are more robust as impact of errors in configuration are limited to the daemon are more robust as impact of errors in configuration are limited to the daemon
in whose file the error is made. in whose file the error is made.
.. index:: service integrated-vtysh-config
.. clicmd:: service integrated-vtysh-config .. clicmd:: service integrated-vtysh-config
.. index:: service integrated-vtysh-config
.. clicmd:: no service integrated-vtysh-config
Control whether integrated :file:`frr.conf` file is written when Control whether integrated :file:`frr.conf` file is written when
'write file' is issued. 'write file' is issued.
@ -195,7 +189,6 @@ in whose file the error is made.
preset one of the two operating modes and ensure consistent operation across preset one of the two operating modes and ensure consistent operation across
installations. installations.
.. index:: write integrated
.. clicmd:: write integrated .. clicmd:: write integrated
Unconditionally (regardless of ``service integrated-vtysh-config`` setting) Unconditionally (regardless of ``service integrated-vtysh-config`` setting)

4
doc/user/watchfrr.rst
View File

@ -16,14 +16,12 @@ require end users management.
WATCHFRR commands WATCHFRR commands
================= =================
.. index:: show watchfrr
.. clicmd:: show watchfrr .. clicmd:: show watchfrr
Give status information about the state of the different daemons being Give status information about the state of the different daemons being
watched by WATCHFRR watched by WATCHFRR
.. index:: watchfrr ignore DAEMON .. clicmd:: watchfrr ignore DAEMON
.. clicmd:: [no] watchfrr ignore DAEMON
Tell WATCHFRR to ignore a particular DAEMON if it goes unresponsive. Tell WATCHFRR to ignore a particular DAEMON if it goes unresponsive.
This is particularly useful when you are a developer and need to debug This is particularly useful when you are a developer and need to debug

1
doc/user/wecmp_linkbw.rst
View File

@ -173,7 +173,6 @@ ECMP as recommended in [Draft-IETF-idr-link-bandwidth]_.
The operator can change these behaviors with the following configuration: The operator can change these behaviors with the following configuration:
.. index:: bgp bestpath bandwidth <ignore | skip-missing | default-weight-for-missing>
.. clicmd:: bgp bestpath bandwidth <ignore | skip-missing | default-weight-for-missing> .. clicmd:: bgp bestpath bandwidth <ignore | skip-missing | default-weight-for-missing>
The different options imply behavior as follows: The different options imply behavior as follows:

134
doc/user/zebra.rst
View File

@ -115,44 +115,30 @@ Interface Commands
Standard Commands Standard Commands
----------------- -----------------
.. index:: interface IFNAME
.. clicmd:: interface IFNAME .. clicmd:: interface IFNAME
.. index:: interface IFNAME vrf VRF
.. clicmd:: interface IFNAME vrf VRF .. clicmd:: interface IFNAME vrf VRF
.. index:: shutdown
.. clicmd:: shutdown .. clicmd:: shutdown
.. index:: shutdown
.. clicmd:: no shutdown
Up or down the current interface. Up or down the current interface.
.. index:: ip address ADDRESS/PREFIX
.. clicmd:: ip address ADDRESS/PREFIX .. clicmd:: ip address ADDRESS/PREFIX
.. index:: ipv6 address ADDRESS/PREFIX
.. clicmd:: ipv6 address ADDRESS/PREFIX .. clicmd:: ipv6 address ADDRESS/PREFIX
.. index:: ip address ADDRESS/PREFIX
.. clicmd:: no ip address ADDRESS/PREFIX
.. index:: ipv6 address ADDRESS/PREFIX
.. clicmd:: no ipv6 address ADDRESS/PREFIX
Set the IPv4 or IPv6 address/prefix for the interface. Set the IPv4 or IPv6 address/prefix for the interface.
.. index:: ip address LOCAL-ADDR peer PEER-ADDR/PREFIX
.. clicmd:: ip address LOCAL-ADDR peer PEER-ADDR/PREFIX .. clicmd:: ip address LOCAL-ADDR peer PEER-ADDR/PREFIX
.. index:: ip address LOCAL-ADDR peer PEER-ADDR/PREFIX
.. clicmd:: no ip address LOCAL-ADDR peer PEER-ADDR/PREFIX
Configure an IPv4 Point-to-Point address on the interface. (The concept of Configure an IPv4 Point-to-Point address on the interface. (The concept of
PtP addressing does not exist for IPv6.) PtP addressing does not exist for IPv6.)
@ -162,38 +148,28 @@ Standard Commands
behind the other end of the link (or even on the link in Point-to-Multipoint behind the other end of the link (or even on the link in Point-to-Multipoint
setups), though generally /32s are used. setups), though generally /32s are used.
.. index:: description DESCRIPTION ...
.. clicmd:: description DESCRIPTION ... .. clicmd:: description DESCRIPTION ...
Set description for the interface. Set description for the interface.
.. index:: multicast
.. clicmd:: multicast .. clicmd:: multicast
.. index:: multicast
.. clicmd:: no multicast
Enable or disables multicast flag for the interface. Enable or disables multicast flag for the interface.
.. index:: bandwidth (1-10000000)
.. clicmd:: bandwidth (1-10000000) .. clicmd:: bandwidth (1-10000000)
.. index:: bandwidth (1-10000000)
.. clicmd:: no bandwidth (1-10000000)
Set bandwidth value of the interface in kilobits/sec. This is for Set bandwidth value of the interface in kilobits/sec. This is for
calculating OSPF cost. This command does not affect the actual device calculating OSPF cost. This command does not affect the actual device
configuration. configuration.
.. index:: link-detect
.. clicmd:: link-detect .. clicmd:: link-detect
.. index:: link-detect
.. clicmd:: no link-detect
Enable/disable link-detect on platforms which support this. Currently only Enable/disable link-detect on platforms which support this. Currently only
Linux, and only where network interface drivers support reporting Linux, and only where network interface drivers support reporting
@ -212,11 +188,8 @@ Link Parameters Commands
protocol extensions that can be used with MPLS-TE. FRR does not protocol extensions that can be used with MPLS-TE. FRR does not
support a complete RSVP-TE solution currently. support a complete RSVP-TE solution currently.
.. index:: link-params
.. clicmd:: link-params .. clicmd:: link-params
.. index:: link-param
.. clicmd:: no link-param
Enter into the link parameters sub node. At least 'enable' must be Enter into the link parameters sub node. At least 'enable' must be
set to activate the link parameters, and consequently routing set to activate the link parameters, and consequently routing
@ -228,24 +201,18 @@ Link Parameters Commands
Under link parameter statement, the following commands set the different TE values: Under link parameter statement, the following commands set the different TE values:
.. index:: link-params [enable]
.. clicmd:: link-params [enable] .. clicmd:: link-params [enable]
Enable link parameters for this interface. Enable link parameters for this interface.
.. index:: link-params [metric (0-4294967295)]
.. clicmd:: link-params [metric (0-4294967295)] .. clicmd:: link-params [metric (0-4294967295)]
.. index:: link-params max-bw BANDWIDTH
.. clicmd:: link-params max-bw BANDWIDTH .. clicmd:: link-params max-bw BANDWIDTH
.. index:: link-params max-rsv-bw BANDWIDTH
.. clicmd:: link-params max-rsv-bw BANDWIDTH .. clicmd:: link-params max-rsv-bw BANDWIDTH
.. index:: link-params unrsv-bw (0-7) BANDWIDTH
.. clicmd:: link-params unrsv-bw (0-7) BANDWIDTH .. clicmd:: link-params unrsv-bw (0-7) BANDWIDTH
.. index:: link-params admin-grp BANDWIDTH
.. clicmd:: link-params admin-grp BANDWIDTH .. clicmd:: link-params admin-grp BANDWIDTH
These commands specifies the Traffic Engineering parameters of the interface These commands specifies the Traffic Engineering parameters of the interface
@ -258,22 +225,16 @@ Link Parameters Commands
Note that BANDIWDTH is specified in IEEE floating point format and express Note that BANDIWDTH is specified in IEEE floating point format and express
in Bytes/second. in Bytes/second.
.. index:: link-param delay (0-16777215) [min (0-16777215) | max (0-16777215)]
.. clicmd:: link-param delay (0-16777215) [min (0-16777215) | max (0-16777215)] .. clicmd:: link-param delay (0-16777215) [min (0-16777215) | max (0-16777215)]
.. index:: link-param delay-variation (0-16777215)
.. clicmd:: link-param delay-variation (0-16777215) .. clicmd:: link-param delay-variation (0-16777215)
.. index:: link-param packet-loss PERCENTAGE
.. clicmd:: link-param packet-loss PERCENTAGE .. clicmd:: link-param packet-loss PERCENTAGE
.. index:: link-param res-bw BANDWIDTH
.. clicmd:: link-param res-bw BANDWIDTH .. clicmd:: link-param res-bw BANDWIDTH
.. index:: link-param ava-bw BANDWIDTH
.. clicmd:: link-param ava-bw BANDWIDTH .. clicmd:: link-param ava-bw BANDWIDTH
.. index:: link-param use-bw BANDWIDTH
.. clicmd:: link-param use-bw BANDWIDTH .. clicmd:: link-param use-bw BANDWIDTH
These command specifies additional Traffic Engineering parameters of the These command specifies additional Traffic Engineering parameters of the
@ -287,17 +248,14 @@ Link Parameters Commands
(µs). Loss is specified in PERCENTAGE ranging from 0 to 50.331642% by step (µs). Loss is specified in PERCENTAGE ranging from 0 to 50.331642% by step
of 0.000003. of 0.000003.
.. index:: link-param neighbor <A.B.C.D> as (0-65535)
.. clicmd:: link-param neighbor <A.B.C.D> as (0-65535) .. clicmd:: link-param neighbor <A.B.C.D> as (0-65535)
.. index:: link-param no neighbor
.. clicmd:: link-param no neighbor .. clicmd:: link-param no neighbor
Specifies the remote ASBR IP address and Autonomous System (AS) number Specifies the remote ASBR IP address and Autonomous System (AS) number
for InterASv2 link in OSPF (RFC5392). Note that this option is not yet for InterASv2 link in OSPF (RFC5392). Note that this option is not yet
supported for ISIS (RFC5316). supported for ISIS (RFC5316).
.. index:: ip nht resolve-via-default
.. clicmd:: ip nht resolve-via-default .. clicmd:: ip nht resolve-via-default
Allows nexthop tracking to resolve via the default route. This is useful Allows nexthop tracking to resolve via the default route. This is useful
@ -427,7 +385,6 @@ see https://www.kernel.org/doc/Documentation/networking/vrf.txt.
Because of that difference, there are some subtle differences when running some Because of that difference, there are some subtle differences when running some
commands in relationship to VRF. Here is an extract of some of those commands: commands in relationship to VRF. Here is an extract of some of those commands:
.. index:: vrf VRF
.. clicmd:: vrf VRF .. clicmd:: vrf VRF
This command is available on configuration mode. By default, above command This command is available on configuration mode. By default, above command
@ -436,7 +393,6 @@ commands in relationship to VRF. Here is an extract of some of those commands:
The network administrator can however decide to provision this command in The network administrator can however decide to provision this command in
configuration file to provide more clarity about the intended configuration. configuration file to provide more clarity about the intended configuration.
.. index:: netns NAMESPACE
.. clicmd:: netns NAMESPACE .. clicmd:: netns NAMESPACE
This command is based on VRF configuration mode. This command is available This command is based on VRF configuration mode. This command is available
@ -447,7 +403,6 @@ commands in relationship to VRF. Here is an extract of some of those commands:
decide to provision this command in configuration file to provide more clarity decide to provision this command in configuration file to provide more clarity
about the intended configuration. about the intended configuration.
.. index:: show ip route vrf VRF
.. clicmd:: show ip route vrf VRF .. clicmd:: show ip route vrf VRF
The show command permits dumping the routing table associated to the VRF. If The show command permits dumping the routing table associated to the VRF. If
@ -457,20 +412,17 @@ commands in relationship to VRF. Here is an extract of some of those commands:
launched with :option:`-n` option, this will be the default routing table of launched with :option:`-n` option, this will be the default routing table of
the *Linux network namespace* ``VRF``. the *Linux network namespace* ``VRF``.
.. index:: show ip route vrf VRF table TABLENO
.. clicmd:: show ip route vrf VRF table TABLENO .. clicmd:: show ip route vrf VRF table TABLENO
The show command is only available with :option:`-n` option. This command The show command is only available with :option:`-n` option. This command
will dump the routing table ``TABLENO`` of the *Linux network namespace* will dump the routing table ``TABLENO`` of the *Linux network namespace*
``VRF``. ``VRF``.
.. index:: show ip route vrf VRF tables
.. clicmd:: show ip route vrf VRF tables .. clicmd:: show ip route vrf VRF tables
This command will dump the routing tables within the vrf scope. If `vrf all` This command will dump the routing tables within the vrf scope. If `vrf all`
is executed, all routing tables will be dumped. is executed, all routing tables will be dumped.
.. index:: show <ip|ipv6> route summary [vrf VRF] [table TABLENO] [prefix]
.. clicmd:: show <ip|ipv6> route summary [vrf VRF] [table TABLENO] [prefix] .. clicmd:: show <ip|ipv6> route summary [vrf VRF] [table TABLENO] [prefix]
This command will dump a summary output of the specified VRF and TABLENO This command will dump a summary output of the specified VRF and TABLENO
@ -537,8 +489,7 @@ The push action is generally used for LER devices, which want to encapsulate
all traffic for a wished destination into an MPLS label. This action is stored all traffic for a wished destination into an MPLS label. This action is stored
in routing entry, and can be configured like a route: in routing entry, and can be configured like a route:
.. index:: ip route NETWORK MASK GATEWAY|INTERFACE label LABEL .. clicmd:: ip route NETWORK MASK GATEWAY|INTERFACE label LABEL
.. clicmd:: [no] ip route NETWORK MASK GATEWAY|INTERFACE label LABEL
NETWORK and MASK stand for the IP prefix entry to be added as static NETWORK and MASK stand for the IP prefix entry to be added as static
route entry. route entry.
@ -568,8 +519,7 @@ The swap action is generally used for LSR devices, which swap a packet with a
label, with an other label. The Pop action is used on LER devices, at the label, with an other label. The Pop action is used on LER devices, at the
termination of the MPLS traffic; this is used to remove MPLS header. termination of the MPLS traffic; this is used to remove MPLS header.
.. index:: mpls lsp INCOMING_LABEL GATEWAY OUTGOING_LABEL|explicit-null|implicit-null .. clicmd:: mpls lsp INCOMING_LABEL GATEWAY OUTGOING_LABEL|explicit-null|implicit-null
.. clicmd:: [no] mpls lsp INCOMING_LABEL GATEWAY OUTGOING_LABEL|explicit-null|implicit-null
INCOMING_LABEL and OUTGOING_LABEL are MPLS labels with values ranging from 16 INCOMING_LABEL and OUTGOING_LABEL are MPLS labels with values ranging from 16
to 1048575. to 1048575.
@ -582,7 +532,6 @@ termination of the MPLS traffic; this is used to remove MPLS header.
You can check that the MPLS actions are stored in the zebra MPLS table, by looking at the You can check that the MPLS actions are stored in the zebra MPLS table, by looking at the
presence of the entry. presence of the entry.
.. index:: show mpls table
.. clicmd:: show mpls table .. clicmd:: show mpls table
:: ::
@ -616,11 +565,8 @@ WARNING: RPF lookup results are non-responsive in this version of FRR,
i.e. multicast routing does not actively react to changes in underlying i.e. multicast routing does not actively react to changes in underlying
unicast topology! unicast topology!
.. index:: ip multicast rpf-lookup-mode MODE
.. clicmd:: ip multicast rpf-lookup-mode MODE .. clicmd:: ip multicast rpf-lookup-mode MODE
.. index:: ip multicast rpf-lookup-mode [MODE]
.. clicmd:: no ip multicast rpf-lookup-mode [MODE]
MODE sets the method used to perform RPF lookups. Supported modes: MODE sets the method used to perform RPF lookups. Supported modes:
@ -650,10 +596,10 @@ unicast topology!
what the default behavior is. what the default behavior is.
.. warning:: .. warning::
Unreachable routes do not receive special treatment and do not cause Unreachable routes do not receive special treatment and do not cause
fallback to a second lookup. fallback to a second lookup.
.. index:: show ip rpf ADDR
.. clicmd:: show ip rpf ADDR .. clicmd:: show ip rpf ADDR
Performs a Multicast RPF lookup, as configured with ``ip multicast Performs a Multicast RPF lookup, as configured with ``ip multicast
@ -672,18 +618,14 @@ unicast topology!
Indicates that a multicast source lookup for 192.0.2.1 would use an Indicates that a multicast source lookup for 192.0.2.1 would use an
Unicast RIB entry for 192.0.2.0/24 with a gateway of 198.51.100.1. Unicast RIB entry for 192.0.2.0/24 with a gateway of 198.51.100.1.
.. index:: show ip rpf
.. clicmd:: show ip rpf .. clicmd:: show ip rpf
Prints the entire Multicast RIB. Note that this is independent of the Prints the entire Multicast RIB. Note that this is independent of the
configured RPF lookup mode, the Multicast RIB may be printed yet not configured RPF lookup mode, the Multicast RIB may be printed yet not
used at all. used at all.
.. index:: ip mroute PREFIX NEXTHOP [DISTANCE]
.. clicmd:: ip mroute PREFIX NEXTHOP [DISTANCE] .. clicmd:: ip mroute PREFIX NEXTHOP [DISTANCE]
.. index:: ip mroute PREFIX NEXTHOP [DISTANCE]
.. clicmd:: no ip mroute PREFIX NEXTHOP [DISTANCE]
Adds a static route entry to the Multicast RIB. This performs exactly as the Adds a static route entry to the Multicast RIB. This performs exactly as the
``ip route`` command, except that it inserts the route in the Multicast RIB ``ip route`` command, except that it inserts the route in the Multicast RIB
@ -699,7 +641,6 @@ 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 these commands can be used to filter which routes zebra will install in the
kernel. kernel.
.. index:: ip protocol PROTOCOL route-map ROUTEMAP
.. clicmd:: ip protocol PROTOCOL route-map ROUTEMAP .. clicmd:: ip protocol PROTOCOL route-map ROUTEMAP
Apply a route-map filter to routes for the specified protocol. PROTOCOL can Apply a route-map filter to routes for the specified protocol. PROTOCOL can
@ -728,7 +669,6 @@ kernel.
on a per vrf basis, by entering this command under vrf mode for the vrf you on a per vrf basis, by entering this command under vrf mode for the vrf you
want to apply the route-map against. want to apply the route-map against.
.. index:: set src ADDRESS
.. clicmd:: set src ADDRESS .. clicmd:: set src ADDRESS
Within a route-map, set the preferred source address for matching routes Within a route-map, set the preferred source address for matching routes
@ -767,8 +707,7 @@ IPv6 example for OSPFv3.
not created at startup. On Debian, FRR might start before ifupdown not created at startup. On Debian, FRR might start before ifupdown
completes. Consider a reboot test. completes. Consider a reboot test.
.. index:: zebra route-map delay-timer (0-600) .. clicmd:: zebra route-map delay-timer (0-600)
.. clicmd:: [no] zebra route-map delay-timer (0-600)
Set the delay before any route-maps are processed in zebra. The Set the delay before any route-maps are processed in zebra. The
default time for this is 5 seconds. default time for this is 5 seconds.
@ -842,21 +781,11 @@ FPM Commands
``fpm`` implementation ``fpm`` implementation
---------------------- ----------------------
.. index:: fpm connection ip A.B.C.D port (1-65535)
.. clicmd:: fpm connection ip A.B.C.D port (1-65535) .. clicmd:: fpm connection ip A.B.C.D port (1-65535)
Configure ``zebra`` to connect to a different FPM server than Configure ``zebra`` to connect to a different FPM server than the default of
``127.0.0.1`` port ``2620``. ``127.0.0.1:2060``
.. index:: fpm connection ip A.B.C.D port (1-65535)
.. clicmd:: no fpm connection ip A.B.C.D port (1-65535)
Configure ``zebra`` to connect to the default FPM server at ``127.0.0.1``
port ``2620``.
.. index:: show zebra fpm stats
.. clicmd:: show zebra fpm stats .. clicmd:: show zebra fpm stats
Shows the FPM statistics. Shows the FPM statistics.
@ -892,7 +821,6 @@ FPM Commands
t_conn_up_finishes 1 0 t_conn_up_finishes 1 0
.. index:: clear zebra fpm stats
.. clicmd:: clear zebra fpm stats .. clicmd:: clear zebra fpm stats
Reset statistics related to the zebra code that interacts with the Reset statistics related to the zebra code that interacts with the
@ -902,35 +830,22 @@ FPM Commands
``dplane_fpm_nl`` implementation ``dplane_fpm_nl`` implementation
-------------------------------- --------------------------------
.. index:: fpm address <A.B.C.D|X:X::X:X> [port (1-65535)]
.. clicmd:: fpm address <A.B.C.D|X:X::X:X> [port (1-65535)] .. clicmd:: fpm address <A.B.C.D|X:X::X:X> [port (1-65535)]
Configures the FPM server address. Once configured ``zebra`` will attempt Configures the FPM server address. Once configured ``zebra`` will attempt
to connect to it immediately. to connect to it immediately.
The ``no`` form disables FPM entirely. ``zebra`` will close any current
connections and will not attempt to connect to it anymore.
.. index:: fpm address [<A.B.C.D|X:X::X:X> [port (1-65535)]]
.. clicmd:: no fpm address [<A.B.C.D|X:X::X:X> [port (1-65535)]]
Disables FPM entirely. ``zebra`` will close any current connections and
will not attempt to connect to it anymore.
.. index:: fpm use-next-hop-groups
.. clicmd:: fpm use-next-hop-groups .. clicmd:: fpm use-next-hop-groups
Use the new netlink messages ``RTM_NEWNEXTHOP`` / ``RTM_DELNEXTHOP`` to Use the new netlink messages ``RTM_NEWNEXTHOP`` / ``RTM_DELNEXTHOP`` to
group repeated route next hop information. group repeated route next hop information.
The ``no`` form uses the old known FPM behavior of including next hop
information in the route (e.g. ``RTM_NEWROUTE``) messages.
.. index:: fpm use-next-hop-groups
.. clicmd:: no fpm use-next-hop-groups
Use the old known FPM behavior of including next hop information in the
route (e.g. ``RTM_NEWROUTE``) messages.
.. index:: show fpm counters [json]
.. clicmd:: show fpm counters [json] .. clicmd:: show fpm counters [json]
Show the FPM statistics (plain text or JSON formatted). Show the FPM statistics (plain text or JSON formatted).
@ -955,7 +870,6 @@ FPM Commands
User FPM disable requests: 0 User FPM disable requests: 0
.. index:: clear fpm counters
.. clicmd:: clear fpm counters .. clicmd:: clear fpm counters
Reset statistics related to the zebra code that interacts with the Reset statistics related to the zebra code that interacts with the
@ -974,14 +888,12 @@ interface IP addresses. The dataplane runs in its own pthread, in
order to off-load work from the main zebra pthread. order to off-load work from the main zebra pthread.
.. index:: show zebra dplane [detailed]
.. clicmd:: show zebra dplane [detailed] .. clicmd:: show zebra dplane [detailed]
Display statistics about the updates and events passing through the Display statistics about the updates and events passing through the
dataplane subsystem. dataplane subsystem.
.. index:: show zebra dplane providers
.. clicmd:: show zebra dplane providers .. clicmd:: show zebra dplane providers
Display information about the running dataplane plugins that are Display information about the running dataplane plugins that are
@ -989,7 +901,6 @@ order to off-load work from the main zebra pthread.
present. present.
.. index:: zebra dplane limit [NUMBER]
.. clicmd:: zebra dplane limit [NUMBER] .. clicmd:: zebra dplane limit [NUMBER]
Configure the limit on the number of pending updates that are Configure the limit on the number of pending updates that are
@ -999,7 +910,6 @@ order to off-load work from the main zebra pthread.
zebra Terminal Mode Commands zebra Terminal Mode Commands
============================ ============================
.. index:: show ip route
.. clicmd:: show ip route .. clicmd:: show ip route
Display current routes which zebra holds in its database. Display current routes which zebra holds in its database.
@ -1016,19 +926,15 @@ zebra Terminal Mode Commands
C* 203.181.89.240/28 eth0 C* 203.181.89.240/28 eth0
.. index:: show ipv6 route
.. clicmd:: show ipv6 route .. clicmd:: show ipv6 route
.. index:: show [ip|ipv6] route [PREFIX] [nexthop-group]
.. clicmd:: show [ip|ipv6] route [PREFIX] [nexthop-group] .. clicmd:: show [ip|ipv6] route [PREFIX] [nexthop-group]
Display detailed information about a route. If [nexthop-group] is Display detailed information about a route. If [nexthop-group] is
included, it will display the nexthop group ID the route is using as well. included, it will display the nexthop group ID the route is using as well.
.. index:: show interface [NAME] [{vrf VRF|brief}] [nexthop-group]
.. clicmd:: show interface [NAME] [{vrf VRF|brief}] [nexthop-group] .. clicmd:: show interface [NAME] [{vrf VRF|brief}] [nexthop-group]
.. index:: show interface [NAME] [{vrf all|brief}] [nexthop-group]
.. clicmd:: show interface [NAME] [{vrf all|brief}] [nexthop-group] .. clicmd:: show interface [NAME] [{vrf all|brief}] [nexthop-group]
Display interface information. If no extra information is added, it will Display interface information. If no extra information is added, it will
@ -1036,34 +942,27 @@ zebra Terminal Mode Commands
detailed information about that single interface. If [nexthop-group] is detailed information about that single interface. If [nexthop-group] is
specified, it will display nexthop groups pointing out that interface. specified, it will display nexthop groups pointing out that interface.
.. index:: show ip prefix-list [NAME]
.. clicmd:: show ip prefix-list [NAME] .. clicmd:: show ip prefix-list [NAME]
.. index:: show route-map [NAME]
.. clicmd:: show route-map [NAME] .. clicmd:: show route-map [NAME]
.. index:: show ip protocol
.. clicmd:: show ip protocol .. clicmd:: show ip protocol
.. index:: show ip forward
.. clicmd:: show ip forward .. clicmd:: show ip forward
Display whether the host's IP forwarding function is enabled or not. Display whether the host's IP forwarding function is enabled or not.
Almost any UNIX kernel can be configured with IP forwarding disabled. Almost any UNIX kernel can be configured with IP forwarding disabled.
If so, the box can't work as a router. If so, the box can't work as a router.
.. index:: show ipv6 forward
.. clicmd:: show ipv6 forward .. clicmd:: show ipv6 forward
Display whether the host's IP v6 forwarding is enabled or not. Display whether the host's IP v6 forwarding is enabled or not.
.. index:: show zebra
.. clicmd:: show zebra .. clicmd:: show zebra
Display various statistics related to the installation and deletion Display various statistics related to the installation and deletion
of routes, neighbor updates, and LSP's into the kernel. of routes, neighbor updates, and LSP's into the kernel.
.. index:: show zebra client [summary]
.. clicmd:: show zebra client [summary] .. clicmd:: show zebra client [summary]
Display statistics about clients that are connected to zebra. This is Display statistics about clients that are connected to zebra. This is
@ -1071,7 +970,6 @@ zebra Terminal Mode Commands
zebra and it's clients. If the summary form of the command is choosen zebra and it's clients. If the summary form of the command is choosen
a table is displayed with shortened information. a table is displayed with shortened information.
.. index:: show zebra router table summary
.. clicmd:: show zebra router table summary .. clicmd:: show zebra router table summary
Display summarized data about tables created, their afi/safi/tableid Display summarized data about tables created, their afi/safi/tableid
@ -1079,7 +977,6 @@ zebra Terminal Mode Commands
total number of route nodes in the table. Which will be higher than total number of route nodes in the table. Which will be higher than
the actual number of routes that are held. the actual number of routes that are held.
.. index:: show nexthop-group rib [ID] [vrf NAME] [singleton [ip|ip6]] [type]
.. clicmd:: show nexthop-group rib [ID] [vrf NAME] [singleton [ip|ip6]] [type] .. clicmd:: show nexthop-group rib [ID] [vrf NAME] [singleton [ip|ip6]] [type]
Display nexthop groups created by zebra. The [vrf NAME] option Display nexthop groups created by zebra. The [vrf NAME] option
@ -1097,34 +994,29 @@ Many routing protocols require a router-id to be configured. To have a
consistent router-id across all daemons, the following commands are available consistent router-id across all daemons, the following commands are available
to configure and display the router-id: to configure and display the router-id:
.. index:: router-id A.B.C.D .. clicmd:: [ip] router-id A.B.C.D
.. clicmd:: [no] [ip] router-id A.B.C.D
Allow entering of the router-id. This command also works under the Allow entering of the router-id. This command also works under the
vrf subnode, to allow router-id's per vrf. vrf subnode, to allow router-id's per vrf.
.. index:: router-id A.B.C.D vrf NAME .. clicmd:: [ip] router-id A.B.C.D vrf NAME
.. clicmd:: [no] [ip] router-id A.B.C.D vrf NAME
Configure the router-id of this router from the configure NODE. Configure the router-id of this router from the configure NODE.
A show run of this command will display the router-id command A show run of this command will display the router-id command
under the vrf sub node. This command is deprecated and will under the vrf sub node. This command is deprecated and will
be removed at some point in time in the future. be removed at some point in time in the future.
.. index:: show [ip] router-id [vrf NAME]
.. clicmd:: show [ip] router-id [vrf NAME] .. clicmd:: show [ip] router-id [vrf NAME]
Display the user configured router-id. Display the user configured router-id.
For protocols requiring an IPv6 router-id, the following commands are available: For protocols requiring an IPv6 router-id, the following commands are available:
.. index:: ipv6 router-id X:X::X:X .. clicmd:: ipv6 router-id X:X::X:X
.. clicmd:: [no] ipv6 router-id X:X::X:X
Configure the IPv6 router-id of this router. Like its IPv4 counterpart, Configure the IPv6 router-id of this router. Like its IPv4 counterpart,
this command works under the vrf subnode, to allow router-id's per vrf. this command works under the vrf subnode, to allow router-id's per vrf.
.. index:: show ipv6 router-id [vrf NAME]
.. clicmd:: show ipv6 router-id [vrf NAME] .. clicmd:: show ipv6 router-id [vrf NAME]
Display the user configured IPv6 router-id. Display the user configured IPv6 router-id.