proxmox-mirrors/mirror_frr
1
0
Fork 0
mirror of https://git.proxmox.com/git/mirror_frr synced 2025-04-28 15:36:25 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

doc: remove 'no' form of commands

Browse Source 
These don't need to be documented, most of the time they are obvious,
when they aren't the behavior can just be described in the command
description.

Signed-off-by: Quentin Young <qlyoung@nvidia.com>
This commit is contained in:
Quentin Young 2021-02-19 17:32:07 -05:00
parent 8ed09fbf5a
commit 03750f1eb6
27 changed files with 262 additions and 718 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
doc/user/babeld.rst
View File

@ -34,16 +34,16 @@ Configuration of *babeld* is done in its configuration file
Babel configuration
===================
.. clicmd:: [no] router babel
.. clicmd:: router babel
Enable or disable Babel routing.
.. clicmd:: [no] babel resend-delay (20-655340)
.. clicmd:: babel resend-delay (20-655340)
Specifies the time after which important messages are resent when
avoiding a black-hole. The default is 2000 ms.
.. clicmd:: [no] babel diversity
.. clicmd:: babel diversity
Enable or disable routing using radio frequency diversity. This is
highly recommended in networks with many wireless nodes.
@ -59,7 +59,7 @@ Babel configuration
no role in route selection; you will probably want to set that to 128
or less on nodes with multiple independent radios.
.. clicmd:: [no] network IFNAME
.. clicmd:: network IFNAME
Enable or disable Babel on the given interface.
@ -71,7 +71,7 @@ Babel configuration
Specifying `wireless` (the default) is always correct, but may
cause slower convergence and extra routing traffic.
.. clicmd:: [no] babel split-horizon
.. clicmd:: babel split-horizon
Specifies whether to perform split-horizon on the interface. Specifying
``no babel split-horizon`` is always correct, while ``babel
@ -153,7 +153,7 @@ Babel configuration
effectively disables the use of a RTT-based cost.
.. clicmd:: [no] babel enable-timestamps
.. clicmd:: babel enable-timestamps
Enable or disable sending timestamps with each Hello and IHU message in
order to compute RTT values. The default is `no babel enable-timestamps`.
@ -179,7 +179,7 @@ Babel redistribution
====================
.. clicmd:: [no] redistribute <ipv4|ipv6> KIND
.. clicmd:: redistribute <ipv4|ipv6> KIND
Specify which kind of routes should be redistributed into Babel.
@ -223,7 +223,7 @@ Babel debugging commands
simple: 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
be one of:

34
doc/user/basic.rst
View File

@ -60,17 +60,17 @@ Basic Config Commands
Set hostname of the router.
.. clicmd:: [no] password PASSWORD
.. clicmd:: password PASSWORD
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.
.. clicmd:: [no] enable password PASSWORD
.. clicmd:: enable password PASSWORD
Set enable password. The ``no`` form of the command deletes the enable
password.
.. clicmd:: [no] log trap LEVEL
.. clicmd:: log trap LEVEL
These commands are deprecated and are present only for historical
compatibility. The log trap command sets the current logging level for all
@ -81,7 +81,7 @@ Basic Config Commands
level of existing logging destinations.
.. clicmd:: [no] log stdout LEVEL
.. clicmd:: log stdout LEVEL
Enable logging output to stdout. If the optional second argument specifying
the logging level is not present, the default logging level (typically
@ -100,7 +100,7 @@ Basic Config Commands
terminal output. Use a log file and ``tail -f`` if this rare chance is
inacceptable to your setup.
.. clicmd:: [no] log file [FILENAME [LEVEL]]
.. clicmd:: log file [FILENAME [LEVEL]]
If you want to log into a file, please specify ``filename`` as
in this example:
@ -114,14 +114,14 @@ Basic Config Commands
deprecated ``log trap`` command) will be used. The ``no`` form of the command
disables logging to a file.
.. clicmd:: [no] log syslog [LEVEL]
.. clicmd:: log syslog [LEVEL]
Enable logging output to syslog. If the optional second argument specifying
the logging level is not present, the default logging level (typically
debugging, but can be changed using the deprecated ``log trap`` command) will
be used. The ``no`` form of the command disables logging to syslog.
.. clicmd:: [no] log monitor [LEVEL]
.. clicmd:: log monitor [LEVEL]
Enable logging output to vty terminals that have enabled logging using the
``terminal monitor`` command. By default, monitor logging is enabled at the
@ -131,13 +131,13 @@ Basic Config Commands
level (typically debugging) will be used. The ``no`` form of the command
disables logging to terminal monitors.
.. clicmd:: [no] log facility [FACILITY]
.. clicmd:: log facility [FACILITY]
This command changes the facility used in syslog messages. The default
facility is ``daemon``. The ``no`` form of the command resets the facility
to the default ``daemon`` facility.
.. clicmd:: [no] log record-priority
.. clicmd:: log record-priority
To include the severity in all messages logged to a file, to stdout, or to
a terminal monitor (i.e. anything except syslog),
@ -147,7 +147,7 @@ Basic Config Commands
versions of syslogd can be configured to include the facility and
level in the messages emitted.
.. clicmd:: [no] log timestamp precision [(0-6)]
.. clicmd:: log timestamp precision [(0-6)]
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
@ -162,7 +162,7 @@ Basic Config Commands
In this example, the precision is set to provide timestamps with
millisecond accuracy.
.. clicmd:: [no] log commands
.. clicmd:: log commands
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,
@ -170,7 +170,7 @@ Basic Config Commands
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.
.. clicmd:: [no] log-filter WORD [DAEMON]
.. clicmd:: log-filter WORD [DAEMON]
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
@ -218,10 +218,6 @@ Basic Config Commands
Set motd string from an input.
.. clicmd:: no banner motd
No motd banner string will be printed.
.. clicmd:: exec-timeout MINUTE [SECOND]
Set VTY connection timeout value. When only one argument is specified
@ -229,10 +225,8 @@ Basic Config Commands
used for timeout value in seconds. Default timeout value is 10 minutes.
When timeout value is zero, it means no timeout.
.. clicmd:: no exec-timeout
Do not perform timeout at all. This command is as same as
``exec-timeout 0 0``.
Not setting this, or setting the values to 0 0, means a timeout will not be
enabled.
.. clicmd:: access-class ACCESS-LIST

60
doc/user/bfd.rst
View File

@ -111,20 +111,13 @@ BFDd Commands
`vrf` selects which domain we want to use.
.. 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.
.. clicmd:: profile WORD
Creates a peer profile that can be configured in multiple peers.
.. clicmd:: no profile WORD
Deletes a peer profile. Any peer using the profile will have their
configurations reset to the default values.
Deleting the profile will cause all peers using it to reset to the default
values.
.. clicmd:: show bfd [vrf NAME] peers [json]
@ -178,7 +171,7 @@ BFD peers and profiles share the same BFD session configuration commands.
Configures the minimal echo receive transmission interval that this
system is capable of handling.
.. clicmd:: [no] echo-mode
.. clicmd:: echo-mode
Enables or disables the echo transmission mode. This mode is disabled
by default.
@ -190,13 +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`
section 3).
.. clicmd:: [no] shutdown
.. clicmd:: shutdown
Enables or disables the peer. When the peer is disabled an
'administrative down' message is sent to the remote peer.
.. clicmd:: [no] passive-mode
.. clicmd:: passive-mode
Mark session as passive: a passive session will not attempt to start
the connection and will wait for control packets from peer before it
@ -208,7 +201,7 @@ BFD peers and profiles share the same BFD session configuration commands.
The default is active-mode (or ``no passive-mode``).
.. clicmd:: [no] minimum-ttl (1-254)
.. clicmd:: minimum-ttl (1-254)
For multi hop sessions only: configure the minimum expected TTL for
an incoming BFD control packet.
@ -258,9 +251,6 @@ The following commands are available inside the BGP configuration node.
the connection with its neighbor and, when it goes back up, notify
BGP to try to connect to it.
.. clicmd:: no neighbor <A.B.C.D|X:X::X:X|WORD> bfd
Removes any notification registration for this neighbor.
.. clicmd:: neighbor <A.B.C.D|X:X::X:X|WORD> bfd check-control-plane-failure
@ -271,10 +261,8 @@ The following commands are available inside the BGP configuration node.
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.
.. clicmd:: no neighbor <A.B.C.D|X:X::X:X|WORD> bfd check-control-plane-failure
Disallow to write CBIT independence in BFD outgoing packets. Also disallow
to ignore BFD down notification. This is the default behaviour.
Disabling this disables presence of CBIT independence in BFD outgoing
packets and pays attention to BFD down notifications. This is the default.
.. clicmd:: neighbor <A.B.C.D|X:X::X:X|WORD> bfd profile BFDPROF
@ -283,11 +271,6 @@ The following commands are available inside the BGP configuration node.
BFD profile to the sessions it creates or that already exist.
.. 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:
IS-IS BFD Configuration
@ -301,10 +284,6 @@ The following commands are available inside the interface configuration node.
a new neighbor is found a BFD peer is created to monitor the link
status for fast convergence.
.. 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
IPv4 and IPv6 support are configured then just a IPv6 based session is
created.
@ -313,9 +292,6 @@ The following commands are available inside the interface configuration node.
Use a BFD profile BFDPROF as provided in the BFD configuration.
.. clicmd:: no isis bfd profile BFDPROF
Removes any BFD profile if present.
.. _bfd-ospf-peer-config:
@ -330,10 +306,6 @@ The following commands are available inside the interface configuration node.
a new neighbor is found a BFD peer is created to monitor the link
status for fast convergence.
.. clicmd:: no ip ospf bfd
Removes any notification registration for this interface peers.
.. _bfd-ospf6-peer-config:
@ -348,10 +320,6 @@ The following commands are available inside the interface configuration node.
a new neighbor is found a BFD peer is created to monitor the link
status for fast convergence.
.. clicmd:: no ipv6 ospf6 bfd
Removes any notification registration for this interface peers.
.. _bfd-pim-peer-config:
@ -366,10 +334,6 @@ The following commands are available inside the interface configuration node.
a new neighbor is found a BFD peer is created to monitor the link
status for fast convergence.
.. clicmd:: no ip pim bfd
Removes any notification registration for this interface peers.
.. _bfd-configuration:
@ -686,7 +650,7 @@ sure you have `debugging` level enabled:
You may also fine tune the debug messages by selecting one or more of the
debug levels:
.. clicmd:: [no] debug bfd distributed
.. clicmd:: debug bfd distributed
Toggle BFD data plane (distributed BFD) debugging.
@ -695,17 +659,17 @@ debug levels:
* Data plane received / send messages
* Connection events
.. clicmd:: [no] debug bfd network
.. clicmd:: debug bfd network
Toggle network events: show messages about socket failures and unexpected
BFD messages that may not belong to registered peers.
.. clicmd:: [no] debug bfd peer
.. clicmd:: debug bfd peer
Toggle peer event log messages: show messages about peer creation/removal
and state changes.
.. clicmd:: [no] debug bfd zebra
.. clicmd:: debug bfd zebra
Toggle zebra message events: show messages about interfaces, local
addresses, VRF and daemon peer registrations.

231
doc/user/bgp.rst
View File

@ -257,7 +257,6 @@ internal or external.
Enable a BGP protocol process with the specified ASN. After
this statement you can input any `BGP Commands`.
.. clicmd:: no router bgp ASN
Destroy a BGP protocol process with the specified ASN.
@ -420,7 +419,7 @@ Administrative Distance Metrics
Require policy on EBGP
-------------------------------
.. clicmd:: [no] bgp ebgp-requires-policy
.. clicmd:: bgp ebgp-requires-policy
This command requires incoming and outgoing filters to be applied
for eBGP sessions as part of RFC-8212 compliance. Without the incoming
@ -468,14 +467,14 @@ Require policy on EBGP
Reject routes with AS_SET or AS_CONFED_SET types
------------------------------------------------
.. clicmd:: [no] bgp reject-as-sets
.. clicmd:: bgp reject-as-sets
This command enables rejection of incoming and outgoing routes having AS_SET or AS_CONFED_SET type.
Suppress duplicate updates
--------------------------
.. clicmd:: [no] bgp suppress-duplicates
.. clicmd:: bgp suppress-duplicates
For example, BGP routers can generate multiple identical announcements with
empty community attributes if stripped at egress. This is an undesired behavior.
@ -485,7 +484,7 @@ Suppress duplicate updates
Disable checking if nexthop is connected on EBGP sessions
---------------------------------------------------------
.. clicmd:: [no] bgp disable-ebgp-connected-route-check
.. clicmd:: bgp disable-ebgp-connected-route-check
This command is used to disable the connection verification process for EBGP peering sessions
that are reachable by a single hop but are configured on a loopback interface or otherwise
@ -496,17 +495,17 @@ Disable checking if nexthop is connected on EBGP sessions
Route Flap Dampening
--------------------
.. clicmd:: [no] bgp dampening [(1-45) [(1-20000) (1-20000) (1-255)]]
.. clicmd:: bgp dampening [(1-45) [(1-20000) (1-20000) (1-255)]]
This command enables (with optionally specified dampening parameters) or
disables route-flap dampening for all routes of a BGP instance.
.. clicmd:: [no] neighbor PEER dampening [(1-45) [(1-20000) (1-20000) (1-255)]]
.. clicmd:: neighbor PEER dampening [(1-45) [(1-20000) (1-20000) (1-255)]]
This command enables (with optionally specified dampening parameters) or
disables route-flap dampening for all routes learned from a BGP peer.
.. clicmd:: [no] neighbor GROUP dampening [(1-45) [(1-20000) (1-20000) (1-255)]]
.. clicmd:: neighbor GROUP dampening [(1-45) [(1-20000) (1-20000) (1-255)]]
This command enables (with optionally specified dampening parameters) or
disables route-flap dampening for all routes learned from peers of a peer
@ -1001,7 +1000,7 @@ BGP GR Peer Mode Commands
Administrative Shutdown
-----------------------
.. clicmd:: [no] bgp shutdown [message MSG...]
.. clicmd:: bgp shutdown [message MSG...]
Administrative shutdown of all peers of a bgp instance. Drop all BGP peers,
but preserve their configurations. The peers are notified in accordance with
@ -1035,9 +1034,8 @@ Networks
routes if they aren't present in their IGP routing tables; `bgpd`
doesn't care about IGP routes when announcing its routes.
.. clicmd:: no network A.B.C.D/M
.. clicmd:: [no] bgp network import-check
.. clicmd:: bgp network import-check
This configuration modifies the behavior of the network statement.
If you have this configured the underlying network must exist in
@ -1052,7 +1050,7 @@ Networks
IPv6 Support
------------
.. clicmd:: [no] neighbor A.B.C.D activate
.. clicmd:: neighbor A.B.C.D activate
This configuration modifies whether to enable an address family for a
specific neighbor. By default only the IPv4 unicast address family is
@ -1135,13 +1133,9 @@ Route Aggregation-IPv4 Address Family
Similar to `summary-only`, but will only suppress more specific routes that
are matched by the selected route-map.
.. clicmd:: no aggregate-address A.B.C.D/M
This command removes an aggregate address.
This configuration example setup the aggregate-address under
ipv4 address-family.
This configuration example sets up an ``aggregate-address`` under the ipv4
address-family.
.. code-block:: frr
@ -1191,13 +1185,9 @@ Route Aggregation-IPv6 Address Family
Similar to `summary-only`, but will only suppress more specific routes that
are matched by the selected route-map.
.. clicmd:: no aggregate-address X:X::X:X/M
This command removes an aggregate address.
This configuration example setup the aggregate-address under
ipv6 address-family.
This configuration example sets up an ``aggregate-address`` under the ipv6
address-family.
.. code-block:: frr
@ -1209,13 +1199,13 @@ Route Aggregation-IPv6 Address Family
aggregate-address 50::0/64 route-map aggr-rmap
exit-address-family
.. _bgp-redistribute-to-bgp:
Redistribution
--------------
Redistribute routes from other protocols into BGP.
Redistribute routes from other protocols into BGP.
.. clicmd:: redistribute vnc-direct
@ -1336,7 +1326,7 @@ Defining Peers
peers ASN is the same as mine as specified under the :clicmd:`router bgp ASN`
command the connection will be denied.
.. clicmd:: [no] bgp listen range <A.B.C.D/M|X:X::X:X/M> peer-group PGNAME
.. clicmd:: bgp listen range <A.B.C.D/M|X:X::X:X/M> peer-group PGNAME
Accept connections from any peers in the specified prefix. Configuration
from the specified peer-group is used to configure these peers.
@ -1359,7 +1349,7 @@ Defining Peers
``net.core.optmem_max`` to allow the kernel to allocate the necessary option
memory.
.. clicmd:: [no] coalesce-time (0-4294967295)
.. clicmd:: coalesce-time (0-4294967295)
The time in milliseconds that BGP will delay before deciding what peers
can be put into an update-group together in order to generate a single
@ -1370,7 +1360,7 @@ Defining Peers
Configuring Peers
^^^^^^^^^^^^^^^^^
.. clicmd:: [no] neighbor PEER shutdown [message MSG...] [rtt (1-65535) [count (1-255)]]
.. clicmd:: neighbor PEER shutdown [message MSG...] [rtt (1-65535) [count (1-255)]]
Shutdown the peer. We can delete the neighbor's configuration by
``no neighbor PEER remote-as ASN`` but all configuration of the neighbor
@ -1385,12 +1375,12 @@ Configuring Peers
Additional ``count`` parameter is the number of keepalive messages to count
before shutdown the peer if round-trip-time becomes higher than defined.
.. clicmd:: [no] neighbor PEER disable-connected-check
.. clicmd:: neighbor PEER disable-connected-check
Allow peerings between directly connected eBGP peers using loopback
addresses.
.. clicmd:: [no] neighbor PEER ebgp-multihop
.. clicmd:: neighbor PEER ebgp-multihop
Specifying ``ebgp-multihop`` allows sessions with eBGP neighbors to
establish when they are multiple hops away. When the neighbor is not
@ -1400,11 +1390,11 @@ Configuring Peers
If the peer's IP address is not in the RIB and is reachable via the
default route, then you have to enable ``ip nht resolve-via-default``.
.. clicmd:: [no] neighbor PEER description ...
.. clicmd:: neighbor PEER description ...
Set description of the peer.
.. clicmd:: [no] neighbor PEER version VERSION
.. clicmd:: neighbor PEER version VERSION
Set up the neighbor's BGP version. `version` can be `4`, `4+` or `4-`. BGP
version `4` is the default value used for BGP peering. BGP version `4+`
@ -1413,7 +1403,7 @@ Configuring Peers
revision 00's Multiprotocol Extensions for BGP-4. Some routing software is
still using this version.
.. clicmd:: [no] neighbor PEER interface IFNAME
.. clicmd:: neighbor PEER interface IFNAME
When you connect to a BGP peer over an IPv6 link-local address, you have to
specify the IFNAME of the interface used for the connection. To specify
@ -1423,7 +1413,7 @@ Configuring Peers
This command is deprecated and may be removed in a future release. Its use
should be avoided.
.. clicmd:: [no] neighbor PEER next-hop-self [all]
.. clicmd:: neighbor PEER next-hop-self [all]
This command specifies an announced route's nexthop as being equivalent to
the address of the bgp router if it is learned via eBGP. If the optional
@ -1437,7 +1427,7 @@ Configuring Peers
configurations, as the route-map directive to leave the next-hop unchanged
is only available for ipv4.
.. clicmd:: [no] neighbor PEER update-source <IFNAME|ADDRESS>
.. clicmd:: neighbor PEER update-source <IFNAME|ADDRESS>
Specify the IPv4 source address to use for the :abbr:`BGP` session to this
neighbour, may be specified as either an IPv4 address directly or as an
@ -1451,7 +1441,7 @@ Configuring Peers
neighbor bar update-source lo0
.. clicmd:: [no] neighbor PEER default-originate
.. clicmd:: neighbor PEER default-originate
*bgpd*'s default is to not announce the default route (0.0.0.0/0) even if it
is in routing table. When you want to announce default routes to the peer,
@ -1459,7 +1449,7 @@ Configuring Peers
.. clicmd:: neighbor PEER port PORT
.. clicmd:: [no] neighbor PEER password PASSWORD
.. clicmd:: neighbor PEER password PASSWORD
Set a MD5 password to be used with the tcp socket that is being used
to connect to the remote peer. Please note if you are using this
@ -1469,11 +1459,11 @@ Configuring Peers
.. clicmd:: neighbor PEER send-community
.. clicmd:: [no] neighbor PEER weight WEIGHT
.. clicmd:: neighbor PEER weight WEIGHT
This command specifies a default `weight` value for the neighbor's routes.
.. clicmd:: [no] neighbor PEER maximum-prefix NUMBER [force]
.. clicmd:: neighbor PEER maximum-prefix NUMBER [force]
Sets a maximum number of prefixes we can receive from a given peer. If this
number is exceeded, the BGP session will be destroyed.
@ -1490,14 +1480,14 @@ Configuring Peers
but you want maximum-prefix to act on ALL (including filtered) prefixes. This
option requires `soft-reconfiguration inbound` to be enabled for the peer.
.. clicmd:: [no] neighbor PEER maximum-prefix-out NUMBER
.. clicmd:: neighbor PEER maximum-prefix-out NUMBER
Sets a maximum number of prefixes we can send to a given peer.
Since sent prefix count is managed by update-groups, this option
creates a separate update-group for outgoing updates.
.. clicmd:: [no] neighbor PEER local-as AS-NUMBER [no-prepend] [replace-as]
.. clicmd:: neighbor PEER local-as AS-NUMBER [no-prepend] [replace-as]
Specify an alternate AS for this BGP process when interacting with the
specified peer. With no modifiers, the specified local-as is prepended to
@ -1515,7 +1505,7 @@ Configuring Peers
This command is only allowed for eBGP peers.
.. clicmd:: [no] neighbor <A.B.C.D|X:X::X:X|WORD> as-override
.. clicmd:: neighbor <A.B.C.D|X:X::X:X|WORD> as-override
Override AS number of the originating router with the local AS number.
@ -1527,7 +1517,7 @@ Configuring Peers
This command is only allowed for eBGP peers.
.. clicmd:: [no] neighbor <A.B.C.D|X:X::X:X|WORD> allowas-in [<(1-10)|origin>]
.. clicmd:: neighbor <A.B.C.D|X:X::X:X|WORD> allowas-in [<(1-10)|origin>]
Accept incoming routes with AS path containing AS number with the same value
as the current system AS.
@ -1544,24 +1534,24 @@ Configuring Peers
This command is only allowed for eBGP peers.
.. clicmd:: [no] neighbor <A.B.C.D|X:X::X:X|WORD> addpath-tx-all-paths
.. clicmd:: neighbor <A.B.C.D|X:X::X:X|WORD> addpath-tx-all-paths
Configure BGP to send all known paths to neighbor in order to preserve multi
path capabilities inside a network.
.. clicmd:: [no] neighbor <A.B.C.D|X:X::X:X|WORD> addpath-tx-bestpath-per-AS
.. clicmd:: neighbor <A.B.C.D|X:X::X:X|WORD> addpath-tx-bestpath-per-AS
Configure BGP to send best known paths to neighbor in order to preserve multi
path capabilities inside a network.
.. clicmd:: [no] neighbor PEER ttl-security hops NUMBER
.. clicmd:: neighbor PEER ttl-security hops NUMBER
This command enforces Generalized TTL Security Mechanism (GTSM), as
specified in RFC 5082. With this command, only neighbors that are the
specified number of hops away will be allowed to become neighbors. This
command is mutually exclusive with *ebgp-multihop*.
.. clicmd:: [no] neighbor PEER capability extended-nexthop
.. clicmd:: neighbor PEER capability extended-nexthop
Allow bgp to negotiate the extended-nexthop capability with it's peer.
If you are peering over a v6 LL address then this capability is turned
@ -1569,37 +1559,37 @@ Configuring Peers
turning on this command will allow BGP to install v4 routes with
v6 nexthops if you do not have v4 configured on interfaces.
.. clicmd:: [no] bgp fast-external-failover
.. clicmd:: bgp fast-external-failover
This command causes bgp to not take down ebgp peers immediately
when a link flaps. `bgp fast-external-failover` is the default
and will not be displayed as part of a `show run`. The no form
of the command turns off this ability.
.. clicmd:: [no] bgp default ipv4-unicast
.. clicmd:: bgp default ipv4-unicast
This command allows the user to specify that v4 peering is turned
on by default or not. This command defaults to on and is not displayed.
The `no bgp default ipv4-unicast` form of the command is displayed.
.. clicmd:: [no] bgp default show-hostname
.. clicmd:: bgp default show-hostname
This command shows the hostname of the peer in certain BGP commands
outputs. It's easier to troubleshoot if you have a number of BGP peers.
.. clicmd:: [no] bgp default show-nexthop-hostname
.. clicmd:: bgp default show-nexthop-hostname
This command shows the hostname of the next-hop in certain BGP commands
outputs. It's easier to troubleshoot if you have a number of BGP peers
and a number of routes to check.
.. clicmd:: [no] neighbor PEER advertisement-interval (0-600)
.. clicmd:: neighbor PEER advertisement-interval (0-600)
Setup the minimum route advertisement interval(mrai) for the
peer in question. This number is between 0 and 600 seconds,
with the default advertisement interval being 0.
.. clicmd:: [no] neighbor PEER timers delayopen (1-240)
.. clicmd:: neighbor PEER timers delayopen (1-240)
This command allows the user enable the
`RFC 4271 <https://tools.ietf.org/html/rfc4271/>` DelayOpenTimer with the
@ -1639,7 +1629,7 @@ Peer Filtering
on reflected routes. This option allows the modifications to be reflected as
well. Once enabled, it affects all reflected routes.
.. clicmd:: [no] neighbor PEER sender-as-path-loop-detection
.. clicmd:: neighbor PEER sender-as-path-loop-detection
Enable the detection of sender side AS path loops and filter the
bad routes before they are sent.
@ -1678,7 +1668,6 @@ Capability Negotiation
.. clicmd:: neighbor PEER strict-capability-match
.. clicmd:: no neighbor PEER strict-capability-match
Strictly compares remote capabilities and local capabilities. If
capabilities are different, send Unsupported Capability error then reset
@ -1689,7 +1678,7 @@ Capability Negotiation
Negotiation. Please use *dont-capability-negotiate* command to disable the
feature.
.. clicmd:: [no] neighbor PEER dont-capability-negotiate
.. clicmd:: neighbor PEER dont-capability-negotiate
Suppress sending Capability Negotiation as OPEN message optional parameter
to the peer. This command only affects the peer is configured other than
@ -1711,7 +1700,6 @@ Capability Negotiation
.. clicmd:: neighbor PEER override-capability
.. clicmd:: no neighbor PEER override-capability
Override the result of Capability Negotiation with local configuration.
Ignore remote peer's capability value.
@ -1727,9 +1715,7 @@ AS path access list is user defined AS path.
This command defines a new AS path access list.
.. clicmd:: no bgp as-path access-list WORD
.. clicmd:: no bgp as-path access-list WORD permit|deny LINE
.. _bgp-bogon-filter-example:
@ -1747,18 +1733,18 @@ Bogon ASN filter policy configuration example
Using AS Path in Route Map
--------------------------
.. clicmd:: [no] match as-path WORD
.. clicmd:: match as-path WORD
For a given as-path, WORD, match it on the BGP as-path given for the prefix
and if it matches do normal route-map actions. The no form of the command
removes this match from the route-map.
.. clicmd:: [no] set as-path prepend AS-PATH
.. clicmd:: set as-path prepend AS-PATH
Prepend the given string of AS numbers to the AS_PATH of the BGP path's NLRI.
The no form of this command removes this set operation from the route-map.
.. clicmd:: [no] set as-path prepend last-as NUM
.. clicmd:: set as-path prepend last-as NUM
Prepend the existing last AS number (the leftmost ASN) to the AS_PATH.
The no form of this command removes this set operation from the route-map.
@ -1933,12 +1919,9 @@ expanded
Otherwise it is defined as an expanded community list. This feature is left
for backward compatibility. Use of this feature is not recommended.
.. clicmd:: no bgp community-list [standard|expanded] NAME
Deletes the community list specified by ``NAME``. All community lists share
the same namespace, so it's not necessary to specify ``standard`` or
``expanded``; these modifiers are purely aesthetic.
Note that all community lists share the same namespace, so it's not
necessary to specify ``standard`` or ``expanded``; these modifiers are
purely aesthetic.
.. clicmd:: show bgp community-list [NAME detail]
@ -2207,24 +2190,13 @@ Extended Community Lists
expression (:ref:`bgp-regular-expressions`) to match an extended communities
attribute in BGP updates.
.. clicmd:: no bgp extcommunity-list NAME
Note that all extended community lists shares a single name space, so it's
not necessary to specify their type when creating or destroying them.
.. clicmd:: no bgp extcommunity-list standard NAME
.. clicmd:: no bgp extcommunity-list expanded NAME
These commands delete extended community lists specified by `name`. All of
extended community lists shares a single name space. So extended community
lists can be removed simply specifying the name.
.. clicmd:: show bgp extcommunity-list
.. clicmd:: show bgp extcommunity-list NAME detail
.. clicmd:: show bgp extcommunity-list [NAME detail]
This command displays current extcommunity-list information. When `name` is
specified the community list's information is shown.::
# show bgp extcommunity-list
specified the community list's information is shown.
.. _bgp-extended-communities-in-route-map:
@ -2311,15 +2283,9 @@ Two types of large community lists are supported, namely `standard` and
lowest to highest. `line` can also be a regular expression which matches
this Large Community attribute.
.. clicmd:: no bgp large-community-list NAME
.. clicmd:: no bgp large-community-list standard NAME
.. clicmd:: no bgp large-community-list expanded NAME
These commands delete Large Community lists specified by `name`. All Large
Community lists share a single namespace. This means Large Community lists
can be removed by simply specifying the name.
Note that all community lists share the same namespace, so it's not
necessary to specify ``standard`` or ``expanded``; these modifiers are
purely aesthetic.
.. clicmd:: show bgp large-community-list
@ -2436,10 +2402,6 @@ address-family:
Specifies the route distinguisher to be added to a route exported from the
current unicast VRF to VPN.
.. clicmd:: no rd vpn export [AS:NN|IP:nn]
Deletes any previously-configured export route distinguisher.
.. clicmd:: rt vpn import|export|both RTLIST...
Specifies the route-target list to be attached to a route (export) or the
@ -2450,10 +2412,6 @@ address-family:
extended community values as described in
:ref:`bgp-extended-communities-attribute`.
.. clicmd:: no rt vpn import|export|both [RTLIST...]
Deletes any previously-configured import or export route-target list.
.. clicmd:: label vpn export (0..1048575)|auto
Enables an MPLS label to be attached to a route exported from the current
@ -2462,37 +2420,21 @@ address-family:
is not running, or if this command is not configured, automatic label
assignment will not complete, which will block corresponding route export.
.. clicmd:: no label vpn export [(0..1048575)|auto]
Deletes any previously-configured export label.
.. clicmd:: nexthop vpn export A.B.C.D|X:X::X:X
Specifies an optional nexthop value to be assigned to a route exported from
the current unicast VRF to VPN. If left unspecified, the nexthop will be set
to 0.0.0.0 or 0:0::0:0 (self).
.. clicmd:: no nexthop vpn export [A.B.C.D|X:X::X:X]
Deletes any previously-configured export nexthop.
.. clicmd:: route-map vpn import|export MAP
Specifies an optional route-map to be applied to routes imported or exported
between the current unicast VRF and VPN.
.. clicmd:: no route-map vpn import|export [MAP]
Deletes any previously-configured import or export route-map.
.. clicmd:: import|export vpn
Enables import or export of routes between the current unicast VRF and VPN.
.. clicmd:: no import|export vpn
Disables import or export of routes between the current unicast VRF and VPN.
.. clicmd:: import vrf VRFNAME
Shortcut syntax for specifying automatic leaking from vrf VRFNAME to
@ -2505,11 +2447,6 @@ address-family:
The CLI will disallow attempts to configure incompatible leaking
modes.
.. clicmd:: no import vrf VRFNAME
Disables automatic leaking from vrf VRFNAME to the current VRF using
the VPN RIB as intermediary.
.. _bgp-evpn:
@ -2560,7 +2497,7 @@ disable the feature via configuration CLI. Once the feature is disable under
bgp vrf instance or MAC-VLAN interface is not configured, all the routes follow
the same behavior of using same next-hop and RMAC values.
.. clicmd:: [no] advertise-pip [ip <addr> [mac <addr>]]
.. clicmd:: advertise-pip [ip <addr> [mac <addr>]]
Enables or disables advertise-pip feature, specifiy system-IP and/or system-MAC
parameters.
@ -2577,9 +2514,9 @@ Ethernet Segments
An Ethernet Segment can be configured by specifying a system-MAC and a
local discriminatior against the bond interface on the PE (via zebra) -
.. clicmd:: [no] evpn mh es-id (1-16777215)
.. clicmd:: evpn mh es-id (1-16777215)
.. clicmd:: [no] evpn mh es-sys-mac X:X:X:X:X:X
.. clicmd:: evpn mh es-sys-mac X:X:X:X:X:X
The sys-mac and local discriminator are used for generating a 10-byte,
Type-3 Ethernet Segment ID.
@ -2602,7 +2539,7 @@ forward BUM traffic received via the overlay network. This implementation
uses a preference based DF election specified by draft-ietf-bess-evpn-pref-df.
The DF preference is configurable per-ES (via zebra) -
.. clicmd:: [no] evpn mh es-df-pref (1-16777215)
.. clicmd:: evpn mh es-df-pref (1-16777215)
BUM traffic is rxed via the overlay by all PEs attached to a server but
only the DF can forward the de-capsulated traffic to the access port. To
@ -2620,9 +2557,9 @@ ES-PE based on just the EAD-per-ES route.
Note that by default we advertise and expect EAD-per-EVI routes.
.. clicmd:: [no] disable-ead-evi-rx
.. clicmd:: disable-ead-evi-rx
.. clicmd:: [no] disable-ead-evi-tx
.. clicmd:: disable-ead-evi-tx
Fast failover
"""""""""""""
@ -2636,13 +2573,13 @@ been introduced for the express purpose of efficient ES failovers.
On dataplanes that support layer3 nexthop groups the feature can be turned
on via the following BGP config -
.. clicmd:: [no] use-es-l3nhg
.. clicmd:: use-es-l3nhg
- Local ES (MAC/Neigh) failover via ES-redirect.
On dataplanes that do not have support for ES-redirect the feature can be
turned off via the following zebra config -
.. clicmd:: [no] evpn mh redirect-off
.. clicmd:: evpn mh redirect-off
Uplink/Core tracking
""""""""""""""""""""
@ -2651,7 +2588,7 @@ When all the underlay links go down the PE no longer has access to the VxLAN
protodowned on the PE. A link can be setup for uplink tracking via the
following zebra configuration -
.. clicmd:: [no] evpn mh uplink
.. clicmd:: evpn mh uplink
Proxy advertisements
""""""""""""""""""""
@ -2662,9 +2599,9 @@ the ES peer (PE2) goes down PE1 continues to advertise hosts learnt from PE2
for a holdtime during which it attempts to establish local reachability of
the host. This holdtime is configurable via the following zebra commands -
.. clicmd:: [no] evpn mh neigh-holdtime (0-86400)
.. clicmd:: evpn mh neigh-holdtime (0-86400)
.. clicmd:: [no] evpn mh mac-holdtime (0-86400)
.. clicmd:: evpn mh mac-holdtime (0-86400)
Startup delay
"""""""""""""
@ -2673,7 +2610,7 @@ and EVPN network to converge before enabling the ESs. For this duration the
ES bonds are held protodown. The startup delay is configurable via the
following zebra command -
.. clicmd:: [no] evpn mh startup-delay (0-3600)
.. clicmd:: evpn mh startup-delay (0-3600)
+Support with VRF network namespace backend
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -2731,7 +2668,7 @@ advertisement to take effect is 60 seconds. The conditional advertisement can ta
effect depending on when the tracked route is removed from the BGP table and
when the next instance of the BGP scanner occurs.
.. clicmd:: [no] neighbor A.B.C.D advertise-map NAME [exist-map|non-exist-map] NAME
.. clicmd:: neighbor A.B.C.D advertise-map NAME [exist-map|non-exist-map] NAME
This command enables BGP scanner process to monitor routes specified by
exist-map or non-exist-map command in BGP table and conditionally advertises
@ -2897,38 +2834,38 @@ Debugging
Display Listen sockets and the vrf that created them. Useful for debugging of when
listen is not working and this is considered a developer debug statement.
.. clicmd:: [no] debug bgp neighbor-events
.. clicmd:: debug bgp neighbor-events
Enable or disable debugging for neighbor events. This provides general
information on BGP events such as peer connection / disconnection, session
establishment / teardown, and capability negotiation.
.. clicmd:: [no] debug bgp updates
.. clicmd:: debug bgp updates
Enable or disable debugging for BGP updates. This provides information on
BGP UPDATE messages transmitted and received between local and remote
instances.
.. clicmd:: [no] debug bgp keepalives
.. clicmd:: debug bgp keepalives
Enable or disable debugging for BGP keepalives. This provides information on
BGP KEEPALIVE messages transmitted and received between local and remote
instances.
.. clicmd:: [no] debug bgp bestpath <A.B.C.D/M|X:X::X:X/M>
.. clicmd:: debug bgp bestpath <A.B.C.D/M|X:X::X:X/M>
Enable or disable debugging for bestpath selection on the specified prefix.
.. clicmd:: [no] debug bgp nht
.. clicmd:: debug bgp nht
Enable or disable debugging of BGP nexthop tracking.
.. clicmd:: [no] debug bgp update-groups
.. clicmd:: debug bgp update-groups
Enable or disable debugging of dynamic update groups. This provides general
information on group creation, deletion, join and prune events.
.. clicmd:: [no] debug bgp zebra
.. clicmd:: debug bgp zebra
Enable or disable debugging of communications between *bgpd* and *zebra*.
@ -2939,7 +2876,6 @@ Dumping Messages and Routing Tables
.. clicmd:: dump bgp all-et PATH [INTERVAL]
.. clicmd:: no dump bgp all [PATH] [INTERVAL]
Dump all BGP packet and events to `path` file.
If `interval` is set, a new file will be created for echo `interval` of
@ -2951,7 +2887,6 @@ Dumping Messages and Routing Tables
.. clicmd:: dump bgp updates-et PATH [INTERVAL]
.. clicmd:: no dump bgp updates [PATH] [INTERVAL]
Dump only BGP updates messages to `path` file.
If `interval` is set, a new file will be created for echo `interval` of
@ -2963,7 +2898,6 @@ Dumping Messages and Routing Tables
.. clicmd:: dump bgp routes-mrt PATH INTERVAL
.. clicmd:: no dump bgp route-mrt [PATH] [INTERVAL]
Dump whole BGP routing table to `path`. This is heavy process. The path
`path` can be set with date and time formatting (strftime). If `interval` is
@ -3357,7 +3291,6 @@ with:
.. clicmd:: neighbor PEER route-reflector-client
.. clicmd:: no neighbor PEER route-reflector-client
To avoid single points of failure, multiple route reflectors can be configured.
@ -3366,7 +3299,7 @@ by route reflectors to avoid looping.
.. clicmd:: bgp cluster-id A.B.C.D
.. clicmd:: [no] bgp no-rib
.. clicmd:: bgp no-rib
To set and unset the BGP daemon ``-n`` / ``--no_kernel`` options during runtime
to disable BGP route installation to the RIB (Zebra), the ``[no] bgp no-rib``
@ -3379,7 +3312,7 @@ starting the daemon and the configuration gets saved, the option will persist
unless removed from the configuration with the negating command prior to the
configuration write operation.
.. clicmd:: [no] bgp send-extra-data zebra
.. clicmd:: bgp send-extra-data zebra
This Command turns off the ability of BGP to send extra data to zebra.
In this case it's the AS-Path being used for the path. The default behavior
@ -3428,7 +3361,7 @@ status in FIB:
7. If the route which is already installed in dataplane is removed for some
reason, sending withdraw message to peers is not currently supported.
.. clicmd:: [no] bgp suppress-fib-pending
.. clicmd:: bgp suppress-fib-pending
This command is applicable at the global level and at an individual
bgp level. If applied at the global level all bgp instances will

18
doc/user/bmp.rst
View File

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

7
doc/user/eigrpd.rst
View File

@ -72,14 +72,8 @@ EIGRP Configuration
carrying out any of the EIGRP commands. Specify vrf NAME if you want
eigrp to work within the specified vrf.
.. clicmd:: no router eigrp (1-65535) [vrf NAME]
Disable EIGRP.
.. clicmd:: network NETWORK
.. clicmd:: no network NETWORK
Set the EIGRP enable interface by `network`. The interfaces which
have addresses matching with `network` are enabled.
@ -102,7 +96,6 @@ EIGRP Configuration
.. clicmd:: passive-interface (IFNAME|default)
.. clicmd:: no passive-interface IFNAME
This command sets the specified interface to passive mode. On passive mode
interface, all receiving packets are ignored and eigrpd does not send either

80
doc/user/fabricd.rst
View File

@ -34,27 +34,19 @@ in the configuration:
.. clicmd:: router openfabric WORD
.. clicmd:: no router openfabric WORD
Enable or disable the OpenFabric process by specifying the OpenFabric domain with
'WORD'.
.. clicmd:: net XX.XXXX. ... .XXX.XX
.. clicmd:: no net XX.XXXX. ... .XXX.XX
Set/Unset network entity title (NET) provided in ISO format.
.. clicmd:: domain-password [clear | md5] <password>
.. clicmd:: no domain-password
Configure the authentication password for a domain, as clear text or md5 one.
.. clicmd:: attached-bit [receive ignore | send]
.. clicmd:: no attached-bit
Set attached bit for inter-area traffic:
- receive
@ -64,25 +56,20 @@ in the configuration:
.. clicmd:: log-adjacency-changes
.. clicmd:: no log-adjacency-changes
Log changes in adjacency state.
.. clicmd:: set-overload-bit
.. clicmd:: no set-overload-bit
Set overload bit to avoid any transit traffic.
.. clicmd:: purge-originator
.. clicmd:: no purge-originator
Enable or disable :rfc:`6232` purge originator identification.
.. clicmd:: fabric-tier (0-14)
.. clicmd:: no fabric-tier
Configure a static tier number to advertise as location in the fabric
@ -93,25 +80,21 @@ OpenFabric Timer
.. clicmd:: lsp-gen-interval (1-120)
.. clicmd:: no lsp-gen-interval
Set minimum interval in seconds between regenerating same LSP.
.. clicmd:: lsp-refresh-interval (1-65235)
.. clicmd:: no lsp-refresh-interval
Set LSP refresh interval in seconds.
.. clicmd:: max-lsp-lifetime (360-65535)
.. clicmd:: no max-lsp-lifetime
Set LSP maximum LSP lifetime in seconds.
.. clicmd:: spf-interval (1-120)
.. clicmd:: no spf-interval
Set minimum interval between consecutive SPF calculations in seconds.
@ -122,7 +105,6 @@ OpenFabric interface
.. clicmd:: ip router openfabric WORD
.. clicmd:: no ip router openfabric WORD
.. _ip-router-openfabric-word:
@ -132,44 +114,37 @@ OpenFabric interface
.. clicmd:: openfabric csnp-interval (1-600)
.. clicmd:: no openfabric csnp-interval
Set CSNP interval in seconds.
.. clicmd:: openfabric hello-interval (1-600)
.. clicmd:: no openfabric hello-interval
Set Hello interval in seconds.
.. clicmd:: openfabric hello-multiplier (2-100)
.. clicmd:: no openfabric hello-multiplier
Set multiplier for Hello holding time.
.. clicmd:: openfabric metric (0-16777215)
.. clicmd:: no openfabric metric
Set interface metric value.
.. clicmd:: openfabric passive
.. clicmd:: no openfabric passive
Configure the passive mode for this interface.
.. clicmd:: openfabric password [clear | md5] <password>
.. clicmd:: no openfabric password
Configure the authentication password (clear or encoded text) for the
interface.
.. clicmd:: openfabric psnp-interval (1-120)
.. clicmd:: no openfabric psnp-interval
Set PSNP interval in seconds.
@ -226,63 +201,43 @@ Debugging OpenFabric
.. clicmd:: debug openfabric adj-packets
.. clicmd:: no debug openfabric adj-packets
OpenFabric Adjacency related packets.
OpenFabric Adjacency related packets.
.. clicmd:: debug openfabric checksum-errors
.. clicmd:: no debug openfabric checksum-errors
OpenFabric LSP checksum errors.
OpenFabric LSP checksum errors.
.. clicmd:: debug openfabric events
.. clicmd:: no debug openfabric events
OpenFabric Events.
OpenFabric Events.
.. clicmd:: debug openfabric local-updates
.. clicmd:: no debug openfabric local-updates
OpenFabric local update packets.
OpenFabric local update packets.
.. clicmd:: debug openfabric lsp-gen
.. clicmd:: no debug openfabric lsp-gen
Generation of own LSPs.
Generation of own LSPs.
.. clicmd:: debug openfabric lsp-sched
.. clicmd:: no debug openfabric lsp-sched
Debug scheduling of generation of own LSPs.
Debug scheduling of generation of own LSPs.
.. clicmd:: debug openfabric packet-dump
.. clicmd:: no debug openfabric packet-dump
OpenFabric packet dump.
OpenFabric packet dump.
.. clicmd:: debug openfabric protocol-errors
.. clicmd:: no debug openfabric protocol-errors
OpenFabric LSP protocol errors.
OpenFabric LSP protocol errors.
.. clicmd:: debug openfabric route-events
.. clicmd:: no debug openfabric route-events
OpenFabric Route related events.
OpenFabric Route related events.
.. clicmd:: debug openfabric snp-packets
.. clicmd:: no debug openfabric snp-packets
OpenFabric CSNP/PSNP packets.
OpenFabric CSNP/PSNP packets.
.. clicmd:: debug openfabric spf-events
@ -290,25 +245,18 @@ OpenFabric CSNP/PSNP packets.
.. clicmd:: debug openfabric spf-triggers
.. clicmd:: no debug openfabric spf-events
.. clicmd:: no debug openfabric spf-statistics
.. clicmd:: no debug openfabric spf-triggers
OpenFabric Shortest Path First Events, Timing and Statistic Data and triggering
events.
OpenFabric Shortest Path First Events, Timing and Statistic Data and
triggering events.
.. clicmd:: debug openfabric update-packets
.. clicmd:: no debug openfabric update-packets
Update related packets.
Update-related packets.
.. clicmd:: show debugging openfabric
Print which OpenFabric debug levels are active.
OpenFabric configuration example
================================

9
doc/user/filter.rst
View File

@ -94,7 +94,6 @@ 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
length specified in the prefix list.
.. clicmd:: no ip prefix-list NAME
.. _ip-prefix-list-description:
@ -106,10 +105,6 @@ ip prefix-list description
Descriptions may be added to prefix lists. This command adds a
description to the prefix list.
.. 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:
@ -121,10 +116,6 @@ ip prefix-list sequential number control
With this command, the IP prefix list sequential number is displayed.
This is the default behavior.
.. clicmd:: no ip prefix-list sequence-number
With this command, the IP prefix list sequential number is not
displayed.
.. _showing-ip-prefix-list:

8
doc/user/flowspec.rst
View File

@ -139,7 +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 address-family` node.
.. clicmd:: [no] local-install <IFNAME | any>
.. clicmd:: local-install <IFNAME | any>
By default, Flowspec is activated on all interfaces. Installing it to a named
interface will result in allowing only this interface. Conversely, enabling any
@ -165,7 +165,7 @@ following:
- 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
.. clicmd:: [no] rt redirect import RTLIST...
.. clicmd:: rt redirect import RTLIST...
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
@ -235,13 +235,13 @@ match.
``TABLEID`` is the table number identifier referencing the non standard
routing table used in this example.
.. clicmd:: [no] debug bgp flowspec
.. clicmd:: debug bgp flowspec
You can troubleshoot Flowspec, or BGP policy based routing. For instance, if
you encounter some issues when decoding a Flowspec entry, you should enable
:clicmd:`debug bgp flowspec`.
.. clicmd:: [no] debug bgp pbr [error]
.. clicmd:: debug bgp pbr [error]
If you fail to apply the flowspec entry into *zebra*, there should be some
relationship with policy routing mechanism. Here,

41
doc/user/ipv6.rst
View File

@ -17,13 +17,10 @@ no longer possible.
Router Advertisement
====================
.. clicmd:: no ipv6 nd suppress-ra
Send router advertisement messages.
.. 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.
.. clicmd:: ipv6 nd prefix ipv6prefix [valid-lifetime] [preferred-lifetime] [off-link] [no-autoconfig] [router-address]
@ -54,19 +51,19 @@ Router Advertisement
Default: not set, i.e. hosts do not assume a complete IP address is placed.
.. clicmd:: [no] ipv6 nd ra-interval [(1-1800)]
.. clicmd:: ipv6 nd ra-interval [(1-1800)]
The maximum time allowed between sending unsolicited multicast router
advertisements from the interface, in seconds.
Default: ``600``
.. clicmd:: [no] ipv6 nd ra-interval [msec (70-1800000)]
.. clicmd:: ipv6 nd ra-interval [msec (70-1800000)]
The maximum time allowed between sending unsolicited multicast router
advertisements from the interface, in milliseconds.
Default: ``600000``
.. clicmd:: [no] ipv6 nd ra-fast-retrans
.. clicmd:: ipv6 nd ra-fast-retrans
RFC4861 states that consecutive RA packets should be sent no more
frequently than three seconds apart. FRR by default allows faster
@ -77,7 +74,7 @@ Router Advertisement
and neighbor establishment.
Default: enabled
.. clicmd:: [no] ipv6 nd ra-retrans-interval [(0-4294967295)]
.. clicmd:: ipv6 nd ra-retrans-interval [(0-4294967295)]
The value to be placed in the retrans timer field of router advertisements
sent from the interface, in msec. Indicates the interval between router
@ -86,7 +83,7 @@ Router Advertisement
msec.
Default: ``0``
.. clicmd:: [no] ipv6 nd ra-hop-limit [(0-255)]
.. clicmd:: ipv6 nd ra-hop-limit [(0-255)]
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.
@ -94,7 +91,7 @@ Router Advertisement
router. Must be between zero or 255 hops.
Default: ``64``
.. clicmd:: [no] ipv6 nd ra-lifetime [(0-9000)]
.. clicmd:: ipv6 nd ra-lifetime [(0-9000)]
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
@ -104,7 +101,7 @@ Router Advertisement
(or default) and 9000 seconds.
Default: ``1800``
.. clicmd:: [no] ipv6 nd reachable-time [(1-3600000)]
.. clicmd:: ipv6 nd reachable-time [(1-3600000)]
The value to be placed in the Reachable Time field in the Router
Advertisement messages sent by the router, in milliseconds. The configured
@ -112,7 +109,7 @@ Router Advertisement
means unspecified (by this router).
Default: ``0``
.. clicmd:: [no] ipv6 nd managed-config-flag
.. clicmd:: ipv6 nd managed-config-flag
Set/unset flag in IPv6 router advertisements which indicates to hosts that
they should use managed (stateful) protocol for addresses autoconfiguration
@ -120,28 +117,28 @@ Router Advertisement
autoconfiguration.
Default: not set
.. clicmd:: [no] ipv6 nd other-config-flag
.. clicmd:: ipv6 nd other-config-flag
Set/unset flag in IPv6 router advertisements which indicates to hosts that
they should use administered (stateful) protocol to obtain autoconfiguration
information other than addresses.
Default: not set
.. clicmd:: [no] ipv6 nd home-agent-config-flag
.. clicmd:: ipv6 nd home-agent-config-flag
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.
Default: not set
.. clicmd:: [no] ipv6 nd home-agent-preference [(0-65535)]
.. clicmd:: ipv6 nd home-agent-preference [(0-65535)]
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
stands for the lowest preference possible.
Default: ``0``
.. clicmd:: [no] ipv6 nd home-agent-lifetime [(0-65520)]
.. clicmd:: ipv6 nd home-agent-lifetime [(0-65520)]
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
@ -149,18 +146,18 @@ Router Advertisement
Default: ``0``
.. clicmd:: [no] ipv6 nd adv-interval-option
.. clicmd:: ipv6 nd adv-interval-option
Include an Advertisement Interval option which indicates to hosts the maximum time,
in milliseconds, between successive unsolicited Router Advertisements.
Default: not set
.. clicmd:: [no] ipv6 nd router-preference [(high|medium|low)]
.. clicmd:: ipv6 nd router-preference [(high|medium|low)]
Set default router preference in IPv6 router advertisements per RFC4191.
Default: medium
.. clicmd:: [no] ipv6 nd mtu [(1-65535)]
.. clicmd:: ipv6 nd mtu [(1-65535)]
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
@ -168,7 +165,7 @@ Router Advertisement
Default: don't advertise any MTU option.
.. clicmd:: [no] ipv6 nd rdnss ipv6address [lifetime]
.. clicmd:: ipv6 nd rdnss ipv6address [lifetime]
Recursive DNS server address to advertise using the RDNSS (type 25) option
described in RFC8106. Can be specified more than once to advertise multiple
@ -185,7 +182,7 @@ Router Advertisement
Default: do not emit RDNSS option
.. clicmd:: [no] ipv6 nd dnssl domain-name-suffix [lifetime]
.. clicmd:: ipv6 nd dnssl domain-name-suffix [lifetime]
Advertise DNS search list using the DNSSL (type 31) option described in
RFC8106. Specify more than once to advertise multiple domain name suffixes.

192
doc/user/isisd.rst
View File

@ -33,7 +33,7 @@ ISIS router
To start the ISIS process you have to specify the ISIS router. As of this
writing, *isisd* does not support multiple ISIS processes.
.. clicmd:: [no] router isis WORD [vrf NAME]
.. clicmd:: router isis WORD [vrf NAME]
Enable or disable the ISIS process by specifying the ISIS domain with
'WORD'. *isisd* does not yet support multiple ISIS processes but you must
@ -42,31 +42,21 @@ writing, *isisd* does not support multiple ISIS processes.
.. clicmd:: net XX.XXXX. ... .XXX.XX
.. clicmd:: no net XX.XXXX. ... .XXX.XX
Set/Unset network entity title (NET) provided in ISO format.
.. clicmd:: hostname dynamic
.. clicmd:: no hostname dynamic
Enable support for dynamic hostname.
.. clicmd:: area-password [clear | md5] <password>
.. clicmd:: domain-password [clear | md5] <password>
.. clicmd:: no area-password
.. clicmd:: no domain-password
Configure the authentication password for an area, respectively a domain, as
clear text or md5 one.
.. clicmd:: attached-bit [receive ignore | send]
.. clicmd:: no attached-bit
Set attached bit for inter-area traffic:
- receive
@ -76,14 +66,10 @@ writing, *isisd* does not support multiple ISIS processes.
.. clicmd:: log-adjacency-changes
.. clicmd:: no log-adjacency-changes
Log changes in adjacency state.
.. clicmd:: metric-style [narrow | transition | wide]
.. clicmd:: no metric-style
Set old-style (ISO 10589) or new-style packet formats:
- narrow
@ -95,17 +81,13 @@ writing, *isisd* does not support multiple ISIS processes.
.. clicmd:: set-overload-bit
.. clicmd:: no set-overload-bit
Set overload bit to avoid any transit traffic.
.. clicmd:: purge-originator
.. clicmd:: no purge-originator
Enable or disable :rfc:`6232` purge originator identification.
.. clicmd:: [no] lsp-mtu (128-4352)
.. clicmd:: lsp-mtu (128-4352)
Configure the maximum size of generated LSPs, in bytes.
@ -115,43 +97,23 @@ writing, *isisd* does not support multiple ISIS processes.
ISIS Timer
==========
.. clicmd:: lsp-gen-interval (1-120)
.. clicmd:: lsp-gen-interval [level-1 | level-2] (1-120)
.. clicmd:: no lsp-gen-interval
.. clicmd:: no lsp-gen-interval [level-1 | level-2]
Set minimum interval in seconds between regenerating same LSP,
globally, for an area (level-1) or a domain (level-2).
.. clicmd:: lsp-refresh-interval [level-1 | level-2] (1-65235)
.. clicmd:: no lsp-refresh-interval [level-1 | level-2]
Set LSP refresh interval in seconds, globally, for an area (level-1) or a
domain (level-2).
.. clicmd:: max-lsp-lifetime (360-65535)
.. clicmd:: max-lsp-lifetime [level-1 | level-2] (360-65535)
.. clicmd:: no max-lsp-lifetime
.. clicmd:: no max-lsp-lifetime [level-1 | level-2]
Set LSP maximum LSP lifetime in seconds, globally, for an area (level-1) or
a domain (level-2).
.. clicmd:: spf-interval (1-120)
.. clicmd:: spf-interval [level-1 | level-2] (1-120)
.. clicmd:: no spf-interval
.. clicmd:: no spf-interval [level-1 | level-2]
Set minimum interval between consecutive SPF calculations in seconds.
.. _isis-fast-reroute:
@ -161,22 +123,17 @@ ISIS Fast-Reroute
.. clicmd:: 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.
.. clicmd:: [no] fast-reroute priority-limit [critical | high | medium] [level-1 | level-2]
.. clicmd:: fast-reroute priority-limit [critical | high | medium] [level-1 | level-2]
Limit LFA backup computation up to the specified prefix priority.
first.
.. clicmd:: [no] fast-reroute load-sharing disable [level-1 | level-2]
.. clicmd:: fast-reroute load-sharing disable [level-1 | level-2]
Disable load sharing across multiple LFA backups.
.. clicmd:: [no] fast-reroute remote-lfa prefix-list [WORD] [level-1 | level-2]
.. clicmd:: fast-reroute remote-lfa prefix-list [WORD] [level-1 | level-2]
Configure a prefix-list to select eligible PQ nodes (valid for all protected
interfaces).
@ -188,8 +145,6 @@ ISIS region
.. clicmd:: is-type [level-1 | level-1-2 | level-2-only]
.. clicmd:: no is-type
Define the ISIS router behavior:
- level-1
@ -206,7 +161,7 @@ ISIS interface
.. _ip-router-isis-word:
.. clicmd:: [no] <ip|ipv6> router isis WORD [vrf NAME]
.. clicmd:: <ip|ipv6> router isis WORD [vrf NAME]
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
@ -215,8 +170,6 @@ ISIS interface
.. clicmd:: isis circuit-type [level-1 | level-1-2 | level-2]
.. clicmd:: no isis circuit-type
Configure circuit type for interface:
- level-1
@ -226,14 +179,8 @@ ISIS interface
- level-2-only
Level-2 only adjacencies are formed
.. clicmd:: isis csnp-interval (1-600)
.. clicmd:: isis csnp-interval (1-600) [level-1 | level-2]
.. clicmd:: no isis csnp-interval
.. clicmd:: no isis csnp-interval [level-1 | level-2]
Set CSNP interval in seconds globally, for an area (level-1) or a domain
(level-2).
@ -241,110 +188,73 @@ ISIS interface
Add padding to IS-IS hello packets.
.. clicmd:: isis hello-interval (1-600)
.. clicmd:: isis hello-interval (1-600) [level-1 | level-2]
.. clicmd:: no isis hello-interval
.. clicmd:: no isis hello-interval [level-1 | level-2]
Set Hello interval in seconds globally, for an area (level-1) or a domain
(level-2).
.. clicmd:: isis hello-multiplier (2-100)
.. clicmd:: isis hello-multiplier (2-100) [level-1 | level-2]
.. clicmd:: no isis hello-multiplier
.. clicmd:: no isis hello-multiplier [level-1 | level-2]
Set multiplier for Hello holding time globally, for an area (level-1) or a
domain (level-2).
.. clicmd:: isis metric [(0-255) | (0-16777215)]
.. clicmd:: isis metric [(0-255) | (0-16777215)] [level-1 | level-2]
.. clicmd:: no isis metric
.. clicmd:: no isis metric [level-1 | level-2]
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
command :clicmd:`metric-style [narrow | transition | wide]`).
.. clicmd:: isis network point-to-point
.. clicmd:: no isis network point-to-point
Set network type to 'Point-to-Point' (broadcast by default).
.. clicmd:: isis passive
.. clicmd:: no isis passive
Configure the passive mode for this interface.
.. clicmd:: isis password [clear | md5] <password>
.. clicmd:: no isis password
Configure the authentication password (clear or encoded text) for the
interface.
.. clicmd:: isis priority (0-127)
.. clicmd:: isis priority (0-127) [level-1 | level-2]
.. clicmd:: no isis priority
.. clicmd:: no isis priority [level-1 | level-2]
Set priority for Designated Router election, globally, for the area
(level-1) or the domain (level-2).
.. clicmd:: isis psnp-interval (1-120)
.. clicmd:: isis psnp-interval (1-120) [level-1 | level-2]
.. clicmd:: no isis psnp-interval
.. clicmd:: no isis psnp-interval [level-1 | level-2]
Set PSNP interval in seconds globally, for an area (level-1) or a domain
(level-2).
.. clicmd:: isis three-way-handshake
.. clicmd:: no isis three-way-handshake
Enable or disable :rfc:`5303` Three-Way Handshake for P2P adjacencies.
Three-Way Handshake is enabled by default.
.. clicmd:: [no] isis fast-reroute lfa [level-1 | level-2]
.. clicmd:: isis fast-reroute lfa [level-1 | level-2]
Enable per-prefix LFA fast reroute link protection.
.. clicmd:: [no] isis fast-reroute lfa [level-1 | level-2] exclude interface IFNAME
.. clicmd:: isis fast-reroute lfa [level-1 | level-2] exclude interface IFNAME
Exclude an interface from the LFA backup nexthop computation.
.. clicmd:: [no] isis fast-reroute ti-lfa [level-1|level-2] [node-protection]
.. clicmd:: isis fast-reroute ti-lfa [level-1|level-2] [node-protection]
Enable per-prefix TI-LFA fast reroute link or node protection.
.. clicmd:: [no] 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]
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
messages in order for RLFA to work.
.. clicmd:: [no] 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]
Limit Remote LFA PQ node selection within the specified metric.
.. _showing-isis-information:
Showing ISIS information
@ -358,37 +268,21 @@ Showing ISIS information
Show information about ISIS node.
.. clicmd:: show isis interface
.. clicmd:: show isis interface detail
.. clicmd:: show isis interface <interface name>
.. clicmd:: show isis interface [detail] [IFNAME]
Show state and configuration of ISIS specified interface, or all interfaces
if no interface is given with or without details.
.. clicmd:: show isis neighbor
.. clicmd:: show isis neighbor <System Id>
.. clicmd:: show isis neighbor detail
.. clicmd:: show isis neighbor [detail] [SYSTEMID]
Show state and information of ISIS specified neighbor, or all neighbors if
no system id is given with or without details.
.. clicmd:: show isis database
.. clicmd:: show isis database [detail]
.. clicmd:: show isis database <LSP id> [detail]
.. clicmd:: show isis database detail <LSP id>
.. clicmd:: show isis database [detail] [LSPID]
Show the ISIS database globally, for a specific LSP id without or with
details.
.. clicmd:: show isis topology
.. clicmd:: show isis topology [level-1|level-2]
Show topology IS-IS paths to Intermediate Systems, globally, in area
@ -404,6 +298,7 @@ Showing ISIS information
Show information about the number of prefixes having LFA protection,
and network-wide LFA coverage.
.. _isis-traffic-engineering:
Traffic Engineering
@ -411,20 +306,16 @@ Traffic Engineering
.. note::
At this time, FRR offers partial support for some of the routing
protocol extensions that can be used with MPLS-TE. FRR does not
support a complete RSVP-TE solution currently.
At this time, FRR offers partial support for some of the routing protocol
extensions that can be used with MPLS-TE. FRR does not currently support a
complete RSVP-TE solution.
.. clicmd:: mpls-te on
.. clicmd:: no mpls-te
Enable Traffic Engineering LSP flooding.
.. clicmd:: mpls-te router-address <A.B.C.D>
.. clicmd:: no mpls-te router-address
Configure stable IP address for MPLS-TE.
.. clicmd:: show isis mpls-te interface
@ -441,6 +332,7 @@ Traffic Engineering
:ref:`ospf-traffic-engineering`
.. _debugging-isis:
Segment Routing
@ -457,29 +349,29 @@ Known limitations:
- No support for SRLB
- Only one SRGB and default SPF Algorithm is supported
.. clicmd:: [no] segment-routing on
.. clicmd:: segment-routing on
Enable Segment Routing.
.. clicmd:: [no] segment-routing global-block (0-1048575) (0-1048575)
.. clicmd:: segment-routing global-block (0-1048575) (0-1048575)
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
may not exceed 65535.
.. clicmd:: [no] segment-routing local-block (0-1048575) (0-1048575)
.. clicmd:: segment-routing local-block (0-1048575) (0-1048575)
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
may not exceed 65535.
.. clicmd:: [no] segment-routing node-msd (1-16)
.. clicmd:: segment-routing node-msd (1-16)
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
is 32.
.. 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]
.. 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]
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'
@ -501,82 +393,55 @@ Debugging ISIS
.. clicmd:: debug isis adj-packets
.. clicmd:: no debug isis adj-packets
IS-IS Adjacency related packets.
.. clicmd:: debug isis checksum-errors
.. clicmd:: no debug isis checksum-errors
IS-IS LSP checksum errors.
.. clicmd:: debug isis events
.. clicmd:: no debug isis events
IS-IS Events.
.. clicmd:: debug isis local-updates
.. clicmd:: no debug isis local-updates
IS-IS local update packets.
.. clicmd:: debug isis packet-dump
.. clicmd:: no debug isis packet-dump
IS-IS packet dump.
.. clicmd:: debug isis protocol-errors
.. clicmd:: no debug isis protocol-errors
IS-IS LSP protocol errors.
.. clicmd:: debug isis route-events
.. clicmd:: no debug isis route-events
IS-IS Route related events.
.. clicmd:: debug isis snp-packets
.. clicmd:: no debug isis snp-packets
IS-IS CSNP/PSNP packets.
.. clicmd:: debug isis spf-events
.. clicmd:: debug isis spf-statistics
.. clicmd:: debug isis spf-triggers
.. clicmd:: no debug isis spf-events
.. clicmd:: no debug isis spf-statistics
.. clicmd:: no debug isis spf-triggers
IS-IS Shortest Path First Events, Timing and Statistic Data and triggering
events.
.. clicmd:: debug isis update-packets
.. clicmd:: no debug isis update-packets
Update related packets.
.. clicmd:: debug isis sr-events
.. clicmd:: no debug isis sr-events
IS-IS Segment Routing events.
.. clicmd:: debug isis lfa
.. clicmd:: no debug isis lfa
IS-IS LFA events.
@ -584,6 +449,8 @@ Debugging ISIS
Print which ISIS debug level is activate.
.. _isis-config-examples:
ISIS Configuration Examples
===========================
@ -695,6 +562,9 @@ A Segment Routing configuration, with IPv4, IPv6, SRGB and MSD configuration.
segment-routing node-msd 8
!
.. _isis-vrf-config-examples:
ISIS Vrf Configuration Examples
===============================
@ -712,5 +582,3 @@ A simple vrf example:
net 47.0023.0000.0000.0000.0000.0000.0000.1900.0004.00
metric-style wide
is-type level-2-only

24
doc/user/ldpd.rst
View File

@ -97,45 +97,45 @@ implementation.
LDP Configuration
===================
.. clicmd:: [no] mpls ldp
.. clicmd:: mpls ldp
Enable or disable LDP daemon
.. clicmd:: [no] router-id A.B.C.D
.. clicmd:: router-id A.B.C.D
The following command located under MPLS router node configures the MPLS
router-id of the local device.
.. clicmd:: [no] ordered-control
.. clicmd:: ordered-control
Configure LDP Ordered Label Distribution Control.
.. clicmd:: [no] address-family [ipv4 | ipv6]
.. clicmd:: address-family [ipv4 | ipv6]
Configure LDP for IPv4 or IPv6 address-family. Located under MPLS route node,
this subnode permits configuring the LDP neighbors.
.. clicmd:: [no] interface IFACE
.. clicmd:: interface IFACE
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
enabled. By default it is disabled. Once this command executed, the
address-family interface node is configured.
.. clicmd:: [no] discovery transport-address A.B.C.D | A:B::C:D
.. clicmd:: discovery transport-address A.B.C.D | A:B::C:D
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
interface.
.. clicmd:: [no] neighbor A.B.C.D password PASSWORD
.. clicmd:: neighbor A.B.C.D password PASSWORD
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
configured password. PASSWORD is a clear text password wit its digest sent
through the network.
.. clicmd:: [no] neighbor A.B.C.D holdtime HOLDTIME
.. clicmd:: neighbor A.B.C.D holdtime 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
@ -143,16 +143,16 @@ LDP Configuration
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.
.. clicmd:: [no] discovery hello holdtime HOLDTIME
.. clicmd:: discovery hello holdtime HOLDTIME
.. clicmd:: [no] discovery hello interval INTERVAL
.. clicmd:: discovery hello interval INTERVAL
INTERVAL value ranges from 1 to 65535 seconds. Default value is 5 seconds.
This is the value between each hello timer message sent.
HOLDTIME value ranges from 1 to 65535 seconds. Default value is 15 seconds.
That value is added as a TLV in the LDP messages.
.. clicmd:: [no] dual-stack transport-connection prefer ipv4
.. clicmd:: dual-stack transport-connection prefer ipv4
When *ldpd* is configured for dual-stack operation, the transport connection
preference is IPv6 by default (as specified by :rfc:`7552`). On such
@ -230,7 +230,7 @@ LDP debugging commands
========================
.. clicmd:: [no] debug mpls ldp KIND
.. clicmd:: debug mpls ldp KIND
Enable or disable debugging messages of a given kind. ``KIND`` can
be one of:

1
doc/user/ospf6d.rst
View File

@ -62,7 +62,6 @@ OSPF6 router
.. clicmd:: auto-cost reference-bandwidth COST
.. clicmd:: no auto-cost reference-bandwidth
This sets the reference bandwidth for cost calculations, where this
bandwidth is considered equivalent to an OSPF cost of 1, specified in

94
doc/user/ospfd.rst
View File

@ -82,13 +82,11 @@ To start OSPF process you have to specify the OSPF router.
.. clicmd:: router ospf [(1-65535)] vrf NAME
.. clicmd:: no router ospf [(1-65535)] vrf NAME
Enable or disable the OSPF process.
.. clicmd:: ospf router-id A.B.C.D
.. clicmd:: no ospf router-id [A.B.C.D]
This sets the router-ID of the OSPF process. The router-ID may be an IP
address of the router, but need not be - it can be any arbitrary 32bit
@ -99,7 +97,6 @@ To start OSPF process you have to specify the OSPF router.
.. clicmd:: ospf abr-type TYPE
.. clicmd:: no ospf abr-type TYPE
`type` can be cisco|ibm|shortcut|standard. The "Cisco" and "IBM" types
are equivalent.
@ -133,7 +130,6 @@ To start OSPF process you have to specify the OSPF router.
.. clicmd:: ospf rfc1583compatibility
.. clicmd:: no ospf rfc1583compatibility
:rfc:`2328`, the successor to :rfc:`1583`, suggests according
to section G.2 (changes) in section 16.4 a change to the path
@ -146,7 +142,6 @@ To start OSPF process you have to specify the OSPF router.
.. clicmd:: log-adjacency-changes [detail]
.. clicmd:: no log-adjacency-changes [detail]
Configures ospfd to log changes in adjacency. With the optional
detail argument, all changes in adjacency status are shown. Without detail,
@ -154,7 +149,6 @@ To start OSPF process you have to specify the OSPF router.
.. clicmd:: passive-interface INTERFACE
.. clicmd:: no passive-interface INTERFACE
Do not speak OSPF interface on the
given interface, but do advertise the interface as a stub link in the
@ -209,7 +203,6 @@ To start OSPF process you have to specify the OSPF router.
.. clicmd:: max-metric router-lsa administrative
.. clicmd:: no max-metric router-lsa [on-startup|on-shutdown|administrative]
This enables :rfc:`3137` support, where the OSPF process describes its
transit links in its router-LSA as having infinite distance so that other
@ -240,7 +233,6 @@ To start OSPF process you have to specify the OSPF router.
.. clicmd:: auto-cost reference-bandwidth (1-4294967)
.. clicmd:: no auto-cost reference-bandwidth
This sets the reference
bandwidth for cost calculations, where this bandwidth is considered
@ -256,9 +248,7 @@ To start OSPF process you have to specify the OSPF router.
.. clicmd:: network A.B.C.D/M area (0-4294967295)
.. clicmd:: no network A.B.C.D/M area A.B.C.D
.. clicmd:: no network A.B.C.D/M area (0-4294967295)
This command specifies the OSPF enabled interface(s). If the interface has
an address from range 192.168.1.0/24 then the command below enables ospf
@ -287,7 +277,6 @@ To start OSPF process you have to specify the OSPF router.
.. clicmd:: proactive-arp
.. clicmd:: no proactive-arp
This command enables or disables sending ARP requests to update neighbor
table entries. It speeds up convergence for /32 networks on a P2P
@ -319,9 +308,7 @@ Areas
.. clicmd:: area (0-4294967295) range A.B.C.D/M
.. clicmd:: no area A.B.C.D range A.B.C.D/M
.. clicmd:: no area (0-4294967295) range A.B.C.D/M
Summarize intra area paths from specified area into one Type-3 summary-LSA
announced to other areas. This command can be used only in ABR and ONLY
@ -343,7 +330,6 @@ Areas
.. clicmd:: area A.B.C.D range IPV4_PREFIX not-advertise
.. clicmd:: no area A.B.C.D range IPV4_PREFIX not-advertise
Instead of summarizing intra area paths filter them - i.e. intra area paths from this
range are not advertised into other areas.
@ -351,7 +337,6 @@ Areas
.. clicmd:: area A.B.C.D range IPV4_PREFIX substitute IPV4_PREFIX
.. clicmd:: no area A.B.C.D range IPV4_PREFIX substitute IPV4_PREFIX
Substitute summarized prefix with another prefix.
@ -372,17 +357,13 @@ Areas
.. clicmd:: area (0-4294967295) virtual-link A.B.C.D
.. clicmd:: no area A.B.C.D virtual-link A.B.C.D
.. clicmd:: no area (0-4294967295) virtual-link A.B.C.D
.. clicmd:: area A.B.C.D shortcut
.. clicmd:: area (0-4294967295) shortcut
.. clicmd:: no area A.B.C.D shortcut
.. clicmd:: no area (0-4294967295) shortcut
Configure the area as Shortcut capable. See :rfc:`3509`. This requires
that the 'abr-type' be set to 'shortcut'.
@ -391,9 +372,7 @@ Areas
.. clicmd:: area (0-4294967295) stub
.. clicmd:: no area A.B.C.D stub
.. clicmd:: no area (0-4294967295) stub
Configure the area to be a stub area. That is, an area where no router
originates routes external to OSPF and hence an area where all external
@ -406,16 +385,13 @@ Areas
.. clicmd:: area (0-4294967295) stub no-summary
.. clicmd:: no area A.B.C.D stub no-summary
.. clicmd:: no area (0-4294967295) stub no-summary
Prevents an *ospfd* ABR from injecting inter-area
summaries into the specified stub area.
.. clicmd:: area A.B.C.D default-cost (0-16777215)
.. clicmd:: no area A.B.C.D default-cost (0-16777215)
Set the cost of default-summary LSAs announced to stubby areas.
@ -423,9 +399,7 @@ Areas
.. clicmd:: area (0-4294967295) export-list NAME
.. clicmd:: no area A.B.C.D export-list NAME
.. clicmd:: no area (0-4294967295) export-list NAME
Filter Type-3 summary-LSAs announced to other areas originated from intra-
area paths from specified area.
@ -452,9 +426,7 @@ Areas
.. clicmd:: area (0-4294967295) import-list NAME
.. clicmd:: no area A.B.C.D import-list NAME
.. clicmd:: no area (0-4294967295) import-list NAME
Same as export-list, but it applies to paths announced into specified area
as Type-3 summary-LSAs.
@ -467,13 +439,9 @@ Areas
.. clicmd:: area (0-4294967295) filter-list prefix NAME out
.. clicmd:: no area A.B.C.D filter-list prefix NAME in
.. clicmd:: no area A.B.C.D filter-list prefix NAME out
.. clicmd:: no area (0-4294967295) filter-list prefix NAME in
.. clicmd:: no area (0-4294967295) filter-list prefix NAME out
Filtering Type-3 summary-LSAs to/from area using prefix lists. This command
makes sense in ABR only.
@ -482,9 +450,7 @@ Areas
.. clicmd:: area (0-4294967295) authentication
.. clicmd:: no area A.B.C.D authentication
.. clicmd:: no area (0-4294967295) authentication
Specify that simple password authentication should be used for the given
area.
@ -508,7 +474,6 @@ Interfaces
.. clicmd:: ip ospf area AREA [ADDR]
.. clicmd:: no ip ospf area [ADDR]
Enable OSPF on the interface, optionally restricted to just the IP address
given by `ADDR`, putting it in the `AREA` area. Per interface area settings
@ -520,7 +485,6 @@ Interfaces
.. clicmd:: ip ospf authentication-key AUTH_KEY
.. clicmd:: no ip ospf authentication-key
Set OSPF authentication key to a simple password. After setting `AUTH_KEY`,
all OSPF packets are authenticated. `AUTH_KEY` has length up to 8 chars.
@ -546,7 +510,6 @@ Interfaces
.. clicmd:: ip ospf message-digest-key KEYID md5 KEY
.. clicmd:: no ip ospf message-digest-key
Set OSPF authentication key to a cryptographic password. The cryptographic
algorithm is MD5.
@ -559,7 +522,6 @@ Interfaces
.. clicmd:: ip ospf cost (1-65535)
.. clicmd:: no ip ospf cost
Set link cost for the specified interface. The cost value is set to
router-LSA's metric field and used for SPF calculation.
@ -568,7 +530,6 @@ Interfaces
.. clicmd:: ip ospf dead-interval minimal hello-multiplier (2-20)
.. clicmd:: no ip ospf dead-interval
Set number of seconds for RouterDeadInterval timer value used for Wait Timer
and Inactivity Timer. This value must be the same for all routers attached
@ -585,7 +546,6 @@ Interfaces
.. clicmd:: ip ospf hello-interval (1-65535)
.. clicmd:: no ip ospf hello-interval
Set number of seconds for HelloInterval timer value. Setting this value,
Hello packet will be sent every timer value seconds on the specified interface.
@ -604,13 +564,11 @@ Interfaces
net.ipv4.conf.<interface name>.rp_filter value to 0. In order for
the ospf multicast packets to be delivered by the kernel.
.. clicmd:: no ip ospf network
Set explicitly network type for specified interface.
.. clicmd:: ip ospf priority (0-255)
.. clicmd:: no ip ospf priority
Set RouterPriority integer value. The router with the highest priority will
be more eligible to become Designated Router. Setting the value to 0, makes
@ -618,7 +576,6 @@ Interfaces
.. clicmd:: ip ospf retransmit-interval (1-65535)
.. clicmd:: no ip ospf retransmit interval
Set number of seconds for RxmtInterval timer value. This value is used when
retransmitting Database Description and Link State Request packets. The
@ -626,14 +583,12 @@ Interfaces
.. clicmd:: ip ospf transmit-delay (1-65535) [A.B.C.D]
.. clicmd:: no ip ospf transmit-delay [(1-65535)] [A.B.C.D]
Set number of seconds for InfTransDelay value. LSAs' age should be
incremented by this value when transmitting. The default value is 1 second.
.. clicmd:: ip ospf area (A.B.C.D|(0-4294967295))
.. clicmd:: no ip ospf area
Enable ospf on an interface and set associated area.
@ -691,7 +646,6 @@ Redistribution
.. clicmd:: default-information originate always metric (0-16777214) metric-type (1|2) route-map WORD
.. clicmd:: no default-information originate
Originate an AS-External (type-5) LSA describing a default route into all
external-routing capable areas, of the specified metric and metric type. If
@ -700,7 +654,6 @@ Redistribution
.. clicmd:: distribute-list NAME out (kernel|connected|static|rip|ospf
.. clicmd:: no distribute-list NAME out (kernel|connected|static|rip|ospf
.. _ospf-distribute-list:
@ -710,15 +663,12 @@ Redistribution
.. clicmd:: default-metric (0-16777214)
.. clicmd:: no default-metric
.. clicmd:: distance (1-255)
.. clicmd:: no distance (1-255)
.. clicmd:: distance ospf (intra-area|inter-area|external) (1-255)
.. clicmd:: no distance ospf
Graceful Restart Helper
@ -726,7 +676,6 @@ Graceful Restart Helper
.. clicmd:: graceful-restart helper-only [A.B.C.D]
.. clicmd:: no graceful-restart helper-only [A.B.C.D]
Configure Graceful Restart (RFC 3623) helper support.
By default, helper support is disabled for all neighbours.
@ -737,7 +686,6 @@ Graceful Restart Helper
.. clicmd:: graceful-restart helper strict-lsa-checking
.. clicmd:: no graceful-restart helper strict-lsa-checking
If 'strict-lsa-checking' is configured then the helper will
abort the Graceful Restart when a LSA change occurs which
@ -746,13 +694,11 @@ Graceful Restart Helper
.. clicmd:: graceful-restart helper supported-grace-time
.. clicmd:: no graceful-restart helper supported-grace-time
Supports as HELPER for configured grace period.
.. clicmd:: graceful-restart helper planned-only
.. clicmd:: no graceful-restart helper planned-only
It helps to support as HELPER only for planned
restarts. By default, it supports both planned and
@ -824,9 +770,7 @@ Opaque LSA
.. clicmd:: capability opaque
.. clicmd:: no ospf opaque-lsa
.. clicmd:: no capability opaque
*ospfd* supports Opaque LSA (:rfc:`2370`) as partial support for
MPLS Traffic Engineering LSAs. The opaque-lsa capability must be
@ -863,7 +807,6 @@ Traffic Engineering
.. clicmd:: mpls-te on
.. clicmd:: no mpls-te
Enable Traffic Engineering LSA flooding.
@ -874,7 +817,6 @@ Traffic Engineering
.. clicmd:: mpls-te inter-as area <area-id>|as
.. clicmd:: no mpls-te inter-as
Enable :rfc:`5392` support - Inter-AS TE v2 - to flood Traffic Engineering
parameters of Inter-AS link. 2 modes are supported: AREA and AS; LSA are
@ -898,7 +840,6 @@ Router Information
.. clicmd:: router-info [as | area]
.. clicmd:: no router-info
Enable Router Information (:rfc:`4970`) LSA advertisement with AS scope
(default) or Area scope flooding when area is specified. Old syntax
@ -908,23 +849,18 @@ Router Information
.. clicmd:: pce address <A.B.C.D>
.. clicmd:: no pce address
.. clicmd:: pce domain as (0-65535)
.. clicmd:: no pce domain as (0-65535)
.. clicmd:: pce neighbor as (0-65535)
.. clicmd:: no pce neighbor as (0-65535)
.. clicmd:: pce flag BITPATTERN
.. clicmd:: no pce flag
.. clicmd:: pce scope BITPATTERN
.. clicmd:: no pce scope
The commands are conform to :rfc:`5088` and allow OSPF router announce Path
Computation Element (PCE) capabilities through the Router Information (RI)
@ -950,28 +886,28 @@ Segment Routing
This is an EXPERIMENTAL support of Segment Routing as per `RFC 8665` for MPLS
dataplane.
.. clicmd:: [no] segment-routing on
.. clicmd:: segment-routing on
Enable Segment Routing. Even if this also activate routing information
support, it is preferable to also activate routing information, and set
accordingly the Area or AS flooding.
.. clicmd:: [no] segment-routing global-block (0-1048575) (0-1048575)
.. clicmd:: segment-routing global-block (0-1048575) (0-1048575)
Fix the Segment Routing Global Block i.e. the label range used by MPLS to
store label in the MPLS FIB for Prefix SID.
.. clicmd:: [no] segment-routing local-block (0-1048575) (0-1048575)
.. clicmd:: segment-routing local-block (0-1048575) (0-1048575)
Fix the Segment Routing Local Block i.e. the label range used by MPLS to
store label in the MPLS FIB for Adjacency SID.
.. clicmd:: [no] segment-routing node-msd (1-16)
.. clicmd:: segment-routing node-msd (1-16)
Fix the Maximum Stack Depth supported by the router. The value depend of the
MPLS dataplane. E.g. for Linux kernel, since version 4.13 it is 32.
.. clicmd:: [no] segment-routing prefix A.B.C.D/M [index (0-65535)|no-php-flag|explicit-null]
.. clicmd:: segment-routing prefix A.B.C.D/M [index (0-65535)|no-php-flag|explicit-null]
prefix with /32 corresponding to a loopback interface are currently
supported. The 'no-php-flag' means NO Penultimate Hop Popping that allows SR
@ -990,13 +926,13 @@ External Route Summarisation
This feature summarises originated external LSAs(Type-5 and Type-7).
Summary Route will be originated on-behalf of all matched external LSAs.
.. clicmd:: [no] summary-address A.B.C.D/M [tag (1-4294967295)]
.. clicmd:: summary-address A.B.C.D/M [tag (1-4294967295)]
This command enable/disables summarisation for the configured address
range. Tag is the optional parameter. If tag configured Summary route
will be originated with the configured tag.
.. clicmd:: [no] summary-address A.B.C.D/M no-advertise
.. clicmd:: summary-address A.B.C.D/M no-advertise
This command to ensure not advertise the summary lsa for the matched
external LSAs.
@ -1006,7 +942,6 @@ Summary Route will be originated on-behalf of all matched external LSAs.
Configure aggregation delay timer interval. Summarisation starts only after
this delay timer expiry. By default, delay interval is 5 secs.
.. clicmd:: no aggregation timer
Resetting the aggregation delay interval to default value.
@ -1033,7 +968,6 @@ Debugging OSPF
.. clicmd:: debug ospf packet (hello|dd|ls-request|ls-update|ls-ack|all) (send|recv) [detail]
.. clicmd:: no debug ospf packet (hello|dd|ls-request|ls-update|ls-ack|all) (send|recv) [detail]
Dump Packet for debugging
@ -1041,9 +975,7 @@ Debugging OSPF
.. clicmd:: debug ospf ism (status|events|timers)
.. clicmd:: no debug ospf ism
.. clicmd:: no debug ospf ism (status|events|timers)
Show debug information of Interface State Machine
@ -1051,21 +983,17 @@ Debugging OSPF
.. clicmd:: debug ospf nsm (status|events|timers)
.. clicmd:: no debug ospf nsm
.. clicmd:: no debug ospf nsm (status|events|timers)
Show debug information of Network State Machine
.. clicmd:: debug ospf event
.. clicmd:: no debug ospf event
Show debug information of OSPF event
.. clicmd:: debug ospf nssa
.. clicmd:: no debug ospf nssa
Show debug information about Not So Stub Area
@ -1073,15 +1001,12 @@ Debugging OSPF
.. clicmd:: debug ospf lsa (generate|flooding|refresh)
.. clicmd:: no debug ospf lsa
.. clicmd:: no debug ospf lsa (generate|flooding|refresh)
Show debug detail of Link State messages
.. clicmd:: debug ospf te
.. clicmd:: no debug ospf te
Show debug information about Traffic Engineering LSA
@ -1089,21 +1014,18 @@ Debugging OSPF
.. clicmd:: debug ospf zebra (interface|redistribute)
.. clicmd:: no debug ospf zebra
.. clicmd:: no debug ospf zebra (interface|redistribute)
Show debug information of ZEBRA API
.. clicmd:: debug ospf graceful-restart helper
.. clicmd:: no debug ospf graceful-restart helper
Enable/disable debug information for OSPF Graceful Restart Helper
.. clicmd:: show debugging ospf
.. clicmd:: [no] debug ospf lsa aggregate
.. clicmd:: debug ospf lsa aggregate
Debug commnd to enable/disable external route summarisation specific debugs.

26
doc/user/pathd.rst
View File

@ -113,7 +113,7 @@ Configuration Commands
Configure segment routing traffic engineering.
.. clicmd:: [no] segment-list NAME
.. clicmd:: segment-list NAME
Delete or start a segment list definition.
@ -122,7 +122,7 @@ Configuration Commands
Delete or specify a segment in a segment list definition.
.. clicmd:: [no] policy color COLOR endpoint ENDPOINT
.. clicmd:: policy color COLOR endpoint ENDPOINT
Delete or start a policy definition.
@ -137,27 +137,27 @@ Configuration Commands
Specify the policy SID.
.. clicmd:: [no] 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
Delete or define an explicit candidate path.
.. clicmd:: [no] candidate-path preference PREFERENCE name NAME dynamic
.. clicmd:: candidate-path preference PREFERENCE name NAME dynamic
Delete or start a dynamic candidate path definition.
.. clicmd:: [no] affinity {exclude-any|include-any|include-all} BITPATTERN
.. clicmd:: affinity {exclude-any|include-any|include-all} BITPATTERN
Delete or specify an affinity constraint for a dynamic candidate path.
.. clicmd:: [no] bandwidth BANDWIDTH [required]
.. clicmd:: bandwidth BANDWIDTH [required]
Delete or specify a bandwidth constraint for a dynamic candidate path.
.. clicmd:: [no] metric [bound] METRIC VALUE [required]
.. clicmd:: metric [bound] METRIC VALUE [required]
Delete or specify a metric constraint for a dynamic candidate path.
@ -185,7 +185,7 @@ Configuration Commands
- bnc: Border Node Count metric
.. clicmd:: [no] objective-function OBJFUN1 [required]
.. clicmd:: objective-function OBJFUN1 [required]
Delete or specify a PCEP objective function constraint for a dynamic
candidate path.
@ -210,7 +210,7 @@ Configuration Commands
- msn: Minimize the number of Shared Nodes [RFC8800]
.. clicmd:: [no] debug pathd pcep [basic|path|message|pceplib]
.. clicmd:: debug pathd pcep [basic|path|message|pceplib]
Enable or disable debugging for the pcep module:
@ -225,13 +225,13 @@ Configuration Commands
Configure PCEP support.
.. clicmd:: [no] pce-config NAME
.. clicmd:: pce-config NAME
Define a shared PCE configuration that can be used in multiple PCE
declarations.
.. clicmd:: [no] pce NAME
.. clicmd:: pce NAME
Define or delete a PCE definition.
@ -296,7 +296,7 @@ Configuration Commands
configuration group.
.. clicmd:: [no] pcc
.. clicmd:: pcc
Disable or start the definition of a PCC.
@ -306,7 +306,7 @@ Configuration Commands
Specify the maximum SID depth in a PCC definition.
.. clicmd:: [no] peer WORD [precedence (1-255)]
.. clicmd:: peer WORD [precedence (1-255)]
Specify a peer and its precedence in a PCC definition.

2
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
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
nexthop-group tables. Existing tables will not be modified to fit in this

13
doc/user/pim.rst
View File

@ -154,16 +154,16 @@ Certain signals have special meanings to *pimd*.
urib-only
Lookup in the Unicast Rib only.
.. clicmd:: [no] ip msdp mesh-group [WORD]
.. clicmd:: ip msdp mesh-group [WORD]
Create or Delete a multicast source discovery protocol mesh-group using
[WORD] as the group name.
.. clicmd:: [no] ip msdp mesh-group WORD member A.B.C.D
.. clicmd:: ip msdp mesh-group WORD member A.B.C.D
Attach or Delete A.B.C.D to the MSDP mesh group WORD specified.
.. clicmd:: [no] ip msdp mesh-group WORD source A.B.C.D
.. clicmd:: 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
mesh group packets being sent.
@ -174,7 +174,7 @@ Certain signals have special meanings to *pimd*.
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.
.. clicmd:: [no] ip igmp watermark-warn (10-60000)
.. clicmd:: ip igmp watermark-warn (10-60000)
Configure watermark warning generation for an igmp group limit. Generates
warning once the configured group limit is reached while adding new groups.
@ -224,7 +224,7 @@ 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
management.
.. clicmd:: [no] ip pim use-source A.B.C.D
.. clicmd:: ip pim use-source A.B.C.D
If you have multiple addresses configured on a particular interface
and would like pim to use a specific source address associated with
@ -321,15 +321,12 @@ Multicast Source Discovery Protocol (MSDP) Configuration
Establish a MSDP connection with a peer.
.. clicmd:: no ip msdp mesh-group [WORD] member A.B.C.D
Remove a MSDP peer member from a MSDP mesh-group.
.. clicmd:: no ip msdp mesh-group [WORD] source A.B.C.D
Delete a MSDP mesh-group.
.. clicmd:: no ip msdp peer A.B.C.D
Delete a MSDP peer connection.

23
doc/user/ripd.rst
View File

@ -93,13 +93,11 @@ RIP Configuration
`no router rip` command. RIP must be enabled before carrying out any of the
RIP commands.
.. clicmd:: no router rip
Disable RIP.
.. clicmd:: network NETWORK
.. clicmd:: no network NETWORK
Set the RIP enable interface by NETWORK. The interfaces which have addresses
matching with NETWORK are enabled.
@ -112,7 +110,6 @@ RIP Configuration
.. clicmd:: network IFNAME
.. clicmd:: no network IFNAME
Set a RIP enabled interface by IFNAME. Both the sending and
receiving of RIP packets will be enabled on the port specified in the
@ -121,7 +118,6 @@ RIP Configuration
.. clicmd:: neighbor A.B.C.D
.. clicmd:: no neighbor A.B.C.D
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
@ -146,7 +142,6 @@ RIP Configuration
.. clicmd:: passive-interface (IFNAME|default)
.. clicmd:: no passive-interface IFNAME
This command sets the specified interface to passive mode. On passive mode
interface, all receiving packets are processed as normal and ripd does not
@ -158,7 +153,6 @@ RIP Configuration
.. clicmd:: ip split-horizon
.. clicmd:: no ip split-horizon
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
@ -190,10 +184,6 @@ discussion on the security implications of RIPv1 see :ref:`rip-authentication`.
Default: Send Version 2, and accept either version.
.. clicmd:: no version
Reset the global version setting back to the default.
.. clicmd:: ip rip send version VERSION
VERSION can be ``1``, ``2``, or ``1 2``.
@ -232,7 +222,6 @@ If you want to specify RIP only static routes:
.. clicmd:: 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
only inside RIP. This command should be used only by advanced users who are
@ -290,7 +279,6 @@ received. Redistributed routes' metric is set to 1.
.. clicmd:: default-metric (1-16)
.. clicmd:: no default-metric (1-16)
This command modifies the default metric value for redistributed routes.
The default value is 1. This command does not affect connected route even if
@ -312,20 +300,17 @@ Distance value is used in zebra daemon. Default RIP distance is 120.
.. clicmd:: distance (1-255)
.. clicmd:: no distance (1-255)
Set default RIP distance to specified value.
.. clicmd:: 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
address matches the specified prefix.
.. clicmd:: 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
address matches the specified prefix and the specified access-list.
@ -427,26 +412,22 @@ To prevent such unauthenticated querying of routes disable RIPv1,
.. clicmd:: ip rip authentication mode md5
.. clicmd:: no ip rip authentication mode md5
Set the interface with RIPv2 MD5 authentication.
.. clicmd:: ip rip authentication mode text
.. clicmd:: no ip rip authentication mode text
Set the interface with RIPv2 simple password authentication.
.. clicmd:: ip rip authentication string STRING
.. clicmd:: no ip rip authentication string STRING
RIP version 2 has simple text authentication. This command sets
authentication string. The string must be shorter than 16 characters.
.. clicmd:: ip rip authentication key-chain KEY-CHAIN
.. clicmd:: no ip rip authentication key-chain KEY-CHAIN
Specify Keyed MD5 chain.
@ -490,10 +471,6 @@ RIP Timers
The ``timers basic`` command allows the the default values of the timers
listed above to be changed.
.. clicmd:: no timers basic
The `no timers basic` command will reset the timers to the default settings
listed above.
.. _show-rip-information:

10
doc/user/routemap.rst
View File

@ -257,7 +257,7 @@ Route Map Set Command
Subtract the BGP local preference from an existing `local_pref`.
.. clicmd:: [no] set distance DISTANCE
.. clicmd:: set distance DISTANCE
Set the Administrative distance to DISTANCE to use for the route.
This is only locally significant and will not be dispersed to peers.
@ -266,7 +266,7 @@ Route Map Set Command
Set the route's weight.
.. clicmd:: [no] set metric <[+|-](1-4294967295)|rtt|+rtt|-rtt>
.. clicmd:: set metric <[+|-](1-4294967295)|rtt|+rtt|-rtt>
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
@ -298,6 +298,7 @@ Route Map Set Command
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.
.. _route-map-call-command:
Route Map Call Command
@ -308,6 +309,7 @@ Route Map Call Command
Call route-map `name`. If it returns deny, deny the route and
finish processing the route-map.
.. _route-map-exit-action-command:
Route Map Exit Action Command
@ -325,6 +327,7 @@ Route Map Exit Action Command
Proceed processing the route-map at the first entry whose order is >= N
.. _route-map-optimization-command:
Route Map Optimization Command
@ -341,9 +344,6 @@ Route Map Optimization Command
of all the prefixes in all the prefix-lists that are included in the
match rule of all the sequences of a route-map.
.. clicmd:: no route-map optimization
Disable the route-map processing optimization.
Route Map Examples
==================

4
doc/user/rpki.rst
View File

@ -101,7 +101,6 @@ The following commands are independent of a specific cache server.
.. clicmd:: rpki polling_period (1-3600)
.. clicmd:: no rpki polling_period
Set the number of seconds the router waits until the router asks the cache
again for updated data.
@ -112,7 +111,6 @@ The following commands are independent of a specific cache server.
.. clicmd:: rpki cache (A.B.C.D|WORD) PORT [SSH_USERNAME] [SSH_PRIVKEY_PATH] [SSH_PUBKEY_PATH] [KNOWN_HOSTS_PATH] 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
and cache server is based on plain TCP. Protecting the connection between
@ -150,7 +148,6 @@ Validating BGP Updates
.. clicmd:: 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
state.
@ -181,7 +178,6 @@ Debugging
.. clicmd:: debug rpki
.. clicmd:: no debug rpki
Enable or disable debugging output for RPKI.

2
doc/user/sharp.rst
View File

@ -67,7 +67,7 @@ keyword. At present, no sharp commands will be preserved in the config.
Install a label into the kernel that causes the specified vrf NAME table to
be used for pop and forward operations when the specified label is seen.
.. clicmd:: [no] sharp watch <nexthop <A.B.C.D|X:X::X:X>|import <A.B.C.D/M:X:X::X:X/M> [connected]
.. clicmd:: sharp watch <nexthop <A.B.C.D|X:X::X:X>|import <A.B.C.D/M:X:X::X:X/M> [connected]
Instruct zebra to monitor and notify sharp when the specified nexthop is
changed. The notification from zebra is written into the debug log.

1
doc/user/snmp.rst
View File

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

10
doc/user/vnc.rst
View File

@ -147,11 +147,7 @@ Defaults section.
exit-vnc
.. 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:
.. clicmd:: l2rd NVE-ID-VALUE
@ -307,7 +303,6 @@ L2 Group Configuration.
exit-vnc
.. clicmd:: no vnc l2-group NAME
Delete the L2 group named `name`.
@ -320,7 +315,6 @@ The following statements are valid in a L2 group definition:
.. clicmd:: labels LABEL-LIST
.. clicmd:: no labels LABEL-LIST
Add or remove labels associated with the group. `label-list` is a
space separated list of label values in the range of 0-1048575.
@ -466,7 +460,6 @@ Redistribution Command Syntax
.. clicmd:: vnc redistribute ipv4|ipv6 bgp-direct-to-nve-groups view VIEWNAME
.. 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
both the address family to import (`ipv4` or `ipv6`) and the protocol
@ -484,7 +477,6 @@ Redistribution Command Syntax
.. clicmd:: 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
`group-name` to routes redistributed from another routing protocol.

20
doc/user/vrrp.rst
View File

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

3
doc/user/vtysh.rst
View File

@ -51,7 +51,7 @@ and the :clicmd:`terminal paginate` command:
This variable should be set by the user according to their preferences,
in their :file:`~/.profile` file.
.. clicmd:: [no] terminal paginate
.. clicmd:: terminal paginate
Enables/disables vtysh output pagination. This command is intended to
be placed in :file:`vtysh.conf` to set a system-wide default. If this
@ -161,7 +161,6 @@ in whose file the error is made.
.. clicmd:: service integrated-vtysh-config
.. clicmd:: no service integrated-vtysh-config
Control whether integrated :file:`frr.conf` file is written when
'write file' is issued.

2
doc/user/watchfrr.rst
View File

@ -21,7 +21,7 @@ WATCHFRR commands
Give status information about the state of the different daemons being
watched by WATCHFRR
.. clicmd:: [no] watchfrr ignore DAEMON
.. clicmd:: watchfrr ignore DAEMON
Tell WATCHFRR to ignore a particular DAEMON if it goes unresponsive.
This is particularly useful when you are a developer and need to debug

49
doc/user/zebra.rst
View File

@ -124,7 +124,6 @@ Standard Commands
.. clicmd:: shutdown
.. clicmd:: no shutdown
Up or down the current interface.
@ -133,16 +132,13 @@ Standard Commands
.. clicmd:: ipv6 address ADDRESS/PREFIX
.. clicmd:: no ip address ADDRESS/PREFIX
.. clicmd:: no ipv6 address ADDRESS/PREFIX
Set the IPv4 or IPv6 address/prefix for the interface.
.. clicmd:: 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
PtP addressing does not exist for IPv6.)
@ -160,14 +156,12 @@ Standard Commands
.. clicmd:: multicast
.. clicmd:: no multicast
Enable or disables multicast flag for the interface.
.. clicmd:: bandwidth (1-10000000)
.. clicmd:: no bandwidth (1-10000000)
Set bandwidth value of the interface in kilobits/sec. This is for
calculating OSPF cost. This command does not affect the actual device
@ -176,7 +170,6 @@ Standard Commands
.. clicmd:: link-detect
.. clicmd:: no link-detect
Enable/disable link-detect on platforms which support this. Currently only
Linux, and only where network interface drivers support reporting
@ -197,7 +190,6 @@ Link Parameters Commands
.. clicmd:: link-params
.. clicmd:: no link-param
Enter into the link parameters sub node. At least 'enable' must be
set to activate the link parameters, and consequently routing
@ -497,7 +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
in routing entry, and can be configured like a route:
.. clicmd:: [no] ip route NETWORK MASK GATEWAY|INTERFACE label LABEL
.. clicmd:: ip route NETWORK MASK GATEWAY|INTERFACE label LABEL
NETWORK and MASK stand for the IP prefix entry to be added as static
route entry.
@ -527,7 +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
termination of the MPLS traffic; this is used to remove MPLS header.
.. clicmd:: [no] mpls lsp INCOMING_LABEL GATEWAY OUTGOING_LABEL|explicit-null|implicit-null
.. clicmd:: mpls lsp INCOMING_LABEL GATEWAY OUTGOING_LABEL|explicit-null|implicit-null
INCOMING_LABEL and OUTGOING_LABEL are MPLS labels with values ranging from 16
to 1048575.
@ -575,7 +567,6 @@ unicast topology!
.. clicmd:: 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:
@ -635,7 +626,6 @@ unicast topology!
.. clicmd:: 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
``ip route`` command, except that it inserts the route in the Multicast RIB
@ -717,7 +707,7 @@ IPv6 example for OSPFv3.
not created at startup. On Debian, FRR might start before ifupdown
completes. Consider a reboot test.
.. clicmd:: [no] zebra route-map delay-timer (0-600)
.. clicmd:: zebra route-map delay-timer (0-600)
Set the delay before any route-maps are processed in zebra. The
default time for this is 5 seconds.
@ -793,15 +783,8 @@ FPM Commands
.. clicmd:: fpm connection ip A.B.C.D port (1-65535)
Configure ``zebra`` to connect to a different FPM server than
``127.0.0.1`` port ``2620``.
.. 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``.
Configure ``zebra`` to connect to a different FPM server than the default of
``127.0.0.1:2060``
.. clicmd:: show zebra fpm stats
@ -852,24 +835,16 @@ FPM Commands
Configures the FPM server address. Once configured ``zebra`` will attempt
to connect to it immediately.
.. 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.
The ``no`` form disables FPM entirely. ``zebra`` will close any current
connections and will not attempt to connect to it anymore.
.. clicmd:: fpm use-next-hop-groups
Use the new netlink messages ``RTM_NEWNEXTHOP`` / ``RTM_DELNEXTHOP`` to
group repeated route next hop information.
.. 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.
The ``no` form uses the old known FPM behavior of including next hop
information in the route (e.g. ``RTM_NEWROUTE``) messages.
.. clicmd:: show fpm counters [json]
@ -1019,12 +994,12 @@ Many routing protocols require a router-id to be configured. To have a
consistent router-id across all daemons, the following commands are available
to configure and display the router-id:
.. clicmd:: [no] [ip] router-id A.B.C.D
.. clicmd:: [ip] router-id A.B.C.D
Allow entering of the router-id. This command also works under the
vrf subnode, to allow router-id's per vrf.
.. clicmd:: [no] [ip] router-id A.B.C.D vrf NAME
.. clicmd:: [ip] router-id A.B.C.D vrf NAME
Configure the router-id of this router from the configure NODE.
A show run of this command will display the router-id command
@ -1037,7 +1012,7 @@ to configure and display the router-id:
For protocols requiring an IPv6 router-id, the following commands are available:
.. clicmd:: [no] ipv6 router-id X:X::X:X
.. clicmd:: ipv6 router-id X:X::X:X
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.