+.. _packet-binary-dump-format:
+
Packet Binary Dump Format
=========================
Packet Binary Dump Format
-------------------------
-FRR can dump routing protocol packet into file with a binary format
-(@pxref{Dump BGP packets and table}).
+FRR can dump routing protocol packet into file with a binary format.
It seems to be better that we share the MRT's header format for
backward compatibility with MRT's dump logs. We should also define the
Starting BGP
============
-Default configuration file of *bgpd* is :file:`bgpd.conf`.
-*bgpd* searches the current directory first then
-|INSTALL_PREFIX_ETC|/bgpd.conf. All of bgpd's command must be
-configured in :file:`bgpd.conf`.
+Default configuration file of *bgpd* is :file:`bgpd.conf`. *bgpd* searches the
+current directory first then |INSTALL_PREFIX_ETC|/bgpd.conf. All of bgpd's
+command must be configured in :file:`bgpd.conf`.
-*bgpd* specific invocation options are described below. Common
-options may also be specified (:ref:`Common_Invocation_Options`).
+*bgpd* specific invocation options are described below. Common options may also
+be specified (:ref:`Common_Invocation_Options`).
+.. program:: bgpd
+.. option:: -p <port>
+.. option:: --bgp_port <port>
-*-p `PORT`*
+ Set the bgp protocol's port number.
-*--bgp_port=`PORT`*
- Set the bgp protocol's port number.
+.. option:: -r
+.. option:: --retain
+ When program terminates, retain BGP routes added by zebra.
-*-r*
+.. option:: -l
+.. option:: --listenon
-*--retain*
- When program terminates, retain BGP routes added by zebra.
-
-
-*-l*
-
-*--listenon*
- Specify a specific IP address for bgpd to listen on, rather than its
- default of INADDR_ANY / IN6ADDR_ANY. This can be useful to constrain bgpd
- to an internal address, or to run multiple bgpd processes on one host.
+ Specify a specific IP address for bgpd to listen on, rather than its
+ default of INADDR_ANY / IN6ADDR_ANY. This can be useful to constrain bgpd
+ to an internal address, or to run multiple bgpd processes on one host.
.. _BGP_router:
BGP router
==========
-First of all you must configure BGP router with *router bgp*
-command. To configure BGP router, you need AS number. AS number is an
-identification of autonomous system. BGP protocol uses the AS number
-for detecting whether the BGP connection is internal one or external one.
+First of all you must configure BGP router with *router bgp* command. To
+configure BGP router, you need AS number. AS number is an identification of
+autonomous system. BGP protocol uses the AS number for detecting whether the
+BGP connection is internal one or external one.
.. index:: router bgp ASN
-
.. clicmd:: router bgp ASN
- Enable a BGP protocol process with the specified `asn`. After
- this statement you can input any `BGP Commands`. You can not
- create different BGP process under different `asn` without
- specifying `multiple-instance` (:ref:`Multiple_instance`).
-.. index:: no router bgp ASN
+ Enable a BGP protocol process with the specified ASN. After
+ this statement you can input any `BGP Commands`. You can not
+ create different BGP process under different ASN without
+ specifying `multiple-instance` (:ref:`Multiple_instance`).
+.. index:: no router bgp ASN
.. clicmd:: no router bgp ASN
- Destroy a BGP protocol process with the specified `asn`.
-.. index:: bgp router-id `A.B.C.D`
+ Destroy a BGP protocol process with the specified ASN.
-.. clicmd:: bgp router-id `A.B.C.D`
+.. index:: bgp router-id A.B.C.D
+.. clicmd:: bgp router-id A.B.C.D
- This command specifies the router-ID. If *bgpd* connects to *zebra* it gets
- interface and address information. In that case default router ID value
- is selected as the largest IP Address of the interfaces. When
- `router zebra` is not enabled *bgpd* can't get interface information
- so `router-id` is set to 0.0.0.0. So please set router-id by hand.
+ This command specifies the router-ID. If *bgpd* connects to *zebra* it gets
+ interface and address information. In that case default router ID value is
+ selected as the largest IP Address of the interfaces. When `router zebra` is
+ not enabled *bgpd* can't get interface information so `router-id` is set to
+ 0.0.0.0. So please set router-id by hand.
.. _BGP_distance:
------------
.. index:: distance bgp (1-255) (1-255) (1-255)
-
.. clicmd:: distance bgp (1-255) (1-255) (1-255)
- This command change distance value of BGP. Each argument is distance
- value for external routes, internal routes and local routes.
-
-.. index:: distance (1-255) `A.B.C.D/M`
-
-.. clicmd:: distance (1-255) `A.B.C.D/M`
-
-.. index:: distance (1-255) `A.B.C.D/M` `word`
+ This command change distance value of BGP. Each argument is distance value
+ for external routes, internal routes and local routes.
-.. clicmd:: distance (1-255) `A.B.C.D/M` `word`
+.. index:: distance (1-255) A.B.C.D/M
+.. clicmd:: distance (1-255) A.B.C.D/M
- This command set distance value to
+.. index:: distance (1-255) A.B.C.D/M word
+.. clicmd:: distance (1-255) A.B.C.D/M word
.. _BGP_decision_process:
The decision process FRR BGP uses to select routes is as follows:
+1. Weight check
-*1. Weight check*
- prefer higher local weight routes to lower routes.
+ Prefer higher local weight routes to lower routes.
+2. Local preference check
-*2. Local preference check*
- prefer higher local preference routes to lower.
+ Prefer higher local preference routes to lower.
-*3. Local route check*
- Prefer local routes (statics, aggregates, redistributed) to received routes.
+3. Local route check
+ Prefer local routes (statics, aggregates, redistributed) to received routes.
-*4. AS path length check*
- Prefer shortest hop-count AS_PATHs.
+4. AS path length check
+ Prefer shortest hop-count AS_PATHs.
-*5. Origin check*
- Prefer the lowest origin type route. That is, prefer IGP origin routes to
- EGP, to Incomplete routes.
+5. Origin check
+ Prefer the lowest origin type route. That is, prefer IGP origin routes to
+ EGP, to Incomplete routes.
-*6. MED check*
- Where routes with a MED were received from the same AS,
- prefer the route with the lowest MED. :ref:`BGP_MED`.
+6. MED check
+ Where routes with a MED were received from the same AS, prefer the route
+ with the lowest MED. :ref:`BGP_MED`.
-*7. External check*
- Prefer the route received from an external, eBGP peer
- over routes received from other types of peers.
+7. External check
+ Prefer the route received from an external, eBGP peer over routes received
+ from other types of peers.
-*8. IGP cost check*
- Prefer the route with the lower IGP cost.
+8. IGP cost check
+ Prefer the route with the lower IGP cost.
-*9. Multi-path check*
- If multi-pathing is enabled, then check whether
- the routes not yet distinguished in preference may be considered equal. If
- :ref:`bgp_bestpath_as-path_multipath-relax` is set, all such routes are
- considered equal, otherwise routes received via iBGP with identical AS_PATHs
- or routes received from eBGP neighbours in the same AS are considered equal.
+9. Multi-path check
+ If multi-pathing is enabled, then check whether the routes not yet
+ distinguished in preference may be considered equal. If
+ :ref:`bgp_bestpath_as-path_multipath-relax` is set, all such routes are
+ considered equal, otherwise routes received via iBGP with identical AS_PATHs
+ or routes received from eBGP neighbours in the same AS are considered equal.
-*10 Already-selected external check*
- Where both routes were received from eBGP peers, then prefer the route which
- is already selected. Note that this check is not applied if :ref:`bgp_bestpath_compare-routerid` is configured. This check can prevent some cases
- of oscillation.
+10. Already-selected external check
+ Where both routes were received from eBGP peers, then prefer the route
+ which is already selected. Note that this check is not applied if
+ :ref:`bgp_bestpath_compare-routerid` is configured. This check can prevent
+ some cases of oscillation.
-*11. Router-ID check*
- Prefer the route with the lowest `router-ID`. If the
- route has an `ORIGINATOR_ID` attribute, through iBGP reflection, then that
- router ID is used, otherwise the `router-ID` of the peer the route was
- received from is used.
+11. Router-ID check
+ Prefer the route with the lowest `router-ID`. If the route has an
+ `ORIGINATOR_ID` attribute, through iBGP reflection, then that router ID is
+ used, otherwise the `router-ID` of the peer the route was received from is
+ used.
-*12. Cluster-List length check*
- The route with the shortest cluster-list
- length is used. The cluster-list reflects the iBGP reflection path the
- route has taken.
+12. Cluster-List length check
+ The route with the shortest cluster-list length is used. The cluster-list
+ reflects the iBGP reflection path the route has taken.
-*13. Peer address*
- Prefer the route received from the peer with the higher
- transport layer address, as a last-resort tie-breaker.
+13. Peer address
+
+ Prefer the route received from the peer with the higher
+ transport layer address, as a last-resort tie-breaker.
-.. index:: bgp bestpath as-path confed
+.. index:: bgp bestpath as-path confed
.. clicmd:: bgp bestpath as-path confed
- This command specifies that the length of confederation path sets and
- sequences should should be taken into account during the BGP best path
- decision process.
+ This command specifies that the length of confederation path sets and
+ sequences should should be taken into account during the BGP best path
+ decision process.
+.. _bgp_bestpath_as-path_multipath-relax:
.. index:: bgp bestpath as-path multipath-relax
-
.. clicmd:: bgp bestpath as-path multipath-relax
- .. _bgp_bestpath_as-path_multipath-relax:
-
- This command specifies that BGP decision process should consider paths
- of equal AS_PATH length candidates for multipath computation. Without
- the knob, the entire AS_PATH must match for multipath computation.
-
-.. index:: bgp bestpath compare-routerid
+ This command specifies that BGP decision process should consider paths
+ of equal AS_PATH length candidates for multipath computation. Without
+ the knob, the entire AS_PATH must match for multipath computation.
+.. _bgp_bestpath_compare-routerid:
.. clicmd:: bgp bestpath compare-routerid
- .. _bgp_bestpath_compare-routerid:
-
- Ensure that when comparing routes where both are equal on most metrics,
- including local-pref, AS_PATH length, IGP cost, MED, that the tie is broken
- based on router-ID.
+ Ensure that when comparing routes where both are equal on most metrics,
+ including local-pref, AS_PATH length, IGP cost, MED, that the tie is broken
+ based on router-ID.
- If this option is enabled, then the already-selected check, where
- already selected eBGP routes are preferred, is skipped.
+ If this option is enabled, then the already-selected check, where
+ already selected eBGP routes are preferred, is skipped.
- If a route has an `ORIGINATOR_ID` attribute because it has been reflected,
- that `ORIGINATOR_ID` will be used. Otherwise, the router-ID of the peer the
- route was received from will be used.
+ If a route has an `ORIGINATOR_ID` attribute because it has been reflected,
+ that `ORIGINATOR_ID` will be used. Otherwise, the router-ID of the peer the
+ route was received from will be used.
- The advantage of this is that the route-selection (at this point) will be
- more deterministic. The disadvantage is that a few or even one lowest-ID
- router may attract all trafic to otherwise-equal paths because of this
- check. It may increase the possibility of MED or IGP oscillation, unless
- other measures were taken to avoid these. The exact behaviour will be
- sensitive to the iBGP and reflection topology.
+ The advantage of this is that the route-selection (at this point) will be
+ more deterministic. The disadvantage is that a few or even one lowest-ID
+ router may attract all trafic to otherwise-equal paths because of this
+ check. It may increase the possibility of MED or IGP oscillation, unless
+ other measures were taken to avoid these. The exact behaviour will be
+ sensitive to the iBGP and reflection topology.
.. _BGP_route_flap_dampening:
BGP route flap dampening
------------------------
-.. index:: bgp dampening `(1-45)` `(1-20000)` `(1-20000)` `(1-255)`
+.. clicmd:: bgp dampening (1-45) (1-20000) (1-20000) (1-255)
+
-.. clicmd:: bgp dampening `(1-45)` `(1-20000)` `(1-20000)` `(1-255)`
+ This command enables BGP route-flap dampening and specifies dampening parameters.
- This command enables BGP route-flap dampening and specifies dampening parameters.
+ half-life
+ Half-life time for the penalty
-*@asis{half-life}*
- Half-life time for the penalty
+ reuse-threshold
+ Value to start reusing a route
-*@asis{reuse-threshold}*
- Value to start reusing a route
+ suppress-threshold
+ Value to start suppressing a route
-*@asis{suppress-threshold}*
- Value to start suppressing a route
+ max-suppress
+ Maximum duration to suppress a stable route
-*@asis{max-suppress}*
- Maximum duration to suppress a stable route
+ The route-flap damping algorithm is compatible with :rfc:`2439`. The use of
+ this command is not recommended nowadays.
- The route-flap damping algorithm is compatible with :rfc:`2439`. The use of this command
- is not recommended nowadays, see http://www.ripe.net/ripe/docs/ripe-378,,RIPE-378 <http://www.ripe.net/ripe/docs/ripe-378,,RIPE-378>.
+.. seealso::
+
+ `http://www.ripe.net/ripe/docs/ripe-378,,RIPE-378 <http://www.ripe.net/ripe/docs/ripe-378,,RIPE-378>`_
.. _BGP_MED:
BGP MED
=======
-The BGP :abbr:`MED (Multi Exit Discriminator)` attribute has properties which can
-cause subtle convergence problems in BGP. These properties and problems
-have proven to be hard to understand, at least historically, and may still
-not be widely understood. The following attempts to collect together and
-present what is known about MED, to help operators and FRR users in
-designing and configuring their networks.
+The BGP :abbr:`MED (Multi Exit Discriminator)` attribute has properties which
+can cause subtle convergence problems in BGP. These properties and problems
+have proven to be hard to understand, at least historically, and may still not
+be widely understood. The following attempts to collect together and present
+what is known about MED, to help operators and FRR users in designing and
+configuring their networks.
The BGP :abbr:`MED` attribute is intended to allow one AS to indicate its
preferences for its ingress points to another AS. The MED attribute will not be
propagated on to another AS by the receiving AS - it is 'non-transitive' in the
BGP sense.
-E.g., if AS X and AS Y have 2 different BGP peering points, then AS X
-might set a MED of 100 on routes advertised at one and a MED of 200 at the
-other. When AS Y selects between otherwise equal routes to or via
-AS X, AS Y should prefer to take the path via the lower MED peering of 100 with
-AS X. Setting the MED allows an AS to influence the routing taken to it
-within another, neighbouring AS.
+E.g., if AS X and AS Y have 2 different BGP peering points, then AS X might set
+a MED of 100 on routes advertised at one and a MED of 200 at the other. When AS
+Y selects between otherwise equal routes to or via AS X, AS Y should prefer to
+take the path via the lower MED peering of 100 with AS X. Setting the MED
+allows an AS to influence the routing taken to it within another, neighbouring
+AS.
In this use of MED it is not really meaningful to compare the MED value on
-routes where the next AS on the paths differs. E.g., if AS Y also had a
-route for some destination via AS Z in addition to the routes from AS X, and
-AS Z had also set a MED, it wouldn't make sense for AS Y to compare AS Z's
-MED values to those of AS X. The MED values have been set by different
-administrators, with different frames of reference.
+routes where the next AS on the paths differs. E.g., if AS Y also had a route
+for some destination via AS Z in addition to the routes from AS X, and AS Z had
+also set a MED, it wouldn't make sense for AS Y to compare AS Z's MED values to
+those of AS X. The MED values have been set by different administrators, with
+different frames of reference.
The default behaviour of BGP therefore is to not compare MED values across
routes received from different neighbouring ASes. In FRR this is done by
-comparing the neighbouring, left-most AS in the received AS_PATHs of the
-routes and only comparing MED if those are the same.
-
-@ifnottex
-@macro mprec{}
-@math{<}
-@end macro
-@end ifnottex
-
-Unfortunately, this behaviour of MED, of sometimes being compared across
-routes and sometimes not, depending on the properties of those other routes,
-means MED can cause the order of preference over all the routes to be
-undefined. That is, given routes A, B, and C, if A is preferred to B, and B
-is preferred to C, then a well-defined order should mean the preference is
-transitive (in the sense of orders @footnote{For some set of objects to have
-an order, there *must* be some binary ordering relation that is defined
-for *every* combination of those objects, and that relation *must*
-be transitive. I.e.@:, if the relation operator is @mprec{}, and if
-a @mprec{} b and b @mprec{} c then that relation must carry over
-and it *must* be that a @mprec{} c for the objects to have an
-order. The ordering relation may allow for equality, i.e.
-a @mprec{} b and b @mprec{} a may both be true amd imply that
-a and b are equal in the order and not distinguished by it, in
-which case the set has a partial order. Otherwise, if there is an order,
-all the objects have a distinct place in the order and the set has a total
-order.}) and that A would be preferred to C.
+comparing the neighbouring, left-most AS in the received AS_PATHs of the routes
+and only comparing MED if those are the same.
+
+Unfortunately, this behaviour of MED, of sometimes being compared across routes
+and sometimes not, depending on the properties of those other routes, means MED
+can cause the order of preference over all the routes to be undefined. That is,
+given routes A, B, and C, if A is preferred to B, and B is preferred to C, then
+a well-defined order should mean the preference is transitive (in the sense of
+orders @footnote{For some set of objects to have an order, there *must* be some
+binary ordering relation that is defined for *every* combination of those
+objects, and that relation *must* be transitive. I.e.@:, if the relation
+operator is <, and if a < b and b < c then that relation
+must carry over and it *must* be that a < c for the objects to have an
+order. The ordering relation may allow for equality, i.e. a < b and b
+< a may both be true amd imply that a and b are equal in the order and
+not distinguished by it, in which case the set has a partial order. Otherwise,
+if there is an order, all the objects have a distinct place in the order and
+the set has a total order) and that A would be preferred to C.
However, when MED is involved this need not be the case. With MED it is
possible that C is actually preferred over A. So A is preferred to B, B is
preferred to C, but C is preferred to A. This can be true even where BGP
-defines a deterministic 'most preferred' route out of the full set of
-A,B,C. With MED, for any given set of routes there may be a
-deterministically preferred route, but there need not be any way to arrange
-them into any order of preference. With unmodified MED, the order of
-preference of routes literally becomes undefined.
+defines a deterministic 'most preferred' route out of the full set of A,B,C.
+With MED, for any given set of routes there may be a deterministically
+preferred route, but there need not be any way to arrange them into any order
+of preference. With unmodified MED, the order of preference of routes literally
+becomes undefined.
That MED can induce non-transitive preferences over routes can cause issues.
-Firstly, it may be perceived to cause routing table churn locally at
-speakers; secondly, and more seriously, it may cause routing instability in
-iBGP topologies, where sets of speakers continually oscillate between
-different paths.
+Firstly, it may be perceived to cause routing table churn locally at speakers;
+secondly, and more seriously, it may cause routing instability in iBGP
+topologies, where sets of speakers continually oscillate between different
+paths.
The first issue arises from how speakers often implement routing decisions.
-Though BGP defines a selection process that will deterministically select
-the same route as best at any given speaker, even with MED, that process
-requires evaluating all routes together. For performance and ease of
-implementation reasons, many implementations evaluate route preferences in a
-pair-wise fashion instead. Given there is no well-defined order when MED is
-involved, the best route that will be chosen becomes subject to
-implementation details, such as the order the routes are stored in. That
-may be (locally) non-deterministic, e.g.@: it may be the order the routes
-were received in.
+Though BGP defines a selection process that will deterministically select the
+same route as best at any given speaker, even with MED, that process requires
+evaluating all routes together. For performance and ease of implementation
+reasons, many implementations evaluate route preferences in a pair-wise fashion
+instead. Given there is no well-defined order when MED is involved, the best
+route that will be chosen becomes subject to implementation details, such as
+the order the routes are stored in. That may be (locally) non-deterministic,
+e.g.: it may be the order the routes were received in.
This indeterminism may be considered undesirable, though it need not cause
-problems. It may mean additional routing churn is perceived, as sometimes
-more updates may be produced than at other times in reaction to some event .
+problems. It may mean additional routing churn is perceived, as sometimes more
+updates may be produced than at other times in reaction to some event .
This first issue can be fixed with a more deterministic route selection that
ensures routes are ordered by the neighbouring AS during selection.
-:ref:`bgp_deterministic-med`. This may reduce the number of updates as
-routes are received, and may in some cases reduce routing churn. Though, it
-could equally deterministically produce the largest possible set of updates
-in response to the most common sequence of received updates.
+:ref:`bgp_deterministic-med`. This may reduce the number of updates as routes
+are received, and may in some cases reduce routing churn. Though, it could
+equally deterministically produce the largest possible set of updates in
+response to the most common sequence of received updates.
A deterministic order of evaluation tends to imply an additional overhead of
sorting over any set of n routes to a destination. The implementation of
deterministic MED in FRR scales significantly worse than most sorting
-algorithms at present, with the number of paths to a given destination.
-That number is often low enough to not cause any issues, but where there are
-many paths, the deterministic comparison may quickly become increasingly
-expensive in terms of CPU.
-
-Deterministic local evaluation can *not* fix the second, more major,
-issue of MED however. Which is that the non-transitive preference of routes
-MED can cause may lead to routing instability or oscillation across multiple
-speakers in iBGP topologies. This can occur with full-mesh iBGP, but is
-particularly problematic in non-full-mesh iBGP topologies that further
-reduce the routing information known to each speaker. This has primarily
-been documented with iBGP route-reflection topologies. However, any
-route-hiding technologies potentially could also exacerbate oscillation with
-MED.
-
-This second issue occurs where speakers each have only a subset of routes,
-and there are cycles in the preferences between different combinations of
-routes - as the undefined order of preference of MED allows - and the routes
-are distributed in a way that causes the BGP speakers to 'chase' those
-cycles. This can occur even if all speakers use a deterministic order of
-evaluation in route selection.
-
-E.g., speaker 4 in AS A might receive a route from speaker 2 in AS X, and
-from speaker 3 in AS Y; while speaker 5 in AS A might receive that route
-from speaker 1 in AS Y. AS Y might set a MED of 200 at speaker 1, and 100
-at speaker 3. I.e, using ASN:ID:MED to label the speakers:
+algorithms at present, with the number of paths to a given destination. That
+number is often low enough to not cause any issues, but where there are many
+paths, the deterministic comparison may quickly become increasingly expensive
+in terms of CPU.
+
+Deterministic local evaluation can *not* fix the second, more major, issue of
+MED however. Which is that the non-transitive preference of routes MED can
+cause may lead to routing instability or oscillation across multiple speakers
+in iBGP topologies. This can occur with full-mesh iBGP, but is particularly
+problematic in non-full-mesh iBGP topologies that further reduce the routing
+information known to each speaker. This has primarily been documented with iBGP
+route-reflection topologies. However, any route-hiding technologies potentially
+could also exacerbate oscillation with MED.
+
+This second issue occurs where speakers each have only a subset of routes, and
+there are cycles in the preferences between different combinations of routes -
+as the undefined order of preference of MED allows - and the routes are
+distributed in a way that causes the BGP speakers to 'chase' those cycles. This
+can occur even if all speakers use a deterministic order of evaluation in route
+selection.
+
+E.g., speaker 4 in AS A might receive a route from speaker 2 in AS X, and from
+speaker 3 in AS Y; while speaker 5 in AS A might receive that route from
+speaker 1 in AS Y. AS Y might set a MED of 200 at speaker 1, and 100 at speaker
+3. I.e, using ASN:ID:MED to label the speakers:
::
- /---------------\\
+ .
+ /---------------\\
X:2------|--A:4-------A:5--|-Y:1:200
- Y:3:100--|-/ |
- \\---------------/
+ Y:3:100--|-/ |
+ \\---------------/
-Assuming all other metrics are equal (AS_PATH, ORIGIN, 0 IGP costs), then
-based on the RFC4271 decision process speaker 4 will choose X:2 over
-Y:3:100, based on the lower ID of 2. Speaker 4 advertises X:2 to speaker 5.
-Speaker 5 will continue to prefer Y:1:200 based on the ID, and advertise
-this to speaker 4. Speaker 4 will now have the full set of routes, and the
-Y:1:200 it receives from 5 will beat X:2, but when speaker 4 compares
-Y:1:200 to Y:3:100 the MED check now becomes active as the ASes match, and
-now Y:3:100 is preferred. Speaker 4 therefore now advertises Y:3:100 to 5,
-which will also agrees that Y:3:100 is preferred to Y:1:200, and so
-withdraws the latter route from 4. Speaker 4 now has only X:2 and Y:3:100,
-and X:2 beats Y:3:100, and so speaker 4 implicitly updates its route to
-speaker 5 to X:2. Speaker 5 sees that Y:1:200 beats X:2 based on the ID,
-and advertises Y:1:200 to speaker 4, and the cycle continues.
+Assuming all other metrics are equal (AS_PATH, ORIGIN, 0 IGP costs), then based
+on the RFC4271 decision process speaker 4 will choose X:2 over Y:3:100, based
+on the lower ID of 2. Speaker 4 advertises X:2 to speaker 5. Speaker 5 will
+continue to prefer Y:1:200 based on the ID, and advertise this to speaker 4.
+Speaker 4 will now have the full set of routes, and the Y:1:200 it receives
+from 5 will beat X:2, but when speaker 4 compares Y:1:200 to Y:3:100 the MED
+check now becomes active as the ASes match, and now Y:3:100 is preferred.
+Speaker 4 therefore now advertises Y:3:100 to 5, which will also agrees that
+Y:3:100 is preferred to Y:1:200, and so withdraws the latter route from 4.
+Speaker 4 now has only X:2 and Y:3:100, and X:2 beats Y:3:100, and so speaker 4
+implicitly updates its route to speaker 5 to X:2. Speaker 5 sees that Y:1:200
+beats X:2 based on the ID, and advertises Y:1:200 to speaker 4, and the cycle
+continues.
The root cause is the lack of a clear order of preference caused by how MED
sometimes is and sometimes is not compared, leading to this cycle in the
::
- /---> X:2 ---beats---> Y:3:100 --\\
- | |
- | |
- \\---beats--- Y:1:200 <---beats---/
+ .
+ /---> X:2 ---beats---> Y:3:100 --\\
+ | |
+ | |
+ \\---beats--- Y:1:200 <---beats---/
This particular type of oscillation in full-mesh iBGP topologies can be
avoided by speakers preferring already selected, external routes rather than
-choosing to update to new a route based on a post-MED metric (e.g.
-router-ID), at the cost of a non-deterministic selection process. FRR
-implements this, as do many other implementations, so long as it is not
-overridden by setting :ref:`bgp_bestpath_compare-routerid`, and see also
-:ref:`BGP_decision_process`, .
+choosing to update to new a route based on a post-MED metric (e.g. router-ID),
+at the cost of a non-deterministic selection process. FRR implements this, as
+do many other implementations, so long as it is not overridden by setting
+:ref:`bgp_bestpath_compare-routerid`, and see also :ref:`BGP_decision_process`,
+.
However, more complex and insidious cycles of oscillation are possible with
iBGP route-reflection, which are not so easily avoided. These have been
-documented in various places. See, e.g., @cite{McPherson, D. and Gill, V.
-and Walton, D., "Border Gateway Protocol (BGP) Persistent Route Oscillation
-Condition", IETF RFC3345}, and @cite{Flavel, A. and M. Roughan, "Stable
-and flexible iBGP", ACM SIGCOMM 2009}, and @cite{Griffin, T. and G. Wilfong,
-"On the correctness of IBGP configuration", ACM SIGCOMM 2002} for concrete
-examples and further references.
-
-There is as of this writing *no* known way to use MED for its original
-purpose; *and* reduce routing information in iBGP topologies;
-*and* be sure to avoid the instability problems of MED due the
-non-transitive routing preferences it can induce; in general on arbitrary
-networks.
-
-There may be iBGP topology specific ways to reduce the instability risks,
-even while using MED, e.g.@: by constraining the reflection topology and by
-tuning IGP costs between route-reflector clusters, see RFC3345 for details.
-In the near future, the Add-Path extension to BGP may also solve MED
-oscillation while still allowing MED to be used as intended, by distributing
-"best-paths per neighbour AS". This would be at the cost of distributing at
-least as many routes to all speakers as a full-mesh iBGP would, if not more,
-while also imposing similar CPU overheads as the "Deterministic MED" feature
-at each Add-Path reflector.
+documented in various places. See, e.g.:
+
+- [bgp-route-osci-cond]_
+- [stable-flexible-ibgp]_
+- [ibgp-correctness]_
+
+for concrete examples and further references.
+
+There is as of this writing *no* known way to use MED for its original purpose;
+*and* reduce routing information in iBGP topologies; *and* be sure to avoid the
+instability problems of MED due the non-transitive routing preferences it can
+induce; in general on arbitrary networks.
+
+There may be iBGP topology specific ways to reduce the instability risks, even
+while using MED, e.g.: by constraining the reflection topology and by tuning
+IGP costs between route-reflector clusters, see RFC3345 for details. In the
+near future, the Add-Path extension to BGP may also solve MED oscillation while
+still allowing MED to be used as intended, by distributing "best-paths per
+neighbour AS". This would be at the cost of distributing at least as many
+routes to all speakers as a full-mesh iBGP would, if not more, while also
+imposing similar CPU overheads as the "Deterministic MED" feature at each
+Add-Path reflector.
More generally, the instability problems that MED can introduce on more
complex, non-full-mesh, iBGP topologies may be avoided either by:
-
-*
- Setting :ref:`bgp_always-compare-med`, however this allows MED to be compared
+- Setting :ref:`bgp_always-compare-med`, however this allows MED to be compared
across values set by different neighbour ASes, which may not produce
coherent desirable results, of itself.
-
-*
- Effectively ignoring MED by setting MED to the same value (e.g.@: 0) using
+- Effectively ignoring MED by setting MED to the same value (e.g.@: 0) using
:ref:`routemap_set_metric` on all received routes, in combination with
setting :ref:`bgp_always-compare-med` on all speakers. This is the simplest
and most performant way to avoid MED oscillation issues, where an AS is happy
not to allow neighbours to inject this problematic metric.
-
As MED is evaluated after the AS_PATH length check, another possible use for
MED is for intra-AS steering of routes with equal AS_PATH length, as an
-extension of the last case above. As MED is evaluated before IGP metric,
-this can allow cold-potato routing to be implemented to send traffic to
-preferred hand-offs with neighbours, rather than the closest hand-off
-according to the IGP metric.
-
-Note that even if action is taken to address the MED non-transitivity
-issues, other oscillations may still be possible. E.g., on IGP cost if
-iBGP and IGP topologies are at cross-purposes with each other - see the
-Flavel and Roughan paper above for an example. Hence the guideline that the
-iBGP topology should follow the IGP topology.
-
+extension of the last case above. As MED is evaluated before IGP metric, this
+can allow cold-potato routing to be implemented to send traffic to preferred
+hand-offs with neighbours, rather than the closest hand-off according to the
+IGP metric.
+
+Note that even if action is taken to address the MED non-transitivity issues,
+other oscillations may still be possible. E.g., on IGP cost if iBGP and IGP
+topologies are at cross-purposes with each other - see the Flavel and Roughan
+paper above for an example. Hence the guideline that the iBGP topology should
+follow the IGP topology.
+
+.. _bgp_deterministic-med:
.. index:: bgp deterministic-med
-
.. clicmd:: bgp deterministic-med
- .. _bgp_deterministic-med:
-
- Carry out route-selection in way that produces deterministic answers
- locally, even in the face of MED and the lack of a well-defined order of
- preference it can induce on routes. Without this option the preferred route
- with MED may be determined largely by the order that routes were received
- in.
+ Carry out route-selection in way that produces deterministic answers
+ locally, even in the face of MED and the lack of a well-defined order of
+ preference it can induce on routes. Without this option the preferred route
+ with MED may be determined largely by the order that routes were received
+ in.
- Setting this option will have a performance cost that may be noticeable when
- there are many routes for each destination. Currently in FRR it is
- implemented in a way that scales poorly as the number of routes per
- destination increases.
+ Setting this option will have a performance cost that may be noticeable when
+ there are many routes for each destination. Currently in FRR it is
+ implemented in a way that scales poorly as the number of routes per
+ destination increases.
- The default is that this option is not set.
+ The default is that this option is not set.
Note that there are other sources of indeterminism in the route selection
process, specifically, the preference for older and already selected routes
from eBGP peers, :ref:`BGP_decision_process`.
.. index:: bgp always-compare-med
-
.. clicmd:: bgp always-compare-med
- .. _bgp_always-compare-med:
+.. _bgp_always-compare-med:
- Always compare the MED on routes, even when they were received from
- different neighbouring ASes. Setting this option makes the order of
- preference of routes more defined, and should eliminate MED induced
- oscillations.
+ Always compare the MED on routes, even when they were received from
+ different neighbouring ASes. Setting this option makes the order of
+ preference of routes more defined, and should eliminate MED induced
+ oscillations.
- If using this option, it may also be desirable to use :ref:`routemap_set_metric` to set MED to 0 on routes received from external neighbours.
+ If using this option, it may also be desirable to use
+ :ref:`routemap_set_metric` to set MED to 0 on routes received from external
+ neighbours.
- This option can be used, together with :ref:`routemap_set_metric` to use MED
- as an intra-AS metric to steer equal-length AS_PATH routes to, e.g., desired
- exit points.
+ This option can be used, together with :ref:`routemap_set_metric` to use MED
+ as an intra-AS metric to steer equal-length AS_PATH routes to, e.g., desired
+ exit points.
.. _BGP_network:
BGP route
---------
-.. index:: network `A.B.C.D/M`
-
-.. clicmd:: network `A.B.C.D/M`
-
- This command adds the announcement network.::
+.. index:: network A.B.C.D/M
+.. clicmd:: network A.B.C.D/M
- router bgp 1
- address-family ipv4 unicast
- network 10.0.0.0/8
- exit-address-family
+ This command adds the announcement network.::
- This configuration example says that network 10.0.0.0/8 will be
- announced to all neighbors. Some vendors' routers don't advertise
- routes if they aren't present in their IGP routing tables; `bgpd`
- doesn't care about IGP routes when announcing its routes.
+ router bgp 1
+ address-family ipv4 unicast
+ network 10.0.0.0/8
+ exit-address-family
-.. index:: no network `A.B.C.D/M`
+ This configuration example says that network 10.0.0.0/8 will be
+ announced to all neighbors. Some vendors' routers don't advertise
+ 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`
+.. index:: no network A.B.C.D/M
+.. clicmd:: no network A.B.C.D/M
.. _Route_Aggregation:
Route Aggregation
-----------------
-.. index:: aggregate-address `A.B.C.D/M`
+.. index:: aggregate-address A.B.C.D/M
+.. clicmd:: aggregate-address A.B.C.D/M
-.. clicmd:: aggregate-address `A.B.C.D/M`
+ This command specifies an aggregate address.
- This command specifies an aggregate address.
+.. index:: aggregate-address A.B.C.D/M as-set
+.. clicmd:: aggregate-address A.B.C.D/M as-set
-.. index:: aggregate-address `A.B.C.D/M` as-set
+ This command specifies an aggregate address. Resulting routes include
+ AS set.
-.. clicmd:: aggregate-address `A.B.C.D/M` as-set
+.. index:: aggregate-address A.B.C.D/M summary-only
+.. clicmd:: aggregate-address A.B.C.D/M summary-only
- This command specifies an aggregate address. Resulting routes include
- AS set.
+ This command specifies an aggregate address. Aggreated routes will
+ not be announce.
-.. index:: aggregate-address `A.B.C.D/M` summary-only
+.. index:: no aggregate-address A.B.C.D/M
+.. clicmd:: no aggregate-address A.B.C.D/M
-.. clicmd:: aggregate-address `A.B.C.D/M` summary-only
-
- This command specifies an aggregate address. Aggreated routes will
- not be announce.
-
-.. index:: no aggregate-address `A.B.C.D/M`
-
-.. clicmd:: no aggregate-address `A.B.C.D/M`
.. _Redistribute_to_BGP:
-------------------
.. index:: redistribute kernel
-
.. clicmd:: redistribute kernel
- Redistribute kernel route to BGP process.
+ Redistribute kernel route to BGP process.
.. index:: redistribute static
-
.. clicmd:: redistribute static
- Redistribute static route to BGP process.
+ Redistribute static route to BGP process.
.. index:: redistribute connected
-
.. clicmd:: redistribute connected
- Redistribute connected route to BGP process.
+ Redistribute connected route to BGP process.
.. index:: redistribute rip
-
.. clicmd:: redistribute rip
- Redistribute RIP route to BGP process.
+ Redistribute RIP route to BGP process.
.. index:: redistribute ospf
-
.. clicmd:: redistribute ospf
- Redistribute OSPF route to BGP process.
+ Redistribute OSPF route to BGP process.
.. index:: redistribute vpn
-
.. clicmd:: redistribute vpn
- Redistribute VNC routes to BGP process.
-
-.. index:: update-delay `max-delay`
+ Redistribute VNC routes to BGP process.
-.. clicmd:: update-delay `max-delay`
+.. index:: update-delay MAX-DELAY
+.. clicmd:: update-delay MAX-DELAY
-.. index:: update-delay `max-delay` `establish-wait`
+.. index:: update-delay MAX-DELAY ESTABLISH-WAIT
+.. clicmd:: update-delay MAX-DELAY ESTABLISH-WAIT
-.. clicmd:: update-delay `max-delay` `establish-wait`
+ This feature is used to enable read-only mode on BGP process restart or when
+ BGP process is cleared using 'clear ip bgp \*'. When applicable, read-only
+ mode would begin as soon as the first peer reaches Established status and a
+ timer for max-delay seconds is started.
- This feature is used to enable read-only mode on BGP process restart or when
- BGP process is cleared using 'clear ip bgp \*'. When applicable, read-only mode
- would begin as soon as the first peer reaches Established status and a timer
- for max-delay seconds is started.
+ During this mode BGP doesn't run any best-path or generate any updates to its
+ peers. This mode continues until:
- During this mode BGP doesn't run any best-path or generate any updates to its
- peers. This mode continues until:
- 1. All the configured peers, except the shutdown peers, have sent explicit EOR
- (End-Of-RIB) or an implicit-EOR. The first keep-alive after BGP has reached
- Established is considered an implicit-EOR.
- If the establish-wait optional value is given, then BGP will wait for
- peers to reach established from the begining of the update-delay till the
- establish-wait period is over, i.e. the minimum set of established peers for
- which EOR is expected would be peers established during the establish-wait
- window, not necessarily all the configured neighbors.
- 2. max-delay period is over.
- On hitting any of the above two conditions, BGP resumes the decision process
- and generates updates to its peers.
+ 1. All the configured peers, except the shutdown peers, have sent explicit EOR
+ (End-Of-RIB) or an implicit-EOR. The first keep-alive after BGP has reached
+ Established is considered an implicit-EOR.
+ If the establish-wait optional value is given, then BGP will wait for
+ peers to reach established from the begining of the update-delay till the
+ establish-wait period is over, i.e. the minimum set of established peers for
+ which EOR is expected would be peers established during the establish-wait
+ window, not necessarily all the configured neighbors.
+ 2. max-delay period is over.
- Default max-delay is 0, i.e. the feature is off by default.
+ On hitting any of the above two conditions, BGP resumes the decision process
+ and generates updates to its peers.
-.. index:: table-map `route-map-name`
+ Default max-delay is 0, i.e. the feature is off by default.
-.. clicmd:: table-map `route-map-name`
+.. index:: table-map ROUTE-MAP-NAME
+.. clicmd:: table-map ROUTE-MAP-NAME
- This feature is used to apply a route-map on route updates from BGP to Zebra.
- All the applicable match operations are allowed, such as match on prefix,
- next-hop, communities, etc. Set operations for this attach-point are limited
- to metric and next-hop only. Any operation of this feature does not affect
- BGPs internal RIB.
+ This feature is used to apply a route-map on route updates from BGP to
+ Zebra. All the applicable match operations are allowed, such as match on
+ prefix, next-hop, communities, etc. Set operations for this attach-point are
+ limited to metric and next-hop only. Any operation of this feature does not
+ affect BGPs internal RIB.
- Supported for ipv4 and ipv6 address families. It works on multi-paths as well,
- however, metric setting is based on the best-path only.
+ Supported for ipv4 and ipv6 address families. It works on multi-paths as
+ well, however, metric setting is based on the best-path only.
.. _BGP_Peer:
BGP Peer
========
-
.. _Defining_Peer:
Defining Peer
-------------
-.. index:: neighbor `peer` remote-as `asn`
-
-.. clicmd:: neighbor `peer` remote-as `asn`
-
- Creates a new neighbor whose remote-as is `asn`. `peer`
- can be an IPv4 address or an IPv6 address.::
-
- router bgp 1
- neighbor 10.0.0.1 remote-as 2
-
- In this case my router, in AS-1, is trying to peer with AS-2 at
- 10.0.0.1.
+.. index:: neighbor PEER remote-as ASN
+.. clicmd:: neighbor PEER remote-as ASN
- This command must be the first command used when configuring a neighbor.
- If the remote-as is not specified, *bgpd* will complain like this:::
- can't find neighbor 10.0.0.1
+ Creates a new neighbor whose remote-as is ASN. PEER can be an IPv4 address
+ or an IPv6 address.::
+
+ router bgp 1
+ neighbor 10.0.0.1 remote-as 2
+
+ In this case my router, in AS-1, is trying to peer with AS-2 at 10.0.0.1.
+
+ This command must be the first command used when configuring a neighbor. If
+ the remote-as is not specified, *bgpd* will complain like this:::
+
+ can't find neighbor 10.0.0.1
.. _BGP_Peer_commands:
In a `router bgp` clause there are neighbor specific configurations
required.
-.. index:: neighbor `peer` shutdown
-
-.. clicmd:: neighbor `peer` shutdown
-
-.. index:: no neighbor `peer` shutdown
-
-.. clicmd:: no neighbor `peer` shutdown
-
- Shutdown the peer. We can delete the neighbor's configuration by
- `no neighbor `peer` remote-as @var{as-number`} but all
- configuration of the neighbor will be deleted. When you want to
- preserve the configuration, but want to drop the BGP peer, use this
- syntax.
-
-.. index:: neighbor `peer` ebgp-multihop
-
-.. clicmd:: neighbor `peer` ebgp-multihop
-
-.. index:: no neighbor `peer` ebgp-multihop
-
-.. clicmd:: no neighbor `peer` ebgp-multihop
-
-.. index:: neighbor `peer` description ...
-
-.. clicmd:: neighbor `peer` description ...
+.. index:: neighbor PEER shutdown
+.. clicmd:: neighbor PEER shutdown
-.. index:: no neighbor `peer` description ...
+.. index:: no neighbor PEER shutdown
+.. clicmd:: no neighbor PEER shutdown
-.. clicmd:: no neighbor `peer` description ...
+ Shutdown the peer. We can delete the neighbor's configuration by
+ ``no neighbor PEER remote-as ASN`` but all configuration of the neighbor
+ will be deleted. When you want to preserve the configuration, but want to
+ drop the BGP peer, use this syntax.
- Set description of the peer.
+.. index:: neighbor PEER ebgp-multihop
+.. clicmd:: neighbor PEER ebgp-multihop
-.. index:: neighbor `peer` version `version`
+.. index:: no neighbor PEER ebgp-multihop
+.. clicmd:: no neighbor PEER ebgp-multihop
-.. 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+` means that the neighbor supports
- Multiprotocol Extensions for BGP-4. BGP version `4-` is similar but
- the neighbor speaks the old Internet-Draft revision 00's Multiprotocol
- Extensions for BGP-4. Some routing software is still using this
- version.
+.. index:: neighbor PEER description ...
+.. clicmd:: neighbor PEER description ...
-.. index:: neighbor `peer` interface `ifname`
-.. clicmd:: neighbor `peer` interface `ifname`
+.. index:: no neighbor PEER description ...
+.. clicmd:: no neighbor PEER description ...
-.. index:: no neighbor `peer` interface `ifname`
+ Set description of the peer.
-.. clicmd:: no neighbor `peer` interface `ifname`
+.. index:: neighbor PEER version VERSION
+.. clicmd:: neighbor PEER version VERSION
- 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 IPv4 session addresses, see the
- `neighbor `peer` update-source` command below.
+ 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+` means that the neighbor supports
+ Multiprotocol Extensions for BGP-4. BGP version `4-` is similar but
+ the neighbor speaks the old Internet-Draft revision 00's Multiprotocol
+ Extensions for BGP-4. Some routing software is still using this
+ version.
- This command is deprecated and may be removed in a future release. Its
- use should be avoided.
+.. index:: neighbor PEER interface IFNAME
+.. clicmd:: neighbor PEER interface IFNAME
-.. index:: neighbor `peer` next-hop-self [all]
-.. clicmd:: neighbor `peer` next-hop-self [all]
+.. index:: no neighbor PEER interface IFNAME
+.. clicmd:: no neighbor PEER interface IFNAME
-.. index:: no neighbor `peer` next-hop-self [all]
+ 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
+ IPv4 session addresses, see the ``neighbor PEER update-source`` command
+ below.
-.. clicmd:: no neighbor `peer` next-hop-self [all]
+ This command is deprecated and may be removed in a future release. Its use
+ should be avoided.
- 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 keyword `all` is specified the modifiation is done
- also for routes learned via iBGP.
+.. index:: neighbor PEER next-hop-self [all]
+.. clicmd:: neighbor PEER next-hop-self [all]
-.. index:: neighbor `peer` update-source `<ifname|address>`
-.. clicmd:: neighbor `peer` update-source `<ifname|address>`
+.. index:: no neighbor PEER next-hop-self [all]
+.. clicmd:: no neighbor PEER next-hop-self [all]
-.. index:: no neighbor `peer` update-source
+ 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
+ keyword `all` is specified the modifiation is done also for routes learned
+ via iBGP.
-.. clicmd:: no neighbor `peer` update-source
+.. index:: 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 interface name (in which case the *zebra* daemon MUST be running
- in order for *bgpd* to be able to retrieve interface state).::
- router bgp 64555
- neighbor foo update-source 192.168.0.1
- neighbor bar update-source lo0
+.. index:: no neighbor PEER update-source
+.. clicmd:: no neighbor PEER update-source
+ 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
+ interface name (in which case the *zebra* daemon MUST be running in order
+ for *bgpd* to be able to retrieve interface state).::
-.. index:: neighbor `peer` default-originate
+ router bgp 64555
+ neighbor foo update-source 192.168.0.1
+ neighbor bar update-source lo0
-.. clicmd:: neighbor `peer` default-originate
-.. index:: no neighbor `peer` default-originate
+.. index:: neighbor PEER default-originate
+.. clicmd:: neighbor PEER default-originate
-.. clicmd:: no neighbor `peer` default-originate
+.. index:: no neighbor PEER default-originate
+.. clicmd:: no neighbor PEER default-originate
- *bgpd*'s default is to not announce the default route (0.0.0.0/0) even it
- is in routing table. When you want to announce default routes to the
- peer, use this command.
+ *bgpd*'s default is to not announce the default route (0.0.0.0/0) even it
+ is in routing table. When you want to announce default routes to the
+ peer, use this command.
-.. index:: neighbor `peer` port `port`
+.. index:: neighbor PEER port PORT
+.. clicmd:: neighbor PEER port PORT
-.. clicmd:: neighbor `peer` port `port`
+.. index:: neighbor PEER send-community
+.. clicmd:: neighbor PEER send-community
-.. index:: neighbor `peer` port `port`
+.. index:: neighbor PEER weight WEIGHT
+.. clicmd:: neighbor PEER weight WEIGHT
-.. clicmd:: neighbor `peer` port `port`
-.. index:: neighbor `peer` send-community
+.. index:: no neighbor PEER weight WEIGHT
+.. clicmd:: no neighbor PEER weight WEIGHT
-.. clicmd:: neighbor `peer` send-community
+ This command specifies a default `weight` value for the neighbor's routes.
-.. index:: neighbor `peer` send-community
+.. index:: neighbor PEER maximum-prefix NUMBER
+.. clicmd:: neighbor PEER maximum-prefix NUMBER
-.. clicmd:: neighbor `peer` send-community
-.. index:: neighbor `peer` weight `weight`
+.. index:: no neighbor PEER maximum-prefix NUMBER
+.. clicmd:: no neighbor PEER maximum-prefix NUMBER
-.. clicmd:: neighbor `peer` weight `weight`
-.. index:: no neighbor `peer` weight `weight`
+.. index:: neighbor PEER local-as AS-NUMBER
+.. clicmd:: neighbor PEER local-as AS-NUMBER
-.. clicmd:: no neighbor `peer` weight `weight`
- This command specifies a default `weight` value for the neighbor's
- routes.
+.. index:: neighbor PEER local-as AS-NUMBER no-prepend
+.. clicmd:: neighbor PEER local-as AS-NUMBER no-prepend
-.. index:: neighbor `peer` maximum-prefix `number`
-.. clicmd:: neighbor `peer` maximum-prefix `number`
+.. index:: neighbor PEER local-as AS-NUMBER no-prepend replace-as
+.. clicmd:: neighbor PEER local-as AS-NUMBER no-prepend replace-as
-.. index:: no neighbor `peer` maximum-prefix `number`
-.. clicmd:: no neighbor `peer` maximum-prefix `number`
+.. index:: no neighbor PEER local-as
+.. clicmd:: no neighbor PEER local-as
-.. index:: neighbor `peer` local-as `as-number`
+ Specify an alternate AS for this BGP process when interacting with the
+ specified peer. With no modifiers, the specified local-as is prepended to
+ the received AS_PATH when receiving routing updates from the peer, and
+ prepended to the outgoing AS_PATH (after the process local AS) when
+ transmitting local routes to the peer.
-.. clicmd:: neighbor `peer` local-as `as-number`
+ If the no-prepend attribute is specified, then the supplied local-as is not
+ prepended to the received AS_PATH.
-.. index:: neighbor `peer` local-as `as-number` no-prepend
+ If the replace-as attribute is specified, then only the supplied local-as is
+ prepended to the AS_PATH when transmitting local-route updates to this peer.
-.. clicmd:: neighbor `peer` local-as `as-number` no-prepend
+ Note that replace-as can only be specified if no-prepend is.
-.. index:: neighbor `peer` local-as `as-number` no-prepend replace-as
+ This command is only allowed for eBGP peers.
-.. clicmd:: neighbor `peer` local-as `as-number` no-prepend replace-as
+.. index:: neighbor PEER ttl-security hops NUMBER
+.. clicmd:: neighbor PEER ttl-security hops NUMBER
-.. index:: no neighbor `peer` local-as
-.. clicmd:: no neighbor `peer` local-as
+.. index:: no neighbor PEER ttl-security hops NUMBER
+.. clicmd:: no neighbor PEER ttl-security hops NUMBER
- Specify an alternate AS for this BGP process when interacting with the
- specified peer. With no modifiers, the specified local-as is prepended to
- the received AS_PATH when receiving routing updates from the peer, and
- prepended to the outgoing AS_PATH (after the process local AS) when
- transmitting local routes to the peer.
-
- If the no-prepend attribute is specified, then the supplied local-as is not
- prepended to the received AS_PATH.
-
- If the replace-as attribute is specified, then only the supplied local-as is
- prepended to the AS_PATH when transmitting local-route updates to this peer.
-
- Note that replace-as can only be specified if no-prepend is.
-
- This command is only allowed for eBGP peers.
-
-.. index:: neighbor `peer` ttl-security hops `number`
-
-.. clicmd:: neighbor `peer` ttl-security hops `number`
-
-.. index:: no neighbor `peer` ttl-security hops `number`
-
-.. clicmd:: no 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 mututally exclusive with *ebgp-multihop*.
+ 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 mututally exclusive with *ebgp-multihop*.
.. _Peer_filtering:
Peer filtering
--------------
-.. index:: neighbor `peer` distribute-list `name` [in|out]
-
-.. clicmd:: neighbor `peer` distribute-list `name` [in|out]
+.. index:: neighbor PEER distribute-list NAME [in|out]
+.. clicmd:: neighbor PEER distribute-list NAME [in|out]
- This command specifies a distribute-list for the peer. `direct` is
- ``in`` or ``out``.
+ This command specifies a distribute-list for the peer. `direct` is
+ ``in`` or ``out``.
.. index:: neighbor PEER prefix-list NAME [in|out]
-
.. clicmd:: neighbor PEER prefix-list NAME [in|out]
-.. index:: neighbor PEER filter-list NAME [in|out]
+.. index:: neighbor PEER filter-list NAME [in|out]
.. clicmd:: neighbor PEER filter-list NAME [in|out]
-.. index:: neighbor `peer` route-map `name` [in|out]
-.. clicmd:: neighbor `peer` route-map `name` [in|out]
+.. index:: neighbor PEER route-map NAME [in|out]
+.. clicmd:: neighbor PEER route-map NAME [in|out]
- Apply a route-map on the neighbor. `direct` must be `in` or
- `out`.
+ Apply a route-map on the neighbor. `direct` must be `in` or `out`.
.. index:: bgp route-reflector allow-outbound-policy
-
.. clicmd:: bgp route-reflector allow-outbound-policy
- By default, attribute modification via route-map policy out is not reflected
- on reflected routes. This option allows the modifications to be reflected as
- well. Once enabled, it affects all reflected routes.
+ By default, attribute modification via route-map policy out is not reflected
+ on reflected routes. This option allows the modifications to be reflected as
+ well. Once enabled, it affects all reflected routes.
.. _BGP_Peer_Group:
BGP Peer Group
==============
-.. index:: neighbor `word` peer-group
-
-.. clicmd:: neighbor `word` peer-group
+.. index:: neighbor WORD peer-group
+.. clicmd:: neighbor WORD peer-group
- This command defines a new peer group.
+ This command defines a new peer group.
-.. index:: neighbor `peer` peer-group `word`
+.. index:: neighbor PEER peer-group WORD
+.. clicmd:: neighbor PEER peer-group WORD
-.. clicmd:: neighbor `peer` peer-group `word`
-
- This command bind specific peer to peer group `word`.
+ This command bind specific peer to peer group WORD.
.. _BGP_Address_Family:
BGP Address Family
==================
-Multiprotocol BGP enables BGP to carry routing information for multiple
-Network Layer protocols. BGP supports multiple Address Family
-Identifier (AFI), namely IPv4 and IPv6. Support is also provided for
-multiple sets of per-AFI information via Subsequent Address Family
-Identifiers (SAFI). In addition to unicast information, VPN information
-:rfc:`4364` and :rfc:`4659`, and Encapsulation information
-:rfc:`5512` is supported.
+Multiprotocol BGP enables BGP to carry routing information for multiple Network
+Layer protocols. BGP supports multiple Address Family Identifier (AFI), namely
+IPv4 and IPv6. Support is also provided for multiple sets of per-AFI
+information via Subsequent Address Family Identifiers (SAFI). In addition to
+unicast information, VPN information :rfc:`4364` and :rfc:`4659`, and
+Encapsulation information :rfc:`5512` is supported.
.. index:: show ip bgp vpnv4 all
-
.. clicmd:: show ip bgp vpnv4 all
-.. index:: show ipv6 bgp vpn all
+.. index:: show ipv6 bgp vpn all
.. clicmd:: show ipv6 bgp vpn all
- Print active IPV4 or IPV6 routes advertised via the VPN SAFI.
-.. index:: show ip bgp encap all
+ Print active IPV4 or IPV6 routes advertised via the VPN SAFI.
+.. index:: show ip bgp encap all
.. clicmd:: show ip bgp encap all
-.. index:: show ipv6 bgp encap all
+.. index:: show ipv6 bgp encap all
.. clicmd:: show ipv6 bgp encap all
- Print active IPV4 or IPV6 routes advertised via the Encapsulation SAFI.
-.. index:: show bgp ipv4 encap summary
+ Print active IPV4 or IPV6 routes advertised via the Encapsulation SAFI.
+.. index:: show bgp ipv4 encap summary
.. clicmd:: show bgp ipv4 encap summary
-.. index:: show bgp ipv4 vpn summary
+.. index:: show bgp ipv4 vpn summary
.. clicmd:: show bgp ipv4 vpn summary
-.. index:: show bgp ipv6 encap summary
+.. index:: show bgp ipv6 encap summary
.. clicmd:: show bgp ipv6 encap summary
-.. index:: show bgp ipv6 vpn summary
+.. index:: show bgp ipv6 vpn summary
.. clicmd:: show bgp ipv6 vpn summary
- Print a summary of neighbor connections for the specified AFI/SAFI combination.
+
+ Print a summary of neighbor connections for the specified AFI/SAFI combination.
.. _Autonomous_System:
Autonomous System
=================
-The :abbr:`AS (Autonomous System)` number is one of the essential
-element of BGP. BGP is a distance vector routing protocol, and the
-AS-Path framework provides distance vector metric and loop detection to
-BGP. @cite{RFC1930, Guidelines for creation, selection, and
-registration of an Autonomous System (AS)} provides some background on
-the concepts of an AS.
+The :abbr:`AS (Autonomous System)` number is one of the essential element of
+BGP. BGP is a distance vector routing protocol, and the AS-Path framework
+provides distance vector metric and loop detection to BGP. :rfc:`1930` provides
+some background on the concepts of an AS.
-The AS number is a two octet value, ranging in value from 1 to 65535.
-The AS numbers 64512 through 65535 are defined as private AS numbers.
-Private AS numbers must not to be advertised in the global Internet.
+The AS number is a two octet value, ranging in value from 1 to 65535. The AS
+numbers 64512 through 65535 are defined as private AS numbers. Private AS
+numbers must not to be advertised in the global Internet.
.. _Display_BGP_Routes_by_AS_Path:
Display BGP Routes by AS Path
-----------------------------
-To show BGP routes which has specific AS path information `show ip bgp` command can be used.
+To show BGP routes which has specific AS path information `show ip bgp` command
+can be used.
.. index:: show bgp ipv4|ipv6 regexp LINE
-
.. clicmd:: show bgp ipv4|ipv6 regexp LINE
- This commands displays BGP routes that matches a regular
- expression `line` (:ref:`BGP_Regular_Expressions`).
+
+ This commands displays BGP routes that matches a regular
+ expression `line` (:ref:`BGP_Regular_Expressions`).
.. _AS_Path_Access_List:
AS path access list is user defined AS path.
.. index:: ip as-path access-list WORD permit|deny LINE
-
.. clicmd:: ip as-path access-list WORD permit|deny LINE
- This command defines a new AS path access list.
-.. index:: no ip as-path access-list WORD
+ This command defines a new AS path access list.
+.. index:: no ip as-path access-list WORD
.. clicmd:: no ip as-path access-list WORD
-.. index:: no ip as-path access-list WORD permit|deny LINE
+.. index:: no ip as-path access-list WORD permit|deny LINE
.. clicmd:: no ip as-path access-list WORD permit|deny LINE
.. _Using_AS_Path_in_Route_Map:
--------------------------
.. index:: match as-path WORD
-
.. clicmd:: match as-path WORD
-.. index:: set as-path prepend AS-PATH
+.. index:: set as-path prepend AS-PATH
.. clicmd:: set as-path prepend AS-PATH
- Prepend the given string of AS numbers to the AS_PATH.
-.. index:: set as-path prepend last-as NUM
+ Prepend the given string of AS numbers to the AS_PATH.
+.. index:: 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.
+
+ Prepend the existing last AS number (the leftmost ASN) to the AS_PATH.
.. _Private_AS_Numbers:
Private AS Numbers
------------------
-
.. _BGP_Communities_Attribute:
BGP Communities Attribute
=========================
-BGP communities attribute is widely used for implementing policy
-routing. Network operators can manipulate BGP communities attribute
-based on their network policy. BGP communities attribute is defined
-in :t:`RFC1997, BGP Communities Attribute` and
-@cite{RFC1998, An Application of the BGP Community Attribute
-in Multi-home Routing}. It is an optional transitive attribute,
-therefore local policy can travel through different autonomous system.
-
-Communities attribute is a set of communities values. Each
-communities value is 4 octet long. The following format is used to
-define communities value.
-
-
-
-*AS:VAL*
- This format represents 4 octet communities value. `AS` is high
- order 2 octet in digit format. `VAL` is low order 2 octet in
- digit format. This format is useful to define AS oriented policy
- value. For example, `7675:80` can be used when AS 7675 wants to
- pass local policy value 80 to neighboring peer.
-
-*internet*
- `internet` represents well-known communities value 0.
-
-*no-export*
- ``no-export`` represents well-known communities value ``NO_EXPORT`` @\*
- @r{(0xFFFFFF01)}. All routes carry this value must not be advertised
- to outside a BGP confederation boundary. If neighboring BGP peer is
- part of BGP confederation, the peer is considered as inside a BGP
- confederation boundary, so the route will be announced to the peer.
-
-*no-advertise*
- ``no-advertise`` represents well-known communities value
- ``NO_ADVERTISE`` @*@r{(0xFFFFFF02)}. All routes carry this value
- must not be advertise to other BGP peers.
-
-*local-AS*
- ``local-AS`` represents well-known communities value
- ``NO_EXPORT_SUBCONFED`` @r{(0xFFFFFF03)}. All routes carry this
- value must not be advertised to external BGP peers. Even if the
- neighboring router is part of confederation, it is considered as
- external BGP peer, so the route will not be announced to the peer.
-
-When BGP communities attribute is received, duplicated communities
-value in the communities attribute is ignored and each communities
-values are sorted in numerical order.
+BGP communities attribute is widely used for implementing policy routing.
+Network operators can manipulate BGP communities attribute based on their
+network policy. BGP communities attribute is defined in :rfc:`1997` and
+:rfc:`1998`. It is an optional transitive attribute, therefore local policy can
+travel through different autonomous system.
+
+Communities attribute is a set of communities values. Each communities value is
+4 octet long. The following format is used to define communities value.
+
+
+AS:VAL
+ This format represents 4 octet communities value. ``AS`` is high order 2
+ octet in digit format. ``VAL`` is low order 2 octet in digit format. This
+ format is useful to define AS oriented policy value. For example,
+ ``7675:80`` can be used when AS 7675 wants to pass local policy value 80 to
+ neighboring peer.
+
+internet
+ `internet` represents well-known communities value 0.
+
+no-export
+ ``no-export`` represents well-known communities value ``NO_EXPORT``
+ ``0xFFFFFF01``. All routes carry this value must not be advertised to
+ outside a BGP confederation boundary. If neighboring BGP peer is part of BGP
+ confederation, the peer is considered as inside a BGP confederation
+ boundary, so the route will be announced to the peer.
+
+no-advertise
+ ``no-advertise`` represents well-known communities value ``NO_ADVERTISE``
+ ``0xFFFFFF02``. All routes carry this value must not be advertise to other
+ BGP peers.
+
+local-AS
+ ``local-AS`` represents well-known communities value ``NO_EXPORT_SUBCONFED``
+ ``0xFFFFFF03``. All routes carry this value must not be advertised to
+ external BGP peers. Even if the neighboring router is part of confederation,
+ it is considered as external BGP peer, so the route will not be announced to
+ the peer.
+
+When BGP communities attribute is received, duplicated communities value in the
+communities attribute is ignored and each communities values are sorted in
+numerical order.
.. _BGP_Community_Lists:
BGP Community Lists
-------------------
-BGP community list is a user defined BGP communites attribute list.
-BGP community list can be used for matching or manipulating BGP
-communities attribute in updates.
-
-There are two types of community list. One is standard community
-list and another is expanded community list. Standard community list
-defines communities attribute. Expanded community list defines
-communities attribute string with regular expression. Standard
-community list is compiled into binary format when user define it.
-Standard community list will be directly compared to BGP communities
-attribute in BGP updates. Therefore the comparison is faster than
+BGP community list is a user defined BGP communites attribute list. BGP
+community list can be used for matching or manipulating BGP communities
+attribute in updates.
+
+There are two types of community list. One is standard community list and
+another is expanded community list. Standard community list defines communities
+attribute. Expanded community list defines communities attribute string with
+regular expression. Standard community list is compiled into binary format when
+user define it. Standard community list will be directly compared to BGP
+communities attribute in BGP updates. Therefore the comparison is faster than
expanded community list.
.. index:: ip community-list standard NAME permit|deny COMMUNITY
-
.. clicmd:: ip community-list standard NAME permit|deny COMMUNITY
- This command defines a new standard community list. `community`
- is communities value. The `community` is compiled into community
- structure. We can define multiple community list under same name. In
- that case match will happen user defined order. Once the
- community list matches to communities attribute in BGP updates it
- return permit or deny by the community list definition. When there is
- no matched entry, deny will be returned. When `community` is
- empty it matches to any routes.
-.. index:: ip community-list expanded NAME permit|deny LINE
+ This command defines a new standard community list. COMUNITY is
+ communities value. The COMUNITY is compiled into community structure. We
+ can define multiple community list under same name. In that case match will
+ happen user defined order. Once the community list matches to communities
+ attribute in BGP updates it return permit or deny by the community list
+ definition. When there is no matched entry, deny will be returned. When
+ COMUNITY is empty it matches to any routes.
+.. index:: ip community-list expanded NAME permit|deny LINE
.. clicmd:: ip community-list expanded NAME permit|deny LINE
- This command defines a new expanded community list. `line` is a
- string expression of communities attribute. `line` can be a
- regular expression (:ref:`BGP_Regular_Expressions`) to match
- the communities attribute in BGP updates.
-.. index:: no ip community-list NAME
+ This command defines a new expanded community list. COMUNITY is a
+ string expression of communities attribute. COMUNITY can be a
+ regular expression (:ref:`BGP_Regular_Expressions`) to match
+ the communities attribute in BGP updates.
+.. index:: no ip community-list NAME
.. clicmd:: no ip community-list NAME
-.. index:: no ip community-list standard NAME
+.. index:: no ip community-list standard NAME
.. clicmd:: no ip community-list standard NAME
-.. index:: no ip community-list expanded NAME
+.. index:: no ip community-list expanded NAME
.. clicmd:: no ip community-list expanded NAME
- These commands delete community lists specified by `name`. All of
- community lists shares a single name space. So community lists can be
- removed simpley specifying community lists name.
-.. index:: show ip community-list
+ These commands delete community lists specified by NAME. All of
+ community lists shares a single name space. So community lists can be
+ removed simpley specifying community lists name.
+.. index:: show ip community-list
.. clicmd:: show ip community-list
-.. index:: show ip community-list NAME
+.. index:: show ip community-list NAME
.. clicmd:: show ip community-list NAME
- This command displays current community list information. When
- `name` is specified the specified community list's information is
- shown.
-::
-
- # show ip community-list
- Named Community standard list CLIST
- permit 7675:80 7675:100 no-export
- deny internet
- Named Community expanded list EXPAND
- permit :
+ This command displays current community list information. When NAME is
+ specified the specified community list's information is shown.
- # show ip community-list CLIST
- Named Community standard list CLIST
- permit 7675:80 7675:100 no-export
- deny internet
+ ::
+
+ # show ip community-list
+ Named Community standard list CLIST
+ permit 7675:80 7675:100 no-export
+ deny internet
+ Named Community expanded list EXPAND
+ permit :
+
+ # show ip community-list CLIST
+ Named Community standard list CLIST
+ permit 7675:80 7675:100 no-export
+ deny internet
.. _Numbered_BGP_Community_Lists:
is called as named community lists.
.. index:: ip community-list (1-99) permit|deny COMMUNITY
-
.. clicmd:: ip community-list (1-99) permit|deny COMMUNITY
- This command defines a new community list. (1-99) is standard
- community list number. Community list name within this range defines
- standard community list. When `community` is empty it matches to
- any routes.
-.. index:: ip community-list (100-199) permit|deny COMMUNITY
+ This command defines a new community list. (1-99) is standard
+ community list number. Community list name within this range defines
+ standard community list. When `community` is empty it matches to
+ any routes.
+.. index:: ip community-list (100-199) permit|deny COMMUNITY
.. clicmd:: ip community-list (100-199) permit|deny COMMUNITY
- This command defines a new community list. (100-199) is expanded
- community list number. Community list name within this range defines
- expanded community list.
-.. index:: ip community-list NAME permit|deny COMMUNITY
+ This command defines a new community list. (100-199) is expanded
+ community list number. Community list name within this range defines
+ expanded community list.
+.. index:: ip community-list NAME permit|deny COMMUNITY
.. clicmd:: ip community-list NAME permit|deny COMMUNITY
- When community list type is not specifed, the community list type is
- automatically detected. If `community` can be compiled into
- communities attribute, the community list is defined as a standard
- community list. Otherwise it is defined as an expanded community
- list. This feature is left for backward compability. Use of this
- feature is not recommended.
+
+ When community list type is not specifed, the community list type is
+ automatically detected. If COMMUNITY can be compiled into communities
+ attribute, the community list is defined as a standard community list.
+ Otherwise it is defined as an expanded community list. This feature is left
+ for backward compability. Use of this feature is not recommended.
.. _BGP_Community_in_Route_Map:
Following commands can be used in Route Map.
.. index:: match community WORD
-
.. clicmd:: match community WORD
-.. index:: match community WORD exact-match
+.. index:: match community WORD exact-match
.. clicmd:: match community WORD exact-match
- This command perform match to BGP updates using community list
- `word`. When the one of BGP communities value match to the one of
- communities value in community list, it is match. When
- `exact-match` keyword is spcified, match happen only when BGP
- updates have completely same communities value specified in the
- community list.
-.. index:: set community none
+ This command perform match to BGP updates using community list WORD. When
+ the one of BGP communities value match to the one of communities value in
+ community list, it is match. When `exact-match` keyword is spcified, match
+ happen only when BGP updates have completely same communities value
+ specified in the community list.
+.. index:: set community none
.. clicmd:: set community none
-.. index:: set community COMMUNITY
+.. index:: set community COMMUNITY
.. clicmd:: set community COMMUNITY
-.. index:: set community COMMUNITY additive
+.. index:: set community COMMUNITY additive
.. clicmd:: set community COMMUNITY additive
- This command manipulate communities value in BGP updates. When
- `none` is specified as communities value, it removes entire
- communities attribute from BGP updates. When `community` is not
- `none`, specified communities value is set to BGP updates. If
- BGP updates already has BGP communities value, the existing BGP
- communities value is replaced with specified `community` value.
- When `additive` keyword is specified, `community` is appended
- to the existing communities value.
-.. index:: set comm-list WORD delete
+ This command manipulate communities value in BGP updates. When
+ `none` is specified as communities value, it removes entire
+ communities attribute from BGP updates. When `community` is not
+ `none`, specified communities value is set to BGP updates. If
+ BGP updates already has BGP communities value, the existing BGP
+ communities value is replaced with specified `community` value.
+ When `additive` keyword is specified, `community` is appended
+ to the existing communities value.
+.. index:: set comm-list WORD delete
.. clicmd:: set comm-list WORD delete
- This command remove communities value from BGP communities attribute.
- The `word` is community list name. When BGP route's communities
- value matches to the community list `word`, the communities value
- is removed. When all of communities value is removed eventually, the
- BGP update's communities attribute is completely removed.
+
+ This command remove communities value from BGP communities attribute.
+ The `word` is community list name. When BGP route's communities
+ value matches to the community list `word`, the communities value
+ is removed. When all of communities value is removed eventually, the
+ BGP update's communities attribute is completely removed.
.. _Display_BGP_Routes_by_Community:
`community` and `community-list` subcommand can be used.
.. index:: show bgp ipv4|ipv6 community
-
.. clicmd:: show bgp ipv4|ipv6 community
-.. index:: show bgp ipv4|ipv6 community COMMUNITY
+.. index:: show bgp ipv4|ipv6 community COMMUNITY
.. clicmd:: show bgp ipv4|ipv6 community COMMUNITY
-.. index:: show bgp ipv4|ipv6 community COMMUNITY exact-match
+.. index:: show bgp ipv4|ipv6 community COMMUNITY exact-match
.. clicmd:: show bgp ipv4|ipv6 community COMMUNITY exact-match
- `show bgp {ipv4|ipv6} community` displays BGP routes which has communities
- attribute. Where the address family can be IPv4 or IPv6 among others. When
- `community` is specified, BGP routes that matches `community` value is
- displayed. For this command, `internet` keyword can't be used for
- `community` value. When `exact-match` is specified, it display only
- routes that have an exact match.
-.. index:: show bgp ipv4|ipv6 community-list WORD
+ `show bgp {ipv4|ipv6} community` displays BGP routes which has communities
+ attribute. Where the address family can be IPv4 or IPv6 among others. When
+ `community` is specified, BGP routes that matches `community` value is
+ displayed. For this command, `internet` keyword can't be used for
+ `community` value. When `exact-match` is specified, it display only
+ routes that have an exact match.
+.. index:: show bgp ipv4|ipv6 community-list WORD
.. clicmd:: show bgp ipv4|ipv6 community-list WORD
-.. index:: show bgp ipv4|ipv6 community-list WORD exact-match
+.. index:: show bgp ipv4|ipv6 community-list WORD exact-match
.. clicmd:: show bgp ipv4|ipv6 community-list WORD exact-match
- This commands display BGP routes for the address family specified that matches
- community list `word`. When `exact-match` is specified, display only
- routes that have an exact match.
+
+ This commands display BGP routes for the address family specified that matches
+ community list `word`. When `exact-match` is specified, display only
+ routes that have an exact match.
.. _Using_BGP_Communities_Attribute:
attribute. AS 7675 provides upstream Internet connection to AS 100.
When following configuration exists in AS 7675, AS 100 networks
operator can set local preference in AS 7675 network by setting BGP
-communities attribute to the updates.
-
-::
-
- router bgp 7675
- neighbor 192.168.0.1 remote-as 100
- address-family ipv4 unicast
- neighbor 192.168.0.1 route-map RMAP in
- exit-address-family
- !
- ip community-list 70 permit 7675:70
- ip community-list 70 deny
- ip community-list 80 permit 7675:80
- ip community-list 80 deny
- ip community-list 90 permit 7675:90
- ip community-list 90 deny
- !
- route-map RMAP permit 10
- match community 70
- set local-preference 70
- !
- route-map RMAP permit 20
- match community 80
- set local-preference 80
- !
- route-map RMAP permit 30
- match community 90
- set local-preference 90
+communities attribute to the updates.::
+
+ router bgp 7675
+ neighbor 192.168.0.1 remote-as 100
+ address-family ipv4 unicast
+ neighbor 192.168.0.1 route-map RMAP in
+ exit-address-family
+ !
+ ip community-list 70 permit 7675:70
+ ip community-list 70 deny
+ ip community-list 80 permit 7675:80
+ ip community-list 80 deny
+ ip community-list 90 permit 7675:90
+ ip community-list 90 deny
+ !
+ route-map RMAP permit 10
+ match community 70
+ set local-preference 70
+ !
+ route-map RMAP permit 20
+ match community 80
+ set local-preference 80
+ !
+ route-map RMAP permit 30
+ match community 90
+ set local-preference 90
Following configuration announce 10.0.0.0/8 from AS 100 to AS 7675.
The route has communities value 7675:80 so when above configuration
exists in AS 7675, announced route's local preference will be set to
-value 80.
-
-::
-
- router bgp 100
- network 10.0.0.0/8
- neighbor 192.168.0.2 remote-as 7675
- address-family ipv4 unicast
- neighbor 192.168.0.2 route-map RMAP out
- exit-address-family
- !
- ip prefix-list PLIST permit 10.0.0.0/8
- !
- route-map RMAP permit 10
- match ip address prefix-list PLIST
- set community 7675:80
+value 80.::
+
+ router bgp 100
+ network 10.0.0.0/8
+ neighbor 192.168.0.2 remote-as 7675
+ address-family ipv4 unicast
+ neighbor 192.168.0.2 route-map RMAP out
+ exit-address-family
+ !
+ ip prefix-list PLIST permit 10.0.0.0/8
+ !
+ route-map RMAP permit 10
+ match ip address prefix-list PLIST
+ set community 7675:80
Following configuration is an example of BGP route filtering using
communities attribute. This configuration only permit BGP routes
which has BGP communities value 0:80 or 0:90. Network operator can
put special internal communities value at BGP border router, then
-limit the BGP routes announcement into the internal network.
-
-::
+limit the BGP routes announcement into the internal network.::
- router bgp 7675
- neighbor 192.168.0.1 remote-as 100
- address-family ipv4 unicast
- neighbor 192.168.0.1 route-map RMAP in
- exit-address-family
- !
- ip community-list 1 permit 0:80 0:90
- !
- route-map RMAP permit in
- match community 1
+ router bgp 7675
+ neighbor 192.168.0.1 remote-as 100
+ address-family ipv4 unicast
+ neighbor 192.168.0.1 route-map RMAP in
+ exit-address-family
+ !
+ ip community-list 1 permit 0:80 0:90
+ !
+ route-map RMAP permit in
+ match community 1
Following exmaple filter BGP routes which has communities value 1:1.
When there is no match community-list returns deny. To avoid
-filtering all of routes, we need to define permit any at last.
-
-::
+filtering all of routes, we need to define permit any at last.::
- router bgp 7675
- neighbor 192.168.0.1 remote-as 100
- address-family ipv4 unicast
- neighbor 192.168.0.1 route-map RMAP in
- exit-address-family
- !
- ip community-list standard FILTER deny 1:1
- ip community-list standard FILTER permit
- !
- route-map RMAP permit 10
- match community FILTER
+ router bgp 7675
+ neighbor 192.168.0.1 remote-as 100
+ address-family ipv4 unicast
+ neighbor 192.168.0.1 route-map RMAP in
+ exit-address-family
+ !
+ ip community-list standard FILTER deny 1:1
+ ip community-list standard FILTER permit
+ !
+ route-map RMAP permit 10
+ match community FILTER
Communities value keyword `internet` has special meanings in
standard community lists. In below example `internet` act as
match any. It matches all of BGP routes even if the route does not
-have communities attribute at all. So community list `INTERNET`
-is same as above example's `FILTER`.
+have communities attribute at all. So community list ``INTERNET``
+is same as above example's ``FILTER``.::
-::
-
- ip community-list standard INTERNET deny 1:1
- ip community-list standard INTERNET permit internet
+ ip community-list standard INTERNET deny 1:1
+ ip community-list standard INTERNET permit internet
Following configuration is an example of communities value deletion.
With this configuration communities value 100:1 and 100:2 is removed
from BGP updates. For communities value deletion, only `permit`
-community-list is used. `deny` community-list is ignored.
+community-list is used. `deny` community-list is ignored.::
-::
-
- router bgp 7675
- neighbor 192.168.0.1 remote-as 100
- address-family ipv4 unicast
- neighbor 192.168.0.1 route-map RMAP in
- exit-address-family
- !
- ip community-list standard DEL permit 100:1 100:2
- !
- route-map RMAP permit 10
- set comm-list DEL delete
+ router bgp 7675
+ neighbor 192.168.0.1 remote-as 100
+ address-family ipv4 unicast
+ neighbor 192.168.0.1 route-map RMAP in
+ exit-address-family
+ !
+ ip community-list standard DEL permit 100:1 100:2
+ !
+ route-map RMAP permit 10
+ set comm-list DEL delete
.. _BGP_Extended_Communities_Attribute:
BGP Extended Communities Attribute
==================================
-BGP extended communities attribute is introduced with MPLS VPN/BGP
-technology. MPLS VPN/BGP expands capability of network infrastructure
-to provide VPN functionality. At the same time it requires a new
-framework for policy routing. With BGP Extended Communities Attribute
-we can use Route Target or Site of Origin for implementing network
-policy for MPLS VPN/BGP.
-
-BGP Extended Communities Attribute is similar to BGP Communities
-Attribute. It is an optional transitive attribute. BGP Extended
-Communities Attribute can carry multiple Extended Community value.
-Each Extended Community value is eight octet length.
+BGP extended communities attribute is introduced with MPLS VPN/BGP technology.
+MPLS VPN/BGP expands capability of network infrastructure to provide VPN
+functionality. At the same time it requires a new framework for policy routing.
+With BGP Extended Communities Attribute we can use Route Target or Site of
+Origin for implementing network policy for MPLS VPN/BGP.
-BGP Extended Communities Attribute provides an extended range
-compared with BGP Communities Attribute. Adding to that there is a
-type field in each value to provides community space structure.
-
-There are two format to define Extended Community value. One is AS
-based format the other is IP address based format.
+BGP Extended Communities Attribute is similar to BGP Communities Attribute. It
+is an optional transitive attribute. BGP Extended Communities Attribute can
+carry multiple Extended Community value. Each Extended Community value is
+eight octet length.
+BGP Extended Communities Attribute provides an extended range compared with BGP
+Communities Attribute. Adding to that there is a type field in each value to
+provides community space structure.
+There are two format to define Extended Community value. One is AS based format
+the other is IP address based format.
*AS:VAL*
- This is a format to define AS based Extended Community value.
- `AS` part is 2 octets Global Administrator subfield in Extended
- Community value. `VAL` part is 4 octets Local Administrator
- subfield. `7675:100` represents AS 7675 policy value 100.
+ This is a format to define AS based Extended Community value.
+ `AS` part is 2 octets Global Administrator subfield in Extended
+ Community value. `VAL` part is 4 octets Local Administrator
+ subfield. `7675:100` represents AS 7675 policy value 100.
*IP-Address:VAL*
- This is a format to define IP address based Extended Community value.
- `IP-Address` part is 4 octets Global Administrator subfield.
- `VAL` part is 2 octets Local Administrator subfield.
- `10.0.0.1:100` represents
+ This is a format to define IP address based Extended Community value.
+ `IP-Address` part is 4 octets Global Administrator subfield.
+ `VAL` part is 2 octets Local Administrator subfield.
+ `10.0.0.1:100` represents
.. _BGP_Extended_Community_Lists:
Lists.
.. index:: ip extcommunity-list standard NAME permit|deny EXTCOMMUNITY
-
.. clicmd:: ip extcommunity-list standard NAME permit|deny EXTCOMMUNITY
- This command defines a new standard extcommunity-list.
- `extcommunity` is extended communities value. The
- `extcommunity` is compiled into extended community structure. We
- can define multiple extcommunity-list under same name. In that case
- match will happen user defined order. Once the extcommunity-list
- matches to extended communities attribute in BGP updates it return
- permit or deny based upon the extcommunity-list definition. When
- there is no matched entry, deny will be returned. When
- `extcommunity` is empty it matches to any routes.
-.. index:: ip extcommunity-list expanded NAME permit|deny LINE
+ This command defines a new standard extcommunity-list.
+ `extcommunity` is extended communities value. The
+ `extcommunity` is compiled into extended community structure. We
+ can define multiple extcommunity-list under same name. In that case
+ match will happen user defined order. Once the extcommunity-list
+ matches to extended communities attribute in BGP updates it return
+ permit or deny based upon the extcommunity-list definition. When
+ there is no matched entry, deny will be returned. When
+ `extcommunity` is empty it matches to any routes.
+.. index:: ip extcommunity-list expanded NAME permit|deny LINE
.. clicmd:: ip extcommunity-list expanded NAME permit|deny LINE
- This command defines a new expanded extcommunity-list. `line` is
- a string expression of extended communities attribute. `line` can
- be a regular expression (:ref:`BGP_Regular_Expressions`) to match an
- extended communities attribute in BGP updates.
-.. index:: no ip extcommunity-list NAME
+ This command defines a new expanded extcommunity-list. `line` is
+ a string expression of extended communities attribute. `line` can
+ be a regular expression (:ref:`BGP_Regular_Expressions`) to match an
+ extended communities attribute in BGP updates.
+.. index:: no ip extcommunity-list NAME
.. clicmd:: no ip extcommunity-list NAME
-.. index:: no ip extcommunity-list standard NAME
+.. index:: no ip extcommunity-list standard NAME
.. clicmd:: no ip extcommunity-list standard NAME
-.. index:: no ip extcommunity-list expanded NAME
+.. index:: no ip extcommunity-list expanded NAME
.. clicmd:: no ip 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 simpley specifying
- the name.
-.. index:: show ip extcommunity-list
+ 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 simpley specifying
+ the name.
+.. index:: show ip extcommunity-list
.. clicmd:: show ip extcommunity-list
-.. index:: show ip extcommunity-list NAME
+.. index:: show ip extcommunity-list NAME
.. clicmd:: show ip extcommunity-list NAME
- This command displays current extcommunity-list information. When
- `name` is specified the community list's information is shown.
+
+ This command displays current extcommunity-list information. When
+ `name` is specified the community list's information is shown.
::
-------------------------------------
.. index:: match extcommunity WORD
-
.. clicmd:: match extcommunity WORD
-.. index:: set extcommunity rt EXTCOMMUNITY
+.. index:: set extcommunity rt EXTCOMMUNITY
.. clicmd:: set extcommunity rt EXTCOMMUNITY
- This command set Route Target value.
-.. index:: set extcommunity soo EXTCOMMUNITY
+ This command set Route Target value.
+.. index:: set extcommunity soo EXTCOMMUNITY
.. clicmd:: set extcommunity soo EXTCOMMUNITY
- This command set Site of Origin value.
+
+ This command set Site of Origin value.
.. _BGP_Large_Communities_Attribute:
===============================
The BGP Large Communities attribute was introduced in Feb 2017 with
-:t:`RFC8092, BGP Large Communities Attribute`.
+:rfc:`8092`.
The BGP Large Communities Attribute is similar to the BGP Communities
Attribute except that it has 3 components instead of two and each of
AS4 operators seamless use.
-
*GLOBAL:LOCAL1:LOCAL2*
- This is the format to define Large Community values. Referencing
- :t:`RFC8195, Use of BGP Large Communities` the values are commonly
- referred to as follows.
- The `GLOBAL` part is a 4 octet Global Administrator field, common
- use of this field is the operators AS number.
- The `LOCAL1` part is a 4 octet Local Data Part 1 subfield referred
- to as a function.
- The `LOCAL2` part is a 4 octet Local Data Part 2 field and referred
- to as the parameter subfield. `65551:1:10` represents AS 65551
- function 1 and parameter 10.
- The referenced RFC above gives some guidelines on recommended usage.
+ This is the format to define Large Community values. Referencing
+ :t:`RFC8195, Use of BGP Large Communities` the values are commonly
+ referred to as follows.
+ The `GLOBAL` part is a 4 octet Global Administrator field, common
+ use of this field is the operators AS number.
+ The `LOCAL1` part is a 4 octet Local Data Part 1 subfield referred
+ to as a function.
+ The `LOCAL2` part is a 4 octet Local Data Part 2 field and referred
+ to as the parameter subfield. `65551:1:10` represents AS 65551
+ function 1 and parameter 10.
+ The referenced RFC above gives some guidelines on recommended usage.
.. _BGP_Large_Community_Lists:
`expanded`.
.. index:: ip large-community-list standard NAME permit|deny LARGE-COMMUNITY
-
.. clicmd:: ip large-community-list standard NAME permit|deny LARGE-COMMUNITY
- This command defines a new standard large-community-list.
- `large-community` is the Large Community value. We
- can add multiple large communities under same name. In that case
- the match will happen in the user defined order. Once the large-community-list
- matches the Large Communities attribute in BGP updates it will return
- permit or deny based upon the large-community-list definition. When
- there is no matched entry, a deny will be returned. When `large-community`
- is empty it matches any routes.
-.. index:: ip large-community-list expanded NAME permit|deny LINE
+ This command defines a new standard large-community-list.
+ `large-community` is the Large Community value. We
+ can add multiple large communities under same name. In that case
+ the match will happen in the user defined order. Once the large-community-list
+ matches the Large Communities attribute in BGP updates it will return
+ permit or deny based upon the large-community-list definition. When
+ there is no matched entry, a deny will be returned. When `large-community`
+ is empty it matches any routes.
+.. index:: ip large-community-list expanded NAME permit|deny LINE
.. clicmd:: ip large-community-list expanded NAME permit|deny LINE
- This command defines a new expanded large-community-list. Where `line` is
- a string matching expression, it will be compared to the entire Large Communities
- attribute as a string, with each large-community in order from lowest to highest.
- `line` can also be a regular expression which matches this Large
- Community attribute.
-.. index:: no ip large-community-list NAME
+ This command defines a new expanded large-community-list. Where `line` is
+ a string matching expression, it will be compared to the entire Large Communities
+ attribute as a string, with each large-community in order from lowest to highest.
+ `line` can also be a regular expression which matches this Large
+ Community attribute.
+.. index:: no ip large-community-list NAME
.. clicmd:: no ip large-community-list NAME
-.. index:: no ip large-community-list standard NAME
+.. index:: no ip large-community-list standard NAME
.. clicmd:: no ip large-community-list standard NAME
-.. index:: no ip large-community-list expanded NAME
+.. index:: no ip large-community-list expanded NAME
.. clicmd:: no ip 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.
-.. index:: show ip large-community-list
+ 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.
+.. index:: show ip large-community-list
.. clicmd:: show ip large-community-list
-.. index:: show ip large-community-list NAME
+.. index:: show ip large-community-list NAME
.. clicmd:: show ip large-community-list NAME
- This command display current large-community-list information. When
- `name` is specified the community list information is shown.
-.. index:: show ip bgp large-community-info
+ This command display current large-community-list information. When
+ `name` is specified the community list information is shown.
+.. index:: show ip bgp large-community-info
.. clicmd:: show ip bgp large-community-info
- This command displays the current large communities in use.
+
+ This command displays the current large communities in use.
.. _BGP_Large_Communities_in_Route_Map:
----------------------------------
.. index:: match large-community LINE
-
.. clicmd:: match large-community LINE
- Where `line` can be a simple string to match, or a regular expression.
- It is very important to note that this match occurs on the entire
- large-community string as a whole, where each large-community is ordered
- from lowest to highest.
-.. index:: set large-community LARGE-COMMUNITY
+ Where `line` can be a simple string to match, or a regular expression.
+ It is very important to note that this match occurs on the entire
+ large-community string as a whole, where each large-community is ordered
+ from lowest to highest.
+.. index:: set large-community LARGE-COMMUNITY
.. clicmd:: set large-community LARGE-COMMUNITY
-.. index:: set large-community LARGE-COMMUNITY LARGE-COMMUNITY
+.. index:: set large-community LARGE-COMMUNITY LARGE-COMMUNITY
.. clicmd:: set large-community LARGE-COMMUNITY LARGE-COMMUNITY
-.. index:: set large-community LARGE-COMMUNITY additive
+.. index:: set large-community LARGE-COMMUNITY additive
.. clicmd:: set large-community LARGE-COMMUNITY additive
- These commands are used for setting large-community values. The first
- command will overwrite any large-communities currently present.
- The second specifies two large-communities, which overwrites the current
- large-community list. The third will add a large-community value without
- overwriting other values. Multiple large-community values can be specified.
+
+ These commands are used for setting large-community values. The first
+ command will overwrite any large-communities currently present.
+ The second specifies two large-communities, which overwrites the current
+ large-community list. The third will add a large-community value without
+ overwriting other values. Multiple large-community values can be specified.
.. _Displaying_BGP_information:
-----------------------
.. index:: show ip bgp
-
.. clicmd:: show ip bgp
-.. index:: show ip bgp A.B.C.D
+.. index:: show ip bgp A.B.C.D
.. clicmd:: show ip bgp A.B.C.D
-.. index:: show ip bgp X:X::X:X
+.. index:: show ip bgp X:X::X:X
.. clicmd:: show ip bgp X:X::X:X
- This command displays BGP routes. When no route is specified it
- display all of IPv4 BGP routes.
-::
+ This command displays BGP routes. When no route is specified it
+ display all of IPv4 BGP routes.
+ ::
+
BGP table version is 0, local router ID is 10.1.1.1
- Status codes: s suppressed, d damped, h history, * valid, > best, i - internal
- Origin codes: i - IGP, e - EGP, ? - incomplete
-
- Network Next Hop Metric LocPrf Weight Path
- *> 1.1.1.1/32 0.0.0.0 0 32768 i
-
- Total number of prefixes 1
+ Status codes: s suppressed, d damped, h history, * valid, > best, i - internal
+ Origin codes: i - IGP, e - EGP, ? - incomplete
+
+ Network Next Hop Metric LocPrf Weight Path
+ \*> 1.1.1.1/32 0.0.0.0 0 32768 i
+
+ Total number of prefixes 1
.. index:: show ip bgp regexp LINE
-
.. clicmd:: show ip bgp regexp LINE
- This command displays BGP routes using AS path regular expression
- (:ref:`BGP_Regular_Expressions`).
-.. index:: show ip bgp community COMMUNITY
+ This command displays BGP routes using AS path regular expression
+ (:ref:`BGP_Regular_Expressions`).
+.. index:: show ip bgp community COMMUNITY
.. clicmd:: show ip bgp community COMMUNITY
-.. index:: show ip bgp community COMMUNITY exact-match
+.. index:: show ip bgp community COMMUNITY exact-match
.. clicmd:: show ip bgp community COMMUNITY exact-match
- This command displays BGP routes using `community` (:ref:`Display_BGP_Routes_by_Community`).
-.. index:: show ip bgp community-list WORD
+ This command displays BGP routes using `community` (:ref:`Display_BGP_Routes_by_Community`).
+.. index:: show ip bgp community-list WORD
.. clicmd:: show ip bgp community-list WORD
-.. index:: show ip bgp community-list WORD exact-match
+.. index:: show ip bgp community-list WORD exact-match
.. clicmd:: show ip bgp community-list WORD exact-match
- This command displays BGP routes using community list (:ref:`Display_BGP_Routes_by_Community`).
-.. index:: show bgp ipv4|ipv6 summary
+ This command displays BGP routes using community list (:ref:`Display_BGP_Routes_by_Community`).
+.. index:: show bgp ipv4|ipv6 summary
.. clicmd:: show bgp ipv4|ipv6 summary
- Show a bgp peer summary for the specified address family.
-.. index:: show bgp ipv4|ipv6 neighbor [PEER]
+ Show a bgp peer summary for the specified address family.
+.. index:: show bgp ipv4|ipv6 neighbor [PEER]
.. clicmd:: show bgp ipv4|ipv6 neighbor [PEER]
- This command shows information on a specific BGP `peer`.
-.. index:: show bgp ipv4|ipv6 dampening dampened-paths
+ This command shows information on a specific BGP `peer`.
+.. index:: show bgp ipv4|ipv6 dampening dampened-paths
.. clicmd:: show bgp ipv4|ipv6 dampening dampened-paths
- Display paths suppressed due to dampening.
-.. index:: show bgp ipv4|ipv6 dampening flap-statistics
+ Display paths suppressed due to dampening.
+.. index:: show bgp ipv4|ipv6 dampening flap-statistics
.. clicmd:: show bgp ipv4|ipv6 dampening flap-statistics
- Display flap statistics of routes.
+
+ Display flap statistics of routes.
.. _Other_BGP_commands:
------------------
.. index:: clear bgp ipv4|ipv6 \*
-
.. clicmd:: clear bgp ipv4|ipv6 \*
- Clear all address family peers.
-.. index:: clear bgp ipv4|ipv6 PEER
+ Clear all address family peers.
+.. index:: clear bgp ipv4|ipv6 PEER
.. clicmd:: clear bgp ipv4|ipv6 PEER
- Clear peers which have addresses of X.X.X.X
-.. index:: clear bgp ipv4|ipv6 PEER soft in
+ Clear peers which have addresses of X.X.X.X
+.. index:: clear bgp ipv4|ipv6 PEER soft in
.. clicmd:: clear bgp ipv4|ipv6 PEER soft in
- Clear peer using soft reconfiguration.
-.. index:: show debug
+ Clear peer using soft reconfiguration.
+.. index:: show debug
.. clicmd:: show debug
-.. index:: debug event
+.. index:: debug event
.. clicmd:: debug event
-.. index:: debug update
+.. index:: debug update
.. clicmd:: debug update
-.. index:: debug keepalive
+.. index:: debug keepalive
.. clicmd:: debug keepalive
-.. index:: no debug event
+.. index:: no debug event
.. clicmd:: no debug event
-.. index:: no debug update
+.. index:: no debug update
.. clicmd:: no debug update
-.. index:: no debug keepalive
+.. index:: no debug keepalive
.. clicmd:: no debug keepalive
+
.. _Capability_Negotiation:
Capability Negotiation
If you want to completely match capabilities with remote peer. Please
use *strict-capability-match* command.
-.. index:: neighbor `peer` strict-capability-match
-
-.. clicmd:: neighbor `peer` strict-capability-match
-
-.. index:: no neighbor `peer` strict-capability-match
-
-.. clicmd:: no neighbor `peer` strict-capability-match
+.. index:: neighbor PEER strict-capability-match
+.. clicmd:: neighbor PEER strict-capability-match
- Strictly compares remote capabilities and local capabilities. If capabilities
- are different, send Unsupported Capability error then reset connection.
+.. index:: no neighbor PEER strict-capability-match
+.. clicmd:: no neighbor PEER strict-capability-match
- You may want to disable sending Capability Negotiation OPEN message
- optional parameter to the peer when remote peer does not implement
- Capability Negotiation. Please use *dont-capability-negotiate*
- command to disable the feature.
+ Strictly compares remote capabilities and local capabilities. If capabilities
+ are different, send Unsupported Capability error then reset connection.
-.. index:: neighbor `peer` dont-capability-negotiate
+ You may want to disable sending Capability Negotiation OPEN message
+ optional parameter to the peer when remote peer does not implement
+ Capability Negotiation. Please use *dont-capability-negotiate*
+ command to disable the feature.
-.. clicmd:: neighbor `peer` dont-capability-negotiate
+.. index:: neighbor PEER dont-capability-negotiate
+.. clicmd:: neighbor PEER dont-capability-negotiate
-.. index:: no neighbor `peer` dont-capability-negotiate
+.. index:: no neighbor PEER dont-capability-negotiate
+.. clicmd:: no neighbor PEER dont-capability-negotiate
-.. clicmd:: no 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 IPv4 unicast configuration.
- Suppress sending Capability Negotiation as OPEN message optional
- parameter to the peer. This command only affects the peer is configured
- other than IPv4 unicast configuration.
+ When remote peer does not have capability negotiation feature, remote
+ peer will not send any capabilities at all. In that case, bgp
+ configures the peer with configured capabilities.
- When remote peer does not have capability negotiation feature, remote
- peer will not send any capabilities at all. In that case, bgp
- configures the peer with configured capabilities.
+ You may prefer locally configured capabilities more than the negotiated
+ capabilities even though remote peer sends capabilities. If the peer
+ is configured by *override-capability*, *bgpd* ignores
+ received capabilities then override negotiated capabilities with
+ configured values.
- You may prefer locally configured capabilities more than the negotiated
- capabilities even though remote peer sends capabilities. If the peer
- is configured by *override-capability*, *bgpd* ignores
- received capabilities then override negotiated capabilities with
- configured values.
+.. index:: neighbor PEER override-capability
+.. clicmd:: neighbor PEER override-capability
-.. index:: neighbor `peer` override-capability
+.. index:: no neighbor PEER override-capability
+.. clicmd:: no neighbor PEER override-capability
-.. clicmd:: neighbor `peer` override-capability
-
-.. index:: no 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.
+ Override the result of Capability Negotiation with local configuration.
+ Ignore remote peer's capability value.
.. _Route_Reflector:
Route Reflector
===============
-.. index:: bgp cluster-id `a.b.c.d`
-
-.. clicmd:: bgp cluster-id `a.b.c.d`
-
+.. index:: bgp cluster-id A.B.C.D
+.. clicmd:: bgp cluster-id A.B.C.D
-.. index:: neighbor `peer` route-reflector-client
+.. index:: neighbor PEER route-reflector-client
+.. clicmd:: neighbor PEER route-reflector-client
-.. clicmd:: neighbor `peer` route-reflector-client
-
-.. index:: no neighbor `peer` route-reflector-client
-
-.. clicmd:: no neighbor `peer` route-reflector-client
+.. index:: no neighbor PEER route-reflector-client
+.. clicmd:: no neighbor PEER route-reflector-client
.. _Route_Server:
Route Server
============
-At an Internet Exchange point, many ISPs are connected to each other by
-external BGP peering. Normally these external BGP connection are done by
-.. clicmd:: full mesh method. As with internal BGP full mesh formation,
+At an Internet Exchange point, many ISPs are connected to each other by the
+"full mesh method". As with internal BGP full mesh formation,
+
this method has a scaling problem.
-This scaling problem is well known. Route Server is a method to resolve
-the problem. Each ISP's BGP router only peers to Route Server. Route
-Server serves as BGP information exchange to other BGP routers. By
-applying this method, numbers of BGP connections is reduced from
-O(n*(n-1)/2) to O(n).
+This scaling problem is well known. Route Server is a method to resolve the
+problem. Each ISP's BGP router only peers to Route Server. Route Server serves
+as BGP information exchange to other BGP routers. By applying this method,
+numbers of BGP connections is reduced from O(n*(n-1)/2) to O(n).
-Unlike normal BGP router, Route Server must have several routing tables
-for managing different routing policies for each BGP speaker. We call the
-routing tables as different ``view`` s. *bgpd* can work as
-normal BGP router or Route Server or both at the same time.
+Unlike normal BGP router, Route Server must have several routing tables for
+managing different routing policies for each BGP speaker. We call the routing
+tables as different "views". *bgpd* can work as normal BGP router or Route
+Server or both at the same time.
.. _Multiple_instance:
Multiple instance
-----------------
-To enable multiple view function of `bgpd`, you must turn on
-multiple instance feature beforehand.
+To enable multiple view function of *bgpd*, you must turn on multiple instance
+feature beforehand.
.. index:: bgp multiple-instance
-
.. clicmd:: bgp multiple-instance
- Enable BGP multiple instance feature. After this feature is enabled,
- you can make multiple BGP instances or multiple BGP views.
-.. index:: no bgp multiple-instance
+ Enable BGP multiple instance feature. After this feature is enabled,
+ you can make multiple BGP instances or multiple BGP views.
+.. index:: no bgp multiple-instance
.. clicmd:: no bgp multiple-instance
- Disable BGP multiple instance feature. You can not disable this feature
- when BGP multiple instances or views exist.
+
+ Disable BGP multiple instance feature. You can not disable this feature
+ when BGP multiple instances or views exist.
When you want to make configuration more Cisco like one,
.. index:: bgp config-type cisco
-
.. clicmd:: bgp config-type cisco
- Cisco compatible BGP configuration output.
+
+ Cisco compatible BGP configuration output.
When bgp config-type cisco is specified,
feature community attribute is not sent to the neighbor. In case of
*bgp config-type cisco* is specified, community attribute is not
sent to the neighbor by default. To send community attribute user has
-to specify *neighbor A.B.C.D send-community* command.
-
-::
-
- !
- router bgp 1
- neighbor 10.0.0.1 remote-as 1
- address-family ipv4 unicast
- no neighbor 10.0.0.1 send-community
- exit-address-family
- !
- router bgp 1
- neighbor 10.0.0.1 remote-as 1
- address-family ipv4 unicast
- neighbor 10.0.0.1 send-community
- exit-address-family
- !
+to specify *neighbor A.B.C.D send-community* command.::
+
+ !
+ router bgp 1
+ neighbor 10.0.0.1 remote-as 1
+ address-family ipv4 unicast
+ no neighbor 10.0.0.1 send-community
+ exit-address-family
+ !
+ router bgp 1
+ neighbor 10.0.0.1 remote-as 1
+ address-family ipv4 unicast
+ neighbor 10.0.0.1 send-community
+ exit-address-family
+ !
.. index:: bgp config-type zebra
-
.. clicmd:: bgp config-type zebra
- FRR style BGP configuration. This is default.
+
+ FRR style BGP configuration. This is default.
.. _BGP_instance_and_view:
same time when BGP multiple instance feature is enabled.
.. index:: router bgp AS-NUMBER
-
.. clicmd:: router bgp AS-NUMBER
- Make a new BGP instance. You can use arbitrary word for the `name`.
-::
+ Make a new BGP instance. You can use arbitrary word for the `name`.
- bgp multiple-instance
- !
- router bgp 1
- neighbor 10.0.0.1 remote-as 2
- neighbor 10.0.0.2 remote-as 3
- !
- router bgp 2
- neighbor 10.0.0.3 remote-as 4
- neighbor 10.0.0.4 remote-as 5
+ ::
+
+ bgp multiple-instance
+ !
+ router bgp 1
+ neighbor 10.0.0.1 remote-as 2
+ neighbor 10.0.0.2 remote-as 3
+ !
+ router bgp 2
+ neighbor 10.0.0.3 remote-as 4
+ neighbor 10.0.0.4 remote-as 5
BGP view is almost same as normal BGP process. The result of
only for exchanging BGP routing information.
.. index:: router bgp AS-NUMBER view NAME
-
.. clicmd:: router bgp AS-NUMBER view NAME
- Make a new BGP view. You can use arbitrary word for the `name`. This
- view's route selection result does not go to the kernel routing table.
-With this command, you can setup Route Server like below.
+ Make a new BGP view. You can use arbitrary word for the `name`. This view's
+ route selection result does not go to the kernel routing table.
-::
+ With this command, you can setup Route Server like below.
- bgp multiple-instance
- !
- router bgp 1 view 1
- neighbor 10.0.0.1 remote-as 2
- neighbor 10.0.0.2 remote-as 3
- !
- router bgp 2 view 2
- neighbor 10.0.0.3 remote-as 4
- neighbor 10.0.0.4 remote-as 5
+ ::
+
+ bgp multiple-instance
+ !
+ router bgp 1 view 1
+ neighbor 10.0.0.1 remote-as 2
+ neighbor 10.0.0.2 remote-as 3
+ !
+ router bgp 2 view 2
+ neighbor 10.0.0.3 remote-as 4
+ neighbor 10.0.0.4 remote-as 5
.. _Routing_policy:
--------------
You can set different routing policy for a peer. For example, you can
-set different filter for a peer.
-
-::
-
- bgp multiple-instance
- !
- router bgp 1 view 1
- neighbor 10.0.0.1 remote-as 2
- address-family ipv4 unicast
- neighbor 10.0.0.1 distribute-list 1 in
- exit-address-family
- !
- router bgp 1 view 2
- neighbor 10.0.0.1 remote-as 2
- address-family ipv4 unicast
- neighbor 10.0.0.1 distribute-list 2 in
- exit-address-family
+set different filter for a peer.::
+
+ bgp multiple-instance
+ !
+ router bgp 1 view 1
+ neighbor 10.0.0.1 remote-as 2
+ address-family ipv4 unicast
+ neighbor 10.0.0.1 distribute-list 1 in
+ exit-address-family
+ !
+ router bgp 1 view 2
+ neighbor 10.0.0.1 remote-as 2
+ address-family ipv4 unicast
+ neighbor 10.0.0.1 distribute-list 2 in
+ exit-address-family
This means BGP update from a peer 10.0.0.1 goes to both BGP view 1 and view
To display routing table of BGP view, you must specify view name.
.. index:: show ip bgp view NAME
-
.. clicmd:: show ip bgp view NAME
- Display routing table of BGP view `name`.
+
+ Display routing table of BGP view ``NAME``.
.. _BGP_Regular_Expressions:
'_' is added.
-
-*.*
- Matches any single character.
+.*
+ Matches any single character.
*
- Matches 0 or more occurrences of pattern.
+ Matches 0 or more occurrences of pattern.
+
- Matches 1 or more occurrences of pattern.
+ Matches 1 or more occurrences of pattern.
?
- Match 0 or 1 occurrences of pattern.
+ Match 0 or 1 occurrences of pattern.
^
- Matches the beginning of the line.
+ Matches the beginning of the line.
$
- Matches the end of the line.
+ Matches the end of the line.
_
- Character `_` has special meanings in BGP regular expressions.
- It matches to space and comma , and AS set delimiter { and } and AS
- confederation delimiter `(` and `)`. And it also matches to
- the beginning of the line and the end of the line. So `_` can be
- used for AS value boundaries match. This character technically evaluates
- to `(^|[,{}() ]|$)`.
+ Character `_` has special meanings in BGP regular expressions. It matches
+ to space and comma , and AS set delimiter { and } and AS confederation
+ delimiter `(` and `)`. And it also matches to the beginning of the line and
+ the end of the line. So `_` can be used for AS value boundaries match. This
+ character technically evaluates to `(^|[,{}() ]|$)`.
.. _How_to_set_up_a_6-Bone_connection:
::
- zebra configuration
- ===================
- !
- ! Actually there is no need to configure zebra
- !
-
- bgpd configuration
- ==================
- !
- ! This means that routes go through zebra and into the kernel.
- !
- router zebra
- !
- ! MP-BGP configuration
- !
- router bgp 7675
- bgp router-id 10.0.0.1
- neighbor 3ffe:1cfa:0:2:2a0:c9ff:fe9e:f56 remote-as `as-number`
- !
- address-family ipv6
- network 3ffe:506::/32
- neighbor 3ffe:1cfa:0:2:2a0:c9ff:fe9e:f56 activate
- neighbor 3ffe:1cfa:0:2:2a0:c9ff:fe9e:f56 route-map set-nexthop out
- neighbor 3ffe:1cfa:0:2:2c0:4fff:fe68:a231 remote-as `as-number`
- neighbor 3ffe:1cfa:0:2:2c0:4fff:fe68:a231 route-map set-nexthop out
- exit-address-family
- !
- ipv6 access-list all permit any
- !
- ! Set output nexthop address.
- !
- route-map set-nexthop permit 10
- match ipv6 address all
- set ipv6 nexthop global 3ffe:1cfa:0:2:2c0:4fff:fe68:a225
- set ipv6 nexthop local fe80::2c0:4fff:fe68:a225
- !
- ! logfile FILENAME is obsolete. Please use log file FILENAME
-
- log file bgpd.log
- !
+ zebra configuration
+ ===================
+ !
+ ! Actually there is no need to configure zebra
+ !
+
+ bgpd configuration
+ ==================
+ !
+ ! This means that routes go through zebra and into the kernel.
+ !
+ router zebra
+ !
+ ! MP-BGP configuration
+ !
+ router bgp 7675
+ bgp router-id 10.0.0.1
+ neighbor 3ffe:1cfa:0:2:2a0:c9ff:fe9e:f56 remote-as `as-number`
+ !
+ address-family ipv6
+ network 3ffe:506::/32
+ neighbor 3ffe:1cfa:0:2:2a0:c9ff:fe9e:f56 activate
+ neighbor 3ffe:1cfa:0:2:2a0:c9ff:fe9e:f56 route-map set-nexthop out
+ neighbor 3ffe:1cfa:0:2:2c0:4fff:fe68:a231 remote-as `as-number`
+ neighbor 3ffe:1cfa:0:2:2c0:4fff:fe68:a231 route-map set-nexthop out
+ exit-address-family
+ !
+ ipv6 access-list all permit any
+ !
+ ! Set output nexthop address.
+ !
+ route-map set-nexthop permit 10
+ match ipv6 address all
+ set ipv6 nexthop global 3ffe:1cfa:0:2:2c0:4fff:fe68:a225
+ set ipv6 nexthop local fe80::2c0:4fff:fe68:a225
+ !
+ ! logfile FILENAME is obsolete. Please use log file FILENAME
+
+ log file bgpd.log
+ !
.. _Dump_BGP_packets_and_table:
==========================
.. index:: dump bgp all PATH [INTERVAL]
-
.. clicmd:: dump bgp all PATH [INTERVAL]
-.. index:: dump bgp all-et PATH [INTERVAL]
+.. index:: dump bgp all-et PATH [INTERVAL]
.. clicmd:: dump bgp all-et PATH [INTERVAL]
-.. index:: no dump bgp all [PATH] [INTERVAL]
+.. index:: no dump bgp all [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 seconds.
- The path `path` can be set with date and time formatting (strftime).
- The type ‘all-et’ enables support for Extended Timestamp Header (:ref:`Packet_Binary_Dump_Format`).
- (:ref:`Packet_Binary_Dump_Format`)
-.. index:: dump bgp updates 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 seconds.
+ The path `path` can be set with date and time formatting (strftime).
+ The type ‘all-et’ enables support for Extended Timestamp Header (:ref:`Packet_Binary_Dump_Format`).
+ (:ref:`Packet_Binary_Dump_Format`)
+.. index:: dump bgp updates PATH [INTERVAL]
.. clicmd:: dump bgp updates PATH [INTERVAL]
-.. index:: dump bgp updates-et PATH [INTERVAL]
+.. index:: dump bgp updates-et PATH [INTERVAL]
.. clicmd:: dump bgp updates-et PATH [INTERVAL]
-.. index:: no dump bgp updates [PATH] [INTERVAL]
+.. index:: no dump bgp updates [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 seconds.
- The path `path` can be set with date and time formatting (strftime).
- The type ‘updates-et’ enables support for Extended Timestamp Header (:ref:`Packet_Binary_Dump_Format`).
-.. index:: dump bgp routes-mrt PATH
+ Dump only BGP updates messages to `path` file.
+ If `interval` is set, a new file will be created for echo `interval` of seconds.
+ The path `path` can be set with date and time formatting (strftime).
+ The type ‘updates-et’ enables support for Extended Timestamp Header (:ref:`Packet_Binary_Dump_Format`).
+.. index:: dump bgp routes-mrt PATH
.. clicmd:: dump bgp routes-mrt PATH
-.. index:: dump bgp routes-mrt PATH INTERVAL
+.. index:: dump bgp routes-mrt PATH INTERVAL
.. clicmd:: dump bgp routes-mrt PATH INTERVAL
-.. index:: no dump bgp route-mrt [PATH] [INTERVAL]
+.. index:: no dump bgp route-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 set, a new file will be created for echo `interval` of seconds.
- Note: the interval variable can also be set using hours and minutes: 04h20m00.
+ 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 set, a new file will be created for echo `interval` of seconds.
-BGP Configuration Examples
-==========================
+ Note: the interval variable can also be set using hours and minutes: 04h20m00.
-Example of a session to an upstream, advertising only one prefix to it.
-
-::
+.. _bgp-configuration-examples:
- router bgp 64512
- bgp router-id 10.236.87.1
- neighbor upstream peer-group
- neighbor upstream remote-as 64515
- neighbor upstream capability dynamic
- neighbor 10.1.1.1 peer-group upstream
- neighbor 10.1.1.1 description ACME ISP
+BGP Configuration Examples
+==========================
- address-family ipv4 unicast
- network 10.236.87.0/24
- neighbor upstream prefix-list pl-allowed-adv out
- exit-address-family
- !
- ip prefix-list pl-allowed-adv seq 5 permit 82.195.133.0/25
- ip prefix-list pl-allowed-adv seq 10 deny any
+Example of a session to an upstream, advertising only one prefix to it.::
+ router bgp 64512
+ bgp router-id 10.236.87.1
+ neighbor upstream peer-group
+ neighbor upstream remote-as 64515
+ neighbor upstream capability dynamic
+ neighbor 10.1.1.1 peer-group upstream
+ neighbor 10.1.1.1 description ACME ISP
+ address-family ipv4 unicast
+ network 10.236.87.0/24
+ neighbor upstream prefix-list pl-allowed-adv out
+ exit-address-family
+ !
+ ip prefix-list pl-allowed-adv seq 5 permit 82.195.133.0/25
+ ip prefix-list pl-allowed-adv seq 10 deny any
A more complex example. With upstream, peer and customer sessions.
Advertising global prefixes and NO_EXPORT prefixes and providing
::
- router bgp 64512
- bgp router-id 10.236.87.1
- neighbor upstream capability dynamic
- neighbor cust capability dynamic
- neighbor peer capability dynamic
- neighbor 10.1.1.1 remote-as 64515
- neighbor 10.1.1.1 peer-group upstream
- neighbor 10.2.1.1 remote-as 64516
- neighbor 10.2.1.1 peer-group upstream
- neighbor 10.3.1.1 remote-as 64517
- neighbor 10.3.1.1 peer-group cust-default
- neighbor 10.3.1.1 description customer1
- neighbor 10.4.1.1 remote-as 64518
- neighbor 10.4.1.1 peer-group cust
- neighbor 10.4.1.1 description customer2
- neighbor 10.5.1.1 remote-as 64519
- neighbor 10.5.1.1 peer-group peer
- neighbor 10.5.1.1 description peer AS 1
- neighbor 10.6.1.1 remote-as 64520
- neighbor 10.6.1.1 peer-group peer
- neighbor 10.6.1.1 description peer AS 2
-
- address-family ipv4 unicast
- network 10.123.456.0/24
- network 10.123.456.128/25 route-map rm-no-export
- neighbor upstream route-map rm-upstream-out out
- neighbor cust route-map rm-cust-in in
- neighbor cust route-map rm-cust-out out
- neighbor cust send-community both
- neighbor peer route-map rm-peer-in in
- neighbor peer route-map rm-peer-out out
- neighbor peer send-community both
- neighbor 10.3.1.1 prefix-list pl-cust1-network in
- neighbor 10.4.1.1 prefix-list pl-cust2-network in
- neighbor 10.5.1.1 prefix-list pl-peer1-network in
- neighbor 10.6.1.1 prefix-list pl-peer2-network in
- exit-address-family
- !
- ip prefix-list pl-default permit 0.0.0.0/0
- !
- ip prefix-list pl-upstream-peers permit 10.1.1.1/32
- ip prefix-list pl-upstream-peers permit 10.2.1.1/32
- !
- ip prefix-list pl-cust1-network permit 10.3.1.0/24
- ip prefix-list pl-cust1-network permit 10.3.2.0/24
- !
- ip prefix-list pl-cust2-network permit 10.4.1.0/24
- !
- ip prefix-list pl-peer1-network permit 10.5.1.0/24
- ip prefix-list pl-peer1-network permit 10.5.2.0/24
- ip prefix-list pl-peer1-network permit 192.168.0.0/24
- !
- ip prefix-list pl-peer2-network permit 10.6.1.0/24
- ip prefix-list pl-peer2-network permit 10.6.2.0/24
- ip prefix-list pl-peer2-network permit 192.168.1.0/24
- ip prefix-list pl-peer2-network permit 192.168.2.0/24
- ip prefix-list pl-peer2-network permit 172.16.1/24
- !
- ip as-path access-list asp-own-as permit ^$
- ip as-path access-list asp-own-as permit _64512_
- !
- ! #################################################################
- ! Match communities we provide actions for, on routes receives from
- ! customers. Communities values of <our-ASN>:X, with X, have actions:
- !
- ! 100 - blackhole the prefix
- ! 200 - set no_export
- ! 300 - advertise only to other customers
- ! 400 - advertise only to upstreams
- ! 500 - set no_export when advertising to upstreams
- ! 2X00 - set local_preference to X00
- !
- ! blackhole the prefix of the route
- ip community-list standard cm-blackhole permit 64512:100
- !
- ! set no-export community before advertising
- ip community-list standard cm-set-no-export permit 64512:200
- !
- ! advertise only to other customers
- ip community-list standard cm-cust-only permit 64512:300
- !
- ! advertise only to upstreams
- ip community-list standard cm-upstream-only permit 64512:400
- !
- ! advertise to upstreams with no-export
- ip community-list standard cm-upstream-noexport permit 64512:500
- !
- ! set local-pref to least significant 3 digits of the community
- ip community-list standard cm-prefmod-100 permit 64512:2100
- ip community-list standard cm-prefmod-200 permit 64512:2200
- ip community-list standard cm-prefmod-300 permit 64512:2300
- ip community-list standard cm-prefmod-400 permit 64512:2400
- ip community-list expanded cme-prefmod-range permit 64512:2...
- !
- ! Informational communities
- !
- ! 3000 - learned from upstream
- ! 3100 - learned from customer
- ! 3200 - learned from peer
- !
- ip community-list standard cm-learnt-upstream permit 64512:3000
- ip community-list standard cm-learnt-cust permit 64512:3100
- ip community-list standard cm-learnt-peer permit 64512:3200
- !
- ! ###################################################################
- ! Utility route-maps
- !
- ! These utility route-maps generally should not used to permit/deny
- ! routes, i.e. they do not have meaning as filters, and hence probably
- ! should be used with 'on-match next'. These all finish with an empty
- ! permit entry so as not interfere with processing in the caller.
- !
- route-map rm-no-export permit 10
- set community additive no-export
- route-map rm-no-export permit 20
- !
- route-map rm-blackhole permit 10
- description blackhole, up-pref and ensure it cant escape this AS
- set ip next-hop 127.0.0.1
- set local-preference 10
- set community additive no-export
- route-map rm-blackhole permit 20
- !
- ! Set local-pref as requested
- route-map rm-prefmod permit 10
- match community cm-prefmod-100
- set local-preference 100
- route-map rm-prefmod permit 20
- match community cm-prefmod-200
- set local-preference 200
- route-map rm-prefmod permit 30
- match community cm-prefmod-300
- set local-preference 300
- route-map rm-prefmod permit 40
- match community cm-prefmod-400
- set local-preference 400
- route-map rm-prefmod permit 50
- !
- ! Community actions to take on receipt of route.
- route-map rm-community-in permit 10
- description check for blackholing, no point continuing if it matches.
- match community cm-blackhole
- call rm-blackhole
- route-map rm-community-in permit 20
- match community cm-set-no-export
- call rm-no-export
- on-match next
- route-map rm-community-in permit 30
- match community cme-prefmod-range
- call rm-prefmod
- route-map rm-community-in permit 40
- !
- ! #####################################################################
- ! Community actions to take when advertising a route.
- ! These are filtering route-maps,
- !
- ! Deny customer routes to upstream with cust-only set.
- route-map rm-community-filt-to-upstream deny 10
- match community cm-learnt-cust
- match community cm-cust-only
- route-map rm-community-filt-to-upstream permit 20
- !
- ! Deny customer routes to other customers with upstream-only set.
- route-map rm-community-filt-to-cust deny 10
- match community cm-learnt-cust
- match community cm-upstream-only
- route-map rm-community-filt-to-cust permit 20
- !
- ! ###################################################################
- ! The top-level route-maps applied to sessions. Further entries could
- ! be added obviously..
- !
- ! Customers
- route-map rm-cust-in permit 10
- call rm-community-in
- on-match next
- route-map rm-cust-in permit 20
- set community additive 64512:3100
- route-map rm-cust-in permit 30
- !
- route-map rm-cust-out permit 10
- call rm-community-filt-to-cust
- on-match next
- route-map rm-cust-out permit 20
- !
- ! Upstream transit ASes
- route-map rm-upstream-out permit 10
- description filter customer prefixes which are marked cust-only
- call rm-community-filt-to-upstream
- on-match next
- route-map rm-upstream-out permit 20
- description only customer routes are provided to upstreams/peers
- match community cm-learnt-cust
- !
- ! Peer ASes
- ! outbound policy is same as for upstream
- route-map rm-peer-out permit 10
- call rm-upstream-out
- !
- route-map rm-peer-in permit 10
- set community additive 64512:3200
+ router bgp 64512
+ bgp router-id 10.236.87.1
+ neighbor upstream capability dynamic
+ neighbor cust capability dynamic
+ neighbor peer capability dynamic
+ neighbor 10.1.1.1 remote-as 64515
+ neighbor 10.1.1.1 peer-group upstream
+ neighbor 10.2.1.1 remote-as 64516
+ neighbor 10.2.1.1 peer-group upstream
+ neighbor 10.3.1.1 remote-as 64517
+ neighbor 10.3.1.1 peer-group cust-default
+ neighbor 10.3.1.1 description customer1
+ neighbor 10.4.1.1 remote-as 64518
+ neighbor 10.4.1.1 peer-group cust
+ neighbor 10.4.1.1 description customer2
+ neighbor 10.5.1.1 remote-as 64519
+ neighbor 10.5.1.1 peer-group peer
+ neighbor 10.5.1.1 description peer AS 1
+ neighbor 10.6.1.1 remote-as 64520
+ neighbor 10.6.1.1 peer-group peer
+ neighbor 10.6.1.1 description peer AS 2
+
+ address-family ipv4 unicast
+ network 10.123.456.0/24
+ network 10.123.456.128/25 route-map rm-no-export
+ neighbor upstream route-map rm-upstream-out out
+ neighbor cust route-map rm-cust-in in
+ neighbor cust route-map rm-cust-out out
+ neighbor cust send-community both
+ neighbor peer route-map rm-peer-in in
+ neighbor peer route-map rm-peer-out out
+ neighbor peer send-community both
+ neighbor 10.3.1.1 prefix-list pl-cust1-network in
+ neighbor 10.4.1.1 prefix-list pl-cust2-network in
+ neighbor 10.5.1.1 prefix-list pl-peer1-network in
+ neighbor 10.6.1.1 prefix-list pl-peer2-network in
+ exit-address-family
+ !
+ ip prefix-list pl-default permit 0.0.0.0/0
+ !
+ ip prefix-list pl-upstream-peers permit 10.1.1.1/32
+ ip prefix-list pl-upstream-peers permit 10.2.1.1/32
+ !
+ ip prefix-list pl-cust1-network permit 10.3.1.0/24
+ ip prefix-list pl-cust1-network permit 10.3.2.0/24
+ !
+ ip prefix-list pl-cust2-network permit 10.4.1.0/24
+ !
+ ip prefix-list pl-peer1-network permit 10.5.1.0/24
+ ip prefix-list pl-peer1-network permit 10.5.2.0/24
+ ip prefix-list pl-peer1-network permit 192.168.0.0/24
+ !
+ ip prefix-list pl-peer2-network permit 10.6.1.0/24
+ ip prefix-list pl-peer2-network permit 10.6.2.0/24
+ ip prefix-list pl-peer2-network permit 192.168.1.0/24
+ ip prefix-list pl-peer2-network permit 192.168.2.0/24
+ ip prefix-list pl-peer2-network permit 172.16.1/24
+ !
+ ip as-path access-list asp-own-as permit ^$
+ ip as-path access-list asp-own-as permit _64512_
+ !
+ ! #################################################################
+ ! Match communities we provide actions for, on routes receives from
+ ! customers. Communities values of <our-ASN>:X, with X, have actions:
+ !
+ ! 100 - blackhole the prefix
+ ! 200 - set no_export
+ ! 300 - advertise only to other customers
+ ! 400 - advertise only to upstreams
+ ! 500 - set no_export when advertising to upstreams
+ ! 2X00 - set local_preference to X00
+ !
+ ! blackhole the prefix of the route
+ ip community-list standard cm-blackhole permit 64512:100
+ !
+ ! set no-export community before advertising
+ ip community-list standard cm-set-no-export permit 64512:200
+ !
+ ! advertise only to other customers
+ ip community-list standard cm-cust-only permit 64512:300
+ !
+ ! advertise only to upstreams
+ ip community-list standard cm-upstream-only permit 64512:400
+ !
+ ! advertise to upstreams with no-export
+ ip community-list standard cm-upstream-noexport permit 64512:500
+ !
+ ! set local-pref to least significant 3 digits of the community
+ ip community-list standard cm-prefmod-100 permit 64512:2100
+ ip community-list standard cm-prefmod-200 permit 64512:2200
+ ip community-list standard cm-prefmod-300 permit 64512:2300
+ ip community-list standard cm-prefmod-400 permit 64512:2400
+ ip community-list expanded cme-prefmod-range permit 64512:2...
+ !
+ ! Informational communities
+ !
+ ! 3000 - learned from upstream
+ ! 3100 - learned from customer
+ ! 3200 - learned from peer
+ !
+ ip community-list standard cm-learnt-upstream permit 64512:3000
+ ip community-list standard cm-learnt-cust permit 64512:3100
+ ip community-list standard cm-learnt-peer permit 64512:3200
+ !
+ ! ###################################################################
+ ! Utility route-maps
+ !
+ ! These utility route-maps generally should not used to permit/deny
+ ! routes, i.e. they do not have meaning as filters, and hence probably
+ ! should be used with 'on-match next'. These all finish with an empty
+ ! permit entry so as not interfere with processing in the caller.
+ !
+ route-map rm-no-export permit 10
+ set community additive no-export
+ route-map rm-no-export permit 20
+ !
+ route-map rm-blackhole permit 10
+ description blackhole, up-pref and ensure it cant escape this AS
+ set ip next-hop 127.0.0.1
+ set local-preference 10
+ set community additive no-export
+ route-map rm-blackhole permit 20
+ !
+ ! Set local-pref as requested
+ route-map rm-prefmod permit 10
+ match community cm-prefmod-100
+ set local-preference 100
+ route-map rm-prefmod permit 20
+ match community cm-prefmod-200
+ set local-preference 200
+ route-map rm-prefmod permit 30
+ match community cm-prefmod-300
+ set local-preference 300
+ route-map rm-prefmod permit 40
+ match community cm-prefmod-400
+ set local-preference 400
+ route-map rm-prefmod permit 50
+ !
+ ! Community actions to take on receipt of route.
+ route-map rm-community-in permit 10
+ description check for blackholing, no point continuing if it matches.
+ match community cm-blackhole
+ call rm-blackhole
+ route-map rm-community-in permit 20
+ match community cm-set-no-export
+ call rm-no-export
+ on-match next
+ route-map rm-community-in permit 30
+ match community cme-prefmod-range
+ call rm-prefmod
+ route-map rm-community-in permit 40
+ !
+ ! #####################################################################
+ ! Community actions to take when advertising a route.
+ ! These are filtering route-maps,
+ !
+ ! Deny customer routes to upstream with cust-only set.
+ route-map rm-community-filt-to-upstream deny 10
+ match community cm-learnt-cust
+ match community cm-cust-only
+ route-map rm-community-filt-to-upstream permit 20
+ !
+ ! Deny customer routes to other customers with upstream-only set.
+ route-map rm-community-filt-to-cust deny 10
+ match community cm-learnt-cust
+ match community cm-upstream-only
+ route-map rm-community-filt-to-cust permit 20
+ !
+ ! ###################################################################
+ ! The top-level route-maps applied to sessions. Further entries could
+ ! be added obviously..
+ !
+ ! Customers
+ route-map rm-cust-in permit 10
+ call rm-community-in
+ on-match next
+ route-map rm-cust-in permit 20
+ set community additive 64512:3100
+ route-map rm-cust-in permit 30
+ !
+ route-map rm-cust-out permit 10
+ call rm-community-filt-to-cust
+ on-match next
+ route-map rm-cust-out permit 20
+ !
+ ! Upstream transit ASes
+ route-map rm-upstream-out permit 10
+ description filter customer prefixes which are marked cust-only
+ call rm-community-filt-to-upstream
+ on-match next
+ route-map rm-upstream-out permit 20
+ description only customer routes are provided to upstreams/peers
+ match community cm-learnt-cust
+ !
+ ! Peer ASes
+ ! outbound policy is same as for upstream
+ route-map rm-peer-out permit 10
+ call rm-upstream-out
+ !
+ route-map rm-peer-in permit 10
+ set community additive 64512:3200
.. _Configuring_FRR_as_a_Route_Server:
Server.
.. include:: rpki.rst
+
+
+.. [bgp-route-osci-cond] McPherson, D. and Gill, V. and Walton, D., "Border Gateway Protocol (BGP) Persistent Route Oscillation Condition", IETF RFC3345
+.. [stable-flexible-ibgp] Flavel, A. and M. Roughan, "Stable and flexible iBGP", ACM SIGCOMM 2009
+.. [ibgp-correctness] Griffin, T. and G. Wilfong, "On the correctness of IBGP configuration", ACM SIGCOMM 2002
Starting and Stopping eigrpd
============================
-The default configuration file name of *eigrpd*'s is
-:file:`eigrpd.conf`. When invocation *eigrpd* searches directory
-|INSTALL_PREFIX_ETC|. If :file:`eigrpd.conf` is not there next
-search current directory. If an integrated config is specified
-configuration is written into frr.conf
+The default configuration file name of *eigrpd*'s is :file:`eigrpd.conf`. When
+invocation *eigrpd* searches directory |INSTALL_PREFIX_ETC|. If
+:file:`eigrpd.conf` is not there next search current directory. If an
+integrated config is specified configuration is written into :file:`frr.conf`.
-The EIGRP protocol requires interface information
-maintained by *zebra* daemon. So running *zebra*
-is mandatory to run *eigrpd*. Thus minimum sequence for running
-EIGRP is like below:
+The EIGRP protocol requires interface information maintained by *zebra* daemon.
+So running *zebra* is mandatory to run *eigrpd*. Thus minimum sequence for
+running EIGRP is:
::
Please note that *zebra* must be invoked before *eigrpd*.
-To stop *eigrpd*. Please use @command{kill `cat
-/var/run/eigrpd.pid`}. Certain signals have special meanings to *eigrpd*.
+To stop *eigrpd*, please use ::
+ kill `cat /var/run/eigrpd.pid`
+
+Certain signals have special meanings to *eigrpd*.
+------------------+-----------------------------------------------------------+
| Signal | Meaning |
===================
.. index:: router eigrp (1-65535)
-
.. clicmd:: router eigrp (1-65535)
+
The `router eigrp` command is necessary to enable EIGRP. To disable EIGRP,
use the `no router eigrp (1-65535)` command. EIGRP must be enabled before
carrying out any of the EIGRP commands.
.. index:: no router eigrp (1-65535)
-
.. clicmd:: no router eigrp (1-65535)
+
Disable EIGRP.
.. index:: network NETWORK
-
.. clicmd:: network NETWORK
-.. index:: no network NETWORK
+.. index:: no network NETWORK
.. clicmd:: no network NETWORK
+
Set the EIGRP enable interface by `network`. The interfaces which
have addresses matching with `network` are enabled.
Below is very simple EIGRP configuration. Interface `eth0` and
interface which address match to `10.0.0.0/8` are EIGRP enabled.
-::
-
- !
- router eigrp 1
- network 10.0.0.0/8
- !
+ ::
+ !
+ router eigrp 1
+ network 10.0.0.0/8
+ !
- Passive interface
.. index:: passive-interface (IFNAME|default)
-
.. clicmd:: passive-interface (IFNAME|default)
-.. index:: no passive-interface IFNAME
+.. index:: no passive-interface IFNAME
.. 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 multicast or unicast EIGRP packets except to EIGRP neighbors
- specified with `neighbor` command. The interface may be specified
- as `default` to make eigrpd default to passive on all interfaces.
+ interface, all receiving packets are ignored and eigrpd does not send either
+ multicast or unicast EIGRP packets except to EIGRP neighbors specified with
+ `neighbor` command. The interface may be specified as `default` to make
+ eigrpd default to passive on all interfaces.
The default is to be passive on all interfaces.
===========================
.. index:: redistribute kernel
-
.. clicmd:: redistribute kernel
-.. index:: redistribute kernel metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535)
+.. index:: redistribute kernel metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535)
.. clicmd:: redistribute kernel metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535)
-.. index:: no redistribute kernel
+.. index:: no redistribute kernel
.. clicmd:: no redistribute kernel
- `redistribute kernel` redistributes routing information from
- kernel route entries into the EIGRP tables. `no redistribute kernel`
- disables the routes.
-.. index:: redistribute static
+ `redistribute kernel` redistributes routing information from kernel route
+ entries into the EIGRP tables. `no redistribute kernel` disables the routes.
+.. index:: redistribute static
.. clicmd:: redistribute static
-.. index:: redistribute static metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535)
+.. index:: redistribute static metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535)
.. clicmd:: redistribute static metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535)
-.. index:: no redistribute static
+.. index:: no redistribute static
.. clicmd:: no redistribute static
- `redistribute static` redistributes routing information from
- static route entries into the EIGRP tables. `no redistribute static`
- disables the routes.
-.. index:: redistribute connected
+ `redistribute static` redistributes routing information from static route
+ entries into the EIGRP tables. `no redistribute static` disables the routes.
+.. index:: redistribute connected
.. clicmd:: redistribute connected
-.. index:: redistribute connected metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535)
+.. index:: redistribute connected metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535)
.. clicmd:: redistribute connected metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535)
-.. index:: no redistribute connected
+.. index:: no redistribute connected
.. clicmd:: no redistribute connected
- Redistribute connected routes into the EIGRP tables. `no redistribute
- connected` disables the connected routes in the EIGRP tables. This command
- redistribute connected of the interface which EIGRP disabled. The connected
- route on EIGRP enabled interface is announced by default.
-.. index:: redistribute ospf
+ Redistribute connected routes into the EIGRP tables. `no redistribute
+ connected` disables the connected routes in the EIGRP tables. This command
+ redistribute connected of the interface which EIGRP disabled. The connected
+ route on EIGRP enabled interface is announced by default.
+.. index:: redistribute ospf
.. clicmd:: redistribute ospf
-.. index:: redistribute ospf metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535)
+.. index:: redistribute ospf metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535)
.. clicmd:: redistribute ospf metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535)
-.. index:: no redistribute ospf
+.. index:: no redistribute ospf
.. clicmd:: no redistribute ospf
- `redistribute ospf` redistributes routing information from ospf route
- entries into the EIGRP tables. `no redistribute ospf` disables the
- routes.
-.. index:: redistribute bgp
+ `redistribute ospf` redistributes routing information from ospf route
+ entries into the EIGRP tables. `no redistribute ospf` disables the routes.
+.. index:: redistribute bgp
.. clicmd:: redistribute bgp
-.. index:: redistribute bgp metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535)
+.. index:: redistribute bgp metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535)
.. clicmd:: redistribute bgp metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535)
-.. index:: no redistribute bgp
+.. index:: no redistribute bgp
.. clicmd:: no redistribute bgp
- `redistribute bgp` redistributes routing information from
- bgp route entries into the EIGRP tables. `no redistribute bgp`
- disables the routes.
+
+ `redistribute bgp` redistributes routing information from bgp route entries
+ into the EIGRP tables. `no redistribute bgp` disables the routes.
.. _Show_EIGRP_Information:
To display EIGRP routes.
.. index:: show ip eigrp topology
-
.. clicmd:: show ip eigrp topology
- Show EIGRP routes.
+
+ Show EIGRP routes.
The command displays all EIGRP routes.
.. index:: show ip eigrp topology
-
.. clicmd:: show ip eigrp topology
- The command displays current EIGRP status
-::
+ The command displays current EIGRP status
- eigrpd> **show ip eigrp topology**
- # show ip eigrp topo
+ ::
- EIGRP Topology Table for AS(4)/ID(0.0.0.0)
+ eigrpd> **show ip eigrp topology**
+ # show ip eigrp topo
- Codes: P - Passive, A - Active, U - Update, Q - Query, R - Reply
- r - reply Status, s - sia Status
+ EIGRP Topology Table for AS(4)/ID(0.0.0.0)
- P 10.0.2.0/24, 1 successors, FD is 256256, serno: 0
- via Connected, enp0s3
+ Codes: P - Passive, A - Active, U - Update, Q - Query, R - Reply
+ r - reply Status, s - sia Status
+
+ P 10.0.2.0/24, 1 successors, FD is 256256, serno: 0
+ via Connected, enp0s3
EIGRP Debug Commands
Debug for EIGRP protocol.
.. index:: debug eigrp packets
-
.. clicmd:: debug eigrp packets
- Debug eigrp packets
-`debug eigrp` will show EIGRP packets that are sent and recevied.
+ Debug eigrp packets
-.. index:: debug eigrp transmit
+ ``debug eigrp`` will show EIGRP packets that are sent and recevied.
+.. index:: debug eigrp transmit
.. clicmd:: debug eigrp transmit
- Debug eigrp transmit events
-`debug eigrp transmit` will display detailed information about the EIGRP transmit events.
+ Debug eigrp transmit events
-.. index:: show debugging eigrp
+ ``debug eigrp transmit`` will display detailed information about the EIGRP
+ transmit events.
+.. index:: show debugging eigrp
.. clicmd:: show debugging eigrp
- Display *eigrpd*'s debugging option.
-`show debugging eigrp` will show all information currently set for eigrpd
-debug.
+ Display *eigrpd*'s debugging option.
+
+ ``show debugging eigrp`` will show all information currently set for eigrpd
+ debug.
Filtering
*********
-FRR provides many very flexible filtering features. Filtering is used
-for both input and output of the routing information. Once filtering is
+FRR provides many very flexible filtering features. Filtering is used
+for both input and output of the routing information. Once filtering is
defined, it can be applied in any direction.
-@comment node-name, next, previous, up
-
IP Access List
==============
-.. index:: {Command} {access-list `name` permit `ipv4-network`} {}
-
-{Command} {access-list `name` permit `ipv4-network`} {}
-.. index:: {Command} {access-list `name` deny `ipv4-network`} {}
+.. index:: access-list NAME permit IPV4-NETWORK
+.. clicmd:: access-list NAME permit IPV4-NETWORK
-{Command} {access-list `name` deny `ipv4-network`} {}
+.. index:: access-list NAME deny IPV4-NETWORK
+.. clicmd:: access-list NAME deny IPV4-NETWORK
- Basic filtering is done by `access-list` as shown in the
- following example.
+ Basic filtering is done by `access-list` as shown in the
+ following example.
-::
+ ::
- access-list filter deny 10.0.0.0/9
- access-list filter permit 10.0.0.0/8
+ access-list filter deny 10.0.0.0/9
+ access-list filter permit 10.0.0.0/8
- @comment node-name, next, previous, up
-
IP Prefix List
==============
*ip prefix-list* provides the most powerful prefix based
-filtering mechanism. In addition to *access-list* functionality,
+filtering mechanism. In addition to *access-list* functionality,
*ip prefix-list* has prefix length range specification and
-sequential number specification. You can add or delete prefix based
+sequential number specification. You can add or delete prefix based
filters to arbitrary points of prefix-list using sequential number specification.
-If no ip prefix-list is specified, it acts as permit. If *ip prefix-list*
+If no ip prefix-list is specified, it acts as permit. If *ip prefix-list*
is defined, and no match is found, default deny is applied.
-.. index:: {Command} {ip prefix-list `name` (permit|deny) `prefix` [le `len`] [ge `len`]} {}
-
-{Command} {ip prefix-list `name` (permit|deny) `prefix` [le `len`] [ge `len`]} {}
-.. index:: {Command} {ip prefix-list `name` seq `number` (permit|deny) `prefix` [le `len`] [ge `len`]} {}
+.. index:: ip prefix-list NAME (permit|deny) PREFIX [le LEN] [ge LEN]
+.. clicmd:: ip prefix-list NAME (permit|deny) PREFIX [le LEN] [ge LEN]
-{Command} {ip prefix-list `name` seq `number` (permit|deny) `prefix` [le `len`] [ge `len`]} {}
- You can create *ip prefix-list* using above commands.
+.. index:: ip prefix-list NAME seq NUMBER (permit|deny) PREFIX [le LEN] [ge LEN]
+.. clicmd:: ip prefix-list NAME seq NUMBER (permit|deny) PREFIX [le LEN] [ge LEN]
+ You can create *ip prefix-list* using above commands.
-
-*@asis{seq}*
- seq `number` can be set either automatically or manually. In the
+ seq
+ seq `number` can be set either automatically or manually. In the
case that sequential numbers are set manually, the user may pick any
- number less than 4294967295. In the case that sequential number are set
+ number less than 4294967295. In the case that sequential number are set
automatically, the sequential number will increase by a unit of five (5)
- per list. If a list with no specified sequential number is created
+ per list. If a list with no specified sequential number is created
after a list with a specified sequential number, the list will
automatically pick the next multiple of five (5) as the list number.
For example, if a list with number 2 already exists and a new list with
- no specified number is created, the next list will be numbered 5. If
+ no specified number is created, the next list will be numbered 5. If
lists 2 and 7 already exist and a new list with no specified number is
created, the new list will be numbered 10.
+ le
+ Specifies prefix length. The prefix list will be applied if the prefix
+ length is less than or equal to the le prefix length.
-*@asis{le}*
- *le* command specifies prefix length. The prefix list will be
- applied if the prefix length is less than or equal to the le prefix length.
-
-
-*@asis{ge}*
- *ge* command specifies prefix length. The prefix list will be
- applied if the prefix length is greater than or equal to the ge prefix length.
-
+ ge
+ Specifies prefix length. The prefix list will be applied if the prefix
+ length is greater than or equal to the ge prefix length.
- Less than or equal to prefix numbers and greater than or equal to
- prefix numbers can be used together. The order of the le and ge
- commands does not matter.
- If a prefix list with a different sequential number but with the exact
- same rules as a previous list is created, an error will result.
- However, in the case that the sequential number and the rules are
- exactly similar, no error will result.
+ Less than or equal to prefix numbers and greater than or equal to
+ prefix numbers can be used together. The order of the le and ge
+ commands does not matter.
- If a list with the same sequential number as a previous list is created,
- the new list will overwrite the old list.
+ If a prefix list with a different sequential number but with the exact
+ same rules as a previous list is created, an error will result.
+ However, in the case that the sequential number and the rules are
+ exactly similar, no error will result.
- Matching of IP Prefix is performed from the smaller sequential number to the
- larger. The matching will stop once any rule has been applied.
+ If a list with the same sequential number as a previous list is created,
+ the new list will overwrite the old list.
- In the case of no le or ge command, the prefix length must match exactly the
- length specified in the prefix list.
+ Matching of IP Prefix is performed from the smaller sequential number to the
+ larger. The matching will stop once any rule has been applied.
-.. index:: {Command} {no ip prefix-list `name`} {}
+ In the case of no le or ge command, the prefix length must match exactly the
+ length specified in the prefix list.
-{Command} {no ip prefix-list `name`} {}
+.. index:: no ip prefix-list NAME
+.. clicmd:: no ip prefix-list NAME
.. _ip_prefix-list_description:
ip prefix-list description
--------------------------
-.. index:: {Command} {ip prefix-list `name` description `desc`} {}
+.. index:: ip prefix-list NAME description DESC
+.. clicmd:: ip prefix-list NAME description DESC
-{Command} {ip prefix-list `name` description `desc`} {}
- Descriptions may be added to prefix lists. This command adds a
- description to the prefix list.
+ Descriptions may be added to prefix lists. This command adds a
+ description to the prefix list.
-.. index:: {Command} {no ip prefix-list `name` description [`desc`]} {}
+.. index:: no ip prefix-list NAME description [DESC]
+.. clicmd:: no ip prefix-list NAME description [DESC]
-{Command} {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.
+ Deletes the description from a prefix list. It is possible to use the
+ command without the full description.
.. _ip_prefix-list_sequential_number_control:
ip prefix-list sequential number control
----------------------------------------
-.. index:: {Command} {ip prefix-list sequence-number} {}
+.. index:: ip prefix-list sequence-number
+.. clicmd:: ip prefix-list sequence-number
-{Command} {ip prefix-list sequence-number} {}
- With this command, the IP prefix list sequential number is displayed.
- This is the default behavior.
+ With this command, the IP prefix list sequential number is displayed.
+ This is the default behavior.
-.. index:: {Command} {no ip prefix-list sequence-number} {}
+.. index:: no ip prefix-list sequence-number
+.. clicmd:: no ip prefix-list sequence-number
-{Command} {no ip prefix-list sequence-number} {}
- With this command, the IP prefix list sequential number is not
- displayed.
+ With this command, the IP prefix list sequential number is not
+ displayed.
.. _Showing_ip_prefix-list:
Showing ip prefix-list
----------------------
-.. index:: {Command} {show ip prefix-list} {}
+.. index:: show ip prefix-list
+.. clicmd:: show ip prefix-list
-{Command} {show ip prefix-list} {}
- Display all IP prefix lists.
+ Display all IP prefix lists.
-.. index:: {Command} {show ip prefix-list `name`} {}
+.. index:: show ip prefix-list NAME
+.. clicmd:: show ip prefix-list NAME
-{Command} {show ip prefix-list `name`} {}
- Show IP prefix list can be used with a prefix list name.
+ Show IP prefix list can be used with a prefix list name.
-.. index:: {Command} {show ip prefix-list `name` seq `num`} {}
+.. index:: show ip prefix-list NAME seq NUM
+.. clicmd:: show ip prefix-list NAME seq NUM
-{Command} {show ip prefix-list `name` seq `num`} {}
- Show IP prefix list can be used with a prefix list name and sequential
- number.
+ Show IP prefix list can be used with a prefix list name and sequential
+ number.
-.. index:: {Command} {show ip prefix-list `name` `a.b.c.d/m`} {}
+.. index:: show ip prefix-list NAME A.B.C.D/M
+.. clicmd:: show ip prefix-list NAME A.B.C.D/M
-{Command} {show ip prefix-list `name` `a.b.c.d/m`} {}
- If the command longer is used, all prefix lists with prefix lengths equal to
- or longer than the specified length will be displayed.
- If the command first match is used, the first prefix length match will be
- displayed.
+ If the command longer is used, all prefix lists with prefix lengths equal to
+ or longer than the specified length will be displayed. If the command first
+ match is used, the first prefix length match will be displayed.
-.. index:: {Command} {show ip prefix-list `name` `a.b.c.d/m` longer} {}
-
-{Command} {show ip prefix-list `name` `a.b.c.d/m` longer} {}
-.. index:: {Command} {show ip prefix-list `name` `a.b.c.d/m` first-match} {}
-
-{Command} {show ip prefix-list `name` `a.b.c.d/m` first-match} {}
-.. index:: {Command} {show ip prefix-list summary} {}
-
-{Command} {show ip prefix-list summary} {}
-.. index:: {Command} {show ip prefix-list summary `name`} {}
-
-{Command} {show ip prefix-list summary `name`} {}
-.. index:: {Command} {show ip prefix-list detail} {}
-
-{Command} {show ip prefix-list detail} {}
-.. index:: {Command} {show ip prefix-list detail `name`} {}
-
-{Command} {show ip prefix-list detail `name`} {}
+.. index:: show ip prefix-list NAME A.B.C.D/M longer
+.. clicmd:: show ip prefix-list NAME A.B.C.D/M longer
+.. index:: show ip prefix-list NAME A.B.C.D/M first-match
+.. clicmd:: show ip prefix-list NAME A.B.C.D/M first-match
+.. index:: show ip prefix-list summary
+.. clicmd:: show ip prefix-list summary
+.. index:: show ip prefix-list summary NAME
+.. clicmd:: show ip prefix-list summary NAME
+.. index:: show ip prefix-list detail
+.. clicmd:: show ip prefix-list detail
+.. index:: show ip prefix-list detail NAME
+.. clicmd:: show ip prefix-list detail NAME
Clear counter of ip prefix-list
-------------------------------
-.. index:: {Command} {clear ip prefix-list} {}
-
-{Command} {clear ip prefix-list} {}
- Clears the counters of all IP prefix lists. Clear IP Prefix List can be
- used with a specified name and prefix.
-
-.. index:: {Command} {clear ip prefix-list `name`} {}
+.. index:: clear ip prefix-list
+.. clicmd:: clear ip prefix-list
-{Command} {clear ip prefix-list `name`} {}
-.. index:: {Command} {clear ip prefix-list `name` `a.b.c.d/m`} {}
+ Clears the counters of all IP prefix lists. Clear IP Prefix List can be used
+ with a specified name and prefix.
-{Command} {clear ip prefix-list `name` `a.b.c.d/m`} {}
+.. index:: clear ip prefix-list NAME
+.. clicmd:: clear ip prefix-list NAME
+.. index:: clear ip prefix-list NAME A.B.C.D/M
+.. clicmd:: clear ip prefix-list NAME A.B.C.D/M
Build without SNMP support.
+.. option:: --disable-vtysh
+
+ Build without VTYSH.
You may specify any combination of the above options to the configure
script. By default, the executables are placed in :file:`/usr/local/sbin`
IPv6 Support
************
-FRR fully supports IPv6 routing. As described so far, Frr supports
-RIPng, OSPFv3, and BGP-4+. You can give IPv6 addresses to an interface
-and configure static IPv6 routing information. FRR IPv6 also provides
-automatic address configuration via a feature called ``address auto configuration``. To do it, the router must send router advertisement
-messages to the all nodes that exist on the network.
+FRR fully supports IPv6 routing. As described so far, Frr supports RIPng,
+OSPFv3, and BGP-4+. You can give IPv6 addresses to an interface and configure
+static IPv6 routing information. FRR IPv6 also provides automatic address
+configuration via a feature called ``address auto configuration``. To do it,
+the router must send router advertisement messages to the all nodes that exist
+on the network.
Previous versions of FRR could be built without IPv6 support. This is
no longer possible.
====================
.. index:: no ipv6 nd suppress-ra
-
.. clicmd:: no ipv6 nd suppress-ra
+
Send router advertisment messages.
.. index:: ipv6 nd suppress-ra
-
.. clicmd:: ipv6 nd suppress-ra
+
Don't send router advertisment messages.
.. index:: ipv6 nd prefix ipv6prefix [valid-lifetime] [preferred-lifetime] [off-link] [no-autoconfig] [router-address]
-
.. clicmd:: ipv6 nd prefix ipv6prefix [valid-lifetime] [preferred-lifetime] [off-link] [no-autoconfig] [router-address]
- Configuring the IPv6 prefix to include in router advertisements. Several prefix
- specific optional parameters and flags may follow:
- - ``valid-lifetime``: the length of time in seconds during what the prefix is
- valid for the purpose of on-link determination. Value ``infinite`` represents
- infinity (i.e. a value of all one bits (``0xffffffff``)).
- Range: ``(0-4294967295)`` Default: ``2592000``
+ Configuring the IPv6 prefix to include in router advertisements. Several prefix
+ specific optional parameters and flags may follow:
- - ``preferred-lifetime``: the length of time in seconds during what addresses
- generated from the prefix remain preferred. Value ``infinite`` represents
- infinity.
- Range: ``(0-4294967295)`` Default: ``604800``
+ - ``valid-lifetime``: the length of time in seconds during what the prefix is
+ valid for the purpose of on-link determination. Value ``infinite`` represents
+ infinity (i.e. a value of all one bits (``0xffffffff``)).
+ Range: ``(0-4294967295)`` Default: ``2592000``
- - ``off-link``: indicates that advertisement makes no statement about on-link or
- off-link properties of the prefix.
- Default: not set, i.e. this prefix can be used for on-link determination.
+ - ``preferred-lifetime``: the length of time in seconds during what addresses
+ generated from the prefix remain preferred. Value ``infinite`` represents
+ infinity.
+ Range: ``(0-4294967295)`` Default: ``604800``
- - ``no-autoconfig``: indicates to hosts on the local link that the specified prefix
- cannot be used for IPv6 autoconfiguration.
+ - ``off-link``: indicates that advertisement makes no statement about on-link or
+ off-link properties of the prefix.
+ Default: not set, i.e. this prefix can be used for on-link determination.
- Default: not set, i.e. prefix can be used for autoconfiguration.
+ - ``no-autoconfig``: indicates to hosts on the local link that the specified prefix
+ cannot be used for IPv6 autoconfiguration.
- - ``router-address``: indicates to hosts on the local link that the specified
- prefix contains a complete IP address by setting R flag.
+ Default: not set, i.e. prefix can be used for autoconfiguration.
- Default: not set, i.e. hosts do not assume a complete IP address is placed.
+ - ``router-address``: indicates to hosts on the local link that the specified
+ prefix contains a complete IP address by setting R flag.
+
+ Default: not set, i.e. hosts do not assume a complete IP address is placed.
.. index::
single: no ipv6 nd ra-interval [(1-1800)]
single: no ipv6 nd ra-interval [(1-1800)]
-
.. clicmd:: [no] ipv6 nd ra-interval [(1-1800)]
- The maximum time allowed between sending unsolicited multicast router
- advertisements from the interface, in seconds.
- Default: ``600``
-
-.. index:: ipv6 nd ra-interval msec (70-1800000)
+ The maximum time allowed between sending unsolicited multicast router
+ advertisements from the interface, in seconds.
+ Default: ``600``
+.. index:: ipv6 nd ra-interval msec (70-1800000)
.. index::
single: no ipv6 nd ra-interval [msec (70-1800000)]
single: ipv6 nd ra-interval msec (70-1800000)
-
.. clicmd:: [no] ipv6 nd ra-interval [msec (70-1800000)]
- The maximum time allowed between sending unsolicited multicast router
- advertisements from the interface, in milliseconds.
- Default: ``600000``
+
+ The maximum time allowed between sending unsolicited multicast router
+ advertisements from the interface, in milliseconds.
+ Default: ``600000``
.. index::
single: ipv6 nd ra-lifetime (0-9000)
single: no ipv6 nd ra-lifetime [(0-9000)]
-
.. clicmd:: [no] ipv6 nd ra-lifetime [(0-9000)]
- The value to be placed in the Router Lifetime field of router advertisements
- sent from the interface, in seconds. Indicates the usefulness of the router
- as a default router on this interface. Setting the value to zero indicates
- that the router should not be considered a default router on this interface.
- Must be either zero or between value specified with ``ipv6 nd ra-interval``
- (or default) and 9000 seconds.
- Default: ``1800``
+
+ 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
+ as a default router on this interface. Setting the value to zero indicates
+ that the router should not be considered a default router on this interface.
+ Must be either zero or between value specified with ``ipv6 nd ra-interval``
+ (or default) and 9000 seconds.
+ Default: ``1800``
.. index::
single: no ipv6 nd reachable-time [(1-3600000)]
single: ipv6 nd reachable-time (1-3600000)
-
.. clicmd:: [no] ipv6 nd reachable-time [(1-3600000)]
- The value to be placed in the Reachable Time field in the Router Advertisement
- messages sent by the router, in milliseconds. The configured time enables the
- router to detect unavailable neighbors. The value zero means unspecified (by
- this router).
- Default: ``0``
+
+ The value to be placed in the Reachable Time field in the Router
+ Advertisement messages sent by the router, in milliseconds. The configured
+ time enables the router to detect unavailable neighbors. The value zero
+ means unspecified (by this router).
+ Default: ``0``
.. index::
single: ipv6 nd managed-config-flag
single: no ipv6 nd managed-config-flag
-
.. clicmd:: [no] 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 in
- addition to any addresses autoconfigured using stateless address
- autoconfiguration.
- Default: not set
+
+ Set/unset flag in IPv6 router advertisements which indicates to hosts that
+ they should use managed (stateful) protocol for addresses autoconfiguration
+ in addition to any addresses autoconfigured using stateless address
+ autoconfiguration.
+ Default: not set
.. index::
single: ipv6 nd other-config-flag
single: no ipv6 nd other-config-flag
-
.. clicmd:: [no] 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
+
+ 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
.. index::
single: ipv6 nd home-agent-config-flag
single: no ipv6 nd home-agent-config-flag
-
.. clicmd:: [no] ipv6 nd home-agent-config-flag
- Set/unset flag in IPv6 router advertisements which indicates to hosts that
- the router acts as a Home Agent and includes a Home Agent Option.
- Default: not set
+
+ 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
.. index:: ipv6 nd home-agent-preference (0-65535)
.. index::
single: no ipv6 nd home-agent-preference [(0-65535)]
single: ipv6 nd home-agent-preference (0-65535)
-
.. clicmd:: [no] ipv6 nd home-agent-preference [(0-65535)]
- The value to be placed in Home Agent Option, when Home Agent config flag is set,
- which indicates to hosts Home Agent preference. The default value of 0 stands
- for the lowest preference possible.
- Default: ``0``
+
+ 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``
.. index::
single: ipv6 nd home-agent-lifetime (0-65520)
single: no ipv6 nd home-agent-lifetime (0-65520)
-
.. clicmd:: [no] ipv6 nd home-agent-lifetime [(0-65520)]
- The value to be placed in Home Agent Option, when Home Agent config flag is set,
- which indicates to hosts Home Agent Lifetime. The default value of 0 means to
- place the current Router Lifetime value.
- Default: ``0``
+ 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
+ place the current Router Lifetime value.
+
+ Default: ``0``
.. index::
single: ipv6 nd adv-interval-option
single: no ipv6 nd adv-interval-option
-
.. clicmd:: [no] 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
+
+ Include an Advertisement Interval option which indicates to hosts the maximum time,
+ in milliseconds, between successive unsolicited Router Advertisements.
+ Default: not set
.. index::
single: ipv6 nd router-preference (high|medium|low)
single: no ipv6 nd router-preference (high|medium|low)
-
.. clicmd:: [no] ipv6 nd router-preference [(high|medium|low)]
- Set default router preference in IPv6 router advertisements per RFC4191.
- Default: medium
+
+ Set default router preference in IPv6 router advertisements per RFC4191.
+ Default: medium
.. index::
single: ipv6 nd mtu (1-65535)
single: no ipv6 nd mtu [(1-65535)]
-
.. clicmd:: [no] ipv6 nd mtu [(1-65535)]
- Include an MTU (type 5) option in each RA packet to assist the attached hosts
- in proper interface configuration. The announced value is not verified to be
- consistent with router interface MTU.
- Default: don't advertise any MTU option.::
- interface eth0
- no ipv6 nd suppress-ra
- ipv6 nd prefix 2001:0DB8:5009::/64
+ 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
+ to be consistent with router interface MTU.
+
+ Default: don't advertise any MTU option.::
+ interface eth0
+ no ipv6 nd suppress-ra
+ ipv6 nd prefix 2001:0DB8:5009::/64
+
+.. seealso::
-For more information see
-:t:`RFC2462 (IPv6 Stateless Address Autoconfiguration)`,
-:t:`RFC4861 (Neighbor Discovery for IP Version 6 (IPv6))`,
-:t:`RFC6275 (Mobility Support in IPv6)` and
-:t:`RFC4191 (Default Router Preferences and More-Specific Routes)`.
+ - :rfc:`2462` (IPv6 Stateless Address Autoconfiguration)
+ - :rfc:`4861` (Neighbor Discovery for IP Version 6 (IPv6))
+ - :rfc:`6275` (Mobility Support in IPv6)
+ - :rfc:`4191` (Default Router Preferences and More-Specific Routes)
****
:abbr:`ISIS (Intermediate System to Intermediate System)` is a routing protocol
-which is described in :t:`ISO10589`, :rfc:`1195`, :rfc:`5308`. ISIS is an
-:abbr:`IGP (Interior Gateway Protocol)`. Compared with :abbr:`RIP`,
+which is described in :t:`ISO10589`, :rfc:`1195`, :rfc:`5308`. ISIS is an
+:abbr:`IGP (Interior Gateway Protocol)`. Compared with :abbr:`RIP`,
:abbr:`ISIS` can provide scalable network support and faster convergence times
like :abbr:`OSPF`. ISIS is widely used in large networks such as :abbr:`ISP
(Internet Service Provider)` and carrier backbone networks.
Configuring isisd
=================
-There are no *isisd* specific options. Common options can be
-specified (:ref:`Common_Invocation_Options`) to *isisd*.
-*isisd* needs to acquire interface information from
-*zebra* in order to function. Therefore *zebra* must be
-running before invoking *isisd*. Also, if *zebra* is
-restarted then *isisd* must be too.
+There are no *isisd* specific options. Common options can be specified
+(:ref:`Common_Invocation_Options`) to *isisd*. *isisd* needs to acquire
+interface information from *zebra* in order to function. Therefore *zebra* must
+be running before invoking *isisd*. Also, if *zebra* is restarted then *isisd*
+must be too.
-Like other daemons, *isisd* configuration is done in :abbr:`ISIS`
-specific configuration file :file:`isisd.conf`.
+Like other daemons, *isisd* configuration is done in :abbr:`ISIS` specific
+configuration file :file:`isisd.conf`.
.. _ISIS_router:
To start ISIS process you have to specify the ISIS router. As of this
writing, *isisd* does not support multiple ISIS processes.
-.. index:: Command {router isis WORD} {}
+.. index:: router isis WORD
+.. clicmd:: router isis WORD
-Command {router isis WORD} {}
-.. index:: Command {no router isis WORD} {}
+.. index:: no router isis WORD
+.. clicmd:: no router isis WORD
-Command {no router isis WORD} {}
- .. _router_isis_WORD:
+ .. _router_isis_WORD:
- Enable or disable the ISIS process by specifying the ISIS domain with 'WORD'.
- *isisd* does not yet support multiple ISIS processes but you must specify
- the name of ISIS process. The ISIS process name 'WORD' is then used for interface
- (see command :ref:`ip_router_isis_WORD`).
+ Enable or disable the ISIS process by specifying the ISIS domain with
+ 'WORD'. *isisd* does not yet support multiple ISIS processes but you must
+ specify the name of ISIS process. The ISIS process name 'WORD' is then used
+ for interface (see command :ref:`ip_router_isis_WORD`).
-.. index:: {ISIS Command} {net XX.XXXX. ... .XXX.XX} {}
+.. index:: net XX.XXXX. ... .XXX.XX
+.. clicmd:: net XX.XXXX. ... .XXX.XX
-{ISIS Command} {net XX.XXXX. ... .XXX.XX} {}
-.. index:: {ISIS Command} {no net XX.XXXX. ... .XXX.XX} {}
+.. index:: no net XX.XXXX. ... .XXX.XX
+.. clicmd:: no net XX.XXXX. ... .XXX.XX
-{ISIS Command} {no net XX.XXXX. ... .XXX.XX} {}
- Set/Unset network entity title (NET) provided in ISO format.
+ Set/Unset network entity title (NET) provided in ISO format.
-.. index:: {ISIS Command} {hostname dynamic} {}
+.. index:: hostname dynamic
+.. clicmd:: hostname dynamic
-{ISIS Command} {hostname dynamic} {}
-.. index:: {ISIS Command} {no hostname dynamic} {}
+.. index:: no hostname dynamic
+.. clicmd:: no hostname dynamic
-{ISIS Command} {no hostname dynamic} {}
- Enable support for dynamic hostname.
+ Enable support for dynamic hostname.
-.. index:: {ISIS Command} {area-password [clear | md5] <password>} {}
+.. index:: area-password [clear | md5] <password>
+.. clicmd:: area-password [clear | md5] <password>
-{ISIS Command} {area-password [clear | md5] <password>} {}
-.. index:: {ISIS Command} {domain-password [clear | md5] <password>} {}
+.. index:: domain-password [clear | md5] <password>
+.. clicmd:: domain-password [clear | md5] <password>
-{ISIS Command} {domain-password [clear | md5] <password>} {}
-.. index:: {ISIS Command} {no area-password} {}
+.. index:: no area-password
+.. clicmd:: no area-password
-{ISIS Command} {no area-password} {}
-.. index:: {ISIS Command} {no domain-password} {}
+.. index:: no domain-password
+.. clicmd:: no domain-password
-{ISIS Command} {no domain-password} {}
- Configure the authentication password for an area, respectively a domain,
- as clear text or md5 one.
+ Configure the authentication password for an area, respectively a domain, as
+ clear text or md5 one.
-.. index:: {ISIS Command} {log-adjacency-changes} {}
+.. index:: log-adjacency-changes
+.. clicmd:: log-adjacency-changes
-{ISIS Command} {log-adjacency-changes} {}
-.. index:: {ISIS Command} {no log-adjacency-changes} {}
+.. index:: no log-adjacency-changes
+.. clicmd:: no log-adjacency-changes
-{ISIS Command} {no log-adjacency-changes} {}
- Log changes in adjacency state.
+ Log changes in adjacency state.
-.. index:: {ISIS Command} {metric-style [narrow | transition | wide]} {}
+.. index:: metric-style [narrow | transition | wide]
+.. clicmd:: metric-style [narrow | transition | wide]
-{ISIS Command} {metric-style [narrow | transition | wide]} {}
-.. index:: {ISIS Command} {no metric-style} {}
+.. index:: no metric-style
+.. clicmd:: no metric-style
-{ISIS Command} {no metric-style} {}
- .. _metric-style:
+.. _metric-style:
- Set old-style (ISO 10589) or new-style packet formats:
- - narrow Use old style of TLVs with narrow metric
- - transition Send and accept both styles of TLVs during transition
- - wide Use new style of TLVs to carry wider metric
+ Set old-style (ISO 10589) or new-style packet formats:
-.. index:: {ISIS Command} {set-overload-bit} {}
+ - narrow
+ Use old style of TLVs with narrow metric
+ - transition
+ Send and accept both styles of TLVs during transition
+ - wide
+ Use new style of TLVs to carry wider metric
-{ISIS Command} {set-overload-bit} {}
-.. index:: {ISIS Command} {no set-overload-bit} {}
+.. index:: set-overload-bit
+.. clicmd:: set-overload-bit
-{ISIS Command} {no set-overload-bit} {}
- Set overload bit to avoid any transit traffic.
+.. index:: no set-overload-bit
+.. clicmd:: no set-overload-bit
+
+ Set overload bit to avoid any transit traffic.
.. _ISIS_Timer:
ISIS Timer
==========
-.. index:: {ISIS Command} {lsp-gen-interval (1-120)} {}
-
-{ISIS Command} {lsp-gen-interval (1-120)} {}
-.. index:: {ISIS Command} {lsp-gen-interval [level-1 | level-2] (1-120)} {}
-
-{ISIS Command} {lsp-gen-interval [level-1 | level-2] (1-120)} {}
-.. index:: {ISIS Command} {no lsp-gen-interval} {}
-
-{ISIS Command} {no lsp-gen-interval} {}
-.. index:: {ISIS Command} {no lsp-gen-interval [level-1 | level-2]} {}
-
-{ISIS Command} {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).
-
-.. index:: {ISIS Command} {lsp-refresh-interval (1-65235)} {}
-
-{ISIS Command} {lsp-refresh-interval (1-65235)} {}
-.. index:: {ISIS Command} {lsp-refresh-interval [level-1 | level-2] (1-65235)} {}
-
-{ISIS Command} {lsp-refresh-interval [level-1 | level-2] (1-65235)} {}
-.. index:: {ISIS Command} {no lsp-refresh-interval} {}
+.. index:: lsp-gen-interval (1-120)
+.. clicmd:: lsp-gen-interval (1-120)
-{ISIS Command} {no lsp-refresh-interval} {}
-.. index:: {ISIS Command} {no lsp-refresh-interval [level-1 | level-2]} {}
+.. index:: lsp-gen-interval [level-1 | level-2] (1-120)
+.. clicmd:: lsp-gen-interval [level-1 | level-2] (1-120)
-{ISIS Command} {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).
+.. index:: no lsp-gen-interval
+.. clicmd:: no lsp-gen-interval
-.. index:: {ISIS Command} {lsp-refresh-interval (1-65235)} {}
+.. index:: no lsp-gen-interval [level-1 | level-2]
+.. clicmd:: no lsp-gen-interval [level-1 | level-2]
-{ISIS Command} {lsp-refresh-interval (1-65235)} {}
-.. index:: {ISIS Command} {lsp-refresh-interval [level-1 | level-2] (1-65235)} {}
+ Set minimum interval in seconds between regenerating same LSP,
+ globally, for an area (level-1) or a domain (level-2).
-{ISIS Command} {lsp-refresh-interval [level-1 | level-2] (1-65235)} {}
-.. index:: {ISIS Command} {no lsp-refresh-interval} {}
+.. index:: lsp-refresh-interval [level-1 | level-2] (1-65235)
+.. clicmd:: lsp-refresh-interval [level-1 | level-2] (1-65235)
-{ISIS Command} {no lsp-refresh-interval} {}
-.. index:: {ISIS Command} {no lsp-refresh-interval [level-1 | level-2]} {}
+.. index:: no lsp-refresh-interval [level-1 | level-2]
+.. clicmd:: no lsp-refresh-interval [level-1 | level-2]
-{ISIS Command} {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).
+ Set LSP refresh interval in seconds, globally, for an area (level-1) or a
+ domain (level-2).
-.. index:: {ISIS Command} {max-lsp-lifetime (360-65535)} {}
+.. index:: max-lsp-lifetime (360-65535)
+.. clicmd:: max-lsp-lifetime (360-65535)
-{ISIS Command} {max-lsp-lifetime (360-65535)} {}
-.. index:: {ISIS Command} {max-lsp-lifetime [level-1 | level-2] (360-65535)} {}
+.. index:: max-lsp-lifetime [level-1 | level-2] (360-65535)
+.. clicmd:: max-lsp-lifetime [level-1 | level-2] (360-65535)
-{ISIS Command} {max-lsp-lifetime [level-1 | level-2] (360-65535)} {}
-.. index:: {ISIS Command} {no max-lsp-lifetime} {}
+.. index:: no max-lsp-lifetime
+.. clicmd:: no max-lsp-lifetime
-{ISIS Command} {no max-lsp-lifetime} {}
-.. index:: {ISIS Command} {no max-lsp-lifetime [level-1 | level-2]} {}
+.. index:: no max-lsp-lifetime [level-1 | level-2]
+.. clicmd:: no max-lsp-lifetime [level-1 | level-2]
-{ISIS Command} {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).
+ Set LSP maximum LSP lifetime in seconds, globally, for an area (level-1) or
+ a domain (level-2).
-.. index:: {ISIS Command} {spf-interval (1-120)} {}
+.. index:: spf-interval (1-120)
+.. clicmd:: spf-interval (1-120)
-{ISIS Command} {spf-interval (1-120)} {}
-.. index:: {ISIS Command} {spf-interval [level-1 | level-2] (1-120)} {}
+.. index:: spf-interval [level-1 | level-2] (1-120)
+.. clicmd:: spf-interval [level-1 | level-2] (1-120)
-{ISIS Command} {spf-interval [level-1 | level-2] (1-120)} {}
-.. index:: {ISIS Command} {no spf-interval} {}
+.. index:: no spf-interval
+.. clicmd:: no spf-interval
-{ISIS Command} {no spf-interval} {}
-.. index:: {ISIS Command} {no spf-interval [level-1 | level-2]} {}
+.. index:: no spf-interval [level-1 | level-2]
+.. clicmd:: no spf-interval [level-1 | level-2]
-{ISIS Command} {no spf-interval [level-1 | level-2]} {}
- Set minimum interval between consecutive SPF calculations in seconds.
+ Set minimum interval between consecutive SPF calculations in seconds.
.. _ISIS_region:
ISIS region
===========
-.. index:: {ISIS Command} {is-type [level-1 | level-1-2 | level-2-only]} {}
+.. index:: is-type [level-1 | level-1-2 | level-2-only]
+.. clicmd:: is-type [level-1 | level-1-2 | level-2-only]
-{ISIS Command} {is-type [level-1 | level-1-2 | level-2-only]} {}
-.. index:: {ISIS Command} {no is-type} {}
+.. index:: no is-type
+.. clicmd:: no is-type
-{ISIS Command} {no is-type} {}
- Define the ISIS router behavior:
- - level-1 Act as a station router only
- - level-1-2 Act as both a station router and an area router
- - level-2-only Act as an area router only
+ Define the ISIS router behavior:
+
+ - level-1
+ Act as a station router only
+ - level-1-2
+ Act as both a station router and an area router
+ - level-2-only
+ Act as an area router only
.. _ISIS_interface:
ISIS interface
==============
-.. index:: {Interface Command} {ip router isis WORD} {}
+.. index:: ip router isis WORD
+.. clicmd:: ip router isis WORD
+
+.. index:: no ip router isis WORD
+.. clicmd:: no ip router isis WORD
-{Interface Command} {ip router isis WORD} {}
-.. index:: {Interface Command} {no ip router isis WORD} {}
+.. _ip_router_isis_WORD:
-{Interface Command} {no ip router isis WORD} {}
- .. _ip_router_isis_WORD:
+ Activate ISIS adjacency on this interface. Note that the name
+ of ISIS instance must be the same as the one used to configure the ISIS process
+ (see command :ref:`router_isis_WORD`).
- Activate ISIS adjacency on this interface. Note that the name
- of ISIS instance must be the same as the one used to configure the ISIS process
- (see command :ref:`router_isis_WORD`).
+.. index:: isis circuit-type [level-1 | level-1-2 | level-2]
+.. clicmd:: isis circuit-type [level-1 | level-1-2 | level-2]
-.. index:: {Interface Command} {isis circuit-type [level-1 | level-1-2 | level-2]} {}
+.. index:: no isis circuit-type
+.. clicmd:: no isis circuit-type
-{Interface Command} {isis circuit-type [level-1 | level-1-2 | level-2]} {}
-.. index:: {Interface Command} {no isis circuit-type} {}
+ Configure circuit type for interface:
-{Interface Command} {no isis circuit-type} {}
- Configure circuit type for interface:
- - level-1 Level-1 only adjacencies are formed
- - level-1-2 Level-1-2 adjacencies are formed
- - level-2-only Level-2 only adjacencies are formed
+ - level-1
+ Level-1 only adjacencies are formed
+ - level-1-2
+ Level-1-2 adjacencies are formed
+ - level-2-only
+ Level-2 only adjacencies are formed
-.. index:: {Interface Command} {isis csnp-interval (1-600)} {}
+.. index:: isis csnp-interval (1-600)
+.. clicmd:: isis csnp-interval (1-600)
-{Interface Command} {isis csnp-interval (1-600)} {}
-.. index:: {Interface Command} {isis csnp-interval (1-600) [level-1 | level-2]} {}
+.. index:: isis csnp-interval (1-600) [level-1 | level-2]
+.. clicmd:: isis csnp-interval (1-600) [level-1 | level-2]
-{Interface Command} {isis csnp-interval (1-600) [level-1 | level-2]} {}
-.. index:: {Interface Command} {no isis csnp-interval} {}
+.. index:: no isis csnp-interval
+.. clicmd:: no isis csnp-interval
-{Interface Command} {no isis csnp-interval} {}
-.. index:: {Interface Command} {no isis csnp-interval [level-1 | level-2]} {}
+.. index:: no isis csnp-interval [level-1 | level-2]
+.. clicmd:: no isis csnp-interval [level-1 | level-2]
-{Interface Command} {no isis csnp-interval [level-1 | level-2]} {}
- Set CSNP interval in seconds globally, for an area (level-1) or a domain (level-2).
+ Set CSNP interval in seconds globally, for an area (level-1) or a domain
+ (level-2).
-.. index:: {Interface Command} {isis hello padding} {}
+.. index:: isis hello padding
+.. clicmd:: isis hello padding
-{Interface Command} {isis hello padding} {}
- Add padding to IS-IS hello packets.
+ Add padding to IS-IS hello packets.
-.. index:: {Interface Command} {isis hello-interval (1-600)} {}
+.. index:: isis hello-interval (1-600)
+.. clicmd:: isis hello-interval (1-600)
-{Interface Command} {isis hello-interval (1-600)} {}
-.. index:: {Interface Command} {isis hello-interval (1-600) [level-1 | level-2]} {}
+.. index:: isis hello-interval (1-600) [level-1 | level-2]
+.. clicmd:: isis hello-interval (1-600) [level-1 | level-2]
-{Interface Command} {isis hello-interval (1-600) [level-1 | level-2]} {}
-.. index:: {Interface Command} {no isis hello-interval} {}
+.. index:: no isis hello-interval
+.. clicmd:: no isis hello-interval
-{Interface Command} {no isis hello-interval} {}
-.. index:: {Interface Command} {no isis hello-interval [level-1 | level-2]} {}
+.. index:: no isis hello-interval [level-1 | level-2]
+.. clicmd:: no isis hello-interval [level-1 | level-2]
-{Interface Command} {no isis hello-interval [level-1 | level-2]} {}
- Set Hello interval in seconds globally, for an area (level-1) or a domain (level-2).
+ Set Hello interval in seconds globally, for an area (level-1) or a domain
+ (level-2).
-.. index:: {Interface Command} {isis hello-multiplier (2-100)} {}
+.. index:: isis hello-multiplier (2-100)
+.. clicmd:: isis hello-multiplier (2-100)
-{Interface Command} {isis hello-multiplier (2-100)} {}
-.. index:: {Interface Command} {isis hello-multiplier (2-100) [level-1 | level-2]} {}
+.. index:: isis hello-multiplier (2-100) [level-1 | level-2]
+.. clicmd:: isis hello-multiplier (2-100) [level-1 | level-2]
-{Interface Command} {isis hello-multiplier (2-100) [level-1 | level-2]} {}
-.. index:: {Interface Command} {no isis hello-multiplier} {}
+.. index:: no isis hello-multiplier
+.. clicmd:: no isis hello-multiplier
-{Interface Command} {no isis hello-multiplier} {}
-.. index:: {Interface Command} {no isis hello-multiplier [level-1 | level-2]} {}
+.. index:: no isis hello-multiplier [level-1 | level-2]
+.. clicmd:: no isis hello-multiplier [level-1 | level-2]
-{Interface Command} {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).
+ Set multiplier for Hello holding time globally, for an area (level-1) or a
+ domain (level-2).
-.. index:: {Interface Command} {isis metric [(0-255) | (0-16777215)]} {}
+.. index:: isis metric [(0-255) | (0-16777215)]
+.. clicmd:: isis metric [(0-255) | (0-16777215)]
-{Interface Command} {isis metric [(0-255) | (0-16777215)]} {}
-.. index:: {Interface Command} {isis metric [(0-255) | (0-16777215)] [level-1 | level-2]} {}
+.. index:: isis metric [(0-255) | (0-16777215)] [level-1 | level-2]
+.. clicmd:: isis metric [(0-255) | (0-16777215)] [level-1 | level-2]
-{Interface Command} {isis metric [(0-255) | (0-16777215)] [level-1 | level-2]} {}
-.. index:: {Interface Command} {no isis metric} {}
+.. index:: no isis metric
+.. clicmd:: no isis metric
-{Interface Command} {no isis metric} {}
-.. index:: {Interface Command} {no isis metric [level-1 | level-2]} {}
+.. index:: no isis metric [level-1 | level-2]
+.. clicmd:: no isis metric [level-1 | level-2]
-{Interface Command} {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 :ref:`metric-style`).
+ 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 :ref:`metric-style`).
-.. index:: {Interface Command} {isis network point-to-point} {}
+.. index:: isis network point-to-point
+.. clicmd:: isis network point-to-point
-{Interface Command} {isis network point-to-point} {}
-.. index:: {Interface Command} {no isis network point-to-point} {}
+.. index:: no isis network point-to-point
+.. clicmd:: no isis network point-to-point
-{Interface Command} {no isis network point-to-point} {}
- Set network type to 'Point-to-Point' (broadcast by default).
+ Set network type to 'Point-to-Point' (broadcast by default).
-.. index:: {Interface Command} {isis passive} {}
+.. index:: isis passive
+.. clicmd:: isis passive
-{Interface Command} {isis passive} {}
-.. index:: {Interface Command} {no isis passive} {}
+.. index:: no isis passive
+.. clicmd:: no isis passive
-{Interface Command} {no isis passive} {}
- Configure the passive mode for this interface.
+ Configure the passive mode for this interface.
-.. index:: {Interface Command} {isis password [clear | md5] <password>} {}
+.. index:: isis password [clear | md5] <password>
+.. clicmd:: isis password [clear | md5] <password>
-{Interface Command} {isis password [clear | md5] <password>} {}
-.. index:: {Interface Command} {no isis password} {}
+.. index:: no isis password
+.. clicmd:: no isis password
-{Interface Command} {no isis password} {}
- Configure the authentication password (clear or encoded text) for the interface.
+ Configure the authentication password (clear or encoded text) for the
+ interface.
-.. index:: {Interface Command} {isis priority (0-127)} {}
+.. index:: isis priority (0-127)
+.. clicmd:: isis priority (0-127)
-{Interface Command} {isis priority (0-127)} {}
-.. index:: {Interface Command} {isis priority (0-127) [level-1 | level-2]} {}
+.. index:: isis priority (0-127) [level-1 | level-2]
+.. clicmd:: isis priority (0-127) [level-1 | level-2]
-{Interface Command} {isis priority (0-127) [level-1 | level-2]} {}
-.. index:: {Interface Command} {no isis priority} {}
+.. index:: no isis priority
+.. clicmd:: no isis priority
-{Interface Command} {no isis priority} {}
-.. index:: {Interface Command} {no isis priority [level-1 | level-2]} {}
+.. index:: no isis priority [level-1 | level-2]
+.. clicmd:: no isis priority [level-1 | level-2]
-{Interface Command} {no isis priority [level-1 | level-2]} {}
- Set priority for Designated Router election, globally, for the area (level-1)
- or the domain (level-2).
+ Set priority for Designated Router election, globally, for the area
+ (level-1) or the domain (level-2).
-.. index:: {Interface Command} {isis psnp-interval (1-120)} {}
+.. index:: isis psnp-interval (1-120)
+.. clicmd:: isis psnp-interval (1-120)
-{Interface Command} {isis psnp-interval (1-120)} {}
-.. index:: {Interface Command} {isis psnp-interval (1-120) [level-1 | level-2]} {}
+.. index:: isis psnp-interval (1-120) [level-1 | level-2]
+.. clicmd:: isis psnp-interval (1-120) [level-1 | level-2]
-{Interface Command} {isis psnp-interval (1-120) [level-1 | level-2]} {}
-.. index:: {Interface Command} {no isis psnp-interval} {}
+.. index:: no isis psnp-interval
+.. clicmd:: no isis psnp-interval
-{Interface Command} {no isis psnp-interval} {}
-.. index:: {Interface Command} {no isis psnp-interval [level-1 | level-2]} {}
+.. index:: no isis psnp-interval [level-1 | level-2]
+.. clicmd:: no isis psnp-interval [level-1 | level-2]
-{Interface Command} {no isis psnp-interval [level-1 | level-2]} {}
- Set PSNP interval in seconds globally, for an area (level-1) or a domain (level-2).
+ Set PSNP interval in seconds globally, for an area (level-1) or a domain
+ (level-2).
.. _Showing_ISIS_information:
Showing ISIS information
========================
-.. index:: {Command} {show isis summary} {}
+.. index:: show isis summary
+.. clicmd:: show isis summary
-{Command} {show isis summary} {}
- Show summary information about ISIS.
+ Show summary information about ISIS.
-.. index:: {Command} {show isis hostname} {}
+.. index:: show isis hostname
+.. clicmd:: show isis hostname
-{Command} {show isis hostname} {}
- Show information about ISIS node.
+ Show information about ISIS node.
-.. index:: {Command} {show isis interface} {}
+.. index:: show isis interface
+.. clicmd:: show isis interface
-{Command} {show isis interface} {}
-.. index:: {Command} {show isis interface detail} {}
+.. index:: show isis interface detail
+.. clicmd:: show isis interface detail
-{Command} {show isis interface detail} {}
-.. index:: {Command} {show isis interface <interface name>} {}
+.. index:: show isis interface <interface name>
+.. clicmd:: show isis interface <interface name>
-{Command} {show isis interface <interface name>} {}
- Show state and configuration of ISIS specified interface, or all
- interfaces if no interface is given with or without details.
+ Show state and configuration of ISIS specified interface, or all interfaces
+ if no interface is given with or without details.
-.. index:: {Command} {show isis neighbor} {}
+.. index:: show isis neighbor
+.. clicmd:: show isis neighbor
-{Command} {show isis neighbor} {}
-.. index:: {Command} {show isis neighbor <System Id>} {}
+.. index:: show isis neighbor <System Id>
+.. clicmd:: show isis neighbor <System Id>
-{Command} {show isis neighbor <System Id>} {}
-.. index:: {Command} {show isis neighbor detail} {}
+.. index:: show isis neighbor detail
+.. clicmd:: show isis neighbor detail
-{Command} {show isis neighbor detail} {}
- Show state and information of ISIS specified neighbor, or all
- neighbors if no system id is given with or without details.
+ Show state and information of ISIS specified neighbor, or all neighbors if
+ no system id is given with or without details.
-.. index:: {Command} {show isis database} {}
+.. index:: show isis database
+.. clicmd:: show isis database
-{Command} {show isis database} {}
-.. index:: {Command} {show isis database [detail]} {}
+.. index:: show isis database [detail]
+.. clicmd:: show isis database [detail]
-{Command} {show isis database [detail]} {}
-.. index:: {Command} {show isis database <LSP id> [detail]} {}
+.. index:: show isis database <LSP id> [detail]
+.. clicmd:: show isis database <LSP id> [detail]
-{Command} {show isis database <LSP id> [detail]} {}
-.. index:: {Command} {show isis database detail <LSP id>} {}
+.. index:: show isis database detail <LSP id>
+.. clicmd:: show isis database detail <LSP id>
-{Command} {show isis database detail <LSP id>} {}
- Show the ISIS database globally, for a specific LSP id without or with details.
+ Show the ISIS database globally, for a specific LSP id without or with
+ details.
-.. index:: {Command} {show isis topology} {}
+.. index:: show isis topology
+.. clicmd:: show isis topology
-{Command} {show isis topology} {}
-.. index:: {Command} {show isis topology [level-1|level-2]} {}
+.. index:: show isis topology [level-1|level-2]
+.. clicmd:: show isis topology [level-1|level-2]
-{Command} {show isis topology [level-1|level-2]} {}
- Show topology IS-IS paths to Intermediate Systems, globally,
- in area (level-1) or domain (level-2).
+ Show topology IS-IS paths to Intermediate Systems, globally, in area
+ (level-1) or domain (level-2).
-.. index:: {Command} {show ip route isis} {}
+.. index:: show ip route isis
+.. clicmd:: show ip route isis
-{Command} {show ip route isis} {}
- Show the ISIS routing table, as determined by the most recent SPF calculation.
+ Show the ISIS routing table, as determined by the most recent SPF
+ calculation.
-.. _Traffic_Engineering:
+.. _ospf-traffic-engineering:
Traffic Engineering
===================
-.. index:: {ISIS Command} {mpls-te on} {}
+.. index:: mpls-te on
+.. clicmd:: mpls-te on
-{ISIS Command} {mpls-te on} {}
-.. index:: {ISIS Command} {no mpls-te} {}
+.. index:: no mpls-te
+.. clicmd:: no mpls-te
-{ISIS Command} {no mpls-te} {}
- Enable Traffic Engineering LSP flooding.
+ Enable Traffic Engineering LSP flooding.
-.. index:: {ISIS Command} {mpls-te router-address <A.B.C.D>} {}
+.. index:: mpls-te router-address <A.B.C.D>
+.. clicmd:: mpls-te router-address <A.B.C.D>
-{ISIS Command} {mpls-te router-address <A.B.C.D>} {}
-.. index:: {ISIS Command} {no mpls-te router-address} {}
+.. index:: no mpls-te router-address
+.. clicmd:: no mpls-te router-address
-{ISIS Command} {no mpls-te router-address} {}
- Configure stable IP address for MPLS-TE.
+ Configure stable IP address for MPLS-TE.
-.. index:: {Command} {show isis mpls-te interface} {}
+.. index:: show isis mpls-te interface
+.. clicmd:: show isis mpls-te interface
-{Command} {show isis mpls-te interface} {}
-.. index:: {Command} {show isis mpls-te interface `interface`} {}
+.. index:: show isis mpls-te interface INTERFACE
+.. clicmd:: show isis mpls-te interface INTERFACE
-{Command} {show isis mpls-te interface `interface`} {}
- Show MPLS Traffic Engineering parameters for all or specified interface.
+ Show MPLS Traffic Engineering parameters for all or specified interface.
-.. index:: {Command} {show isis mpls-te router} {}
+.. index:: show isis mpls-te router
+.. clicmd:: show isis mpls-te router
-{Command} {show isis mpls-te router} {}
- Show Traffic Engineering router parameters.
+ Show Traffic Engineering router parameters.
.. _Debugging_ISIS:
Debugging ISIS
==============
-.. index:: {Command} {debug isis adj-packets} {}
+.. index:: debug isis adj-packets
+.. clicmd:: debug isis adj-packets
-{Command} {debug isis adj-packets} {}
-.. index:: {Command} {no debug isis adj-packets} {}
+.. index:: no debug isis adj-packets
+.. clicmd:: no debug isis adj-packets
-{Command} {no debug isis adj-packets} {}
- IS-IS Adjacency related packets.
+ IS-IS Adjacency related packets.
-.. index:: {Command} {debug isis checksum-errors} {}
+.. index:: debug isis checksum-errors
+.. clicmd:: debug isis checksum-errors
-{Command} {debug isis checksum-errors} {}
-.. index:: {Command} {no debug isis checksum-errors} {}
+.. index:: no debug isis checksum-errors
+.. clicmd:: no debug isis checksum-errors
-{Command} {no debug isis checksum-errors} {}
- IS-IS LSP checksum errors.
+ IS-IS LSP checksum errors.
-.. index:: {Command} {debug isis events} {}
+.. index:: debug isis events
+.. clicmd:: debug isis events
-{Command} {debug isis events} {}
-.. index:: {Command} {no debug isis events} {}
+.. index:: no debug isis events
+.. clicmd:: no debug isis events
-{Command} {no debug isis events} {}
- IS-IS Events.
+ IS-IS Events.
-.. index:: {Command} {debug isis local-updates} {}
+.. index:: debug isis local-updates
+.. clicmd:: debug isis local-updates
-{Command} {debug isis local-updates} {}
-.. index:: {Command} {no debug isis local-updates} {}
+.. index:: no debug isis local-updates
+.. clicmd:: no debug isis local-updates
-{Command} {no debug isis local-updates} {}
- IS-IS local update packets.
+ IS-IS local update packets.
-.. index:: {Command} {debug isis packet-dump} {}
+.. index:: debug isis packet-dump
+.. clicmd:: debug isis packet-dump
-{Command} {debug isis packet-dump} {}
-.. index:: {Command} {no debug isis packet-dump} {}
+.. index:: no debug isis packet-dump
+.. clicmd:: no debug isis packet-dump
-{Command} {no debug isis packet-dump} {}
- IS-IS packet dump.
+ IS-IS packet dump.
-.. index:: {Command} {debug isis protocol-errors} {}
+.. index:: debug isis protocol-errors
+.. clicmd:: debug isis protocol-errors
-{Command} {debug isis protocol-errors} {}
-.. index:: {Command} {no debug isis protocol-errors} {}
+.. index:: no debug isis protocol-errors
+.. clicmd:: no debug isis protocol-errors
-{Command} {no debug isis protocol-errors} {}
- IS-IS LSP protocol errors.
+ IS-IS LSP protocol errors.
-.. index:: {Command} {debug isis route-events} {}
+.. index:: debug isis route-events
+.. clicmd:: debug isis route-events
-{Command} {debug isis route-events} {}
-.. index:: {Command} {no debug isis route-events} {}
+.. index:: no debug isis route-events
+.. clicmd:: no debug isis route-events
-{Command} {no debug isis route-events} {}
- IS-IS Route related events.
+ IS-IS Route related events.
-.. index:: {Command} {debug isis snp-packets} {}
+.. index:: debug isis snp-packets
+.. clicmd:: debug isis snp-packets
-{Command} {debug isis snp-packets} {}
-.. index:: {Command} {no debug isis snp-packets} {}
+.. index:: no debug isis snp-packets
+.. clicmd:: no debug isis snp-packets
-{Command} {no debug isis snp-packets} {}
- IS-IS CSNP/PSNP packets.
+ IS-IS CSNP/PSNP packets.
-.. index:: {Command} {debug isis spf-events} {}
+.. index:: debug isis spf-events
+.. clicmd:: debug isis spf-events
-{Command} {debug isis spf-events} {}
-.. index:: {Command} {debug isis spf-statistics} {}
+.. index:: debug isis spf-statistics
+.. clicmd:: debug isis spf-statistics
-{Command} {debug isis spf-statistics} {}
-.. index:: {Command} {debug isis spf-triggers} {}
+.. index:: debug isis spf-triggers
+.. clicmd:: debug isis spf-triggers
-{Command} {debug isis spf-triggers} {}
-.. index:: {Command} {no debug isis spf-events} {}
+.. index:: no debug isis spf-events
+.. clicmd:: no debug isis spf-events
-{Command} {no debug isis spf-events} {}
-.. index:: {Command} {no debug isis spf-statistics} {}
+.. index:: no debug isis spf-statistics
+.. clicmd:: no debug isis spf-statistics
-{Command} {no debug isis spf-statistics} {}
-.. index:: {Command} {no debug isis spf-triggers} {}
+.. index:: no debug isis spf-triggers
+.. clicmd:: no debug isis spf-triggers
-{Command} {no debug isis spf-triggers} {}
- IS-IS Shortest Path First Events, Timing and Statistic Data
- and triggering events.
+ IS-IS Shortest Path First Events, Timing and Statistic Data and triggering
+ events.
-.. index:: {Command} {debug isis update-packets} {}
+.. index:: debug isis update-packets
+.. clicmd:: debug isis update-packets
-{Command} {debug isis update-packets} {}
-.. index:: {Command} {no debug isis update-packets} {}
+.. index:: no debug isis update-packets
+.. clicmd:: no debug isis update-packets
-{Command} {no debug isis update-packets} {}
- Update related packets.
+ Update related packets.
-.. index:: {Command} {show debugging isis} {}
+.. index:: show debugging isis
+.. clicmd:: show debugging isis
-{Command} {show debugging isis} {}
- Print which ISIS debug level is activate.
+ Print which ISIS debug level is activate.
ISIS Configuration Examples
===========================
-A simple example, with MD5 authentication enabled:
+A simple example, with MD5 authentication enabled:::
-::
-
- !
- interface eth0
- ip router isis FOO
- isis network point-to-point
- isis circuit-type level-2-only
- !
- router isis FOO
- net 47.0023.0000.0000.0000.0000.0000.0000.1900.0004.00
- metric-style wide
- is-type level-2-only
+ !
+ interface eth0
+ ip router isis FOO
+ isis network point-to-point
+ isis circuit-type level-2-only
+ !
+ router isis FOO
+ net 47.0023.0000.0000.0000.0000.0000.0000.1900.0004.00
+ metric-style wide
+ is-type level-2-only
A Traffic Engineering configuration, with Inter-ASv2 support.
-- First, the 'zebra.conf' part:
-
-::
-
- hostname HOSTNAME
- password PASSWORD
- log file /var/log/zebra.log
- !
- interface eth0
- ip address 10.2.2.2/24
- mpls-te on
- mpls-te link metric 10
- mpls-te link max-bw 1.25e+06
- mpls-te link max-rsv-bw 1.25e+06
- mpls-te link unrsv-bw 0 1.25e+06
- mpls-te link unrsv-bw 1 1.25e+06
- mpls-te link unrsv-bw 2 1.25e+06
- mpls-te link unrsv-bw 3 1.25e+06
- mpls-te link unrsv-bw 4 1.25e+06
- mpls-te link unrsv-bw 5 1.25e+06
- mpls-te link unrsv-bw 6 1.25e+06
- mpls-te link unrsv-bw 7 1.25e+06
- mpls-te link rsc-clsclr 0xab
- !
- interface eth1
- ip address 10.1.1.1/24
- mpls-te on
- mpls-te link metric 10
- mpls-te link max-bw 1.25e+06
- mpls-te link max-rsv-bw 1.25e+06
- mpls-te link unrsv-bw 0 1.25e+06
- mpls-te link unrsv-bw 1 1.25e+06
- mpls-te link unrsv-bw 2 1.25e+06
- mpls-te link unrsv-bw 3 1.25e+06
- mpls-te link unrsv-bw 4 1.25e+06
- mpls-te link unrsv-bw 5 1.25e+06
- mpls-te link unrsv-bw 6 1.25e+06
- mpls-te link unrsv-bw 7 1.25e+06
- mpls-te link rsc-clsclr 0xab
- mpls-te neighbor 10.1.1.2 as 65000
-
-
-- Then the 'isisd.conf' itself:
-
-::
-
- hostname HOSTNAME
- password PASSWORD
- log file /var/log/isisd.log
- !
- !
- interface eth0
- ip router isis FOO
- !
- interface eth1
- ip router isis FOO
- !
- !
- router isis FOO
- isis net 47.0023.0000.0000.0000.0000.0000.0000.1900.0004.00
- mpls-te on
- mpls-te router-address 10.1.1.1
- !
- line vty
-
+First, the 'zebra.conf' part:::
+ hostname HOSTNAME
+ password PASSWORD
+ log file /var/log/zebra.log
+ !
+ interface eth0
+ ip address 10.2.2.2/24
+ mpls-te on
+ mpls-te link metric 10
+ mpls-te link max-bw 1.25e+06
+ mpls-te link max-rsv-bw 1.25e+06
+ mpls-te link unrsv-bw 0 1.25e+06
+ mpls-te link unrsv-bw 1 1.25e+06
+ mpls-te link unrsv-bw 2 1.25e+06
+ mpls-te link unrsv-bw 3 1.25e+06
+ mpls-te link unrsv-bw 4 1.25e+06
+ mpls-te link unrsv-bw 5 1.25e+06
+ mpls-te link unrsv-bw 6 1.25e+06
+ mpls-te link unrsv-bw 7 1.25e+06
+ mpls-te link rsc-clsclr 0xab
+ !
+ interface eth1
+ ip address 10.1.1.1/24
+ mpls-te on
+ mpls-te link metric 10
+ mpls-te link max-bw 1.25e+06
+ mpls-te link max-rsv-bw 1.25e+06
+ mpls-te link unrsv-bw 0 1.25e+06
+ mpls-te link unrsv-bw 1 1.25e+06
+ mpls-te link unrsv-bw 2 1.25e+06
+ mpls-te link unrsv-bw 3 1.25e+06
+ mpls-te link unrsv-bw 4 1.25e+06
+ mpls-te link unrsv-bw 5 1.25e+06
+ mpls-te link unrsv-bw 6 1.25e+06
+ mpls-te link unrsv-bw 7 1.25e+06
+ mpls-te link rsc-clsclr 0xab
+ mpls-te neighbor 10.1.1.2 as 65000
+
+
+Then the 'isisd.conf' itself:::
+
+ hostname HOSTNAME
+ password PASSWORD
+ log file /var/log/isisd.log
+ !
+ !
+ interface eth0
+ ip router isis FOO
+ !
+ interface eth1
+ ip router isis FOO
+ !
+ !
+ router isis FOO
+ isis net 47.0023.0000.0000.0000.0000.0000.0000.1900.0004.00
+ mpls-te on
+ mpls-te router-address 10.1.1.1
+ !
+ line vty
NHRP
****
-*nhrpd* is a daemon to support Next Hop Routing Protocol (NHRP).
-NHRP is described in RFC2332.
+*nhrpd* is an implementation of the :abbr:NHRP `(Next Hop Routing Protocol)`.
+NHRP is described in :rfc`2332`.
-NHRP is used to improve the efficiency of routing computer network
-traffic over Non-Broadcast, Multiple Access (NBMA) Networks. NHRP provides
-an ARP-like solution that allows a system to dynamically learn the NBMA
-address of the other systems that are part of that network, allowing
-these systems to directly communicate without requiring traffic to use
-an intermediate hop.
+NHRP is used to improve the efficiency of routing computer network traffic over
+:abbr:`NBMA (Non-Broadcast, Multiple Access)` networks. NHRP provides an
+ARP-like solution that allows a system to dynamically learn the NBMA address of
+the other systems that are part of that network, allowing these systems to
+directly communicate without requiring traffic to use an intermediate hop.
-Cisco Dynamic Multipoint VPN (DMVPN) is based on NHRP, and
-|PACKAGE_NAME| nhrpd implements this scenario.
+Cisco Dynamic Multipoint VPN (DMVPN) is based on NHRP, and |PACKAGE_NAME| nhrpd
+implements this scenario.
.. _Routing_Design:
This is similar to Cisco FlexVPN; but in contrast to opennhrp which uses
a generic subnet route.
-To create NBMA GRE tunnel you might use the following (linux terminal
-commands):
-::
+To create NBMA GRE tunnel you might use the following (Linux terminal
+commands):::
ip tunnel add gre1 mode gre key 42 ttl 64
ip addr add 10.255.255.2/32 dev gre1
routing protocol (e.g. iBGP) to allow hubs to be able to relay all traffic.
This can be achieved in hubs with the following bgp configuration (network
-command defines the GRE subnet):
-::
+command defines the GRE subnet):::
router bgp 65555
address-family ipv4 unicast
if needed. However, the above should be good in most cases.
This kernel NFLOG target's nflog-group is configured in global nhrp config
-with:
-::
+with:::
nhrp nflog-group 1
-
To start sending these traffic notices out from hubs, use the nhrp
-per-interface directive:
-::
+per-interface directive:::
interface gre1
ip nhrp redirect
-
.. _Integration_with_IKE:
Integration with IKE
OSPFv3
******
-*ospf6d* is a daemon support OSPF version 3 for IPv6 network.
-OSPF for IPv6 is described in RFC2740.
+*ospf6d* is a daemon support OSPF version 3 for IPv6 network. OSPF for IPv6 is
+described in :rfc:`2740`.
.. _OSPF6_router:
OSPF6 router
============
-.. index:: {Command} {router ospf6} {}
+.. index:: router ospf6
+.. clicmd:: router ospf6
-{Command} {router ospf6} {}
+.. index:: router-id A.B.C.D
+.. clicmd:: router-id A.B.C.D
-.. index:: {OSPF6 Command} {router-id `a.b.c.d`} {}
+ Set router's Router-ID.
-{OSPF6 Command} {router-id `a.b.c.d`} {}
- Set router's Router-ID.
+.. index:: interface IFNAME area AREA
+.. clicmd:: interface IFNAME area AREA
-.. index:: {OSPF6 Command} {interface `ifname` area `area`} {}
+ Bind interface to specified area, and start sending OSPF packets. `area` can
+ be specified as 0.
-{OSPF6 Command} {interface `ifname` area `area`} {}
- Bind interface to specified area, and start sending OSPF packets. `area` can
- be specified as 0.
+.. index:: timers throttle spf DELAY INITIAL-HOLDTIME MAX-HOLDTIME
+.. clicmd:: timers throttle spf DELAY INITIAL-HOLDTIME MAX-HOLDTIME
-.. index:: {OSPF6 Command} {timers throttle spf `delay` `initial-holdtime` `max-holdtime`} {}
+.. index:: no timers throttle spf
+.. clicmd:: no timers throttle spf
-{OSPF6 Command} {timers throttle spf `delay` `initial-holdtime` `max-holdtime`} {}
-.. index:: {OSPF6 Command} {no timers throttle spf} {}
+ This command sets the initial `delay`, the `initial-holdtime`
+ and the `maximum-holdtime` between when SPF is calculated and the
+ event which triggered the calculation. The times are specified in
+ milliseconds and must be in the range of 0 to 600000 milliseconds.
-{OSPF6 Command} {no timers throttle spf} {}
- This command sets the initial `delay`, the `initial-holdtime`
- and the `maximum-holdtime` between when SPF is calculated and the
- event which triggered the calculation. The times are specified in
- milliseconds and must be in the range of 0 to 600000 milliseconds.
+ The `delay` specifies the minimum amount of time to delay SPF
+ calculation (hence it affects how long SPF calculation is delayed after
+ an event which occurs outside of the holdtime of any previous SPF
+ calculation, and also serves as a minimum holdtime).
- The `delay` specifies the minimum amount of time to delay SPF
- calculation (hence it affects how long SPF calculation is delayed after
- an event which occurs outside of the holdtime of any previous SPF
- calculation, and also serves as a minimum holdtime).
-
- Consecutive SPF calculations will always be seperated by at least
- 'hold-time' milliseconds. The hold-time is adaptive and initially is
- set to the `initial-holdtime` configured with the above command.
- Events which occur within the holdtime of the previous SPF calculation
- will cause the holdtime to be increased by `initial-holdtime`, bounded
- by the `maximum-holdtime` configured with this command. If the adaptive
- hold-time elapses without any SPF-triggering event occuring then
- the current holdtime is reset to the `initial-holdtime`.
-
-::
+ Consecutive SPF calculations will always be seperated by at least
+ 'hold-time' milliseconds. The hold-time is adaptive and initially is
+ set to the `initial-holdtime` configured with the above command.
+ Events which occur within the holdtime of the previous SPF calculation
+ will cause the holdtime to be increased by `initial-holdtime`, bounded
+ by the `maximum-holdtime` configured with this command. If the adaptive
+ hold-time elapses without any SPF-triggering event occuring then
+ the current holdtime is reset to the `initial-holdtime`.::
router ospf6
timers throttle spf 200 400 10000
- In this example, the `delay` is set to 200ms, the @var{initial
- holdtime} is set to 400ms and the `maximum holdtime` to 10s. Hence
- there will always be at least 200ms between an event which requires SPF
- calculation and the actual SPF calculation. Further consecutive SPF
- calculations will always be seperated by between 400ms to 10s, the
- hold-time increasing by 400ms each time an SPF-triggering event occurs
- within the hold-time of the previous SPF calculation.
+ In this example, the `delay` is set to 200ms, the initial holdtime is set
+ to 400ms and the `maximum holdtime` to 10s. Hence there will always be at
+ least 200ms between an event which requires SPF calculation and the actual
+ SPF calculation. Further consecutive SPF calculations will always be
+ seperated by between 400ms to 10s, the hold-time increasing by 400ms each
+ time an SPF-triggering event occurs within the hold-time of the previous
+ SPF calculation.
-.. index:: {OSPF6 Command} {auto-cost reference-bandwidth `cost`} {}
+.. index:: auto-cost reference-bandwidth COST
+.. clicmd:: auto-cost reference-bandwidth COST
-{OSPF6 Command} {auto-cost reference-bandwidth `cost`} {}
-.. index:: {OSPF6 Command} {no auto-cost reference-bandwidth} {}
+.. index:: no auto-cost reference-bandwidth
+.. clicmd:: no auto-cost reference-bandwidth
-{OSPF6 Command} {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
- Mbits/s. The default is 100Mbit/s (i.e. a link of bandwidth 100Mbit/s
- or higher will have a cost of 1. Cost of lower bandwidth links will be
- scaled with reference to this cost).
+ This sets the reference bandwidth for cost calculations, where this
+ bandwidth is considered equivalent to an OSPF cost of 1, specified in
+ Mbits/s. The default is 100Mbit/s (i.e. a link of bandwidth 100Mbit/s
+ or higher will have a cost of 1. Cost of lower bandwidth links will be
+ scaled with reference to this cost).
- This configuration setting MUST be consistent across all routers
- within the OSPF domain.
+ This configuration setting MUST be consistent across all routers
+ within the OSPF domain.
.. _OSPF6_area:
OSPF6 interface
===============
-.. index:: {Interface Command} {ipv6 ospf6 cost COST} {}
+.. index:: ipv6 ospf6 cost COST
+.. clicmd:: ipv6 ospf6 cost COST
-{Interface Command} {ipv6 ospf6 cost COST} {}
- Sets interface's output cost. Default value depends on the interface
- bandwidth and on the auto-cost reference bandwidth.
+ Sets interface's output cost. Default value depends on the interface
+ bandwidth and on the auto-cost reference bandwidth.
-.. index:: {Interface Command} {ipv6 ospf6 hello-interval HELLOINTERVAL} {}
+.. index:: ipv6 ospf6 hello-interval HELLOINTERVAL
+.. clicmd:: ipv6 ospf6 hello-interval HELLOINTERVAL
-{Interface Command} {ipv6 ospf6 hello-interval HELLOINTERVAL} {}
- Sets interface's Hello Interval. Default 40
+ Sets interface's Hello Interval. Default 40
-.. index:: {Interface Command} {ipv6 ospf6 dead-interval DEADINTERVAL} {}
+.. index:: ipv6 ospf6 dead-interval DEADINTERVAL
+.. clicmd:: ipv6 ospf6 dead-interval DEADINTERVAL
-{Interface Command} {ipv6 ospf6 dead-interval DEADINTERVAL} {}
- Sets interface's Router Dead Interval. Default value is 40.
+ Sets interface's Router Dead Interval. Default value is 40.
-.. index:: {Interface Command} {ipv6 ospf6 retransmit-interval RETRANSMITINTERVAL} {}
+.. index:: ipv6 ospf6 retransmit-interval RETRANSMITINTERVAL
+.. clicmd:: ipv6 ospf6 retransmit-interval RETRANSMITINTERVAL
-{Interface Command} {ipv6 ospf6 retransmit-interval RETRANSMITINTERVAL} {}
- Sets interface's Rxmt Interval. Default value is 5.
+ Sets interface's Rxmt Interval. Default value is 5.
-.. index:: {Interface Command} {ipv6 ospf6 priority PRIORITY} {}
+.. index:: ipv6 ospf6 priority PRIORITY
+.. clicmd:: ipv6 ospf6 priority PRIORITY
-{Interface Command} {ipv6 ospf6 priority PRIORITY} {}
- Sets interface's Router Priority. Default value is 1.
+ Sets interface's Router Priority. Default value is 1.
-.. index:: {Interface Command} {ipv6 ospf6 transmit-delay TRANSMITDELAY} {}
+.. index:: ipv6 ospf6 transmit-delay TRANSMITDELAY
+.. clicmd:: ipv6 ospf6 transmit-delay TRANSMITDELAY
-{Interface Command} {ipv6 ospf6 transmit-delay TRANSMITDELAY} {}
- Sets interface's Inf-Trans-Delay. Default value is 1.
+ Sets interface's Inf-Trans-Delay. Default value is 1.
-.. index:: {Interface Command} {ipv6 ospf6 network (broadcast|point-to-point)} {}
+.. index:: ipv6 ospf6 network (broadcast|point-to-point)
+.. clicmd:: ipv6 ospf6 network (broadcast|point-to-point)
-{Interface Command} {ipv6 ospf6 network (broadcast|point-to-point)} {}
- Set explicitly network type for specifed interface.
+ Set explicitly network type for specifed interface.
.. _Redistribute_routes_to_OSPF6:
Redistribute routes to OSPF6
============================
-.. index:: {OSPF6 Command} {redistribute static} {}
+.. index:: redistribute static
+.. clicmd:: redistribute static
-{OSPF6 Command} {redistribute static} {}
-.. index:: {OSPF6 Command} {redistribute connected} {}
+.. index:: redistribute connected
+.. clicmd:: redistribute connected
-{OSPF6 Command} {redistribute connected} {}
-.. index:: {OSPF6 Command} {redistribute ripng} {}
+.. index:: redistribute ripng
+.. clicmd:: redistribute ripng
-{OSPF6 Command} {redistribute ripng} {}
.. _Showing_OSPF6_information:
Showing OSPF6 information
=========================
-.. index:: {Command} {show ipv6 ospf6 [INSTANCE_ID]} {}
+.. index:: show ipv6 ospf6 [INSTANCE_ID]
+.. clicmd:: show ipv6 ospf6 [INSTANCE_ID]
-{Command} {show ipv6 ospf6 [INSTANCE_ID]} {}
- INSTANCE_ID is an optional OSPF instance ID. To see router ID and OSPF
- instance ID, simply type "show ipv6 ospf6 <cr>".
+ INSTANCE_ID is an optional OSPF instance ID. To see router ID and OSPF
+ instance ID, simply type "show ipv6 ospf6 <cr>".
-.. index:: {Command} {show ipv6 ospf6 database} {}
+.. index:: show ipv6 ospf6 database
+.. clicmd:: show ipv6 ospf6 database
-{Command} {show ipv6 ospf6 database} {}
- This command shows LSA database summary. You can specify the type of LSA.
+ This command shows LSA database summary. You can specify the type of LSA.
-.. index:: {Command} {show ipv6 ospf6 interface} {}
+.. index:: show ipv6 ospf6 interface
+.. clicmd:: show ipv6 ospf6 interface
-{Command} {show ipv6 ospf6 interface} {}
- To see OSPF interface configuration like costs.
+ To see OSPF interface configuration like costs.
-.. index:: {Command} {show ipv6 ospf6 neighbor} {}
+.. index:: show ipv6 ospf6 neighbor
+.. clicmd:: show ipv6 ospf6 neighbor
-{Command} {show ipv6 ospf6 neighbor} {}
- Shows state and chosen (Backup) DR of neighbor.
+ Shows state and chosen (Backup) DR of neighbor.
-.. index:: {Command} {show ipv6 ospf6 request-list A.B.C.D} {}
+.. index:: show ipv6 ospf6 request-list A.B.C.D
+.. clicmd:: show ipv6 ospf6 request-list A.B.C.D
-{Command} {show ipv6 ospf6 request-list A.B.C.D} {}
- Shows requestlist of neighbor.
+ Shows requestlist of neighbor.
-.. index:: {Command} {show ipv6 route ospf6} {}
+.. index:: show ipv6 route ospf6
+.. clicmd:: show ipv6 route ospf6
-{Command} {show ipv6 route ospf6} {}
- This command shows internal routing table.
+ This command shows internal routing table.
-.. index:: {Command} {show ipv6 ospf6 zebra} {}
+.. index:: show ipv6 ospf6 zebra
+.. clicmd:: show ipv6 ospf6 zebra
-{Command} {show ipv6 ospf6 zebra} {}
- Shows state about what is being redistributed between zebra and OSPF6
+ Shows state about what is being redistributed between zebra and OSPF6
OSPF6 Configuration Examples
============================
::
- interface eth0
- ipv6 ospf6 instance-id 0
- !
- router ospf6
- router-id 212.17.55.53
- area 0.0.0.0 range 2001:770:105:2::/64
- interface eth0 area 0.0.0.0
- !
-
-
+ interface eth0
+ ipv6 ospf6 instance-id 0
+ !
+ router ospf6
+ router-id 212.17.55.53
+ area 0.0.0.0 range 2001:770:105:2::/64
+ interface eth0 area 0.0.0.0
+ !
=================
.. index:: Link-state routing protocol
-
.. index:: Distance-vector routing protocol
:abbr:`OSPF` is, mostly, a link-state routing protocol. In contrast
routers.
.. index:: Link State Announcement
-
.. index:: Link State Advertisement
-
.. index:: LSA flooding
-
-.. index:: Link State DataBase
+.. index:: Link State Database
Each router describes their link-state information in a message known
as an :abbr:`LSA (Link State Advertisement)`, which is then propogated
broadly classed as:
- .. index:: OSPF Hello Protocol overview
-
-
-*The Hello Protocol*
- .. index:: OSPF Hello Protocol
-
- The OSPF Hello protocol allows OSPF to quickly detect changes in
- two-way reachability between routers on a link. OSPF can additionally
- avail of other sources of reachability information, such as link-state
- information provided by hardware, or through dedicated reachability
- protocols such as :abbr:`BFD (Bi-directional Forwarding Detection)`.
-
- OSPF also uses the Hello protocol to propagate certain state between
- routers sharing a link, for example:
-
-
-*Hello protocol configured state, such as the dead-interval.*
-
-*Router priority, for DR/BDR election.*
-
-*DR/BDR election results.*
+.. index:: OSPF Hello Protocol
-*Any optional capabilities supported by each router.*
+The Hello Protocol
+^^^^^^^^^^^^^^^^^^
- The Hello protocol is comparatively trivial and will not be explored in
- greater detail than here.
+The OSPF Hello protocol allows OSPF to quickly detect changes in two-way
+reachability between routers on a link. OSPF can additionally avail of other
+sources of reachability information, such as link-state information provided by
+hardware, or through dedicated reachability protocols such as :abbr:`BFD
+(Bidirectional Forwarding Detection)`.
- .. index:: OSPF LSA overview
+OSPF also uses the Hello protocol to propagate certain state between routers
+sharing a link, for example:
+- Hello protocol configured state, such as the dead-interval.
+- Router priority, for DR/BDR election.
+- DR/BDR election results.
+- Any optional capabilities supported by each router.
-*LSAs*
- At the heart of :abbr:`OSPF` are :abbr:`LSA (Link State Advertisement)`
- messages. Despite the name, some :abbr:`LSA`s do not, strictly speaking,
- describe link-state information. Common :abbr:`LSA`s describe information
- such as:
+The Hello protocol is comparatively trivial and will not be explored in greater
+detail than here.
+.. index:: OSPF LSA overview
+.. _ospf-lsas:
-**
- Routers, in terms of their links.
+LSAs
+^^^^
-**
- Networks, in terms of attached routers.
+At the heart of :abbr:`OSPF` are :abbr:`LSA (Link State Advertisement)`
+messages. Despite the name, some :abbr:`LSA` s do not, strictly speaking,
+describe link-state information. Common :abbr:`LSA` s describe information
+such as:
-**
- Routes, external to a link-state domain:
+- Routers, in terms of their links.
+- Networks, in terms of attached routers.
+- Routes, external to a link-state domain:
+ External Routes
+ Routes entirely external to :abbr:`OSPF`. Routers originating such
+ routes are known as :abbr:`ASBR (Autonomous-System Border Router)`
+ routers.
-*External Routes*
- Routes entirely external to :abbr:`OSPF`. Routers originating such
- routes are known as :abbr:`ASBR (Autonomous-System Border Router)`
- routers.
+ Summary Routes
+ Routes which summarise routing information relating to OSPF areas
+ external to the OSPF link-state area at hand, originated by
+ :abbr:`ABR (Area Boundary Router)` routers.
+.. _ospf-lsa-flooding:
-*Summary Routes*
- Routes which summarise routing information relating to OSPF areas
- external to the OSPF link-state area at hand, originated by
- :abbr:`ABR (Area Boundary Router)` routers.
+LSA Flooding
+""""""""""""
+OSPF defines several related mechanisms, used to manage synchronisation of
+:abbr:`LSDB`s between neighbours as neighbours form adjacencies and the
+propogation, or :term:`flooding` of new or updated :abbr:`LSA` s.
-*LSA Flooding*
- OSPF defines several related mechanisms, used to manage synchronisation of
- :abbr:`LSDB`s between neighbours as neighbours form adjacencies and
- the propogation, or :term:`flooding` of new or updated :abbr:`LSA`s.
+:ref:`OSPF_Flooding`.
- :ref:`OSPF_Flooding`.
- .. index:: OSPF Areas overview
+.. index:: OSPF Areas overview
+.. _ospf-areas:
+Areas
+^^^^^
-*Areas*
- OSPF provides for the protocol to be broken up into multiple smaller
- and independent link-state areas. Each area must be connected to a
- common backbone area by an :abbr:`ABR (Area Boundary Router)`. These
- :abbr:`ABR` routers are responsible for summarising the link-state
- routing information of an area into :term:`Summary LSAs`, possibly in a
- condensed (i.e. aggregated) form, and then originating these summaries
- into all other areas the :abbr:`ABR` is connected to.
+OSPF provides for the protocol to be broken up into multiple smaller and
+independent link-state areas. Each area must be connected to a common backbone
+area by an :abbr:`ABR (Area Boundary Router)`. These :abbr:`ABR` routers are
+responsible for summarising the link-state routing information of an area into
+:term:`Summary LSAs`, possibly in a condensed (i.e. aggregated) form, and then
+originating these summaries into all other areas the :abbr:`ABR` is connected
+to.
- Note that only summaries and external routes are passed between areas.
- As these describe *paths*, rather than any router link-states,
- routing between areas hence is by :term:`distance-vector`, **not**
- link-state.
-
- :ref:`OSPF_Areas`.
+Note that only summaries and external routes are passed between areas. As
+these describe *paths*, rather than any router link-states, routing between
+areas hence is by :term:`distance-vector`, **not** link-state.
OSPF LSAs
---------
-:abbr:`LSA`s are the core object in OSPF. Everything else in OSPF
-revolves around detecting what to describe in LSAs, when to update
-them, how to flood them throughout a network and how to calculate
-routes from them.
+The core objects in OSPF are :abbr:`LSA` s. Everything else in OSPF revolves
+around detecting what to describe in LSAs, when to update them, how to flood
+them throughout a network and how to calculate routes from them.
-There are a variety of different :abbr:`LSA`s, for purposes such
-as describing actual link-state information, describing paths (i.e.
-routes), describing bandwidth usage of links for
-:abbr:`TE (Traffic Engineering)` purposes, and even arbitrary data
-by way of *Opaque* :abbr:`LSA`s.
+There are a variety of different :abbr:`LSA` s, for purposes such as describing
+actual link-state information, describing paths (i.e. routes), describing
+bandwidth usage of links for :abbr:`TE (Traffic Engineering)` purposes, and
+even arbitrary data by way of *Opaque* :abbr:`LSA` s.
LSA Header
^^^^^^^^^^
All LSAs share a common header with the following information:
-* Type
+- Type
- Different types of :abbr:`LSA`s describe different things in
+ Different types of :abbr:`LSA` s describe different things in
:abbr:`OSPF`. Types include:
- * Router LSA
- * Network LSA
- * Network Summary LSA
- * Router Summary LSA
- * AS-External LSA
+ - Router LSA
+ - Network LSA
+ - Network Summary LSA
+ - Router Summary LSA
+ - AS-External LSA
The specifics of the different types of LSA are examined below.
-* Advertising Router
+- Advertising Router
The Router ID of the router originating the LSA, see :ref:`ospf_router-id`.
-* LSA ID
+- LSA ID
The ID of the LSA, which is typically derived in some way from the
information the LSA describes, e.g. a Router LSA uses the Router ID as
an LSA with the same Type, LSA ID and Advertising Router ID, see
:ref:`OSPF_LSA_sequence_number,,LSA_Sequence_Number`.
-* Age
+- Age
- A number to allow stale :abbr:`LSA`s to, eventually, be purged by routers
+ A number to allow stale :abbr:`LSA` s to, eventually, be purged by routers
from their :abbr:`LSDB`s.
The value nominally is one of seconds. An age of 3600, i.e. 1 hour, is
.. _OSPF_LSA_sequence_number:
-* Sequence Number
+- Sequence Number
A number used to distinguish newer instances of an LSA from older instances.
Link-State LSAs
^^^^^^^^^^^^^^^
-Of all the various kinds of :abbr:`LSA`s, just two types comprise the
-actual link-state part of :abbr:`OSPF`, Router :abbr:`LSA`s and
-Network :abbr:`LSA`s. These LSA types are absolutely core to the
+Of all the various kinds of :abbr:`LSA` s, just two types comprise the
+actual link-state part of :abbr:`OSPF`, Router :abbr:`LSA` s and
+Network :abbr:`LSA` s. These LSA types are absolutely core to the
protocol.
Instances of these LSAs are specific to the link-state area in which
they are originated. Routes calculated from these two LSA types are
called :term:`intra-area routes`.
-* Router LSA
+- Router LSA
Each OSPF Router must originate a router :abbr:`LSA` to describe
itself. In it, the router lists each of its :abbr:`OSPF` enabled
interfaces, for the given link-state area, in terms of:
- * Cost
-
- The output cost of that interface, scaled inversely to some commonly known
- reference value, :ref:`OSPF_auto-cost_reference-bandwidth,,auto-cost_reference-bandwidth`.
-
- * Link Type
+ Cost
+ The output cost of that interface, scaled inversely to some commonly known
+ reference value, :ref:`OSPF_auto-cost_reference-bandwidth,,auto-cost_reference-bandwidth`.
- * Transit Network
+ Link Type
+ Transit Network
- A link to a multi-access network, on which the router has at least one
- Full adjacency with another router.
+ A link to a multi-access network, on which the router has at least one
+ Full adjacency with another router.
- * :abbr:`PtP (Point-to-Point)`
+ :abbr:`PtP (Point-to-Point)`
+ A link to a single remote router, with a Full adjacency. No
+ :abbr:`DR (Designated Router)` is elected on such links; no network
+ LSA is originated for such a link.
- A link to a single remote router, with a Full adjacency. No
- :abbr:`DR (Designated Router)` is elected on such links; no network
- LSA is originated for such a link.
+ Stub
+ A link with no adjacent neighbours, or a host route.
- * Stub
-
- A link with no adjacent neighbours, or a host route.
-
- * Link ID and Data
+ - Link ID and Data
These values depend on the Link Type:
- +----------------+-----------------------------------+------------------------------------------+
- | Link Type | Link ID | Link Data |
- +================+===================================+==========================================+
- | Transit | Link IP address of the :abbr:`DR` | Interface IP address |
- +----------------+-----------------------------------+------------------------------------------+
- | Point-to-Point | Router ID of the remote router | Local interface IP address, or the |
- | | | :abbr:`ifindex (MIB-II interface index)` |
- | | | for unnumbered links |
- +----------------+-----------------------------------+------------------------------------------+
- | Stub | IP address | Subnet Mask |
- +----------------+-----------------------------------+------------------------------------------+
-
- Links on a router may be listed multiple times in the Router LSA, e.g.
- a :abbr:`PtP` interface on which OSPF is enabled must *always*
- be described by a Stub link in the Router :abbr:`LSA`, in addition to
- being listed as PtP link in the Router :abbr:`LSA` if the adjacency
- with the remote router is Full.
-
- Stub links may also be used as a way to describe links on which OSPF is
- *not* spoken, known as :term:`passive interfaces`, see :ref:`OSPF_passive-interface,,passive-interface`.
-
-* Network LSA
+ +----------------+-----------------------------------+------------------------------------------+
+ | Link Type | Link ID | Link Data |
+ +================+===================================+==========================================+
+ | Transit | Link IP address of the :abbr:`DR` | Interface IP address |
+ +----------------+-----------------------------------+------------------------------------------+
+ | Point-to-Point | Router ID of the remote router | Local interface IP address, or the |
+ | | | :abbr:`ifindex (MIB-II interface index)` |
+ | | | for unnumbered links |
+ +----------------+-----------------------------------+------------------------------------------+
+ | Stub | IP address | Subnet Mask |
+ +----------------+-----------------------------------+------------------------------------------+
+
+ Links on a router may be listed multiple times in the Router LSA, e.g. a
+ :abbr:`PtP` interface on which OSPF is enabled must *always* be described
+ by a Stub link in the Router :abbr:`LSA`, in addition to being listed as
+ PtP link in the Router :abbr:`LSA` if the adjacency with the remote router
+ is Full.
+
+ Stub links may also be used as a way to describe links on which OSPF is
+ *not* spoken, known as :term:`passive interfaces`, see
+ :ref:`OSPF_passive-interface,,passive-interface`.
+
+- Network LSA
On multi-access links (e.g. ethernets, certain kinds of ATM and X.25
configurations), routers elect a :abbr:`DR`. The :abbr:`DR` is
responsible for originating a Network :abbr:`LSA`, which helps reduce
the information needed to describe multi-access networks with multiple
routers attached. The :abbr:`DR` also acts as a hub for the flooding of
- :abbr:`LSA`s on that link, thus reducing flooding overheads.
+ :abbr:`LSA` s on that link, thus reducing flooding overheads.
The contents of the Network LSA describes the:
- * Subnet Mask
+ - Subnet Mask
As the :abbr:`LSA` ID of a Network LSA must be the IP address of the
:abbr:`DR`, the Subnet Mask together with the :abbr:`LSA` ID gives
you the network address.
- * Attached Routers
+ - Attached Routers
Each router fully-adjacent with the :abbr:`DR` is listed in the LSA,
- by their Router-ID. This allows the corresponding Router :abbr:`LSA`s to be
+ by their Router-ID. This allows the corresponding Router :abbr:`LSA` s to be
easily retrieved from the :abbr:`LSDB`.
Summary of Link State LSAs:
stage of :abbr:`SPF` calculation concerns itself only with these two
LSA types.
+.. _ospf-link-state-lsa-examples:
+
Link-State LSA Examples
^^^^^^^^^^^^^^^^^^^^^^^
-The example below (:ref:`OSPF_Link-State_LSA_Example`) shows two
-:abbr:`LSA`s, both originated by the same router (Router ID
-192.168.0.49) and with the same :abbr:`LSA` ID (192.168.0.49), but of
-different LSA types.
+The example below shows two :abbr:`LSA` s, both originated by the same router
+(Router ID 192.168.0.49) and with the same :abbr:`LSA` ID (192.168.0.49), but
+of different LSA types.
The first LSA being the router LSA describing 192.168.0.49's links: 2 links
to multi-access networks with fully-adjacent neighbours (i.e. Transit
:abbr:`DR`, listing the Router IDs of 4 routers on that network which
are fully adjacent with 192.168.0.49.
-.. _OSPF_Link-State_LSA_Example:
-
::
# show ip ospf database router 192.168.0.49
find all the attached routers on that link, leading potentially to more
links and Network and Router LSAs, etc. etc.
-From just the above two :abbr:`LSA`s, one can already see the
+From just the above two :abbr:`LSA` s, one can already see the
following partial topology:
::
External LSAs
^^^^^^^^^^^^^
-External, or "Type 5", :abbr:`LSA`s describe routing information which is
+External, or "Type 5", :abbr:`LSA` s describe routing information which is
entirely external to :abbr:`OSPF`, and is "injected" into
:abbr:`OSPF`. Such routing information may have come from another
routing protocol, such as RIP or BGP, they may represent static routes
or they may represent a default route.
-An :abbr:`OSPF` router which originates External :abbr:`LSA`s is known as an
-:abbr:`ASBR (AS Boundary Router)`. Unlike the link-state :abbr:`LSA`s, and
-most other :abbr:`LSA`s, which are flooded only within the area in
-which they originate, External :abbr:`LSA`s are flooded through-out
+An :abbr:`OSPF` router which originates External :abbr:`LSA` s is known as an
+:abbr:`ASBR (AS Boundary Router)`. Unlike the link-state :abbr:`LSA` s, and
+most other :abbr:`LSA` s, which are flooded only within the area in
+which they originate, External :abbr:`LSA` s are flooded through-out
the :abbr:`OSPF` network to all areas capable of carrying External
-:abbr:`LSA`s (:ref:`OSPF_Areas`).
+:abbr:`LSA` s (:ref:`OSPF_Areas`).
Routes internal to OSPF (intra-area or inter-area) are always preferred
over external routes.
The External :abbr:`LSA` describes the following:
-* IP Network number
-
- The IP Network number of the route is described by the :abbr:`LSA` ID
- field.
-
-* IP Network Mask
-
- The body of the External LSA describes the IP Network Mask of the
- route. This, together with the :abbr:`LSA` ID, describes the prefix
- of the IP route concerned.
-
-* Metric
-
- The cost of the External Route. This cost may be an OSPF cost (also
- known as a "Type 1" metric), i.e. equivalent to the normal OSPF costs,
- or an externally derived cost ("Type 2" metric) which is not comparable
- to OSPF costs and always considered larger than any OSPF cost. Where
- there are both Type 1 and 2 External routes for a route, the Type 1 is
- always preferred.
+IP Network number
+ The IP Network number of the route is described by the :abbr:`LSA` ID field.
-* Forwarding Address
+IP Network Mask
+ The body of the External LSA describes the IP Network Mask of the route.
+ This, together with the :abbr:`LSA` ID, describes the prefix of the IP route
+ concerned.
- The address of the router to forward packets to for the route. This may
- be, and usually is, left as 0 to specify that the ASBR originating the
- External :abbr:`LSA` should be used. There must be an internal OSPF
- route to the forwarding address, for the forwarding address to be
- useable.
+Metric
+ The cost of the External Route. This cost may be an OSPF cost (also known as
+ a "Type 1" metric), i.e. equivalent to the normal OSPF costs, or an
+ externally derived cost ("Type 2" metric) which is not comparable to OSPF
+ costs and always considered larger than any OSPF cost. Where there are both
+ Type 1 and 2 External routes for a route, the Type 1 is always preferred.
-* Tag
+Forwarding Address
+ The address of the router to forward packets to for the route. This may be,
+ and usually is, left as 0 to specify that the ASBR originating the External
+ :abbr:`LSA` should be used. There must be an internal OSPF route to the
+ forwarding address, for the forwarding address to be useable.
- An arbitrary 4-bytes of data, not interpreted by OSPF, which may
- carry whatever information about the route which OSPF speakers desire.
+Tag
+ An arbitrary 4-bytes of data, not interpreted by OSPF, which may carry
+ whatever information about the route which OSPF speakers desire.
AS External LSA Example
^^^^^^^^^^^^^^^^^^^^^^^
To illustrate, below is an example of an External :abbr:`LSA` in the
-:abbr:`LSDB` of an OSPF router. It describes a route to the IP prefix
-of 192.168.165.0/24, originated by the ASBR with Router-ID
-192.168.0.49. The metric of 20 is external to OSPF. The forwarding
-address is 0, so the route should forward to the originating ASBR if
-selected.
+:abbr:`LSDB` of an OSPF router. It describes a route to the IP prefix of
+192.168.165.0/24, originated by the ASBR with Router-ID 192.168.0.49. The
+metric of 20 is external to OSPF. The forwarding address is 0, so the route
+should forward to the originating ASBR if selected.
::
We can add this to our partial topology from above, which now looks
-like:
-::
-
- --------------------- Network: ......
- | Designated Router IP: 192.168.1.3
- |
- IP: 192.168.1.3 /---- External route: 192.168.165.0/24
- (transit link) / Cost: 20 (External metric)
- (cost: 10) /
- Router ID: 192.168.0.49(stub)---------- IP: 192.168.3.190/32
- (cost: 10) (cost: 39063)
- (transit link)
- IP: 192.168.0.49
- |
- |
- ------------------------------ Network: 192.168.0.48/29
- | | | Designated Router IP: 192.168.0.49
- | | |
- | | Router ID: 192.168.0.54
- | |
- | Router ID: 192.168.0.53
- |
- Router ID: 192.168.0.52
+like:::
+
+ --------------------- Network: ......
+ | Designated Router IP: 192.168.1.3
+ |
+ IP: 192.168.1.3 /---- External route: 192.168.165.0/24
+ (transit link) / Cost: 20 (External metric)
+ (cost: 10) /
+ Router ID: 192.168.0.49(stub)---------- IP: 192.168.3.190/32
+ (cost: 10) (cost: 39063)
+ (transit link)
+ IP: 192.168.0.49
+ |
+ |
+ ------------------------------ Network: 192.168.0.48/29
+ | | | Designated Router IP: 192.168.0.49
+ | | |
+ | | Router ID: 192.168.0.54
+ | |
+ | Router ID: 192.168.0.53
+ |
+ Router ID: 192.168.0.52
Summary LSAs
^^^^^^^^^^^^
-Summary LSAs are created by :abbr:`ABR`s to summarise the destinations available within one area to other areas. These LSAs may describe IP networks, potentially in aggregated form, or :abbr:`ASBR` routers.
-
-.. _OSPF_Flooding:
-
-OSPF Flooding
--------------
-
-.. _OSPF_Areas:
-
-OSPF Areas
-----------
-
-
+Summary LSAs are created by :abbr:`ABR`s to summarise the destinations
+available within one area to other areas. These LSAs may describe IP networks,
+potentially in aggregated form, or :abbr:`ASBR` routers.
OSPFv2
******
-:abbr:`OSPF (Open Shortest Path First)` version 2 is a routing protocol
-which is described in :rfc:`2328`. OSPF is an
-:abbr:`IGP (Interior Gateway Protocol)`. Compared with :abbr:`RIP`,
-:abbr:`OSPF` can provide scalable network support and faster
-convergence times. OSPF is widely used in large networks such as
-:abbr:`ISP (Internet Service Provider)` backbone and enterprise
-networks.
+:abbr:`OSPF (Open Shortest Path First)` version 2 is a routing protocol which
+is described in :rfc:`2328`. OSPF is an :abbr:`IGP (Interior Gateway
+Protocol)`. Compared with :abbr:`RIP`, :abbr:`OSPF` can provide scalable
+network support and faster convergence times. OSPF is widely used in large
+networks such as :abbr:`ISP (Internet Service Provider)` backbone and
+enterprise networks.
-@include ospf_fundamentals.texi
+.. include:: ospf_fundamentals.rst
-.. _Configuring_ospfd:
+.. _configuring-ospfd:
Configuring ospfd
=================
-There are no *ospfd* specific options. Common options can be
-specified (:ref:`Common_Invocation_Options`) to *ospfd*.
-*ospfd* needs to acquire interface information from
-*zebra* in order to function. Therefore *zebra* must be
-running before invoking *ospfd*. Also, if *zebra* is
-restarted then *ospfd* must be too.
+There are no *ospfd* specific options. Common options can be specified
+(:ref:`Common_Invocation_Options`) to *ospfd*. *ospfd* needs to acquire
+interface information from *zebra* in order to function. Therefore *zebra* must
+be running before invoking *ospfd*. Also, if *zebra* is restarted then *ospfd*
+must be too.
-Like other daemons, *ospfd* configuration is done in :abbr:`OSPF`
-specific configuration file :file:`ospfd.conf`.
+Like other daemons, *ospfd* configuration is done in :abbr:`OSPF` specific
+configuration file :file:`ospfd.conf`.
.. _OSPF_router:
OSPF router
===========
-To start OSPF process you have to specify the OSPF router. As of this
+To start OSPF process you have to specify the OSPF router. As of this
writing, *ospfd* does not support multiple OSPF processes.
-.. index:: Command {router ospf} {}
+.. index:: router ospf
+.. clicmd:: router ospf
-Command {router ospf} {}
-.. index:: Command {no router ospf} {}
+.. index:: no router ospf
+.. clicmd:: no router ospf
-Command {no router ospf} {}
- Enable or disable the OSPF process. *ospfd* does not yet
- support multiple OSPF processes. So you can not specify an OSPF process
- number.
+ Enable or disable the OSPF process. *ospfd* does not yet
+ support multiple OSPF processes. So you can not specify an OSPF process
+ number.
-.. index:: {OSPF Command} {ospf router-id `a.b.c.d`} {}
+.. index:: ospf router-id A.B.C.D
+.. clicmd:: ospf router-id A.B.C.D
-{OSPF Command} {ospf router-id `a.b.c.d`} {}
-.. index:: {OSPF Command} {no ospf router-id} {}
+.. index:: no ospf router-id
+.. clicmd:: no ospf router-id
-{OSPF Command} {no ospf router-id} {}
- .. _ospf_router-id:
+.. _ospf_router-id:
- This sets the router-ID of the OSPF process. The
- router-ID may be an IP address of the router, but need not be - it can
- be any arbitrary 32bit number. However it MUST be unique within the
- entire OSPF domain to the OSPF speaker - bad things will happen if
- multiple OSPF speakers are configured with the same router-ID! If one
- is not specified then *ospfd* will obtain a router-ID
- automatically from *zebra*.
+ 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 number. However it MUST be unique within the
+ entire OSPF domain to the OSPF speaker - bad things will happen if
+ multiple OSPF speakers are configured with the same router-ID! If one
+ is not specified then *ospfd* will obtain a router-ID
+ automatically from *zebra*.
-.. index:: {OSPF Command} {ospf abr-type `type`} {}
-
-{OSPF Command} {ospf abr-type `type`} {}
-.. index:: {OSPF Command} {no ospf abr-type `type`} {}
-
-{OSPF Command} {no ospf abr-type `type`} {}
- `type` can be cisco|ibm|shortcut|standard. The "Cisco" and "IBM" types
- are equivalent.
-
- The OSPF standard for ABR behaviour does not allow an ABR to consider
- routes through non-backbone areas when its links to the backbone are
- down, even when there are other ABRs in attached non-backbone areas
- which still can reach the backbone - this restriction exists primarily
- to ensure routing-loops are avoided.
-
- With the "Cisco" or "IBM" ABR type, the default in this release of
- FRR, this restriction is lifted, allowing an ABR to consider
- summaries learnt from other ABRs through non-backbone areas, and hence
- route via non-backbone areas as a last resort when, and only when,
- backbone links are down.
-
- Note that areas with fully-adjacent virtual-links are considered to be
- "transit capable" and can always be used to route backbone traffic, and
- hence are unaffected by this setting (:ref:`OSPF_virtual-link`).
-
- More information regarding the behaviour controlled by this command can
- be found in :rfc:`3509`, and :t:`draft-ietf-ospf-shortcut-abr-02.txt`.
-
- Quote: "Though the definition of the :abbr:`ABR (Area Border Router)`
- in the OSPF specification does not require a router with multiple
- attached areas to have a backbone connection, it is actually
- necessary to provide successful routing to the inter-area and
- external destinations. If this requirement is not met, all traffic
- destined for the areas not connected to such an ABR or out of the
- OSPF domain, is dropped. This document describes alternative ABR
- behaviors implemented in Cisco and IBM routers."
-
-.. index:: {OSPF Command} {ospf rfc1583compatibility} {}
-
-{OSPF Command} {ospf rfc1583compatibility} {}
-.. index:: {OSPF Command} {no ospf rfc1583compatibility} {}
-
-{OSPF Command} {no ospf rfc1583compatibility} {}
- :rfc:`2328`, the sucessor to :rfc:`1583`, suggests according
- to section G.2 (changes) in section 16.4 a change to the path
- preference algorithm that prevents possible routing loops that were
- possible in the old version of OSPFv2. More specifically it demands
- that inter-area paths and intra-area backbone path are now of equal preference
- but still both preferred to external paths.
-
- This command should NOT be set normally.
-
-.. index:: {OSPF Command} {log-adjacency-changes [detail]} {}
-
-{OSPF Command} {log-adjacency-changes [detail]} {}
-.. index:: {OSPF Command} {no log-adjacency-changes [detail]} {}
-
-{OSPF Command} {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,
- only changes to full or regressions are shown.
-
-.. index:: {OSPF Command} {passive-interface `interface`} {}
-
-{OSPF Command} {passive-interface `interface`} {}
-.. index:: {OSPF Command} {no passive-interface `interface`} {}
-
-{OSPF Command} {no passive-interface `interface`} {}
- .. _OSPF_passive-interface:
-
- Do not speak OSPF interface on the
- given interface, but do advertise the interface as a stub link in the
- router-:abbr:`LSA (Link State Advertisement)` for this router. This
- allows one to advertise addresses on such connected interfaces without
- having to originate AS-External/Type-5 LSAs (which have global flooding
- scope) - as would occur if connected addresses were redistributed into
- OSPF (:ref:`Redistribute_routes_to_OSPF`)@. This is the only way to
- advertise non-OSPF links into stub areas.
-
-.. index:: {OSPF Command} {timers throttle spf `delay` `initial-holdtime` `max-holdtime`} {}
-
-{OSPF Command} {timers throttle spf `delay` `initial-holdtime` `max-holdtime`} {}
-.. index:: {OSPF Command} {no timers throttle spf} {}
-
-{OSPF Command} {no timers throttle spf} {}
- This command sets the initial `delay`, the `initial-holdtime`
- and the `maximum-holdtime` between when SPF is calculated and the
- event which triggered the calculation. The times are specified in
- milliseconds and must be in the range of 0 to 600000 milliseconds.
-
- The `delay` specifies the minimum amount of time to delay SPF
- calculation (hence it affects how long SPF calculation is delayed after
- an event which occurs outside of the holdtime of any previous SPF
- calculation, and also serves as a minimum holdtime).
-
- Consecutive SPF calculations will always be seperated by at least
- 'hold-time' milliseconds. The hold-time is adaptive and initially is
- set to the `initial-holdtime` configured with the above command.
- Events which occur within the holdtime of the previous SPF calculation
- will cause the holdtime to be increased by `initial-holdtime`, bounded
- by the `maximum-holdtime` configured with this command. If the adaptive
- hold-time elapses without any SPF-triggering event occuring then
- the current holdtime is reset to the `initial-holdtime`. The current
- holdtime can be viewed with :ref:`show_ip_ospf`, where it is expressed as
- a multiplier of the `initial-holdtime`.
+.. index:: ospf abr-type TYPE
+.. clicmd:: ospf abr-type TYPE
+
+.. index:: no ospf abr-type TYPE
+.. clicmd:: no ospf abr-type TYPE
+
+ `type` can be cisco|ibm|shortcut|standard. The "Cisco" and "IBM" types
+ are equivalent.
+
+ The OSPF standard for ABR behaviour does not allow an ABR to consider
+ routes through non-backbone areas when its links to the backbone are
+ down, even when there are other ABRs in attached non-backbone areas
+ which still can reach the backbone - this restriction exists primarily
+ to ensure routing-loops are avoided.
-::
+ With the "Cisco" or "IBM" ABR type, the default in this release of
+ FRR, this restriction is lifted, allowing an ABR to consider
+ summaries learnt from other ABRs through non-backbone areas, and hence
+ route via non-backbone areas as a last resort when, and only when,
+ backbone links are down.
+
+ Note that areas with fully-adjacent virtual-links are considered to be
+ "transit capable" and can always be used to route backbone traffic, and
+ hence are unaffected by this setting (:ref:`OSPF_virtual-link`).
+
+ More information regarding the behaviour controlled by this command can
+ be found in :rfc:`3509`, and :t:`draft-ietf-ospf-shortcut-abr-02.txt`.
+
+ Quote: "Though the definition of the :abbr:`ABR (Area Border Router)`
+ in the OSPF specification does not require a router with multiple
+ attached areas to have a backbone connection, it is actually
+ necessary to provide successful routing to the inter-area and
+ external destinations. If this requirement is not met, all traffic
+ destined for the areas not connected to such an ABR or out of the
+ OSPF domain, is dropped. This document describes alternative ABR
+ behaviors implemented in Cisco and IBM routers."
- router ospf
- timers throttle spf 200 400 10000
+.. index:: ospf rfc1583compatibility
+.. clicmd:: ospf rfc1583compatibility
+.. index:: no ospf rfc1583compatibility
+.. clicmd:: no ospf rfc1583compatibility
- In this example, the `delay` is set to 200ms, the @var{initial
- holdtime} is set to 400ms and the `maximum holdtime` to 10s. Hence
- there will always be at least 200ms between an event which requires SPF
- calculation and the actual SPF calculation. Further consecutive SPF
- calculations will always be seperated by between 400ms to 10s, the
- hold-time increasing by 400ms each time an SPF-triggering event occurs
- within the hold-time of the previous SPF calculation.
+ :rfc:`2328`, the sucessor to :rfc:`1583`, suggests according
+ to section G.2 (changes) in section 16.4 a change to the path
+ preference algorithm that prevents possible routing loops that were
+ possible in the old version of OSPFv2. More specifically it demands
+ that inter-area paths and intra-area backbone path are now of equal preference
+ but still both preferred to external paths.
+
+ This command should NOT be set normally.
+
+.. index:: log-adjacency-changes [detail]
+.. clicmd:: log-adjacency-changes [detail]
+
+.. index:: no 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,
+ only changes to full or regressions are shown.
+
+.. index:: passive-interface INTERFACE
+.. clicmd:: passive-interface INTERFACE
+
+.. index:: no passive-interface INTERFACE
+.. clicmd:: no passive-interface INTERFACE
- This command supercedes the *timers spf* command in previous FRR
- releases.
+.. _ospf_passive-interface:
+
+ Do not speak OSPF interface on the
+ given interface, but do advertise the interface as a stub link in the
+ router-:abbr:`LSA (Link State Advertisement)` for this router. This
+ allows one to advertise addresses on such connected interfaces without
+ having to originate AS-External/Type-5 LSAs (which have global flooding
+ scope) - as would occur if connected addresses were redistributed into
+ OSPF (:ref:`Redistribute_routes_to_OSPF`). This is the only way to
+ advertise non-OSPF links into stub areas.
+
+.. index:: timers throttle spf DELAY INITIAL-HOLDTIME MAX-HOLDTIME
+.. clicmd:: timers throttle spf DELAY INITIAL-HOLDTIME MAX-HOLDTIME
+
+.. index:: no timers throttle spf
+.. clicmd:: no timers throttle spf
+
+ This command sets the initial `delay`, the `initial-holdtime`
+ and the `maximum-holdtime` between when SPF is calculated and the
+ event which triggered the calculation. The times are specified in
+ milliseconds and must be in the range of 0 to 600000 milliseconds.
+
+ The `delay` specifies the minimum amount of time to delay SPF
+ calculation (hence it affects how long SPF calculation is delayed after
+ an event which occurs outside of the holdtime of any previous SPF
+ calculation, and also serves as a minimum holdtime).
+
+ Consecutive SPF calculations will always be seperated by at least
+ 'hold-time' milliseconds. The hold-time is adaptive and initially is
+ set to the `initial-holdtime` configured with the above command.
+ Events which occur within the holdtime of the previous SPF calculation
+ will cause the holdtime to be increased by `initial-holdtime`, bounded
+ by the `maximum-holdtime` configured with this command. If the adaptive
+ hold-time elapses without any SPF-triggering event occuring then
+ the current holdtime is reset to the `initial-holdtime`. The current
+ holdtime can be viewed with :ref:`show_ip_ospf`, where it is expressed as
+ a multiplier of the `initial-holdtime`.
-.. index:: {OSPF Command} {max-metric router-lsa [on-startup|on-shutdown] (5-86400)} {}
+ ::
+
+ router ospf
+ timers throttle spf 200 400 10000
+
+
+ In this example, the `delay` is set to 200ms, the initial holdtime is set to
+ 400ms and the `maximum holdtime` to 10s. Hence there will always be at least
+ 200ms between an event which requires SPF calculation and the actual SPF
+ calculation. Further consecutive SPF calculations will always be seperated
+ by between 400ms to 10s, the hold-time increasing by 400ms each time an
+ SPF-triggering event occurs within the hold-time of the previous SPF
+ calculation.
-{OSPF Command} {max-metric router-lsa [on-startup|on-shutdown] (5-86400)} {}
-.. index:: {OSPF Command} {max-metric router-lsa administrative} {}
+ This command supercedes the *timers spf* command in previous FRR
+ releases.
-{OSPF Command} {max-metric router-lsa administrative} {}
-.. index:: {OSPF Command} {no max-metric router-lsa [on-startup|on-shutdown|administrative]} {}
+.. index:: max-metric router-lsa [on-startup|on-shutdown] (5-86400)
+.. clicmd:: max-metric router-lsa [on-startup|on-shutdown] (5-86400)
-{OSPF Command} {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 routers will avoid calculating
- transit paths through the router while still being able to reach
- networks through the router.
+.. index:: max-metric router-lsa administrative
+.. clicmd:: max-metric router-lsa administrative
+
+.. index:: no max-metric router-lsa [on-startup|on-shutdown|administrative]
+.. clicmd:: no max-metric router-lsa [on-startup|on-shutdown|administrative]
- This support may be enabled administratively (and indefinitely) or
- conditionally. Conditional enabling of max-metric router-lsas can be
- for a period of seconds after startup and/or for a period of seconds
- prior to shutdown.
+ This enables :rfc:`3137` support, where the OSPF process describes its
+ transit links in its router-LSA as having infinite distance so that other
+ routers will avoid calculating transit paths through the router while still
+ being able to reach networks through the router.
- Enabling this for a period after startup allows OSPF to converge fully
- first without affecting any existing routes used by other routers,
- while still allowing any connected stub links and/or redistributed
- routes to be reachable. Enabling this for a period of time in advance
- of shutdown allows the router to gracefully excuse itself from the OSPF
- domain.
+ This support may be enabled administratively (and indefinitely) or
+ conditionally. Conditional enabling of max-metric router-lsas can be for a
+ period of seconds after startup and/or for a period of seconds prior to
+ shutdown.
- Enabling this feature administratively allows for administrative
- intervention for whatever reason, for an indefinite period of time.
- Note that if the configuration is written to file, this administrative
- form of the stub-router command will also be written to file. If
- *ospfd* is restarted later, the command will then take effect
- until manually deconfigured.
+ Enabling this for a period after startup allows OSPF to converge fully first
+ without affecting any existing routes used by other routers, while still
+ allowing any connected stub links and/or redistributed routes to be
+ reachable. Enabling this for a period of time in advance of shutdown allows
+ the router to gracefully excuse itself from the OSPF domain.
- Configured state of this feature as well as current status, such as the
- number of second remaining till on-startup or on-shutdown ends, can be
- viewed with the :ref:`show_ip_ospf` command.
+ Enabling this feature administratively allows for administrative
+ intervention for whatever reason, for an indefinite period of time. Note
+ that if the configuration is written to file, this administrative form of
+ the stub-router command will also be written to file. If *ospfd* is
+ restarted later, the command will then take effect until manually
+ deconfigured.
-.. index:: {OSPF Command} {auto-cost reference-bandwidth (1-4294967)} {}
+ Configured state of this feature as well as current status, such as the
+ number of second remaining till on-startup or on-shutdown ends, can be
+ viewed with the :ref:`show_ip_ospf` command.
-{OSPF Command} {auto-cost reference-bandwidth (1-4294967)} {}
-.. index:: {OSPF Command} {no auto-cost reference-bandwidth} {}
+.. index:: auto-cost reference-bandwidth (1-4294967)
+.. clicmd:: auto-cost reference-bandwidth (1-4294967)
-{OSPF Command} {no auto-cost reference-bandwidth} {}
- .. _OSPF_auto-cost_reference-bandwidth:
+.. index:: no auto-cost reference-bandwidth
+.. 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 Mbits/s. The default is
- 100Mbit/s (i.e. a link of bandwidth 100Mbit/s or higher will have a
- cost of 1. Cost of lower bandwidth links will be scaled with reference
- to this cost).
+.. _OSPF_auto-cost_reference-bandwidth:
- This configuration setting MUST be consistent across all routers within the
- OSPF domain.
+ This sets the reference
+ bandwidth for cost calculations, where this bandwidth is considered
+ equivalent to an OSPF cost of 1, specified in Mbits/s. The default is
+ 100Mbit/s (i.e. a link of bandwidth 100Mbit/s or higher will have a
+ cost of 1. Cost of lower bandwidth links will be scaled with reference
+ to this cost).
-.. index:: {OSPF Command} {network `a.b.c.d/m` area `a.b.c.d`} {}
+ This configuration setting MUST be consistent across all routers within the
+ OSPF domain.
-{OSPF Command} {network `a.b.c.d/m` area `a.b.c.d`} {}
-.. index:: {OSPF Command} {network `a.b.c.d/m` area `(0-4294967295)`} {}
+.. index:: network A.B.C.D/M area A.B.C.D
+.. clicmd:: network A.B.C.D/M area A.B.C.D
-{OSPF Command} {network `a.b.c.d/m` area `(0-4294967295)`} {}
-.. index:: {OSPF Command} {no network `a.b.c.d/m` area `a.b.c.d`} {}
+.. index:: network A.B.C.D/M area (0-4294967295)
+.. clicmd:: network A.B.C.D/M area (0-4294967295)
-{OSPF Command} {no network `a.b.c.d/m` area `a.b.c.d`} {}
-.. index:: {OSPF Command} {no network `a.b.c.d/m` area `(0-4294967295)`} {}
+.. index:: no network A.B.C.D/M area A.B.C.D
+.. clicmd:: no network A.B.C.D/M area A.B.C.D
-{OSPF Command} {no network `a.b.c.d/m` area `(0-4294967295)`} {}
- .. _OSPF_network_command:
+.. index:: no network A.B.C.D/M area (0-4294967295)
+.. 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
- on this interface so router can provide network information to the other
- ospf routers via this interface.
+.. _OSPF_network_command:
+
+ This command specifies the OSPF enabled interface(s). If the interface has
+ an address from range 192.168.1.0/24 then the command below enables ospf
+ on this interface so router can provide network information to the other
+ ospf routers via this interface.
::
- router ospf
- network 192.168.1.0/24 area 0.0.0.0
+ router ospf
+ network 192.168.1.0/24 area 0.0.0.0
- Prefix length in interface must be equal or bigger (ie. smaller network) than
- prefix length in network statement. For example statement above doesn't enable
- ospf on interface with address 192.168.1.1/23, but it does on interface with
- address 192.168.1.129/25.
+ Prefix length in interface must be equal or bigger (ie. smaller network) than
+ prefix length in network statement. For example statement above doesn't enable
+ ospf on interface with address 192.168.1.1/23, but it does on interface with
+ address 192.168.1.129/25.
- Note that the behavior when there is a peer address
- defined on an interface changed after release 0.99.7.
- Currently, if a peer prefix has been configured,
- then we test whether the prefix in the network command contains
- the destination prefix. Otherwise, we test whether the network command prefix
- contains the local address prefix of the interface.
+ Note that the behavior when there is a peer address
+ defined on an interface changed after release 0.99.7.
+ Currently, if a peer prefix has been configured,
+ then we test whether the prefix in the network command contains
+ the destination prefix. Otherwise, we test whether the network command prefix
+ contains the local address prefix of the interface.
- In some cases it may be more convenient to enable OSPF on a per
- interface/subnet basis (:ref:`OSPF_ip_ospf_area_command`).
+ In some cases it may be more convenient to enable OSPF on a per
+ interface/subnet basis (:ref:`OSPF_ip_ospf_area_command`).
.. _OSPF_area:
OSPF area
=========
-.. index:: {OSPF Command} {area `a.b.c.d` range `a.b.c.d/m`} {}
+.. index:: area A.B.C.D range A.B.C.D/M
+.. clicmd:: area A.B.C.D range A.B.C.D/M
-{OSPF Command} {area `a.b.c.d` range `a.b.c.d/m`} {}
-.. index:: {OSPF Command} {area (0-4294967295) range `a.b.c.d/m`} {}
+.. index:: area (0-4294967295) range A.B.C.D/M
+.. clicmd:: area (0-4294967295) range A.B.C.D/M
-{OSPF Command} {area (0-4294967295) range `a.b.c.d/m`} {}
-.. index:: {OSPF Command} {no area `a.b.c.d` range `a.b.c.d/m`} {}
+.. index:: no area A.B.C.D range A.B.C.D/M
+.. clicmd:: no area A.B.C.D range A.B.C.D/M
-{OSPF Command} {no area `a.b.c.d` range `a.b.c.d/m`} {}
-.. index:: {OSPF Command} {no area (0-4294967295) range `a.b.c.d/m`} {}
+.. index:: no area (0-4294967295) range A.B.C.D/M
+.. clicmd:: no area (0-4294967295) range A.B.C.D/M
-{OSPF Command} {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
- router-LSAs (Type-1) and network-LSAs (Type-2) (ie. LSAs with scope area) can
- be summarized. Type-5 AS-external-LSAs can't be summarized - their scope is AS.
- Summarizing Type-7 AS-external-LSAs isn't supported yet by FRR.
+ 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
+ router-LSAs (Type-1) and network-LSAs (Type-2) (ie. LSAs with scope area) can
+ be summarized. Type-5 AS-external-LSAs can't be summarized - their scope is AS.
+ Summarizing Type-7 AS-external-LSAs isn't supported yet by FRR.
::
- router ospf
- network 192.168.1.0/24 area 0.0.0.0
- network 10.0.0.0/8 area 0.0.0.10
- area 0.0.0.10 range 10.0.0.0/8
+ router ospf
+ network 192.168.1.0/24 area 0.0.0.0
+ network 10.0.0.0/8 area 0.0.0.10
+ area 0.0.0.10 range 10.0.0.0/8
- With configuration above one Type-3 Summary-LSA with routing info 10.0.0.0/8 is
- announced into backbone area if area 0.0.0.10 contains at least one intra-area
- network (ie. described with router or network LSA) from this range.
+ With configuration above one Type-3 Summary-LSA with routing info 10.0.0.0/8 is
+ announced into backbone area if area 0.0.0.10 contains at least one intra-area
+ network (ie. described with router or network LSA) from this range.
-.. index:: {OSPF Command} {area `a.b.c.d` range IPV4_PREFIX not-advertise} {}
+.. index:: area A.B.C.D range IPV4_PREFIX not-advertise
+.. clicmd:: area A.B.C.D range IPV4_PREFIX not-advertise
-{OSPF Command} {area `a.b.c.d` range IPV4_PREFIX not-advertise} {}
-.. index:: {OSPF Command} {no area `a.b.c.d` range IPV4_PREFIX not-advertise} {}
+.. index:: no area A.B.C.D range IPV4_PREFIX not-advertise
+.. clicmd:: no area A.B.C.D range IPV4_PREFIX not-advertise
-{OSPF Command} {no area `a.b.c.d` range IPV4_PREFIX not-advertise} {}
- Instead of summarizing intra area paths filter them - ie. intra area paths from this
- range are not advertised into other areas.
- This command makes sense in ABR only.
+ Instead of summarizing intra area paths filter them - ie. intra area paths from this
+ range are not advertised into other areas.
+ This command makes sense in ABR only.
-.. index:: {OSPF Command} {area `a.b.c.d` range IPV4_PREFIX substitute IPV4_PREFIX} {}
+.. index:: area A.B.C.D range IPV4_PREFIX substitute IPV4_PREFIX
+.. clicmd:: area A.B.C.D range IPV4_PREFIX substitute IPV4_PREFIX
-{OSPF Command} {area `a.b.c.d` range IPV4_PREFIX substitute IPV4_PREFIX} {}
-.. index:: {OSPF Command} {no area `a.b.c.d` range IPV4_PREFIX substitute IPV4_PREFIX} {}
+.. index:: no area A.B.C.D range IPV4_PREFIX substitute IPV4_PREFIX
+.. clicmd:: no area A.B.C.D range IPV4_PREFIX substitute IPV4_PREFIX
-{OSPF Command} {no area `a.b.c.d` range IPV4_PREFIX substitute IPV4_PREFIX} {}
- Substitute summarized prefix with another prefix.
+ Substitute summarized prefix with another prefix.
::
- router ospf
- network 192.168.1.0/24 area 0.0.0.0
- network 10.0.0.0/8 area 0.0.0.10
- area 0.0.0.10 range 10.0.0.0/8 substitute 11.0.0.0/8
+ router ospf
+ network 192.168.1.0/24 area 0.0.0.0
+ network 10.0.0.0/8 area 0.0.0.10
+ area 0.0.0.10 range 10.0.0.0/8 substitute 11.0.0.0/8
- One Type-3 summary-LSA with routing info 11.0.0.0/8 is announced into backbone area if
- area 0.0.0.10 contains at least one intra-area network (ie. described with router-LSA or
- network-LSA) from range 10.0.0.0/8.
- This command makes sense in ABR only.
+ One Type-3 summary-LSA with routing info 11.0.0.0/8 is announced into backbone area if
+ area 0.0.0.10 contains at least one intra-area network (ie. described with router-LSA or
+ network-LSA) from range 10.0.0.0/8.
+ This command makes sense in ABR only.
-.. index:: {OSPF Command} {area `a.b.c.d` virtual-link `a.b.c.d`} {}
+.. index:: area A.B.C.D virtual-link A.B.C.D
+.. clicmd:: area A.B.C.D virtual-link A.B.C.D
-{OSPF Command} {area `a.b.c.d` virtual-link `a.b.c.d`} {}
-.. index:: {OSPF Command} {area (0-4294967295) virtual-link `a.b.c.d`} {}
+.. index:: area (0-4294967295) virtual-link A.B.C.D
+.. clicmd:: area (0-4294967295) virtual-link A.B.C.D
-{OSPF Command} {area (0-4294967295) virtual-link `a.b.c.d`} {}
-.. index:: {OSPF Command} {no area `a.b.c.d` virtual-link `a.b.c.d`} {}
+.. index:: no area A.B.C.D virtual-link A.B.C.D
+.. clicmd:: no area A.B.C.D virtual-link A.B.C.D
-{OSPF Command} {no area `a.b.c.d` virtual-link `a.b.c.d`} {}
-.. index:: {OSPF Command} {no area (0-4294967295) virtual-link `a.b.c.d`} {}
+.. index:: no area (0-4294967295) virtual-link A.B.C.D
+.. clicmd:: no area (0-4294967295) virtual-link A.B.C.D
-{OSPF Command} {no area (0-4294967295) virtual-link `a.b.c.d`} {}
- .. _OSPF_virtual-link:
+.. _OSPF_virtual-link:
-.. index:: {OSPF Command} {area `a.b.c.d` shortcut} {}
+.. index:: area A.B.C.D shortcut
+.. clicmd:: area A.B.C.D shortcut
-{OSPF Command} {area `a.b.c.d` shortcut} {}
-.. index:: {OSPF Command} {area (0-4294967295) shortcut} {}
+.. index:: area (0-4294967295) shortcut
+.. clicmd:: area (0-4294967295) shortcut
-{OSPF Command} {area (0-4294967295) shortcut} {}
-.. index:: {OSPF Command} {no area `a.b.c.d` shortcut} {}
+.. index:: no area A.B.C.D shortcut
+.. clicmd:: no area A.B.C.D shortcut
-{OSPF Command} {no area `a.b.c.d` shortcut} {}
-.. index:: {OSPF Command} {no area (0-4294967295) shortcut} {}
+.. index:: no area (0-4294967295) shortcut
+.. clicmd:: no area (0-4294967295) shortcut
-{OSPF Command} {no area (0-4294967295) shortcut} {}
- Configure the area as Shortcut capable. See :rfc:`3509`. This requires
- that the 'abr-type' be set to 'shortcut'.
+ Configure the area as Shortcut capable. See :rfc:`3509`. This requires
+ that the 'abr-type' be set to 'shortcut'.
-.. index:: {OSPF Command} {area `a.b.c.d` stub} {}
+.. index:: area A.B.C.D stub
+.. clicmd:: area A.B.C.D stub
-{OSPF Command} {area `a.b.c.d` stub} {}
-.. index:: {OSPF Command} {area (0-4294967295) stub} {}
+.. index:: area (0-4294967295) stub
+.. clicmd:: area (0-4294967295) stub
-{OSPF Command} {area (0-4294967295) stub} {}
-.. index:: {OSPF Command} {no area `a.b.c.d` stub} {}
+.. index:: no area A.B.C.D stub
+.. clicmd:: no area A.B.C.D stub
-{OSPF Command} {no area `a.b.c.d` stub} {}
-.. index:: {OSPF Command} {no area (0-4294967295) stub} {}
+.. index:: no area (0-4294967295) stub
+.. clicmd:: no area (0-4294967295) stub
-{OSPF Command} {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
- routes are via the ABR(s). Hence, ABRs for such an area do not need
- to pass AS-External LSAs (type-5s) or ASBR-Summary LSAs (type-4) into the
- area. They need only pass Network-Summary (type-3) LSAs into such an area,
- along with a default-route summary.
+ 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
+ routes are via the ABR(s). Hence, ABRs for such an area do not need
+ to pass AS-External LSAs (type-5s) or ASBR-Summary LSAs (type-4) into the
+ area. They need only pass Network-Summary (type-3) LSAs into such an area,
+ along with a default-route summary.
-.. index:: {OSPF Command} {area `a.b.c.d` stub no-summary} {}
+.. index:: area A.B.C.D stub no-summary
+.. clicmd:: area A.B.C.D stub no-summary
-{OSPF Command} {area `a.b.c.d` stub no-summary} {}
-.. index:: {OSPF Command} {area (0-4294967295) stub no-summary} {}
+.. index:: area (0-4294967295) stub no-summary
+.. clicmd:: area (0-4294967295) stub no-summary
-{OSPF Command} {area (0-4294967295) stub no-summary} {}
-.. index:: {OSPF Command} {no area `a.b.c.d` stub no-summary} {}
+.. index:: no area A.B.C.D stub no-summary
+.. clicmd:: no area A.B.C.D stub no-summary
-{OSPF Command} {no area `a.b.c.d` stub no-summary} {}
-.. index:: {OSPF Command} {no area (0-4294967295) stub no-summary} {}
+.. index:: no area (0-4294967295) stub no-summary
+.. clicmd:: no area (0-4294967295) stub no-summary
-{OSPF Command} {no area (0-4294967295) stub no-summary} {}
- Prevents an *ospfd* ABR from injecting inter-area
- summaries into the specified stub area.
+ Prevents an *ospfd* ABR from injecting inter-area
+ summaries into the specified stub area.
-.. index:: {OSPF Command} {area `a.b.c.d` default-cost (0-16777215)} {}
+.. index:: area A.B.C.D default-cost (0-16777215)
+.. clicmd:: area A.B.C.D default-cost (0-16777215)
-{OSPF Command} {area `a.b.c.d` default-cost (0-16777215)} {}
-.. index:: {OSPF Command} {no area `a.b.c.d` default-cost (0-16777215)} {}
+.. index:: no area A.B.C.D default-cost (0-16777215)
+.. clicmd:: no area A.B.C.D default-cost (0-16777215)
-{OSPF Command} {no area `a.b.c.d` default-cost (0-16777215)} {}
- Set the cost of default-summary LSAs announced to stubby areas.
+ Set the cost of default-summary LSAs announced to stubby areas.
-.. index:: {OSPF Command} {area `a.b.c.d` export-list NAME} {}
+.. index:: area A.B.C.D export-list NAME
+.. clicmd:: area A.B.C.D export-list NAME
-{OSPF Command} {area `a.b.c.d` export-list NAME} {}
-.. index:: {OSPF Command} {area (0-4294967295) export-list NAME} {}
+.. index:: area (0-4294967295) export-list NAME
+.. clicmd:: area (0-4294967295) export-list NAME
-{OSPF Command} {area (0-4294967295) export-list NAME} {}
-.. index:: {OSPF Command} {no area `a.b.c.d` export-list NAME} {}
+.. index:: no area A.B.C.D export-list NAME
+.. clicmd:: no area A.B.C.D export-list NAME
-{OSPF Command} {no area `a.b.c.d` export-list NAME} {}
-.. index:: {OSPF Command} {no area (0-4294967295) export-list NAME} {}
+.. index:: no area (0-4294967295) export-list NAME
+.. clicmd:: no area (0-4294967295) export-list NAME
-{OSPF Command} {no area (0-4294967295) export-list NAME} {}
- Filter Type-3 summary-LSAs announced to other areas originated from intra-
- area paths from specified area.
+ Filter Type-3 summary-LSAs announced to other areas originated from intra-
+ area paths from specified area.
::
- router ospf
- network 192.168.1.0/24 area 0.0.0.0
- network 10.0.0.0/8 area 0.0.0.10
- area 0.0.0.10 export-list foo
- !
- access-list foo permit 10.10.0.0/16
- access-list foo deny any
+ router ospf
+ network 192.168.1.0/24 area 0.0.0.0
+ network 10.0.0.0/8 area 0.0.0.10
+ area 0.0.0.10 export-list foo
+ !
+ access-list foo permit 10.10.0.0/16
+ access-list foo deny any
- With example above any intra-area paths from area 0.0.0.10 and from range
- 10.10.0.0/16 (for example 10.10.1.0/24 and 10.10.2.128/30) are announced into
- other areas as Type-3 summary-LSA's, but any others (for example 10.11.0.0/16
- or 10.128.30.16/30) aren't.
+ With example above any intra-area paths from area 0.0.0.10 and from range
+ 10.10.0.0/16 (for example 10.10.1.0/24 and 10.10.2.128/30) are announced into
+ other areas as Type-3 summary-LSA's, but any others (for example 10.11.0.0/16
+ or 10.128.30.16/30) aren't.
- This command is only relevant if the router is an ABR for the specified
- area.
+ This command is only relevant if the router is an ABR for the specified
+ area.
-.. index:: {OSPF Command} {area `a.b.c.d` import-list NAME} {}
+.. index:: area A.B.C.D import-list NAME
+.. clicmd:: area A.B.C.D import-list NAME
-{OSPF Command} {area `a.b.c.d` import-list NAME} {}
-.. index:: {OSPF Command} {area (0-4294967295) import-list NAME} {}
+.. index:: area (0-4294967295) import-list NAME
+.. clicmd:: area (0-4294967295) import-list NAME
-{OSPF Command} {area (0-4294967295) import-list NAME} {}
-.. index:: {OSPF Command} {no area `a.b.c.d` import-list NAME} {}
+.. index:: no area A.B.C.D import-list NAME
+.. clicmd:: no area A.B.C.D import-list NAME
-{OSPF Command} {no area `a.b.c.d` import-list NAME} {}
-.. index:: {OSPF Command} {no area (0-4294967295) import-list NAME} {}
+.. index:: no area (0-4294967295) import-list NAME
+.. clicmd:: no area (0-4294967295) import-list NAME
-{OSPF Command} {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.
+ Same as export-list, but it applies to paths announced into specified area as
+ Type-3 summary-LSAs.
-.. index:: {OSPF Command} {area `a.b.c.d` filter-list prefix NAME in} {}
+.. index:: area A.B.C.D filter-list prefix NAME in
+.. clicmd:: area A.B.C.D filter-list prefix NAME in
-{OSPF Command} {area `a.b.c.d` filter-list prefix NAME in} {}
-.. index:: {OSPF Command} {area `a.b.c.d` filter-list prefix NAME out} {}
+.. index:: area A.B.C.D filter-list prefix NAME out
+.. clicmd:: area A.B.C.D filter-list prefix NAME out
-{OSPF Command} {area `a.b.c.d` filter-list prefix NAME out} {}
-.. index:: {OSPF Command} {area (0-4294967295) filter-list prefix NAME in} {}
+.. index:: area (0-4294967295) filter-list prefix NAME in
+.. clicmd:: area (0-4294967295) filter-list prefix NAME in
-{OSPF Command} {area (0-4294967295) filter-list prefix NAME in} {}
-.. index:: {OSPF Command} {area (0-4294967295) filter-list prefix NAME out} {}
+.. index:: area (0-4294967295) filter-list prefix NAME out
+.. clicmd:: area (0-4294967295) filter-list prefix NAME out
-{OSPF Command} {area (0-4294967295) filter-list prefix NAME out} {}
-.. index:: {OSPF Command} {no area `a.b.c.d` filter-list prefix NAME in} {}
+.. index:: no area A.B.C.D filter-list prefix NAME in
+.. clicmd:: no area A.B.C.D filter-list prefix NAME in
-{OSPF Command} {no area `a.b.c.d` filter-list prefix NAME in} {}
-.. index:: {OSPF Command} {no area `a.b.c.d` filter-list prefix NAME out} {}
+.. index:: no area A.B.C.D filter-list prefix NAME out
+.. clicmd:: no area A.B.C.D filter-list prefix NAME out
-{OSPF Command} {no area `a.b.c.d` filter-list prefix NAME out} {}
-.. index:: {OSPF Command} {no area (0-4294967295) filter-list prefix NAME in} {}
+.. index:: no area (0-4294967295) filter-list prefix NAME in
+.. clicmd:: no area (0-4294967295) filter-list prefix NAME in
-{OSPF Command} {no area (0-4294967295) filter-list prefix NAME in} {}
-.. index:: {OSPF Command} {no area (0-4294967295) filter-list prefix NAME out} {}
+.. index:: no area (0-4294967295) filter-list prefix NAME out
+.. clicmd:: no area (0-4294967295) filter-list prefix NAME out
-{OSPF Command} {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.
+ Filtering Type-3 summary-LSAs to/from area using prefix lists. This command
+ makes sense in ABR only.
-.. index:: {OSPF Command} {area `a.b.c.d` authentication} {}
+.. index:: area A.B.C.D authentication
+.. clicmd:: area A.B.C.D authentication
-{OSPF Command} {area `a.b.c.d` authentication} {}
-.. index:: {OSPF Command} {area (0-4294967295) authentication} {}
+.. index:: area (0-4294967295) authentication
+.. clicmd:: area (0-4294967295) authentication
-{OSPF Command} {area (0-4294967295) authentication} {}
-.. index:: {OSPF Command} {no area `a.b.c.d` authentication} {}
+.. index:: no area A.B.C.D authentication
+.. clicmd:: no area A.B.C.D authentication
-{OSPF Command} {no area `a.b.c.d` authentication} {}
-.. index:: {OSPF Command} {no area (0-4294967295) authentication} {}
+.. index:: no area (0-4294967295) authentication
+.. clicmd:: no area (0-4294967295) authentication
-{OSPF Command} {no area (0-4294967295) authentication} {}
- Specify that simple password authentication should be used for the given
- area.
+ Specify that simple password authentication should be used for the given
+ area.
-.. index:: {OSPF Command} {area `a.b.c.d` authentication message-digest} {}
+.. index:: area A.B.C.D authentication message-digest
+.. clicmd:: area A.B.C.D authentication message-digest
-{OSPF Command} {area `a.b.c.d` authentication message-digest} {}
-.. index:: {OSPF Command} {area (0-4294967295) authentication message-digest} {}
+.. index:: area (0-4294967295) authentication message-digest
+.. clicmd:: area (0-4294967295) authentication message-digest
-{OSPF Command} {area (0-4294967295) authentication message-digest} {}
- .. _area_authentication_message-digest:
+.. _area_authentication_message-digest:
- Specify that OSPF packets
- must be authenticated with MD5 HMACs within the given area. Keying
- material must also be configured on a per-interface basis (:ref:`ip_ospf_message-digest-key`).
+ Specify that OSPF packets
+ must be authenticated with MD5 HMACs within the given area. Keying
+ material must also be configured on a per-interface basis (:ref:`ip_ospf_message-digest-key`).
- MD5 authentication may also be configured on a per-interface basis
- (:ref:`ip_ospf_authentication_message-digest`). Such per-interface
- settings will override any per-area authentication setting.
+ MD5 authentication may also be configured on a per-interface basis
+ (:ref:`ip_ospf_authentication_message-digest`). Such per-interface
+ settings will override any per-area authentication setting.
.. _OSPF_interface:
OSPF interface
==============
-.. index:: {Interface Command} {ip ospf area `AREA` [`ADDR`]} {}
+.. index:: ip ospf area AREA [ADDR]
+.. clicmd:: ip ospf area AREA [ADDR]
-{Interface Command} {ip ospf area `AREA` [`ADDR`]} {}
-.. index:: {Interface Command} {no ip ospf area [`ADDR`]} {}
+.. index:: no ip ospf area [ADDR]
+.. clicmd:: no ip ospf area [ADDR]
-{Interface Command} {no ip ospf area [`ADDR`]} {}
- .. _OSPF_ip_ospf_area_command:
+.. _OSPF_ip_ospf_area_command:
- Enable OSPF on the interface, optionally restricted to just the IP address
- given by `ADDR`, putting it in the `AREA` area. Per interface area
- settings take precedence to network commands (:ref:`OSPF_network_command`).
+ Enable OSPF on the interface, optionally restricted to just the IP address
+ given by `ADDR`, putting it in the `AREA` area. Per interface area
+ settings take precedence to network commands (:ref:`OSPF_network_command`).
- If you have a lot of interfaces, and/or a lot of subnets, then enabling OSPF
- via this command may result in a slight performance improvement.
+ If you have a lot of interfaces, and/or a lot of subnets, then enabling OSPF
+ via this command may result in a slight performance improvement.
-.. index:: {Interface Command} {ip ospf authentication-key `AUTH_KEY`} {}
+.. index:: ip ospf authentication-key AUTH_KEY
+.. clicmd:: ip ospf authentication-key AUTH_KEY
-{Interface Command} {ip ospf authentication-key `AUTH_KEY`} {}
-.. index:: {Interface Command} {no ip ospf authentication-key} {}
+.. index:: no ip ospf authentication-key
+.. clicmd:: no ip ospf authentication-key
-{Interface Command} {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.
+ 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.
- Simple text password authentication is insecure and deprecated in favour of
- MD5 HMAC authentication (:ref:`ip_ospf_authentication_message-digest`).
+ Simple text password authentication is insecure and deprecated in favour of
+ MD5 HMAC authentication (:ref:`ip_ospf_authentication_message-digest`).
-.. index:: {Interface Command} {ip ospf authentication message-digest} {}
+.. index:: ip ospf authentication message-digest
+.. clicmd:: ip ospf authentication message-digest
-{Interface Command} {ip ospf authentication message-digest} {}
- .. _ip_ospf_authentication_message-digest:
+.. _ip_ospf_authentication_message-digest:
- Specify that MD5 HMAC
- authentication must be used on this interface. MD5 keying material must
- also be configured (:ref:`ip_ospf_message-digest-key`). Overrides any
- authentication enabled on a per-area basis (:ref:`area_authentication_message-digest`).
+ Specify that MD5 HMAC
+ authentication must be used on this interface. MD5 keying material must
+ also be configured (:ref:`ip_ospf_message-digest-key`). Overrides any
+ authentication enabled on a per-area basis (:ref:`area_authentication_message-digest`).
- Note that OSPF MD5 authentication requires that time never go backwards
- (correct time is NOT important, only that it never goes backwards), even
- across resets, if ospfd is to be able to promptly reestabish adjacencies
- with its neighbours after restarts/reboots. The host should have system
- time be set at boot from an external or non-volatile source (eg battery backed clock, NTP,
- etc.) or else the system clock should be periodically saved to non-volative
- storage and restored at boot if MD5 authentication is to be expected to work
- reliably.
+ Note that OSPF MD5 authentication requires that time never go backwards
+ (correct time is NOT important, only that it never goes backwards), even
+ across resets, if ospfd is to be able to promptly reestabish adjacencies
+ with its neighbours after restarts/reboots. The host should have system
+ time be set at boot from an external or non-volatile source (eg battery backed clock, NTP,
+ etc.) or else the system clock should be periodically saved to non-volative
+ storage and restored at boot if MD5 authentication is to be expected to work
+ reliably.
-.. index:: {Interface Command} {ip ospf message-digest-key KEYID md5 KEY} {}
+.. index:: ip ospf message-digest-key KEYID md5 KEY
+.. clicmd:: ip ospf message-digest-key KEYID md5 KEY
-{Interface Command} {ip ospf message-digest-key KEYID md5 KEY} {}
-.. index:: {Interface Command} {no ip ospf message-digest-key} {}
+.. index:: no ip ospf message-digest-key
+.. clicmd:: no ip ospf message-digest-key
-{Interface Command} {no ip ospf message-digest-key} {}
- .. _ip_ospf_message-digest-key:
+.. _ip_ospf_message-digest-key:
- Set OSPF authentication key to a
- cryptographic password. The cryptographic algorithm is MD5.
+ Set OSPF authentication key to a
+ cryptographic password. The cryptographic algorithm is MD5.
- KEYID identifies secret key used to create the message digest. This ID
- is part of the protocol and must be consistent across routers on a
- link.
+ KEYID identifies secret key used to create the message digest. This ID
+ is part of the protocol and must be consistent across routers on a
+ link.
- KEY is the actual message digest key, of up to 16 chars (larger strings
- will be truncated), and is associated with the given KEYID.
+ KEY is the actual message digest key, of up to 16 chars (larger strings
+ will be truncated), and is associated with the given KEYID.
-.. index:: {Interface Command} {ip ospf cost (1-65535)} {}
+.. index:: ip ospf cost (1-65535)
+.. clicmd:: ip ospf cost (1-65535)
-{Interface Command} {ip ospf cost (1-65535)} {}
-.. index:: {Interface Command} {no ip ospf cost} {}
+.. index:: no ip ospf cost
+.. clicmd:: no ip ospf cost
-{Interface Command} {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.
+ Set link cost for the specified interface. The cost value is set to router-LSA's
+ metric field and used for SPF calculation.
-.. index:: {Interface Command} {ip ospf dead-interval (1-65535)} {}
+.. index:: ip ospf dead-interval (1-65535)
+.. clicmd:: ip ospf dead-interval (1-65535)
-{Interface Command} {ip ospf dead-interval (1-65535)} {}
-.. index:: {Interface Command} {ip ospf dead-interval minimal hello-multiplier (2-20)} {}
+.. index:: ip ospf dead-interval minimal hello-multiplier (2-20)
+.. clicmd:: ip ospf dead-interval minimal hello-multiplier (2-20)
-{Interface Command} {ip ospf dead-interval minimal hello-multiplier (2-20)} {}
-.. index:: {Interface Command} {no ip ospf dead-interval} {}
+.. index:: no ip ospf dead-interval
+.. clicmd:: no ip ospf dead-interval
-{Interface Command} {no ip ospf dead-interval} {}
- .. _ip_ospf_dead-interval_minimal:
+.. _ip_ospf_dead-interval_minimal:
- Set number of seconds for
- RouterDeadInterval timer value used for Wait Timer and Inactivity
- Timer. This value must be the same for all routers attached to a
- common network. The default value is 40 seconds.
+ 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 to a
+ common network. The default value is 40 seconds.
- If 'minimal' is specified instead, then the dead-interval is set to 1
- second and one must specify a hello-multiplier. The hello-multiplier
- specifies how many Hellos to send per second, from 2 (every 500ms) to
- 20 (every 50ms). Thus one can have 1s convergence time for OSPF. If this form
- is specified, then the hello-interval advertised in Hello packets is set to
- 0 and the hello-interval on received Hello packets is not checked, thus
- the hello-multiplier need NOT be the same across multiple routers on a common
- link.
+ If 'minimal' is specified instead, then the dead-interval is set to 1
+ second and one must specify a hello-multiplier. The hello-multiplier
+ specifies how many Hellos to send per second, from 2 (every 500ms) to
+ 20 (every 50ms). Thus one can have 1s convergence time for OSPF. If this form
+ is specified, then the hello-interval advertised in Hello packets is set to
+ 0 and the hello-interval on received Hello packets is not checked, thus
+ the hello-multiplier need NOT be the same across multiple routers on a common
+ link.
-.. index:: {Interface Command} {ip ospf hello-interval (1-65535)} {}
+.. index:: ip ospf hello-interval (1-65535)
+.. clicmd:: ip ospf hello-interval (1-65535)
-{Interface Command} {ip ospf hello-interval (1-65535)} {}
-.. index:: {Interface Command} {no ip ospf hello-interval} {}
+.. index:: no ip ospf hello-interval
+.. clicmd:: no ip ospf hello-interval
-{Interface Command} {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.
- This value must be the same for all routers attached to a common network.
- The default value is 10 seconds.
+ Set number of seconds for HelloInterval timer value. Setting this value,
+ Hello packet will be sent every timer value seconds on the specified interface.
+ This value must be the same for all routers attached to a common network.
+ The default value is 10 seconds.
- This command has no effect if :ref:`ip_ospf_dead-interval_minimal` is also
- specified for the interface.
+ This command has no effect if :ref:`ip_ospf_dead-interval_minimal` is also
+ specified for the interface.
-.. index:: {Interface Command} {ip ospf network (broadcast|non-broadcast|point-to-multipoint|point-to-point)} {}
+.. index:: ip ospf network (broadcast|non-broadcast|point-to-multipoint|point-to-point)
+.. clicmd:: ip ospf network (broadcast|non-broadcast|point-to-multipoint|point-to-point)
-{Interface Command} {ip ospf network (broadcast|non-broadcast|point-to-multipoint|point-to-point)} {}
-.. index:: {Interface Command} {no ip ospf network} {}
+.. index:: no ip ospf network
+.. clicmd:: no ip ospf network
-{Interface Command} {no ip ospf network} {}
- Set explicitly network type for specifed interface.
+ Set explicitly network type for specifed interface.
-.. index:: {Interface Command} {ip ospf priority (0-255)} {}
+.. index:: ip ospf priority (0-255)
+.. clicmd:: ip ospf priority (0-255)
-{Interface Command} {ip ospf priority (0-255)} {}
-.. index:: {Interface Command} {no ip ospf priority} {}
+.. index:: no ip ospf priority
+.. clicmd:: no ip ospf priority
-{Interface Command} {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 the router ineligible to become Designated Router. The
- default value is 1.
+ Set RouterPriority integer value. The router with the highest priority
+ will be more eligible to become Designated Router. Setting the value
+ to 0, makes the router ineligible to become Designated Router. The
+ default value is 1.
-.. index:: {Interface Command} {ip ospf retransmit-interval (1-65535)} {}
+.. index:: ip ospf retransmit-interval (1-65535)
+.. clicmd:: ip ospf retransmit-interval (1-65535)
-{Interface Command} {ip ospf retransmit-interval (1-65535)} {}
-.. index:: {Interface Command} {no ip ospf retransmit interval} {}
+.. index:: no ip ospf retransmit interval
+.. clicmd:: no ip ospf retransmit interval
-{Interface Command} {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 default value is 5 seconds.
+ Set number of seconds for RxmtInterval timer value. This value is used
+ when retransmitting Database Description and Link State Request packets.
+ The default value is 5 seconds.
-.. index:: {Interface Command} {ip ospf transmit-delay} {}
+.. index:: ip ospf transmit-delay
+.. clicmd:: ip ospf transmit-delay
-{Interface Command} {ip ospf transmit-delay} {}
-.. index:: {Interface Command} {no ip ospf transmit-delay} {}
+.. index:: no ip ospf transmit-delay
+.. clicmd:: no ip ospf transmit-delay
-{Interface Command} {no ip ospf transmit-delay} {}
- Set number of seconds for InfTransDelay value. LSAs' age should be
- incremented by this value when transmitting.
- The default value is 1 seconds.
+ Set number of seconds for InfTransDelay value. LSAs' age should be
+ incremented by this value when transmitting.
+ The default value is 1 seconds.
-.. index:: {Interface Command} {ip ospf area (A.B.C.D|(0-4294967295))} {}
+.. index:: ip ospf area (A.B.C.D|(0-4294967295))
+.. clicmd:: ip ospf area (A.B.C.D|(0-4294967295))
-{Interface Command} {ip ospf area (A.B.C.D|(0-4294967295))} {}
-.. index:: {Interface Command} {no ip ospf area} {}
+.. index:: no ip ospf area
+.. clicmd:: no ip ospf area
-{Interface Command} {no ip ospf area} {}
- Enable ospf on an interface and set associated area.
+ Enable ospf on an interface and set associated area.
.. _Redistribute_routes_to_OSPF:
Redistribute routes to OSPF
===========================
-.. index:: {OSPF Command} {redistribute (kernel|connected|static|rip|bgp)} {}
+.. index:: redistribute (kernel|connected|static|rip|bgp)
+.. clicmd:: redistribute (kernel|connected|static|rip|bgp)
-{OSPF Command} {redistribute (kernel|connected|static|rip|bgp)} {}
-.. index:: {OSPF Command} {redistribute (kernel|connected|static|rip|bgp) `route-map`} {}
+.. index:: redistribute (kernel|connected|static|rip|bgp) ROUTE-MAP
+.. clicmd:: redistribute (kernel|connected|static|rip|bgp) ROUTE-MAP
-{OSPF Command} {redistribute (kernel|connected|static|rip|bgp) `route-map`} {}
-.. index:: {OSPF Command} {redistribute (kernel|connected|static|rip|bgp) metric-type (1|2)} {}
+.. index:: redistribute (kernel|connected|static|rip|bgp) metric-type (1|2)
+.. clicmd:: redistribute (kernel|connected|static|rip|bgp) metric-type (1|2)
-{OSPF Command} {redistribute (kernel|connected|static|rip|bgp) metric-type (1|2)} {}
-.. index:: {OSPF Command} {redistribute (kernel|connected|static|rip|bgp) metric-type (1|2) route-map `word`} {}
+.. index:: redistribute (kernel|connected|static|rip|bgp) metric-type (1|2) route-map WORD
+.. clicmd:: redistribute (kernel|connected|static|rip|bgp) metric-type (1|2) route-map WORD
-{OSPF Command} {redistribute (kernel|connected|static|rip|bgp) metric-type (1|2) route-map `word`} {}
-.. index:: {OSPF Command} {redistribute (kernel|connected|static|rip|bgp) metric (0-16777214)} {}
+.. index:: redistribute (kernel|connected|static|rip|bgp) metric (0-16777214)
+.. clicmd:: redistribute (kernel|connected|static|rip|bgp) metric (0-16777214)
-{OSPF Command} {redistribute (kernel|connected|static|rip|bgp) metric (0-16777214)} {}
-.. index:: {OSPF Command} {redistribute (kernel|connected|static|rip|bgp) metric (0-16777214) route-map `word`} {}
+.. index:: redistribute (kernel|connected|static|rip|bgp) metric (0-16777214) route-map WORD
+.. clicmd:: redistribute (kernel|connected|static|rip|bgp) metric (0-16777214) route-map WORD
-{OSPF Command} {redistribute (kernel|connected|static|rip|bgp) metric (0-16777214) route-map `word`} {}
-.. index:: {OSPF Command} {redistribute (kernel|connected|static|rip|bgp) metric-type (1|2) metric (0-16777214)} {}
+.. index:: redistribute (kernel|connected|static|rip|bgp) metric-type (1|2) metric (0-16777214)
+.. clicmd:: redistribute (kernel|connected|static|rip|bgp) metric-type (1|2) metric (0-16777214)
-{OSPF Command} {redistribute (kernel|connected|static|rip|bgp) metric-type (1|2) metric (0-16777214)} {}
-.. index:: {OSPF Command} {redistribute (kernel|connected|static|rip|bgp) metric-type (1|2) metric (0-16777214) route-map `word`} {}
+.. index:: redistribute (kernel|connected|static|rip|bgp) metric-type (1|2) metric (0-16777214) route-map WORD
+.. clicmd:: redistribute (kernel|connected|static|rip|bgp) metric-type (1|2) metric (0-16777214) route-map WORD
-{OSPF Command} {redistribute (kernel|connected|static|rip|bgp) metric-type (1|2) metric (0-16777214) route-map `word`} {}
-.. index:: {OSPF Command} {no redistribute (kernel|connected|static|rip|bgp)} {}
+.. index:: no redistribute (kernel|connected|static|rip|bgp)
+.. clicmd:: no redistribute (kernel|connected|static|rip|bgp)
-{OSPF Command} {no redistribute (kernel|connected|static|rip|bgp)} {}
- .. _OSPF_redistribute:
+.. _OSPF_redistribute:
- Redistribute routes of the specified protocol
- or kind into OSPF, with the metric type and metric set if specified,
- filtering the routes using the given route-map if specified.
- Redistributed routes may also be filtered with distribute-lists, see
- :ref:`ospf_distribute-list`.
+ Redistribute routes of the specified protocol
+ or kind into OSPF, with the metric type and metric set if specified,
+ filtering the routes using the given route-map if specified.
+ Redistributed routes may also be filtered with distribute-lists, see
+ :ref:`ospf_distribute-list`.
- Redistributed routes are distributed as into OSPF as Type-5 External
- LSAs into links to areas that accept external routes, Type-7 External LSAs
- for NSSA areas and are not redistributed at all into Stub areas, where
- external routes are not permitted.
+ Redistributed routes are distributed as into OSPF as Type-5 External
+ LSAs into links to areas that accept external routes, Type-7 External LSAs
+ for NSSA areas and are not redistributed at all into Stub areas, where
+ external routes are not permitted.
- Note that for connected routes, one may instead use
- :term:`passive-interface`, see :ref:`OSPF_passive-interface`.
+ Note that for connected routes, one may instead use
+ :term:`passive-interface`, see :ref:`OSPF_passive-interface`.
-.. index:: {OSPF Command} {default-information originate} {}
+.. index:: default-information originate
+.. clicmd:: default-information originate
-{OSPF Command} {default-information originate} {}
-.. index:: {OSPF Command} {default-information originate metric (0-16777214)} {}
+.. index:: default-information originate metric (0-16777214)
+.. clicmd:: default-information originate metric (0-16777214)
-{OSPF Command} {default-information originate metric (0-16777214)} {}
-.. index:: {OSPF Command} {default-information originate metric (0-16777214) metric-type (1|2)} {}
+.. index:: default-information originate metric (0-16777214) metric-type (1|2)
+.. clicmd:: default-information originate metric (0-16777214) metric-type (1|2)
-{OSPF Command} {default-information originate metric (0-16777214) metric-type (1|2)} {}
-.. index:: {OSPF Command} {default-information originate metric (0-16777214) metric-type (1|2) route-map `word`} {}
+.. index:: default-information originate metric (0-16777214) metric-type (1|2) route-map WORD
+.. clicmd:: default-information originate metric (0-16777214) metric-type (1|2) route-map WORD
-{OSPF Command} {default-information originate metric (0-16777214) metric-type (1|2) route-map `word`} {}
-.. index:: {OSPF Command} {default-information originate always} {}
+.. index:: default-information originate always
+.. clicmd:: default-information originate always
-{OSPF Command} {default-information originate always} {}
-.. index:: {OSPF Command} {default-information originate always metric (0-16777214)} {}
+.. index:: default-information originate always metric (0-16777214)
+.. clicmd:: default-information originate always metric (0-16777214)
-{OSPF Command} {default-information originate always metric (0-16777214)} {}
-.. index:: {OSPF Command} {default-information originate always metric (0-16777214) metric-type (1|2)} {}
+.. index:: default-information originate always metric (0-16777214) metric-type (1|2)
+.. clicmd:: default-information originate always metric (0-16777214) metric-type (1|2)
-{OSPF Command} {default-information originate always metric (0-16777214) metric-type (1|2)} {}
-.. index:: {OSPF Command} {default-information originate always metric (0-16777214) metric-type (1|2) route-map `word`} {}
+.. index:: default-information originate always metric (0-16777214) metric-type (1|2) route-map WORD
+.. clicmd:: default-information originate always metric (0-16777214) metric-type (1|2) route-map WORD
-{OSPF Command} {default-information originate always metric (0-16777214) metric-type (1|2) route-map `word`} {}
-.. index:: {OSPF Command} {no default-information originate} {}
+.. index:: no default-information originate
+.. clicmd:: no default-information originate
-{OSPF Command} {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 the 'always' keyword is given then the default is always
- advertised, even when there is no default present in the routing table.
+ 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 the 'always' keyword is given then the default is always
+ advertised, even when there is no default present in the routing table.
-.. index:: {OSPF Command} {distribute-list NAME out (kernel|connected|static|rip|ospf} {}
+.. index:: distribute-list NAME out (kernel|connected|static|rip|ospf
+.. clicmd:: distribute-list NAME out (kernel|connected|static|rip|ospf
-{OSPF Command} {distribute-list NAME out (kernel|connected|static|rip|ospf} {}
-.. index:: {OSPF Command} {no distribute-list NAME out (kernel|connected|static|rip|ospf} {}
+.. index:: no distribute-list NAME out (kernel|connected|static|rip|ospf
+.. clicmd:: no distribute-list NAME out (kernel|connected|static|rip|ospf
-{OSPF Command} {no distribute-list NAME out (kernel|connected|static|rip|ospf} {}
- .. _ospf_distribute-list:
+.. _ospf_distribute-list:
- Apply the access-list filter, NAME, to
- redistributed routes of the given type before allowing the routes to
- redistributed into OSPF (:ref:`OSPF_redistribute`).
+ Apply the access-list filter, NAME, to
+ redistributed routes of the given type before allowing the routes to
+ redistributed into OSPF (:ref:`OSPF_redistribute`).
-.. index:: {OSPF Command} {default-metric (0-16777214)} {}
+.. index:: default-metric (0-16777214)
+.. clicmd:: default-metric (0-16777214)
-{OSPF Command} {default-metric (0-16777214)} {}
-.. index:: {OSPF Command} {no default-metric} {}
+.. index:: no default-metric
+.. clicmd:: no default-metric
-{OSPF Command} {no default-metric} {}
-.. index:: {OSPF Command} {distance (1-255)} {}
+.. index:: distance (1-255)
+.. clicmd:: distance (1-255)
-{OSPF Command} {distance (1-255)} {}
-.. index:: {OSPF Command} {no distance (1-255)} {}
+.. index:: no distance (1-255)
+.. clicmd:: no distance (1-255)
-{OSPF Command} {no distance (1-255)} {}
-.. index:: {OSPF Command} {distance ospf (intra-area|inter-area|external) (1-255)} {}
+.. index:: distance ospf (intra-area|inter-area|external) (1-255)
+.. clicmd:: distance ospf (intra-area|inter-area|external) (1-255)
-{OSPF Command} {distance ospf (intra-area|inter-area|external) (1-255)} {}
-.. index:: {OSPF Command} {no distance ospf} {}
+.. index:: no distance ospf
+.. clicmd:: no distance ospf
-{OSPF Command} {no distance ospf} {}
-.. index:: {Command} {router zebra} {}
+.. index:: router zebra
+.. clicmd:: router zebra
-{Command} {router zebra} {}
-.. index:: {Command} {no router zebra} {}
+.. index:: no router zebra
+.. clicmd:: no router zebra
-{Command} {no router zebra} {}
.. _Showing_OSPF_information:
Showing OSPF information
========================
-.. index:: {Command} {show ip ospf} {}
+.. _show_ip_ospf:
-{Command} {show ip ospf} {}
- .. _show_ip_ospf:
+.. index:: show ip ospf
+.. clicmd:: show ip ospf
- Show information on a variety of general OSPF and
- area state and configuration information.
+ Show information on a variety of general OSPF and area state and
+ configuration information.
-.. index:: {Command} {show ip ospf interface [INTERFACE]} {}
+.. index:: show ip ospf interface [INTERFACE]
+.. clicmd:: show ip ospf interface [INTERFACE]
-{Command} {show ip ospf interface [INTERFACE]} {}
- Show state and configuration of OSPF the specified interface, or all
- interfaces if no interface is given.
+ Show state and configuration of OSPF the specified interface, or all
+ interfaces if no interface is given.
-.. index:: {Command} {show ip ospf neighbor} {}
+.. index:: show ip ospf neighbor
+.. clicmd:: show ip ospf neighbor
-{Command} {show ip ospf neighbor} {}
-.. index:: {Command} {show ip ospf neighbor INTERFACE} {}
+.. index:: show ip ospf neighbor INTERFACE
+.. clicmd:: show ip ospf neighbor INTERFACE
-{Command} {show ip ospf neighbor INTERFACE} {}
-.. index:: {Command} {show ip ospf neighbor detail} {}
+.. index:: show ip ospf neighbor detail
+.. clicmd:: show ip ospf neighbor detail
-{Command} {show ip ospf neighbor detail} {}
-.. index:: {Command} {show ip ospf neighbor INTERFACE detail} {}
+.. index:: show ip ospf neighbor INTERFACE detail
+.. clicmd:: show ip ospf neighbor INTERFACE detail
-{Command} {show ip ospf neighbor INTERFACE detail} {}
-.. index:: {Command} {show ip ospf database} {}
+.. index:: show ip ospf database
+.. clicmd:: show ip ospf database
-{Command} {show ip ospf database} {}
-.. index:: {Command} {show ip ospf database (asbr-summary|external|network|router|summary)} {}
+.. index:: show ip ospf database (asbr-summary|external|network|router|summary)
+.. clicmd:: show ip ospf database (asbr-summary|external|network|router|summary)
-{Command} {show ip ospf database (asbr-summary|external|network|router|summary)} {}
-.. index:: {Command} {show ip ospf database (asbr-summary|external|network|router|summary) `link-state-id`} {}
+.. index:: show ip ospf database (asbr-summary|external|network|router|summary) LINK-STATE-ID
+.. clicmd:: show ip ospf database (asbr-summary|external|network|router|summary) LINK-STATE-ID
-{Command} {show ip ospf database (asbr-summary|external|network|router|summary) `link-state-id`} {}
-.. index:: {Command} {show ip ospf database (asbr-summary|external|network|router|summary) `link-state-id` adv-router `adv-router`} {}
+.. index:: show ip ospf database (asbr-summary|external|network|router|summary) LINK-STATE-ID adv-router ADV-ROUTER
+.. clicmd:: show ip ospf database (asbr-summary|external|network|router|summary) LINK-STATE-ID adv-router ADV-ROUTER
-{Command} {show ip ospf database (asbr-summary|external|network|router|summary) `link-state-id` adv-router `adv-router`} {}
-.. index:: {Command} {show ip ospf database (asbr-summary|external|network|router|summary) adv-router `adv-router`} {}
+.. index:: show ip ospf database (asbr-summary|external|network|router|summary) adv-router ADV-ROUTER
+.. clicmd:: show ip ospf database (asbr-summary|external|network|router|summary) adv-router ADV-ROUTER
-{Command} {show ip ospf database (asbr-summary|external|network|router|summary) adv-router `adv-router`} {}
-.. index:: {Command} {show ip ospf database (asbr-summary|external|network|router|summary) `link-state-id` self-originate} {}
+.. index:: show ip ospf database (asbr-summary|external|network|router|summary) LINK-STATE-ID self-originate
+.. clicmd:: show ip ospf database (asbr-summary|external|network|router|summary) LINK-STATE-ID self-originate
-{Command} {show ip ospf database (asbr-summary|external|network|router|summary) `link-state-id` self-originate} {}
-.. index:: {Command} {show ip ospf database (asbr-summary|external|network|router|summary) self-originate} {}
+.. index:: show ip ospf database (asbr-summary|external|network|router|summary) self-originate
+.. clicmd:: show ip ospf database (asbr-summary|external|network|router|summary) self-originate
-{Command} {show ip ospf database (asbr-summary|external|network|router|summary) self-originate} {}
-.. index:: {Command} {show ip ospf database max-age} {}
+.. index:: show ip ospf database max-age
+.. clicmd:: show ip ospf database max-age
-{Command} {show ip ospf database max-age} {}
-.. index:: {Command} {show ip ospf database self-originate} {}
+.. index:: show ip ospf database self-originate
+.. clicmd:: show ip ospf database self-originate
-{Command} {show ip ospf database self-originate} {}
-.. index:: {Command} {show ip ospf route} {}
+.. index:: show ip ospf route
+.. clicmd:: show ip ospf route
-{Command} {show ip ospf route} {}
- Show the OSPF routing table, as determined by the most recent SPF calculation.
+ Show the OSPF routing table, as determined by the most recent SPF calculation.
.. _Opaque_LSA:
Opaque LSA
==========
-.. index:: {OSPF Command} {ospf opaque-lsa} {}
+.. index:: ospf opaque-lsa
+.. clicmd:: ospf opaque-lsa
-{OSPF Command} {ospf opaque-lsa} {}
-.. index:: {OSPF Command} {capability opaque} {}
+.. index:: capability opaque
+.. clicmd:: capability opaque
-{OSPF Command} {capability opaque} {}
-.. index:: {OSPF Command} {no ospf opaque-lsa} {}
+.. index:: no ospf opaque-lsa
+.. clicmd:: no ospf opaque-lsa
-{OSPF Command} {no ospf opaque-lsa} {}
-.. index:: {OSPF Command} {no capability opaque} {}
+.. index:: no capability opaque
+.. clicmd:: no capability opaque
-{OSPF Command} {no capability opaque} {}
- *ospfd* support Opaque LSA (RFC2370) as fondment for MPLS Traffic Engineering LSA. Prior to used MPLS TE, opaque-lsa must be enable in the configuration file. Alternate command could be "mpls-te on" (:ref:`OSPF_Traffic_Engineering`).
+ *ospfd* support Opaque LSA (RFC2370) as fondment for MPLS Traffic Engineering
+ LSA. Prior to used MPLS TE, opaque-lsa must be enable in the configuration
+ file. Alternate command could be "mpls-te on"
+ (:ref:`ospf-traffic-engineering`).
-.. index:: {Command} {show ip ospf database (opaque-link|opaque-area|opaque-external)} {}
+.. index:: show ip ospf database (opaque-link|opaque-area|opaque-external)
+.. clicmd:: show ip ospf database (opaque-link|opaque-area|opaque-external)
-{Command} {show ip ospf database (opaque-link|opaque-area|opaque-external)} {}
-.. index:: {Command} {show ip ospf database (opaque-link|opaque-area|opaque-external) `link-state-id`} {}
+.. index:: show ip ospf database (opaque-link|opaque-area|opaque-external) LINK-STATE-ID
+.. clicmd:: show ip ospf database (opaque-link|opaque-area|opaque-external) LINK-STATE-ID
-{Command} {show ip ospf database (opaque-link|opaque-area|opaque-external) `link-state-id`} {}
-.. index:: {Command} {show ip ospf database (opaque-link|opaque-area|opaque-external) `link-state-id` adv-router `adv-router`} {}
+.. index:: show ip ospf database (opaque-link|opaque-area|opaque-external) LINK-STATE-ID adv-router ADV-ROUTER
+.. clicmd:: show ip ospf database (opaque-link|opaque-area|opaque-external) LINK-STATE-ID adv-router ADV-ROUTER
-{Command} {show ip ospf database (opaque-link|opaque-area|opaque-external) `link-state-id` adv-router `adv-router`} {}
-.. index:: {Command} {show ip ospf database (opaque-link|opaque-area|opaque-external) adv-router `adv-router`} {}
+.. index:: show ip ospf database (opaque-link|opaque-area|opaque-external) adv-router ADV-ROUTER
+.. clicmd:: show ip ospf database (opaque-link|opaque-area|opaque-external) adv-router ADV-ROUTER
-{Command} {show ip ospf database (opaque-link|opaque-area|opaque-external) adv-router `adv-router`} {}
-.. index:: {Command} {show ip ospf database (opaque-link|opaque-area|opaque-external) `link-state-id` self-originate} {}
+.. index:: show ip ospf database (opaque-link|opaque-area|opaque-external) LINK-STATE-ID self-originate
+.. clicmd:: show ip ospf database (opaque-link|opaque-area|opaque-external) LINK-STATE-ID self-originate
-{Command} {show ip ospf database (opaque-link|opaque-area|opaque-external) `link-state-id` self-originate} {}
-.. index:: {Command} {show ip ospf database (opaque-link|opaque-area|opaque-external) self-originate} {}
+.. index:: show ip ospf database (opaque-link|opaque-area|opaque-external) self-originate
+.. clicmd:: show ip ospf database (opaque-link|opaque-area|opaque-external) self-originate
-{Command} {show ip ospf database (opaque-link|opaque-area|opaque-external) self-originate} {}
- Show Opaque LSA from the database.
+ Show Opaque LSA from the database.
-.. _Traffic_Engineering:
+.. _ospf-traffic-engineering:
Traffic Engineering
===================
-.. index:: {OSPF Command} {mpls-te on} {}
-
-{OSPF Command} {mpls-te on} {}
-.. index:: {OSPF Command} {no mpls-te} {}
+.. index:: mpls-te on
+.. clicmd:: mpls-te on
-{OSPF Command} {no mpls-te} {}
- Enable Traffic Engineering LSA flooding.
+.. index:: no mpls-te
+.. clicmd:: no mpls-te
-.. index:: {OSPF Command} {mpls-te router-address <A.B.C.D>} {}
+ Enable Traffic Engineering LSA flooding.
-{OSPF Command} {mpls-te router-address <A.B.C.D>} {}
-.. index:: {OSPF Command} {no mpls-te} {}
+.. index:: mpls-te router-address <A.B.C.D>
+.. clicmd:: mpls-te router-address <A.B.C.D>
-{OSPF Command} {no mpls-te} {}
- Configure stable IP address for MPLS-TE. This IP address is then advertise in Opaque LSA Type-10 TLV=1 (TE)
- option 1 (Router-Address).
+ Configure stable IP address for MPLS-TE. This IP address is then advertise
+ in Opaque LSA Type-10 TLV=1 (TE) option 1 (Router-Address).
-.. index:: {OSPF Command} {mpls-te inter-as area <area-id>|as} {}
+.. index:: mpls-te inter-as area <area-id>|as
+.. clicmd:: mpls-te inter-as area <area-id>|as
-{OSPF Command} {mpls-te inter-as area <area-id>|as} {}
-.. index:: {OSPF Command} {no mpls-te inter-as} {}
+.. index:: no mpls-te inter-as
+.. clicmd:: no mpls-te inter-as
-{OSPF Command} {no mpls-te inter-as} {}
- Enable RFC5392 suuport - Inter-AS TE v2 - to flood Traffic Engineering parameters of Inter-AS link.
- 2 modes are supported: AREA and AS; LSA are flood in AREA <area-id> with Opaque Type-10,
- respectively in AS with Opaque Type-11. In all case, Opaque-LSA TLV=6.
+ 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
+ flood in AREA <area-id> with Opaque Type-10, respectively in AS with Opaque
+ Type-11. In all case, Opaque-LSA TLV=6.
-.. index:: {Command} {show ip ospf mpls-te interface} {}
+.. index:: show ip ospf mpls-te interface
+.. clicmd:: show ip ospf mpls-te interface
-{Command} {show ip ospf mpls-te interface} {}
-.. index:: {Command} {show ip ospf mpls-te interface `interface`} {}
+.. index:: show ip ospf mpls-te interface INTERFACE
+.. clicmd:: show ip ospf mpls-te interface INTERFACE
-{Command} {show ip ospf mpls-te interface `interface`} {}
- Show MPLS Traffic Engineering parameters for all or specified interface.
+ Show MPLS Traffic Engineering parameters for all or specified interface.
-.. index:: {Command} {show ip ospf mpls-te router} {}
+.. index:: show ip ospf mpls-te router
+.. clicmd:: show ip ospf mpls-te router
-{Command} {show ip ospf mpls-te router} {}
- Show Traffic Engineering router parameters.
+ Show Traffic Engineering router parameters.
.. _Router_Information:
Router Information
==================
-.. index:: {OSPF Command} {router-info [as | area <A.B.C.D>]} {}
+.. index:: router-info [as | area <A.B.C.D>]
+.. clicmd:: router-info [as | area <A.B.C.D>]
-{OSPF Command} {router-info [as | area <A.B.C.D>]} {}
-.. index:: {OSPF Command} {no router-info} {}
+.. index:: no router-info
+.. clicmd:: no router-info
-{OSPF Command} {no router-info} {}
- Enable Router Information (RFC4970) LSA advertisement with AS scope (default) or Area scope flooding
- when area is specified.
+ Enable Router Information (:rfc:`4970`) LSA advertisement with AS scope
+ (default) or Area scope flooding when area is specified.
-.. index:: {OSPF Command} {pce address <A.B.C.D>} {}
+.. index:: pce address <A.B.C.D>
+.. clicmd:: pce address <A.B.C.D>
-{OSPF Command} {pce address <A.B.C.D>} {}
-.. index:: {OSPF Command} {no pce address} {}
+.. index:: no pce address
+.. clicmd:: no pce address
-{OSPF Command} {no pce address} {}
-.. index:: {OSPF Command} {pce domain as (0-65535)} {}
+.. index:: pce domain as (0-65535)
+.. clicmd:: pce domain as (0-65535)
-{OSPF Command} {pce domain as (0-65535)} {}
-.. index:: {OSPF Command} {no pce domain as (0-65535)} {}
+.. index:: no pce domain as (0-65535)
+.. clicmd:: no pce domain as (0-65535)
-{OSPF Command} {no pce domain as (0-65535)} {}
-.. index:: {OSPF Command} {pce neighbor as (0-65535)} {}
+.. index:: pce neighbor as (0-65535)
+.. clicmd:: pce neighbor as (0-65535)
-{OSPF Command} {pce neighbor as (0-65535)} {}
-.. index:: {OSPF Command} {no pce neighbor as (0-65535)} {}
+.. index:: no pce neighbor as (0-65535)
+.. clicmd:: no pce neighbor as (0-65535)
-{OSPF Command} {no pce neighbor as (0-65535)} {}
-.. index:: {OSPF Command} {pce flag BITPATTERN} {}
+.. index:: pce flag BITPATTERN
+.. clicmd:: pce flag BITPATTERN
-{OSPF Command} {pce flag BITPATTERN} {}
-.. index:: {OSPF Command} {no pce flag} {}
+.. index:: no pce flag
+.. clicmd:: no pce flag
-{OSPF Command} {no pce flag} {}
-.. index:: {OSPF Command} {pce scope BITPATTERN} {}
+.. index:: pce scope BITPATTERN
+.. clicmd:: pce scope BITPATTERN
-{OSPF Command} {pce scope BITPATTERN} {}
-.. index:: {OSPF Command} {no pce scope} {}
+.. index:: no pce scope
+.. clicmd:: no pce scope
-{OSPF Command} {no pce scope} {}
- The commands are conform to RFC 5088 and allow OSPF router announce Path Compuatation Elemenent (PCE) capabilities
- through the Router Information (RI) LSA. Router Information must be enable prior to this. The command set/unset
- respectively the PCE IP adress, Autonomous System (AS) numbers of controlled domains, neighbor ASs, flag and scope.
- For flag and scope, please refer to RFC5088 for the BITPATTERN recognition. Multiple 'pce neighbor' command could
- be specified in order to specify all PCE neighbours.
+ The commands are conform to :rfc:`5088` and allow OSPF router announce Path
+ Compuatation Elemenent (PCE) capabilities through the Router Information (RI)
+ LSA. Router Information must be enable prior to this. The command set/unset
+ respectively the PCE IP adress, Autonomous System (AS) numbers of controlled
+ domains, neighbor ASs, flag and scope. For flag and scope, please refer to
+ :rfc`5088` for the BITPATTERN recognition. Multiple 'pce neighbor' command
+ could be specified in order to specify all PCE neighbours.
-.. index:: {Command} {show ip ospf router-info} {}
+.. index:: show ip ospf router-info
+.. clicmd:: show ip ospf router-info
-{Command} {show ip ospf router-info} {}
- Show Router Capabilities flag.
-.. index:: {Command} {show ip ospf router-info pce} {}
+ Show Router Capabilities flag.
+.. index:: show ip ospf router-info pce
+.. clicmd:: show ip ospf router-info pce
-{Command} {show ip ospf router-info pce} {}
- Show Router Capabilities PCE parameters.
+ Show Router Capabilities PCE parameters.
.. _Debugging_OSPF:
Debugging OSPF
==============
-.. index:: {Command} {debug ospf packet (hello|dd|ls-request|ls-update|ls-ack|all) (send|recv) [detail]} {}
+.. index:: debug ospf packet (hello|dd|ls-request|ls-update|ls-ack|all) (send|recv) [detail]
+.. clicmd:: debug ospf packet (hello|dd|ls-request|ls-update|ls-ack|all) (send|recv) [detail]
-{Command} {debug ospf packet (hello|dd|ls-request|ls-update|ls-ack|all) (send|recv) [detail]} {}
-.. index:: {Command} {no debug ospf packet (hello|dd|ls-request|ls-update|ls-ack|all) (send|recv) [detail]} {}
+.. index:: no 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]
-{Command} {no debug ospf packet (hello|dd|ls-request|ls-update|ls-ack|all) (send|recv) [detail]} {}
- Dump Packet for debugging
+ Dump Packet for debugging
-.. index:: {Command} {debug ospf ism} {}
+.. index:: debug ospf ism
+.. clicmd:: debug ospf ism
-{Command} {debug ospf ism} {}
-.. index:: {Command} {debug ospf ism (status|events|timers)} {}
+.. index:: debug ospf ism (status|events|timers)
+.. clicmd:: debug ospf ism (status|events|timers)
-{Command} {debug ospf ism (status|events|timers)} {}
-.. index:: {Command} {no debug ospf ism} {}
+.. index:: no debug ospf ism
+.. clicmd:: no debug ospf ism
-{Command} {no debug ospf ism} {}
-.. index:: {Command} {no debug ospf ism (status|events|timers)} {}
+.. index:: no debug ospf ism (status|events|timers)
+.. clicmd:: no debug ospf ism (status|events|timers)
-{Command} {no debug ospf ism (status|events|timers)} {}
- Show debug information of Interface State Machine
+ Show debug information of Interface State Machine
-.. index:: {Command} {debug ospf nsm} {}
+.. index:: debug ospf nsm
+.. clicmd:: debug ospf nsm
-{Command} {debug ospf nsm} {}
-.. index:: {Command} {debug ospf nsm (status|events|timers)} {}
+.. index:: debug ospf nsm (status|events|timers)
+.. clicmd:: debug ospf nsm (status|events|timers)
-{Command} {debug ospf nsm (status|events|timers)} {}
-.. index:: {Command} {no debug ospf nsm} {}
+.. index:: no debug ospf nsm
+.. clicmd:: no debug ospf nsm
-{Command} {no debug ospf nsm} {}
-.. index:: {Command} {no debug ospf nsm (status|events|timers)} {}
+.. index:: no debug ospf nsm (status|events|timers)
+.. clicmd:: no debug ospf nsm (status|events|timers)
-{Command} {no debug ospf nsm (status|events|timers)} {}
- Show debug information of Network State Machine
+ Show debug information of Network State Machine
-.. index:: {Command} {debug ospf event} {}
+.. index:: debug ospf event
+.. clicmd:: debug ospf event
-{Command} {debug ospf event} {}
-.. index:: {Command} {no debug ospf event} {}
+.. index:: no debug ospf event
+.. clicmd:: no debug ospf event
-{Command} {no debug ospf event} {}
- Show debug information of OSPF event
+ Show debug information of OSPF event
-.. index:: {Command} {debug ospf nssa} {}
+.. index:: debug ospf nssa
+.. clicmd:: debug ospf nssa
-{Command} {debug ospf nssa} {}
-.. index:: {Command} {no debug ospf nssa} {}
+.. index:: no debug ospf nssa
+.. clicmd:: no debug ospf nssa
-{Command} {no debug ospf nssa} {}
- Show debug information about Not So Stub Area
+ Show debug information about Not So Stub Area
-.. index:: {Command} {debug ospf lsa} {}
+.. index:: debug ospf lsa
+.. clicmd:: debug ospf lsa
-{Command} {debug ospf lsa} {}
-.. index:: {Command} {debug ospf lsa (generate|flooding|refresh)} {}
+.. index:: debug ospf lsa (generate|flooding|refresh)
+.. clicmd:: debug ospf lsa (generate|flooding|refresh)
-{Command} {debug ospf lsa (generate|flooding|refresh)} {}
-.. index:: {Command} {no debug ospf lsa} {}
+.. index:: no debug ospf lsa
+.. clicmd:: no debug ospf lsa
-{Command} {no debug ospf lsa} {}
-.. index:: {Command} {no debug ospf lsa (generate|flooding|refresh)} {}
+.. index:: no debug ospf lsa (generate|flooding|refresh)
+.. clicmd:: no debug ospf lsa (generate|flooding|refresh)
-{Command} {no debug ospf lsa (generate|flooding|refresh)} {}
- Show debug detail of Link State messages
+ Show debug detail of Link State messages
-.. index:: {Command} {debug ospf te} {}
+.. index:: debug ospf te
+.. clicmd:: debug ospf te
-{Command} {debug ospf te} {}
-.. index:: {Command} {no debug ospf te} {}
+.. index:: no debug ospf te
+.. clicmd:: no debug ospf te
-{Command} {no debug ospf te} {}
- Show debug information about Traffic Engineering LSA
+ Show debug information about Traffic Engineering LSA
-.. index:: {Command} {debug ospf zebra} {}
+.. index:: debug ospf zebra
+.. clicmd:: debug ospf zebra
-{Command} {debug ospf zebra} {}
-.. index:: {Command} {debug ospf zebra (interface|redistribute)} {}
+.. index:: debug ospf zebra (interface|redistribute)
+.. clicmd:: debug ospf zebra (interface|redistribute)
-{Command} {debug ospf zebra (interface|redistribute)} {}
-.. index:: {Command} {no debug ospf zebra} {}
+.. index:: no debug ospf zebra
+.. clicmd:: no debug ospf zebra
-{Command} {no debug ospf zebra} {}
-.. index:: {Command} {no debug ospf zebra (interface|redistribute)} {}
+.. index:: no debug ospf zebra (interface|redistribute)
+.. clicmd:: no debug ospf zebra (interface|redistribute)
-{Command} {no debug ospf zebra (interface|redistribute)} {}
- Show debug information of ZEBRA API
+ Show debug information of ZEBRA API
-.. index:: {Command} {show debugging ospf} {}
+.. index:: show debugging ospf
+.. clicmd:: show debugging ospf
-{Command} {show debugging ospf} {}
OSPF Configuration Examples
===========================
::
- !
- interface bge0
- ip ospf authentication message-digest
- ip ospf message-digest-key 1 md5 ABCDEFGHIJK
- !
- router ospf
- network 192.168.0.0/16 area 0.0.0.1
- area 0.0.0.1 authentication message-digest
+ !
+ interface bge0
+ ip ospf authentication message-digest
+ ip ospf message-digest-key 1 md5 ABCDEFGHIJK
+ !
+ router ospf
+ network 192.168.0.0/16 area 0.0.0.1
+ area 0.0.0.1 authentication message-digest
An :abbr:`ABR` router, with MD5 authentication and performing summarisation
::
- !
- password ABCDEF
- log file /var/log/frr/ospfd.log
- service advanced-vty
- !
- interface eth0
- ip ospf authentication message-digest
- ip ospf message-digest-key 1 md5 ABCDEFGHIJK
- !
- interface ppp0
- !
- interface br0
- ip ospf authentication message-digest
- ip ospf message-digest-key 2 md5 XYZ12345
- !
- router ospf
- ospf router-id 192.168.0.1
- redistribute connected
- passive interface ppp0
- network 192.168.0.0/24 area 0.0.0.0
- network 10.0.0.0/16 area 0.0.0.0
- network 192.168.1.0/24 area 0.0.0.1
- area 0.0.0.0 authentication message-digest
- area 0.0.0.0 range 10.0.0.0/16
- area 0.0.0.0 range 192.168.0.0/24
- area 0.0.0.1 authentication message-digest
- area 0.0.0.1 range 10.2.0.0/16
- !
+ !
+ password ABCDEF
+ log file /var/log/frr/ospfd.log
+ service advanced-vty
+ !
+ interface eth0
+ ip ospf authentication message-digest
+ ip ospf message-digest-key 1 md5 ABCDEFGHIJK
+ !
+ interface ppp0
+ !
+ interface br0
+ ip ospf authentication message-digest
+ ip ospf message-digest-key 2 md5 XYZ12345
+ !
+ router ospf
+ ospf router-id 192.168.0.1
+ redistribute connected
+ passive interface ppp0
+ network 192.168.0.0/24 area 0.0.0.0
+ network 10.0.0.0/16 area 0.0.0.0
+ network 192.168.1.0/24 area 0.0.0.1
+ area 0.0.0.0 authentication message-digest
+ area 0.0.0.0 range 10.0.0.0/16
+ area 0.0.0.0 range 192.168.0.0/24
+ area 0.0.0.1 authentication message-digest
+ area 0.0.0.1 range 10.2.0.0/16
+ !
A Traffic Engineering configuration, with Inter-ASv2 support.
-- First, the 'zebra.conf' part:
-
-::
-
- hostname HOSTNAME
- password PASSWORD
- log file /var/log/zebra.log
- !
- interface eth0
- ip address 198.168.1.1/24
- mpls-te on
- mpls-te link metric 10
- mpls-te link max-bw 1.25e+06
- mpls-te link max-rsv-bw 1.25e+06
- mpls-te link unrsv-bw 0 1.25e+06
- mpls-te link unrsv-bw 1 1.25e+06
- mpls-te link unrsv-bw 2 1.25e+06
- mpls-te link unrsv-bw 3 1.25e+06
- mpls-te link unrsv-bw 4 1.25e+06
- mpls-te link unrsv-bw 5 1.25e+06
- mpls-te link unrsv-bw 6 1.25e+06
- mpls-te link unrsv-bw 7 1.25e+06
- mpls-te link rsc-clsclr 0xab
- !
- interface eth1
- ip address 192.168.2.1/24
- mpls-te on
- mpls-te link metric 10
- mpls-te link max-bw 1.25e+06
- mpls-te link max-rsv-bw 1.25e+06
- mpls-te link unrsv-bw 0 1.25e+06
- mpls-te link unrsv-bw 1 1.25e+06
- mpls-te link unrsv-bw 2 1.25e+06
- mpls-te link unrsv-bw 3 1.25e+06
- mpls-te link unrsv-bw 4 1.25e+06
- mpls-te link unrsv-bw 5 1.25e+06
- mpls-te link unrsv-bw 6 1.25e+06
- mpls-te link unrsv-bw 7 1.25e+06
- mpls-te link rsc-clsclr 0xab
- mpls-te neighbor 192.168.2.2 as 65000
-
-
-- Then the 'ospfd.conf' itself:
-
-::
-
- hostname HOSTNAME
- password PASSWORD
- log file /var/log/ospfd.log
- !
- !
- interface eth0
- ip ospf hello-interval 60
- ip ospf dead-interval 240
- !
- interface eth1
- ip ospf hello-interval 60
- ip ospf dead-interval 240
- !
- !
- router ospf
- ospf router-id 192.168.1.1
- network 192.168.0.0/16 area 1
- ospf opaque-lsa
+First, the 'zebra.conf' part:::
+
+ hostname HOSTNAME
+ password PASSWORD
+ log file /var/log/zebra.log
+ !
+ interface eth0
+ ip address 198.168.1.1/24
+ mpls-te on
+ mpls-te link metric 10
+ mpls-te link max-bw 1.25e+06
+ mpls-te link max-rsv-bw 1.25e+06
+ mpls-te link unrsv-bw 0 1.25e+06
+ mpls-te link unrsv-bw 1 1.25e+06
+ mpls-te link unrsv-bw 2 1.25e+06
+ mpls-te link unrsv-bw 3 1.25e+06
+ mpls-te link unrsv-bw 4 1.25e+06
+ mpls-te link unrsv-bw 5 1.25e+06
+ mpls-te link unrsv-bw 6 1.25e+06
+ mpls-te link unrsv-bw 7 1.25e+06
+ mpls-te link rsc-clsclr 0xab
+ !
+ interface eth1
+ ip address 192.168.2.1/24
+ mpls-te on
+ mpls-te link metric 10
+ mpls-te link max-bw 1.25e+06
+ mpls-te link max-rsv-bw 1.25e+06
+ mpls-te link unrsv-bw 0 1.25e+06
+ mpls-te link unrsv-bw 1 1.25e+06
+ mpls-te link unrsv-bw 2 1.25e+06
+ mpls-te link unrsv-bw 3 1.25e+06
+ mpls-te link unrsv-bw 4 1.25e+06
+ mpls-te link unrsv-bw 5 1.25e+06
+ mpls-te link unrsv-bw 6 1.25e+06
+ mpls-te link unrsv-bw 7 1.25e+06
+ mpls-te link rsc-clsclr 0xab
+ mpls-te neighbor 192.168.2.2 as 65000
+
+
+Then the 'ospfd.conf' itself:::
+
+ hostname HOSTNAME
+ password PASSWORD
+ log file /var/log/ospfd.log
+ !
+ !
+ interface eth0
+ ip ospf hello-interval 60
+ ip ospf dead-interval 240
+ !
+ interface eth1
+ ip ospf hello-interval 60
+ ip ospf dead-interval 240
+ !
+ !
+ router ospf
+ ospf router-id 192.168.1.1
+ network 192.168.0.0/16 area 1
+ ospf opaque-lsa
mpls-te
mpls-te router-address 192.168.1.1
mpls-te inter-as area 1
- !
- line vty
+ !
+ line vty
-A router information example with PCE advsertisement:
+A router information example with PCE advsertisement:::
-::
-
- !
- router ospf
- ospf router-id 192.168.1.1
- network 192.168.0.0/16 area 1
- capability opaque
+ !
+ router ospf
+ ospf router-id 192.168.1.1
+ network 192.168.0.0/16 area 1
+ capability opaque
mpls-te
mpls-te router-address 192.168.1.1
- router-info area 0.0.0.1
+ router-info area 0.0.0.1
pce address 192.168.1.1
pce flag 0x80
pce domain as 65400
pce neighbor as 65500
pce neighbor as 65200
pce scope 0x80
- !
-
-
+ !
Overview of the Zebra Protocol
==============================
-Zebra Protocol is used by protocol daemons to communicate with the
-zebra daemon.
-
-Each protocol daemon may request and send information to and from the
-zebra daemon such as interface states, routing state,
-nexthop-validation, and so on. Protocol daemons may also install routes
-with zebra. The zebra daemon manages which route is installed into the
-forwarding table with the kernel.
-
-Zebra Protocol is a streaming protocol, with a common header. Two
-versions of the header are in use. Version 0 is implicitely versioned.
-Version 1 has an explicit version field. Version 0 can be distinguished
-from all other versions by examining the 3rd byte of the header, which
-contains a marker value for all versions bar version 0. The marker byte
-corresponds to the command field in version 0, and the marker value is
-a reserved command in version 0.
-
-We do not anticipate there will be further versions of the header for
-the foreseeable future, as the command field in version 1 is wide
-enough to allow for future extensions to done compatibly through
-seperate commands.
-
-Version 0 is used by all versions of GNU Zebra as of this writing, and
-versions of Quagga up to and including Quagga 0.98. Version 2 was created
-for 0.99.21 of Quagga. Version 3 designates VRF compatibility and was
-released in 1.0. Version 4 will be used as of FRR 2.0 to indicate that
-we are a different Routing Suite now and to hopefully prevent accidental
-Quagga <-> FRR issues.
+Zebra Protocol is used by protocol daemons to communicate with the zebra
+daemon.
+
+Each protocol daemon may request and send information to and from the zebra
+daemon such as interface states, routing state, nexthop-validation, and so on.
+Protocol daemons may also install routes with zebra. The zebra daemon manages
+which route is installed into the forwarding table with the kernel.
+
+Zebra Protocol is a streaming protocol, with a common header. Two versions of
+the header are in use. Version 0 is implicitely versioned. Version 1 has an
+explicit version field. Version 0 can be distinguished from all other versions
+by examining the 3rd byte of the header, which contains a marker value for all
+versions bar version 0. The marker byte corresponds to the command field in
+version 0, and the marker value is a reserved command in version 0.
+
+We do not anticipate there will be further versions of the header for the
+foreseeable future, as the command field in version 1 is wide enough to allow
+for future extensions to done compatibly through seperate commands.
+
+Version 0 is used by all versions of GNU Zebra as of this writing, and versions
+of Quagga up to and including Quagga 0.98. Version 2 was created for 0.99.21 of
+Quagga. Version 3 designates VRF compatibility and was released in 1.0.
+Version 4 will be used as of FRR 2.0 to indicate that we are a different
+Routing Suite now and to hopefully prevent accidental Quagga <-> FRR issues.
Zebra Protocol Definition
=========================
::
- 0 1 2 3
- 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
- +-------------------------------+---------------+
- | Length (2) | Command (1) |
- +-------------------------------+---------------+
+ 0 1 2 3
+ 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+ +-------------------------------+---------------+
+ | Length (2) | Command (1) |
+ +-------------------------------+---------------+
Zebra Protocol Common Header (version 1)
::
- 0 1 2 3
- 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
- +-------------------------------+---------------+-------------+
- | Length (2) | Marker (1) | Version (1) |
- +-------------------------------+---------------+-------------+
- | Command (2) |
- +-------------------------------+
+ 0 1 2 3
+ 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+ +-------------------------------+---------------+-------------+
+ | Length (2) | Marker (1) | Version (1) |
+ +-------------------------------+---------------+-------------+
+ | Command (2) |
+ +-------------------------------+
Zebra Protocol Header Field Definitions
---------------------------------------
-@table @samp
-@item Length
-Total packet length including this header. The minimum length is 3
-bytes for version 0 messages and 6 bytes for version 1 messages.
+Length
+ Total packet length including this header. The minimum length is 3 bytes for
+ version 0 messages and 6 bytes for version 1 messages.
-@item Marker
-Static marker with a value of 255 always. This is to allow version 0
-Zserv headers (which do not include version explicitely) to be
-distinguished from versioned headers. Not present in version 0
-messages.
+Marker
+ Static marker with a value of 255 always. This is to allow version 0 Zserv
+ headers (which do not include version explicitly) to be distinguished from
+ versioned headers. Not present in version 0 messages.
-@item Version
-Version number of the Zserv message. Clients should not continue
-processing messages past the version field for versions they do not
-recognise. Not present in version 0 messages.
+Version
+ Version number of the Zserv message. Clients should not continue processing
+ messages past the version field for versions they do not recognise. Not
+ present in version 0 messages.
+
+Command
+ The Zebra Protocol command.
-@item Command
-The Zebra Protocol command.
-@end table
Zebra Protocol Commands
-----------------------
-@multitable {ZEBRA_REDISTRIBUTE_DEFAULT_DELETE_WHATEVER} {99999}
-@headitem Command @tab Value
-@item ZEBRA_INTERFACE_ADD
-@tab 1
-@item ZEBRA_INTERFACE_DELETE
-@tab 2
-@item ZEBRA_INTERFACE_ADDRESS_ADD
-@tab 3
-@item ZEBRA_INTERFACE_ADDRESS_DELETE
-@tab 4
-@item ZEBRA_INTERFACE_UP
-@tab 5
-@item ZEBRA_INTERFACE_DOWN
-@tab 6
-@item ZEBRA_IPV4_ROUTE_ADD
-@tab 7
-@item ZEBRA_IPV4_ROUTE_DELETE
-@tab 8
-@item ZEBRA_IPV6_ROUTE_ADD
-@tab 9
-@item ZEBRA_IPV6_ROUTE_DELETE
-@tab 10
-@item ZEBRA_REDISTRIBUTE_ADD
-@tab 11
-@item ZEBRA_REDISTRIBUTE_DELETE
-@tab 12
-@item ZEBRA_REDISTRIBUTE_DEFAULT_ADD
-@tab 13
-@item ZEBRA_REDISTRIBUTE_DEFAULT_DELETE
-@tab 14
-@item ZEBRA_IPV4_NEXTHOP_LOOKUP
-@tab 15
-@item ZEBRA_IPV6_NEXTHOP_LOOKUP
-@tab 16
-@end multitable
++-----------------------------------+-------+
+| Command | Value |
++===================================+=======+
+| ZEBRA_INTERFACE_ADD | 1 |
++-----------------------------------+-------+
+| ZEBRA_INTERFACE_DELETE | 2 |
++-----------------------------------+-------+
+| ZEBRA_INTERFACE_ADDRESS_ADD | 3 |
++-----------------------------------+-------+
+| ZEBRA_INTERFACE_ADDRESS_DELETE | 4 |
++-----------------------------------+-------+
+| ZEBRA_INTERFACE_UP | 5 |
++-----------------------------------+-------+
+| ZEBRA_INTERFACE_DOWN | 6 |
++-----------------------------------+-------+
+| ZEBRA_IPV4_ROUTE_ADD | 7 |
++-----------------------------------+-------+
+| ZEBRA_IPV4_ROUTE_DELETE | 8 |
++-----------------------------------+-------+
+| ZEBRA_IPV6_ROUTE_ADD | 9 |
++-----------------------------------+-------+
+| ZEBRA_IPV6_ROUTE_DELETE | 10 |
++-----------------------------------+-------+
+| ZEBRA_REDISTRIBUTE_ADD | 11 |
++-----------------------------------+-------+
+| ZEBRA_REDISTRIBUTE_DELETE | 12 |
++-----------------------------------+-------+
+| ZEBRA_REDISTRIBUTE_DEFAULT_ADD | 13 |
++-----------------------------------+-------+
+| ZEBRA_REDISTRIBUTE_DEFAULT_DELETE | 14 |
++-----------------------------------+-------+
+| ZEBRA_IPV4_NEXTHOP_LOOKUP | 15 |
++-----------------------------------+-------+
+| ZEBRA_IPV6_NEXTHOP_LOOKUP | 16 |
++-----------------------------------+-------+
***
RIP -- Routing Information Protocol is widely deployed interior gateway
-protocol. RIP was developed in the 1970s at Xerox Labs as part of the
-XNS routing protocol. RIP is a :term:`distance-vector` protocol and is
-based on the :term:`Bellman-Ford` algorithms. As a distance-vector
+protocol. RIP was developed in the 1970s at Xerox Labs as part of the
+XNS routing protocol. RIP is a :term:`distance-vector` protocol and is
+based on the :term:`Bellman-Ford` algorithms. As a distance-vector
protocol, RIP router send updates to its neighbors periodically, thus
-allowing the convergence to a known topology. In each update, the
+allowing the convergence to a known topology. In each update, the
distance to any given network will be broadcasted to its neighboring
router.
Starting and Stopping ripd
==========================
-The default configuration file name of *ripd*'s is
-:file:`ripd.conf`. When invocation *ripd* searches directory
-|INSTALL_PREFIX_ETC|. If :file:`ripd.conf` is not there next
-search current directory.
+The default configuration file name of *ripd*'s is :file:`ripd.conf`. When
+invocation *ripd* searches directory |INSTALL_PREFIX_ETC|. If :file:`ripd.conf`
+is not there next search current directory.
-RIP uses UDP port 520 to send and receive RIP packets. So the user must have
-the capability to bind the port, generally this means that the user must
-have superuser privileges. RIP protocol requires interface information
-maintained by *zebra* daemon. So running *zebra*
-is mandatory to run *ripd*. Thus minimum sequence for running
-RIP is like below:
+RIP uses UDP port 520 to send and receive RIP packets. So the user must have
+the capability to bind the port, generally this means that the user must have
+superuser privileges. RIP protocol requires interface information maintained by
+*zebra* daemon. So running *zebra* is mandatory to run *ripd*. Thus minimum
+sequence for running RIP is like below:
::
Please note that *zebra* must be invoked before *ripd*.
-To stop *ripd*. Please use @command{kill `cat
-/var/run/ripd.pid`}. Certain signals have special meaningss to *ripd*.
+To stop *ripd*. Please use::
+ kill `cat /var/run/ripd.pid`
+
+Certain signals have special meaningss to *ripd*.
+-------------+------------------------------------------------------+
| Signal | Action |
| ``SIGTERM`` | Sweep all installed routes and gracefully terminate. |
+-------------+------------------------------------------------------+
-*ripd* invocation options. Common options that can be specified
+*ripd* invocation options. Common options that can be specified
(:ref:`Common_Invocation_Options`).
.. option:: -r
RIP netmask
-----------
-The netmask features of *ripd* support both version 1 and version 2 of
-RIP. Version 1 of RIP originally contained no netmask information. In
-RIP version 1, network classes were originally used to determine the
-size of the netmask. Class A networks use 8 bits of mask, Class B
-networks use 16 bits of masks, while Class C networks use 24 bits of
-mask. Today, the most widely used method of a network mask is assigned
-to the packet on the basis of the interface that received the packet.
-Version 2 of RIP supports a variable length subnet mask (VLSM). By
-extending the subnet mask, the mask can be divided and reused. Each
-subnet can be used for different purposes such as large to middle size
-LANs and WAN links. FRR *ripd* does not support the non-sequential
-netmasks that are included in RIP Version 2.
-
-In a case of similar information with the same prefix and metric, the
-old information will be suppressed. Ripd does not currently support
-equal cost multipath routing.
+The netmask features of *ripd* support both version 1 and version 2 of RIP.
+Version 1 of RIP originally contained no netmask information. In RIP version 1,
+network classes were originally used to determine the size of the netmask.
+Class A networks use 8 bits of mask, Class B networks use 16 bits of masks,
+while Class C networks use 24 bits of mask. Today, the most widely used method
+of a network mask is assigned to the packet on the basis of the interface that
+received the packet. Version 2 of RIP supports a variable length subnet mask
+(VLSM). By extending the subnet mask, the mask can be divided and reused. Each
+subnet can be used for different purposes such as large to middle size LANs and
+WAN links. FRR *ripd* does not support the non-sequential netmasks that are
+included in RIP Version 2.
+
+In a case of similar information with the same prefix and metric, the old
+information will be suppressed. Ripd does not currently support equal cost
+multipath routing.
.. _RIP_Configuration:
RIP Configuration
=================
-.. index:: Command {router rip} {}
-
-Command {router rip} {}
- The `router rip` command is necessary to enable RIP. To disable
- RIP, use the `no router rip` command. RIP must be enabled before
- carrying out any of the RIP commands.
-
-.. index:: Command {no router rip} {}
+.. index:: router rip
+.. clicmd:: router rip
-Command {no router rip} {}
- Disable RIP.
+ The `router rip` command is necessary to enable RIP. To disable RIP, use the
+ `no router rip` command. RIP must be enabled before carrying out any of the
+ RIP commands.
-.. index:: {RIP Command} {network `network`} {}
+.. index:: no router rip
+.. clicmd:: no router rip
-{RIP Command} {network `network`} {}
-.. index:: {RIP Command} {no network `network`} {}
+ Disable RIP.
-{RIP Command} {no network `network`} {}
- Set the RIP enable interface by `network`. The interfaces which
- have addresses matching with `network` are enabled.
+.. index:: network NETWORK
+.. clicmd:: network NETWORK
- This group of commands either enables or disables RIP interfaces between
- certain numbers of a specified network address. For example, if the
- network for 10.0.0.0/24 is RIP enabled, this would result in all the
- addresses from 10.0.0.0 to 10.0.0.255 being enabled for RIP. The `no network` command will disable RIP for the specified network.
+.. index:: no network NETWORK
+.. clicmd:: no network NETWORK
-.. index:: {RIP Command} {network `ifname`} {}
+ Set the RIP enable interface by NETWORK. The interfaces which have addresses
+ matching with NETWORK are enabled.
-{RIP Command} {network `ifname`} {}
-.. index:: {RIP Command} {no network `ifname`} {}
+ This group of commands either enables or disables RIP interfaces between
+ certain numbers of a specified network address. For example, if the network
+ for 10.0.0.0/24 is RIP enabled, this would result in all the addresses from
+ 10.0.0.0 to 10.0.0.255 being enabled for RIP. The `no network` command will
+ disable RIP for the specified network.
-{RIP Command} {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
- `network ifname` command. The `no network ifname` command will disable
- RIP on the specified interface.
+.. index:: network IFNAME
+.. clicmd:: network IFNAME
-.. index:: {RIP Command} {neighbor `a.b.c.d`} {}
+.. index:: no network IFNAME
+.. clicmd:: no network IFNAME
-{RIP Command} {neighbor `a.b.c.d`} {}
-.. index:: {RIP Command} {no neighbor `a.b.c.d`} {}
+ Set a RIP enabled interface by IFNAME. Both the sending and
+ receiving of RIP packets will be enabled on the port specified in the
+ `network ifname` command. The `no network ifname` command will disable
+ RIP on the specified interface.
-{RIP Command} {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 able to understand multicasting, where packets are sent
- to a network or a group of addresses. In a situation where a neighbor
- cannot process multicast packets, it is necessary to establish a direct
- link between routers. The neighbor command allows the network
- administrator to specify a router as a RIP neighbor. The `no neighbor a.b.c.d` command will disable the RIP neighbor.
+.. index:: neighbor A.B.C.D
+.. clicmd:: neighbor A.B.C.D
- Below is very simple RIP configuration. Interface `eth0` and
- interface which address match to `10.0.0.0/8` are RIP enabled.
+.. index:: no 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
+ able to understand multicasting, where packets are sent to a network or a
+ group of addresses. In a situation where a neighbor cannot process multicast
+ packets, it is necessary to establish a direct link between routers. The
+ neighbor command allows the network administrator to specify a router as a
+ RIP neighbor. The `no neighbor a.b.c.d` command will disable the RIP
+ neighbor.
- !
- router rip
- network 10.0.0.0/8
- network eth0
- !
+ Below is very simple RIP configuration. Interface `eth0` and interface which
+ address match to `10.0.0.0/8` are RIP enabled.
+ ::
- Passive interface
+ !
+ router rip
+ network 10.0.0.0/8
+ network eth0
+ !
-.. index:: {RIP command} {passive-interface (`IFNAME`|default)} {}
-{RIP command} {passive-interface (`IFNAME`|default)} {}
-.. index:: {RIP command} {no passive-interface `IFNAME`} {}
+.. index:: passive-interface (IFNAME|default)
+.. clicmd:: passive-interface (IFNAME|default)
-{RIP command} {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 send either multicast or unicast RIP packets except to RIP neighbors
- specified with `neighbor` command. The interface may be specified
- as `default` to make ripd default to passive on all interfaces.
+.. index:: no passive-interface IFNAME
+.. clicmd:: no passive-interface IFNAME
- The default is to be passive on all interfaces.
+ This command sets the specified interface to passive mode. On passive mode
+ interface, all receiving packets are processed as normal and ripd does not
+ send either multicast or unicast RIP packets except to RIP neighbors
+ specified with `neighbor` command. The interface may be specified as
+ `default` to make ripd default to passive on all interfaces.
- RIP split-horizon
+ The default is to be passive on all interfaces.
-.. index:: {Interface command} {ip split-horizon} {}
+.. index:: ip split-horizon
+.. clicmd:: ip split-horizon
-{Interface command} {ip split-horizon} {}
-.. index:: {Interface command} {no ip split-horizon} {}
+.. index:: no ip split-horizon
+.. clicmd:: no ip split-horizon
-{Interface command} {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 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
+ split-horizon`.
.. _RIP_Version_Control:
RIP Version Control
===================
-RIP can be configured to send either Version 1 or Version 2 packets.
-The default is to send RIPv2 while accepting both RIPv1 and RIPv2 (and
-replying with packets of the appropriate version for REQUESTS /
-triggered updates). The version to receive and send can be specified
-globally, and further overriden on a per-interface basis if needs be
-for send and receive seperately (see below).
+RIP can be configured to send either Version 1 or Version 2 packets. The
+default is to send RIPv2 while accepting both RIPv1 and RIPv2 (and replying
+with packets of the appropriate version for REQUESTS / triggered updates). The
+version to receive and send can be specified globally, and further overriden on
+a per-interface basis if needs be for send and receive seperately (see below).
-It is important to note that RIPv1 can not be authenticated. Further,
-if RIPv1 is enabled then RIP will reply to REQUEST packets, sending the
-state of its RIP routing table to any remote routers that ask on
-demand. For a more detailed discussion on the security implications of
-RIPv1 see :ref:`RIP_Authentication`.
+It is important to note that RIPv1 cannot be authenticated. Further, if RIPv1
+is enabled then RIP will reply to REQUEST packets, sending the state of its RIP
+routing table to any remote routers that ask on demand. For a more detailed
+discussion on the security implications of RIPv1 see :ref:`RIP_Authentication`.
-.. index:: {RIP Command} {version `version`} {}
+.. index:: version VERSION
+.. clicmd:: version VERSION
-{RIP Command} {version `version`} {}
- Set RIP version to accept for reads and send. `version`
- can be either `1'' or `2''.
+ Set RIP version to accept for reads and send. ``VERSION`` can be either 1 or
+ 1.
- Disabling RIPv1 by specifying version 2 is STRONGLY encouraged,
- :ref:`RIP_Authentication`. This may become the default in a future
- release.
+ Disabling RIPv1 by specifying version 2 is STRONGLY encouraged,
+ :ref:`RIP_Authentication`. This may become the default in a future release.
- Default: Send Version 2, and accept either version.
+ Default: Send Version 2, and accept either version.
-.. index:: {RIP Command} {no version} {}
+.. index:: no version
+.. clicmd:: no version
-{RIP Command} {no version} {}
- Reset the global version setting back to the default.
+ Reset the global version setting back to the default.
-.. index:: {Interface command} {ip rip send version `version`} {}
+.. index:: ip rip send version VERSION
+.. clicmd:: ip rip send version VERSION
-{Interface command} {ip rip send version `version`} {}
- `version` can be `1', `2' or `1 2'.
+ VERSION can be ``1``, ``2``, or ``1 2``.
- This interface command overrides the global rip version setting, and
- selects which version of RIP to send packets with, for this interface
- specifically. Choice of RIP Version 1, RIP Version 2, or both versions.
- In the latter case, where `1 2' is specified, packets will be both
- broadcast and multicast.
+ This interface command overrides the global rip version setting, and selects
+ which version of RIP to send packets with, for this interface specifically.
+ Choice of RIP Version 1, RIP Version 2, or both versions. In the latter
+ case, where ``1 2`` is specified, packets will be both broadcast and
+ multicast.
- Default: Send packets according to the global version (version 2)
+ Default: Send packets according to the global version (version 2)
-.. index:: {Interface command} {ip rip receive version `version`} {}
+.. index:: ip rip receive version VERSION
+.. clicmd:: ip rip receive version VERSION
-{Interface command} {ip rip receive version `version`} {}
- `version` can be `1', `2' or `1 2'.
+ VERSION can be ``1``, ``2``, or ``1 2``.
- This interface command overrides the global rip version setting, and
- selects which versions of RIP packets will be accepted on this
- interface. Choice of RIP Version 1, RIP Version 2, or both.
+ This interface command overrides the global rip version setting, and selects
+ which versions of RIP packets will be accepted on this interface. Choice of
+ RIP Version 1, RIP Version 2, or both.
- Default: Accept packets according to the global setting (both 1 and 2).
+ Default: Accept packets according to the global setting (both 1 and 2).
.. _How_to_Announce_RIP_route:
How to Announce RIP route
=========================
-.. index:: {RIP command} {redistribute kernel} {}
+.. index:: redistribute kernel
+.. clicmd:: redistribute kernel
-{RIP command} {redistribute kernel} {}
-.. index:: {RIP command} {redistribute kernel metric (0-16)} {}
+.. index:: redistribute kernel metric (0-16)
+.. clicmd:: redistribute kernel metric (0-16)
-{RIP command} {redistribute kernel metric (0-16)} {}
-.. index:: {RIP command} {redistribute kernel route-map `route-map`} {}
+.. index:: redistribute kernel route-map ROUTE-MAP
+.. clicmd:: redistribute kernel route-map ROUTE-MAP
-{RIP command} {redistribute kernel route-map `route-map`} {}
-.. index:: {RIP command} {no redistribute kernel} {}
+.. index:: no redistribute kernel
+.. clicmd:: no redistribute kernel
-{RIP command} {no redistribute kernel} {}
- `redistribute kernel` redistributes routing information from
- kernel route entries into the RIP tables. `no redistribute kernel`
- disables the routes.
+ `redistribute kernel` redistributes routing information from kernel route
+ entries into the RIP tables. `no redistribute kernel` disables the routes.
-.. index:: {RIP command} {redistribute static} {}
+.. index:: redistribute static
+.. clicmd:: redistribute static
-{RIP command} {redistribute static} {}
-.. index:: {RIP command} {redistribute static metric (0-16)} {}
+.. index:: redistribute static metric (0-16)
+.. clicmd:: redistribute static metric (0-16)
-{RIP command} {redistribute static metric (0-16)} {}
-.. index:: {RIP command} {redistribute static route-map `route-map`} {}
+.. index:: redistribute static route-map ROUTE-MAP
+.. clicmd:: redistribute static route-map ROUTE-MAP
-{RIP command} {redistribute static route-map `route-map`} {}
-.. index:: {RIP command} {no redistribute static} {}
+.. index:: no redistribute static
+.. clicmd:: no redistribute static
-{RIP command} {no redistribute static} {}
- `redistribute static` redistributes routing information from
- static route entries into the RIP tables. `no redistribute static`
- disables the routes.
+ `redistribute static` redistributes routing information from static route
+ entries into the RIP tables. `no redistribute static` disables the routes.
-.. index:: {RIP command} {redistribute connected} {}
+.. index:: redistribute connected
+.. clicmd:: redistribute connected
-{RIP command} {redistribute connected} {}
-.. index:: {RIP command} {redistribute connected metric (0-16)} {}
+.. index:: redistribute connected metric (0-16)
+.. clicmd:: redistribute connected metric (0-16)
-{RIP command} {redistribute connected metric (0-16)} {}
-.. index:: {RIP command} {redistribute connected route-map `route-map`} {}
+.. index:: redistribute connected route-map ROUTE-MAP
+.. clicmd:: redistribute connected route-map ROUTE-MAP
-{RIP command} {redistribute connected route-map `route-map`} {}
-.. index:: {RIP command} {no redistribute connected} {}
+.. index:: no redistribute connected
+.. clicmd:: no redistribute connected
-{RIP command} {no redistribute connected} {}
- Redistribute connected routes into the RIP tables. `no redistribute connected` disables the connected routes in the RIP tables.
- This command redistribute connected of the interface which RIP disabled.
- The connected route on RIP enabled interface is announced by default.
+ Redistribute connected routes into the RIP tables. `no redistribute
+ connected` disables the connected routes in the RIP tables. This command
+ redistribute connected of the interface which RIP disabled. The connected
+ route on RIP enabled interface is announced by default.
-.. index:: {RIP command} {redistribute ospf} {}
+.. index:: redistribute ospf
+.. clicmd:: redistribute ospf
-{RIP command} {redistribute ospf} {}
-.. index:: {RIP command} {redistribute ospf metric (0-16)} {}
+.. index:: redistribute ospf metric (0-16)
+.. clicmd:: redistribute ospf metric (0-16)
-{RIP command} {redistribute ospf metric (0-16)} {}
-.. index:: {RIP command} {redistribute ospf route-map `route-map`} {}
+.. index:: redistribute ospf route-map ROUTE-MAP
+.. clicmd:: redistribute ospf route-map ROUTE-MAP
-{RIP command} {redistribute ospf route-map `route-map`} {}
-.. index:: {RIP command} {no redistribute ospf} {}
+.. index:: no redistribute ospf
+.. clicmd:: no redistribute ospf
-{RIP command} {no redistribute ospf} {}
- `redistribute ospf` redistributes routing information from
- ospf route entries into the RIP tables. `no redistribute ospf`
- disables the routes.
+ `redistribute ospf` redistributes routing information from ospf route
+ entries into the RIP tables. `no redistribute ospf` disables the routes.
-.. index:: {RIP command} {redistribute bgp} {}
+.. index:: redistribute bgp
+.. clicmd:: redistribute bgp
-{RIP command} {redistribute bgp} {}
-.. index:: {RIP command} {redistribute bgp metric (0-16)} {}
+.. index:: redistribute bgp metric (0-16)
+.. clicmd:: redistribute bgp metric (0-16)
-{RIP command} {redistribute bgp metric (0-16)} {}
-.. index:: {RIP command} {redistribute bgp route-map `route-map`} {}
+.. index:: redistribute bgp route-map ROUTE-MAP
+.. clicmd:: redistribute bgp route-map ROUTE-MAP
-{RIP command} {redistribute bgp route-map `route-map`} {}
-.. index:: {RIP command} {no redistribute bgp} {}
+.. index:: no redistribute bgp
+.. clicmd:: no redistribute bgp
-{RIP command} {no redistribute bgp} {}
- `redistribute bgp` redistributes routing information from
- bgp route entries into the RIP tables. `no redistribute bgp`
- disables the routes.
+ `redistribute bgp` redistributes routing information from bgp route entries
+ into the RIP tables. `no redistribute bgp` disables the routes.
- If you want to specify RIP only static routes:
+ If you want to specify RIP only static routes:
-.. index:: {RIP command} {default-information originate} {}
+.. index:: default-information originate
+.. clicmd:: default-information originate
-{RIP command} {default-information originate} {}
-.. index:: {RIP command} {route `a.b.c.d/m`} {}
+.. index:: route A.B.C.D/M
+.. clicmd:: route A.B.C.D/M
-{RIP command} {route `a.b.c.d/m`} {}
-.. index:: {RIP command} {no route `a.b.c.d/m`} {}
+.. index:: no route A.B.C.D/M
+.. clicmd:: no route A.B.C.D/M
-{RIP command} {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 particularly knowledgeable about the RIP protocol. In
- most cases, we recommend creating a static route in FRR and
- redistributing it in RIP using `redistribute static`.
+ 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
+ particularly knowledgeable about the RIP protocol. In most cases, we
+ recommend creating a static route in FRR and redistributing it in RIP using
+ `redistribute static`.
.. _Filtering_RIP_Routes:
RIP routes can be filtered by a distribute-list.
-.. index:: Command {distribute-list `access_list` `direct` `ifname`} {}
+.. index:: distribute-list ACCESS_LIST DIRECT IFNAME
+.. clicmd:: distribute-list ACCESS_LIST DIRECT IFNAME
-Command {distribute-list `access_list` `direct` `ifname`} {}
- You can apply access lists to the interface with a `distribute-list`
- command. `access_list` is the access list name. `direct` is
- ``in`` or ``out``. If `direct` is ``in`` the access list
- is applied to input packets.
+ You can apply access lists to the interface with a `distribute-list` command.
+ ACCESS_LIST is the access list name. DIRECT is ``in`` or ``out``. If DIRECT
+ is ``in`` the access list is applied to input packets.
- The `distribute-list` command can be used to filter the RIP path.
- `distribute-list` can apply access-lists to a chosen interface.
- First, one should specify the access-list. Next, the name of the
- access-list is used in the distribute-list command. For example, in the
- following configuration ``eth0`` will permit only the paths that
- match the route 10.0.0.0/8
+ The `distribute-list` command can be used to filter the RIP path.
+ `distribute-list` can apply access-lists to a chosen interface. First, one
+ should specify the access-list. Next, the name of the access-list is used in
+ the distribute-list command. For example, in the following configuration
+ ``eth0`` will permit only the paths that match the route 10.0.0.0/8
-::
+ ::
- !
- router rip
- distribute-list private in eth0
- !
- access-list private permit 10 10.0.0.0/8
- access-list private deny any
- !
+ !
+ router rip
+ distribute-list private in eth0
+ !
+ access-list private permit 10 10.0.0.0/8
+ access-list private deny any
+ !
-`distribute-list` can be applied to both incoming and outgoing data.
+ `distribute-list` can be applied to both incoming and outgoing data.
-.. index:: Command {distribute-list prefix `prefix_list` (in|out) `ifname`} {}
+.. index:: distribute-list prefix PREFIX_LIST (in|out) IFNAME
+.. clicmd:: distribute-list prefix PREFIX_LIST (in|out) IFNAME
-Command {distribute-list prefix `prefix_list` (in|out) `ifname`} {}
- You can apply prefix lists to the interface with a
- `distribute-list` command. `prefix_list` is the prefix list
- name. Next is the direction of ``in`` or ``out``. If
- `direct` is ``in`` the access list is applied to input packets.
+ You can apply prefix lists to the interface with a `distribute-list`
+ command. PREFIX_LIST is the prefix list name. Next is the direction of
+ ``in`` or ``out``. If DIRECT is ``in`` the access list is applied to input
+ packets.
.. _RIP_Metric_Manipulation:
RIP Metric Manipulation
=======================
-RIP metric is a value for distance for the network. Usually
+RIP metric is a value for distance for the network. Usually
*ripd* increment the metric when the network information is
-received. Redistributed routes' metric is set to 1.
+received. Redistributed routes' metric is set to 1.
-.. index:: {RIP command} {default-metric (1-16)} {}
+.. index:: default-metric (1-16)
+.. clicmd:: default-metric (1-16)
-{RIP command} {default-metric (1-16)} {}
-.. index:: {RIP command} {no default-metric (1-16)} {}
+.. index:: no default-metric (1-16)
+.. clicmd:: no default-metric (1-16)
-{RIP command} {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 it is redistributed by *redistribute connected*. To modify
- connected route's metric value, please use @command{redistribute
- connected metric} or *route-map*. *offset-list* also
- affects connected routes.
+ This command modifies the default metric value for redistributed routes.
+ The default value is 1. This command does not affect connected route even if
+ it is redistributed by *redistribute connected*. To modify connected route's
+ metric value, please use ``redistribute connected metric`` or *route-map*.
+ *offset-list* also affects connected routes.
-.. index:: {RIP command} {offset-list `access-list` (in|out)} {}
+.. index:: offset-list ACCESS-LIST (in|out)
+.. clicmd:: offset-list ACCESS-LIST (in|out)
-{RIP command} {offset-list `access-list` (in|out)} {}
-.. index:: {RIP command} {offset-list `access-list` (in|out) `ifname`} {}
+.. index:: offset-list ACCESS-LIST (in|out) IFNAME
+.. clicmd:: offset-list ACCESS-LIST (in|out) IFNAME
-{RIP command} {offset-list `access-list` (in|out) `ifname`} {}
.. _RIP_distance:
RIP distance
============
-Distance value is used in zebra daemon. Default RIP distance is 120.
+Distance value is used in zebra daemon. Default RIP distance is 120.
-.. index:: {RIP command} {distance (1-255)} {}
+.. index:: distance (1-255)
+.. clicmd:: distance (1-255)
-{RIP command} {distance (1-255)} {}
-.. index:: {RIP command} {no distance (1-255)} {}
+.. index:: no distance (1-255)
+.. clicmd:: no distance (1-255)
-{RIP command} {no distance (1-255)} {}
- Set default RIP distance to specified value.
+ Set default RIP distance to specified value.
-.. index:: {RIP command} {distance (1-255) `A.B.C.D/M`} {}
+.. index:: distance (1-255) A.B.C.D/M
+.. clicmd:: distance (1-255) A.B.C.D/M
-{RIP command} {distance (1-255) `A.B.C.D/M`} {}
-.. index:: {RIP command} {no distance (1-255) `A.B.C.D/M`} {}
+.. index:: no distance (1-255) A.B.C.D/M
+.. clicmd:: no distance (1-255) A.B.C.D/M
-{RIP command} {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.
+ Set default RIP distance to specified value when the route's source IP
+ address matches the specified prefix.
-.. index:: {RIP command} {distance (1-255) `A.B.C.D/M` `access-list`} {}
+.. index:: distance (1-255) A.B.C.D/M ACCESS-LIST
+.. clicmd:: distance (1-255) A.B.C.D/M ACCESS-LIST
-{RIP command} {distance (1-255) `A.B.C.D/M` `access-list`} {}
-.. index:: {RIP command} {no distance (1-255) `A.B.C.D/M` `access-list`} {}
+.. index:: no distance (1-255) A.B.C.D/M ACCESS-LIST
+.. clicmd:: no distance (1-255) A.B.C.D/M ACCESS-LIST
-{RIP command} {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.
+ Set default RIP distance to specified value when the route's source IP
+ address matches the specified prefix and the specified access-list.
.. _RIP_route-map:
.....
-Cisco applies route-map _before_ routes will exported to rip route table.
-In current FRR's test implementation, *ripd* applies route-map
-after routes are listed in the route table and before routes will be
-announced to an interface (something like output filter). I think it is not
-so clear, but it is draft and it may be changed at future.
+Cisco applies route-map _before_ routes will exported to rip route table. In
+current FRR's test implementation, *ripd* applies route-map after routes are
+listed in the route table and before routes will be announced to an interface
+(something like output filter). I think it is not so clear, but it is draft and
+it may be changed at future.
Route-map statement (:ref:`Route_Map`) is needed to use route-map
functionality.
-.. index:: {Route Map} {match interface `word`} {}
+.. index:: match interface WORD
+.. clicmd:: match interface WORD
-{Route Map} {match interface `word`} {}
- This command match to incoming interface. Notation of this match is
- different from Cisco. Cisco uses a list of interfaces - NAME1 NAME2
- ... NAMEN. Ripd allows only one name (maybe will change in the
- future). Next - Cisco means interface which includes next-hop of
- routes (it is somewhat similar to "ip next-hop" statement). Ripd
- means interface where this route will be sent. This difference is
- because "next-hop" of same routes which sends to different interfaces
- must be different. Maybe it'd be better to made new matches - say
- "match interface-out NAME" or something like that.
+ This command match to incoming interface. Notation of this match is
+ different from Cisco. Cisco uses a list of interfaces - NAME1 NAME2 ...
+ NAMEN. Ripd allows only one name (maybe will change in the future). Next -
+ Cisco means interface which includes next-hop of routes (it is somewhat
+ similar to "ip next-hop" statement). Ripd means interface where this route
+ will be sent. This difference is because "next-hop" of same routes which
+ sends to different interfaces must be different. Maybe it'd be better to
+ made new matches - say "match interface-out NAME" or something like that.
-.. index:: {Route Map} {match ip address `word`} {}
+.. index:: match ip address WORD
+.. clicmd:: match ip address WORD
-{Route Map} {match ip address `word`} {}
-.. index:: {Route Map} {match ip address prefix-list `word`} {}
+.. index:: match ip address prefix-list WORD
+.. clicmd:: match ip address prefix-list WORD
-{Route Map} {match ip address prefix-list `word`} {}
- Match if route destination is permitted by access-list.
+ Match if route destination is permitted by access-list.
-.. index:: {Route Map} {match ip next-hop `word`} {}
+.. index:: match ip next-hop WORD
+.. clicmd:: match ip next-hop WORD
-{Route Map} {match ip next-hop `word`} {}
-.. index:: {Route Map} {match ip next-hop prefix-list `word`} {}
+.. index:: match ip next-hop prefix-list WORD
+.. clicmd:: match ip next-hop prefix-list WORD
-{Route Map} {match ip next-hop prefix-list `word`} {}
- Match if route next-hop (meaning next-hop listed in the rip route-table
- as displayed by "show ip rip") is permitted by access-list.
+ Match if route next-hop (meaning next-hop listed in the rip route-table as
+ displayed by "show ip rip") is permitted by access-list.
-.. index:: {Route Map} {match metric (0-4294967295)} {}
+.. index:: match metric (0-4294967295)
+.. clicmd:: match metric (0-4294967295)
-{Route Map} {match metric (0-4294967295)} {}
- This command match to the metric value of RIP updates. For other
- protocol compatibility metric range is shown as (0-4294967295). But
- for RIP protocol only the value range (0-16) make sense.
+ This command match to the metric value of RIP updates. For other protocol
+ compatibility metric range is shown as (0-4294967295). But for RIP protocol
+ only the value range (0-16) make sense.
-.. index:: {Route Map} {set ip next-hop A.B.C.D} {}
+.. index:: set ip next-hop A.B.C.D
+.. clicmd:: set ip next-hop A.B.C.D
-{Route Map} {set ip next-hop A.B.C.D} {}
- This command set next hop value in RIPv2 protocol. This command does
- not affect RIPv1 because there is no next hop field in the packet.
+ This command set next hop value in RIPv2 protocol. This command does not
+ affect RIPv1 because there is no next hop field in the packet.
-.. index:: {Route Map} {set metric (0-4294967295)} {}
+.. index:: set metric (0-4294967295)
+.. clicmd:: set metric (0-4294967295)
-{Route Map} {set metric (0-4294967295)} {}
- Set a metric for matched route when sending announcement. The metric
- value range is very large for compatibility with other protocols. For
- RIP, valid metric values are from 1 to 16.
+ Set a metric for matched route when sending announcement. The metric value
+ range is very large for compatibility with other protocols. For RIP, valid
+ metric values are from 1 to 16.
.. _RIP_Authentication:
To prevent such unauthenticated querying of routes disable RIPv1,
:ref:`RIP_Version_Control`.
-.. index:: {Interface command} {ip rip authentication mode md5} {}
+.. index:: ip rip authentication mode md5
+.. clicmd:: ip rip authentication mode md5
-{Interface command} {ip rip authentication mode md5} {}
-.. index:: {Interface command} {no ip rip authentication mode md5} {}
+.. index:: no ip rip authentication mode md5
+.. clicmd:: no ip rip authentication mode md5
-{Interface command} {no ip rip authentication mode md5} {}
- Set the interface with RIPv2 MD5 authentication.
+ Set the interface with RIPv2 MD5 authentication.
-.. index:: {Interface command} {ip rip authentication mode text} {}
+.. index:: ip rip authentication mode text
+.. clicmd:: ip rip authentication mode text
-{Interface command} {ip rip authentication mode text} {}
-.. index:: {Interface command} {no ip rip authentication mode text} {}
+.. index:: no ip rip authentication mode text
+.. clicmd:: no ip rip authentication mode text
-{Interface command} {no ip rip authentication mode text} {}
- Set the interface with RIPv2 simple password authentication.
+ Set the interface with RIPv2 simple password authentication.
-.. index:: {Interface command} {ip rip authentication string `string`} {}
+.. index:: ip rip authentication string STRING
+.. clicmd:: ip rip authentication string STRING
-{Interface command} {ip rip authentication string `string`} {}
-.. index:: {Interface command} {no ip rip authentication string `string`} {}
+.. index:: no ip rip authentication string STRING
+.. clicmd:: no ip rip authentication string STRING
-{Interface command} {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.
+ RIP version 2 has simple text authentication. This command sets
+ authentication string. The string must be shorter than 16 characters.
-.. index:: {Interface command} {ip rip authentication key-chain `key-chain`} {}
+.. index:: ip rip authentication key-chain KEY-CHAIN
+.. clicmd:: ip rip authentication key-chain KEY-CHAIN
-{Interface command} {ip rip authentication key-chain `key-chain`} {}
-.. index:: {Interface command} {no ip rip authentication key-chain `key-chain`} {}
+.. index:: no ip rip authentication key-chain KEY-CHAIN
+.. clicmd:: no ip rip authentication key-chain KEY-CHAIN
-{Interface command} {no ip rip authentication key-chain `key-chain`} {}
- Specifiy Keyed MD5 chain.
+ Specifiy Keyed MD5 chain.
::
- !
- key chain test
- key 1
- key-string test
- !
- interface eth1
- ip rip authentication mode md5
- ip rip authentication key-chain test
- !
+ !
+ key chain test
+ key 1
+ key-string test
+ !
+ interface eth1
+ ip rip authentication mode md5
+ ip rip authentication key-chain test
+ !
.. _RIP_Timers:
RIP Timers
==========
-.. index:: {RIP command} {timers basic `update` `timeout` `garbage`} {}
+.. index:: timers basic UPDATE TIMEOUT GARBAGE
+.. clicmd:: timers basic UPDATE TIMEOUT GARBAGE
-{RIP command} {timers basic `update` `timeout` `garbage`} {}
- RIP protocol has several timers. User can configure those timers' values
- by `timers basic` command.
+ RIP protocol has several timers. User can configure those timers' values
+ by `timers basic` command.
- The default settings for the timers are as follows:
+ The default settings for the timers are as follows:
+ - The update timer is 30 seconds. Every update timer seconds, the RIP
+ process is awakened to send an unsolicited Response message containing
+ the complete routing table to all neighboring RIP routers.
+ - The timeout timer is 180 seconds. Upon expiration of the timeout, the
+ route is no longer valid; however, it is retained in the routing table
+ for a short time so that neighbors can be notified that the route has
+ been dropped.
+ - The garbage collect timer is 120 seconds. Upon expiration of the
+ garbage-collection timer, the route is finally removed from the routing
+ table.
-``
- The update timer is 30 seconds. Every update timer seconds, the RIP
- process is awakened to send an unsolicited Response message containing
- the complete routing table to all neighboring RIP routers.
+ The ``timers basic`` command allows the the default values of the timers
+ listed above to be changed.
+.. index:: no timers basic
+.. clicmd:: no timers basic
-``
- The timeout timer is 180 seconds. Upon expiration of the timeout, the
- route is no longer valid; however, it is retained in the routing table
- for a short time so that neighbors can be notified that the route has
- been dropped.
-
-
-``
- The garbage collect timer is 120 seconds. Upon expiration of the
- garbage-collection timer, the route is finally removed from the routing
- table.
-
-
- The `timers basic` command allows the the default values of the timers
- listed above to be changed.
-
-.. index:: {RIP command} {no timers basic} {}
-
-{RIP command} {no timers basic} {}
- The `no timers basic` command will reset the timers to the default
- settings listed above.
+ The `no timers basic` command will reset the timers to the default settings
+ listed above.
.. _Show_RIP_Information:
To display RIP routes.
-.. index:: Command {show ip rip} {}
+.. index:: show ip rip
+.. clicmd:: show ip rip
-Command {show ip rip} {}
- Show RIP routes.
+ Show RIP routes.
The command displays all RIP routes. For routes that are received
through RIP, this command will display the time the packet was sent and
-the tag information. This command will also display this information
+the tag information. This command will also display this information
for routes redistributed into RIP.
-.. index:: Command {show ip rip status} {}
+.. index:: show ip rip status
+.. clicmd:: show ip rip status
-Command {show ip rip status} {}
- The command displays current RIP status. It includes RIP timer,
- filtering, version, RIP enabled interface and RIP peer inforation.
+ The command displays current RIP status. It includes RIP timer,
+ filtering, version, RIP enabled interface and RIP peer inforation.
::
- ripd> **show ip rip status**
- Routing Protocol is "rip"
- Sending updates every 30 seconds with +/-50%, next due in 35 seconds
- Timeout after 180 seconds, garbage collect after 120 seconds
- Outgoing update filter list for all interface is not set
- Incoming update filter list for all interface is not set
- Default redistribution metric is 1
- Redistributing: kernel connected
- Default version control: send version 2, receive version 2
- Interface Send Recv
- Routing for Networks:
- eth0
- eth1
- 1.1.1.1
- 203.181.89.241
- Routing Information Sources:
- Gateway BadPackets BadRoutes Distance Last Update
+ ripd> **show ip rip status**
+ Routing Protocol is "rip"
+ Sending updates every 30 seconds with +/-50%, next due in 35 seconds
+ Timeout after 180 seconds, garbage collect after 120 seconds
+ Outgoing update filter list for all interface is not set
+ Incoming update filter list for all interface is not set
+ Default redistribution metric is 1
+ Redistributing: kernel connected
+ Default version control: send version 2, receive version 2
+ Interface Send Recv
+ Routing for Networks:
+ eth0
+ eth1
+ 1.1.1.1
+ 203.181.89.241
+ Routing Information Sources:
+ Gateway BadPackets BadRoutes Distance Last Update
RIP Debug Commands
Debug for RIP protocol.
-.. index:: Command {debug rip events} {}
-
-Command {debug rip events} {}
- Debug rip events.
-
-`debug rip` will show RIP events. Sending and receiving
-packets, timers, and changes in interfaces are events shown with *ripd*.
-
-.. index:: Command {debug rip packet} {}
-
-Command {debug rip packet} {}
- Debug rip packet.
+.. index:: debug rip events
+.. clicmd:: debug rip events
-`debug rip packet` will display detailed information about the RIP
-packets. The origin and port number of the packet as well as a packet
-dump is shown.
+ Shows RIP events. Sending and receiving packets, timers, and changes in
+ interfaces are events shown with *ripd*.
-.. index:: Command {debug rip zebra} {}
+.. index:: debug rip packet
+.. clicmd:: debug rip packet
-Command {debug rip zebra} {}
- Debug rip between zebra communication.
+ Shows display detailed information about the RIP packets. The origin and
+ port number of the packet as well as a packet dump is shown.
-This command will show the communication between *ripd* and
-*zebra*. The main information will include addition and deletion of
-paths to the kernel and the sending and receiving of interface information.
+.. index:: debug rip zebra
+.. clicmd:: debug rip zebra
-.. index:: Command {show debugging rip} {}
+ This command will show the communication between *ripd* and *zebra*. The
+ main information will include addition and deletion of paths to the kernel
+ and the sending and receiving of interface information.
-Command {show debugging rip} {}
- Display *ripd*'s debugging option.
+.. index:: show debugging rip
+.. clicmd:: show debugging rip
-`show debugging rip` will show all information currently set for ripd
-debug.
+ Shows all information currently set for ripd debug.
RIPng
*****
-*ripngd* supports the RIPng protocol as described in RFC2080. It's an
-IPv6 reincarnation of the RIP protocol.
+*ripngd* supports the RIPng protocol as described in :rfc:`2080`. It's an IPv6
+reincarnation of the RIP protocol.
.. _Invoking_ripngd:
Invoking ripngd
===============
-There are no `ripngd` specific invocation options. Common options
-can be specified (:ref:`Common_Invocation_Options`).
+There are no `ripngd` specific invocation options. Common options can be
+specified (:ref:`Common_Invocation_Options`).
.. _ripngd_Configuration:
Currently ripngd supports the following commands:
-.. index:: Command {router ripng} {}
+.. index:: router ripng
+.. clicmd:: router ripng
-Command {router ripng} {}
- Enable RIPng.
+ Enable RIPng.
-.. index:: {RIPng Command} {flush_timer `time`} {}
+.. index:: flush_timer TIME
+.. clicmd:: flush_timer TIME
-{RIPng Command} {flush_timer `time`} {}
- Set flush timer.
+ Set flush timer.
-.. index:: {RIPng Command} {network `network`} {}
+.. index:: network NETWORK
+.. clicmd:: network NETWORK
-{RIPng Command} {network `network`} {}
- Set RIPng enabled interface by `network`
+ Set RIPng enabled interface by NETWORK.
-.. index:: {RIPng Command} {network `ifname`} {}
+.. index:: network IFNAME
+.. clicmd:: network IFNAME
-{RIPng Command} {network `ifname`} {}
- Set RIPng enabled interface by `ifname`
+ Set RIPng enabled interface by IFNAME.
-.. index:: {RIPng Command} {route `network`} {}
+.. index:: route NETWORK
+.. clicmd:: route NETWORK
-{RIPng Command} {route `network`} {}
- Set RIPng static routing announcement of `network`.
+ Set RIPng static routing announcement of NETWORK.
-.. index:: Command {router zebra} {}
+.. index:: router zebra
+.. clicmd:: router zebra
-Command {router zebra} {}
- This command is the default and does not appear in the configuration.
- With this statement, RIPng routes go to the *zebra* daemon.
+ This command is the default and does not appear in the configuration. With
+ this statement, RIPng routes go to the *zebra* daemon.
.. _ripngd_Terminal_Mode_Commands:
ripngd Terminal Mode Commands
=============================
-.. index:: Command {show ip ripng} {}
+.. index:: show ip ripng
+.. clicmd:: show ip ripng
-Command {show ip ripng} {}
+.. index:: show debugging ripng
+.. clicmd:: show debugging ripng
-.. index:: Command {show debugging ripng} {}
+.. index:: debug ripng events
+.. clicmd:: debug ripng events
-Command {show debugging ripng} {}
-.. index:: Command {debug ripng events} {}
+.. index:: debug ripng packet
+.. clicmd:: debug ripng packet
-Command {debug ripng events} {}
-.. index:: Command {debug ripng packet} {}
+.. index:: debug ripng zebra
+.. clicmd:: debug ripng zebra
-Command {debug ripng packet} {}
-.. index:: Command {debug ripng zebra} {}
-
-Command {debug ripng zebra} {}
ripngd Filtering Commands
=========================
-.. index:: Command {distribute-list `access_list` (in|out) `ifname`} {}
-
-Command {distribute-list `access_list` (in|out) `ifname`} {}
- You can apply an access-list to the interface using the
- `distribute-list` command. `access_list` is an access-list
- name. `direct` is ``in`` or ``out``. If `direct` is
- ``in``, the access-list is applied only to incoming packets.
-
-::
+.. index:: distribute-list ACCESS_LIST (in|out) IFNAME
+.. clicmd:: distribute-list ACCESS_LIST (in|out) IFNAME
- distribute-list local-only out sit1
+ You can apply an access-list to the interface using the `distribute-list`
+ command. ACCESS_LIST is an access-list name. `direct` is ``in`` or
+ ``out``. If `direct` is ``in``, the access-list is applied only to incoming
+ packets.::
+ distribute-list local-only out sit1
This means that if a route matches ip access-list number 10 it's
local-preference value is set to 200.
-See :ref:`BGP_Configuration_Examples` for examples of more sophisticated
+See :ref:`bgp-configuration-examples` for examples of more sophisticated
useage of route-maps, including of the ``call`` action.
Prefix Origin Validation Using RPKI
===================================
-Prefix Origin Validation allows BGP routers to verify if the origin AS of
-an IP prefix is legitimate to announce this IP prefix. The required
-attestation objects are stored in the Resource Public Key Infrastructure
-(:abbr:`RPKI`). However, RPKI-enabled routers do not store cryptographic
-data itself but only validation information. The validation of the
-cryptographic data (so called Route Origin Authorization, or short
-:abbr:`ROA`, objects) will be performed by trusted cache servers. The
-RPKI/RTR protocol defines a standard mechanism to maintain the exchange of
-the prefix/origin AS mapping between the cache server and routers.
-In combination with a BGP Prefix Origin Validation scheme a router is able
-to verify received BGP updates without suffering from cryptographic
-complexity.
+Prefix Origin Validation allows BGP routers to verify if the origin AS of an IP
+prefix is legitimate to announce this IP prefix. The required attestation
+objects are stored in the Resource Public Key Infrastructure (:abbr:`RPKI`).
+However, RPKI-enabled routers do not store cryptographic data itself but only
+validation information. The validation of the cryptographic data (so called
+Route Origin Authorization, or short :abbr:`ROA`, objects) will be performed by
+trusted cache servers. The RPKI/RTR protocol defines a standard mechanism to
+maintain the exchange of the prefix/origin AS mapping between the cache server
+and routers. In combination with a BGP Prefix Origin Validation scheme a
+router is able to verify received BGP updates without suffering from
+cryptographic complexity.
The RPKI/RTR protocol is defined in :rfc:`6810` and the validation scheme in
:rfc:`6811`. The current version of Prefix Origin Validation in FRR implements
both RFCs.
-For a more detailed but still easy-to-read background, we suggest the
-following two articles:
+For a more detailed but still easy-to-read background, we suggest:
-* @cite{Geoff Huston, Randy Bush: Securing BGP, In: The Internet
- Protocol Journal, Volume 14, No. 2, 2011.}
- `http://www.cisco.com/web/about/ac123/ac147/archived_issues/ipj_14-2/142_bgp.html <http://www.cisco.com/web/about/ac123/ac147/archived_issues/ipj_14-2/142_bgp.html>`_
-
-* @cite{Geoff Huston: Resource Certification, In: The Internet Protocol
- Journal, Volume 12, No.1, 2009.}
- `http://www.cisco.com/web/about/ac123/ac147/archived_issues/ipj_12-1/121_resource.html <http://www.cisco.com/web/about/ac123/ac147/archived_issues/ipj_12-1/121_resource.html>`_
+- [Securing-BGP]_
+- [Resource-Certification]_
.. _Features_of_the_Current_Implementation:
In a nutshell, the current implementation provides the following features
-* The BGP router can connect to one or more RPKI cache servers to
- receive validated prefix to origin AS mappings.
- Advanced failover can be implemented by server sockets with different
- preference values.
-
-* If no connection to an RPKI cache server can be established after a
+- The BGP router can connect to one or more RPKI cache servers to receive
+ validated prefix to origin AS mappings. Advanced failover can be implemented
+ by server sockets with different preference values.
+- If no connection to an RPKI cache server can be established after a
pre-defined timeout, the router will process routes without prefix origin
validation. It still will try to establish a connection to an RPKI cache
server in the background.
-
-* By default, enabling RPKI does not change best path selection. In
- particular, invalid prefixes will still be considered during best path
- selection. However, the router can be configured to ignore all invalid
- prefixes.
-
-* Route maps can be configured to match a specific RPKI validation
- state. This allows the creation of local policies, which handle BGP routes
- based on the outcome of the Prefix Origin Validation.
+- By default, enabling RPKI does not change best path selection. In particular,
+ invalid prefixes will still be considered during best path selection.
+ However, the router can be configured to ignore all invalid prefixes.
+- Route maps can be configured to match a specific RPKI validation state. This
+ allows the creation of local policies, which handle BGP routes based on the
+ outcome of the Prefix Origin Validation.
.. _Enabling_RPKI:
Enabling RPKI
-------------
-.. index:: {Command} {rpki} {}
+.. index:: rpki
+.. clicmd:: rpki
-{Command} {rpki} {}
- This command enables the RPKI configuration mode. Most commands that start
- with *rpki* can only be used in this mode.
+ This command enables the RPKI configuration mode. Most commands that start
+ with *rpki* can only be used in this mode.
- When it is used in a telnet session, leaving of this mode cause rpki to be initialized.
+ When it is used in a telnet session, leaving of this mode cause rpki to be initialized.
- Executing this command alone does not activate prefix
- validation. You need to configure at least one reachable cache server. See section
- :ref:`Configuring_RPKI/RTR_Cache_Servers` for configuring a cache server.
+ Executing this command alone does not activate prefix validation. You need
+ to configure at least one reachable cache server. See section
+ :ref:`configuring-rpki-rtr-cache-servers` for configuring a cache server.
-.. _Configuring_RPKI/RTR_Cache_Servers:
+.. _configuring-rpki-rtr-cache-servers:
Configuring RPKI/RTR Cache Servers
----------------------------------
The following commands are independent of a specific cache server.
-.. index:: {RPKI Command} {rpki polling_period (1-3600)} {}
-
-{RPKI Command} {rpki polling_period (1-3600)} {}
-.. index:: {RPKI Command} {no rpki polling_period} {}
-
-{RPKI Command} {no rpki polling_period} {}
- Set the number of seconds the router waits until the router asks the cache again
- for updated data.
+.. index:: rpki polling_period (1-3600)
+.. clicmd:: rpki polling_period (1-3600)
- The default value is 300 seconds.
+.. index:: no rpki polling_period
+.. clicmd:: no rpki polling_period
-.. index:: {RPKI Command} {rpki timeout <1-4,294,967,296>} {}
+ Set the number of seconds the router waits until the router asks the cache
+ again for updated data.
-{RPKI Command} {rpki timeout <1-4,294,967,296>} {}
-.. index:: {RPKI Command} {no rpki timeout} {}
+ The default value is 300 seconds.
-{RPKI Command} {no rpki timeout} {}
- Set the number of seconds the router waits for the cache reply. If the
- cache server is not replying within this time period, the router deletes
- all received prefix records from the prefix table.
+.. index:: rpki timeout <1-4,294,967,296>
+.. clicmd:: rpki timeout <1-4,294,967,296>
- The default value is 600 seconds.
+.. index:: no rpki timeout
+.. clicmd:: no rpki timeout
-.. index:: {RPKI Command} {rpki initial-synchronisation-timeout <1-4,294,967,296>} {}
+ Set the number of seconds the router waits for the cache reply. If the cache
+ server is not replying within this time period, the router deletes all
+ received prefix records from the prefix table.
-{RPKI Command} {rpki initial-synchronisation-timeout <1-4,294,967,296>} {}
-.. index:: {RPKI Command} {no rpki initial-synchronisation-timeout} {}
+ The default value is 600 seconds.
-{RPKI Command} {no rpki initial-synchronisation-timeout} {}
- Set the number of seconds until the first synchronization with the cache
- server needs to be completed. If the timeout expires, BGP routing is
- started without RPKI. The router will try to establish the cache server
- connection in the background.
+.. index:: rpki initial-synchronisation-timeout <1-4,294,967,296>
+.. clicmd:: rpki initial-synchronisation-timeout <1-4,294,967,296>
- The default value is 30 seconds.
+.. index:: no rpki initial-synchronisation-timeout
+.. clicmd:: no rpki initial-synchronisation-timeout
- The following commands configure one or multiple cache servers.
+ Set the number of seconds until the first synchronization with the cache
+ server needs to be completed. If the timeout expires, BGP routing is started
+ without RPKI. The router will try to establish the cache server connection in
+ the background.
-.. index:: {RPKI Socket Command} {rpki cache (`A.B.C.D`|`WORD`) `PORT` [`SSH_USERNAME`] [`SSH_PRIVKEY_PATH`] [`SSH_PUBKEY_PATH`] [`KNOWN_HOSTS_PATH`] `PREFERENCE`} {}
+ The default value is 30 seconds.
-{RPKI Socket Command} {rpki cache (`A.B.C.D`|`WORD`) `PORT` [`SSH_USERNAME`] [`SSH_PRIVKEY_PATH`] [`SSH_PUBKEY_PATH`] [`KNOWN_HOSTS_PATH`] `PREFERENCE`} {}
-.. index:: {RPKI Socket Command} {no rpki cache (`A.B.C.D`|`WORD`) [`PORT`] `PREFERENCE`} {}
+ The following commands configure one or multiple cache servers.
-{RPKI Socket Command} {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 router and cache server by SSH is optional.
- Deleting a socket removes the associated cache server and
- terminates the existing connection.
+.. index:: rpki cache (A.B.C.D|WORD) PORT [SSH_USERNAME] [SSH_PRIVKEY_PATH] [SSH_PUBKEY_PATH] [KNOWN_HOSTS_PATH] PREFERENCE
+.. clicmd:: rpki cache (A.B.C.D|WORD) PORT [SSH_USERNAME] [SSH_PRIVKEY_PATH] [SSH_PUBKEY_PATH] [KNOWN_HOSTS_PATH] PREFERENCE
+.. index:: no rpki cache (A.B.C.D|WORD) [PORT] PREFERENCE
+.. clicmd:: no rpki cache (A.B.C.D|WORD) [PORT] PREFERENCE
+ Add a cache server to the socket. By default, the connection between router
+ and cache server is based on plain TCP. Protecting the connection between
+ router and cache server by SSH is optional. Deleting a socket removes the
+ associated cache server and terminates the existing connection.
-*`A.B.C.D`|`WORD`*
- Address of the cache server.
+ A.B.C.D|WORD
+ Address of the cache server.
+ PORT
+ Port number to connect to the cache server
-*`PORT`*
- Port number to connect to the cache server
+ SSH_USERNAME
+ SSH username to establish an SSH connection to the cache server.
-*`SSH_USERNAME`*
- SSH username to establish an SSH connection to the cache server.
+ SSH_PRIVKEY_PATH
+ Local path that includes the private key file of the router.
-*`SSH_PRIVKEY_PATH`*
- Local path that includes the private key file of the router.
+ SSH_PUBKEY_PATH
+ Local path that includes the public key file of the router.
-*`SSH_PUBKEY_PATH`*
- Local path that includes the public key file of the router.
-
-
-*`KNOWN_HOSTS_PATH`*
- Local path that includes the known hosts file. The default value depends on the
- configuration of the operating system environment, usually
- :file:`~/.ssh/known_hosts`.
+ KNOWN_HOSTS_PATH
+ Local path that includes the known hosts file. The default value depends
+ on the configuration of the operating system environment, usually
+ :file:`~/.ssh/known_hosts`.
.. _Validating_BGP_Updates:
Validating BGP Updates
----------------------
-.. index:: {Route Map Command} {match rpki {notfound|invalid|valid}} {}
+.. index:: match rpki notfound|invalid|valid
+.. clicmd:: match rpki notfound|invalid|valid
-{Route Map Command} {match rpki {notfound|invalid|valid}} {}
-.. index:: {Route Map Command} {no match rpki {notfound|invalid|valid}} {}
+.. index:: no match rpki notfound|invalid|valid
+.. clicmd:: no match rpki notfound|invalid|valid
-{Route Map Command} {no match rpki {notfound|invalid|valid}} {}
- Create a clause for a route map to match prefixes with the specified RPKI state.
+ Create a clause for a route map to match prefixes with the specified RPKI
+ state.
**Note** that the matching of invalid prefixes requires that invalid
- prefixes are considered for best path selection, i.e., @command{bgp
- bestpath prefix-validate disallow-invalid} is not enabled.
+ prefixes are considered for best path selection, i.e.,
+ ``bgp bestpath prefix-validate disallow-invalid`` is not enabled.
In the following example, the router prefers valid routes over invalid
prefixes because invalid routes have a lower local preference.
-::
-
- ! Allow for invalid routes in route selection process
- route bgp 60001
- !
- ! Set local preference of invalid prefixes to 10
- route-map rpki permit 10
- match rpki invalid
- set local-preference 10
- !
- ! Set local preference of valid prefixes to 500
- route-map rpki permit 500
- match rpki valid
- set local-preference 500
+ ::
+
+ ! Allow for invalid routes in route selection process
+ route bgp 60001
+ !
+ ! Set local preference of invalid prefixes to 10
+ route-map rpki permit 10
+ match rpki invalid
+ set local-preference 10
+ !
+ ! Set local preference of valid prefixes to 500
+ route-map rpki permit 500
+ match rpki valid
+ set local-preference 500
.. _Debugging:
Debugging
---------
-.. index:: {Command} {debug rpki} {}
+.. index:: debug rpki
+.. clicmd:: debug rpki
-{Command} {debug rpki} {}
-.. index:: {Command} {no debug rpki} {}
+.. index:: no debug rpki
+.. clicmd:: no debug rpki
-{Command} {no debug rpki} {}
- Enable or disable debugging output for RPKI.
+ Enable or disable debugging output for RPKI.
.. _Displaying_RPKI:
Displaying RPKI
---------------
-.. index:: {Command} {show rpki prefix-table} {}
+.. index:: show rpki prefix-table
+.. clicmd:: show rpki prefix-table
-{Command} {show rpki prefix-table} {}
- Display all validated prefix to origin AS mappings/records which have been
- received from the cache servers and stored in the router. Based on this data,
- the router validates BGP Updates.
+ Display all validated prefix to origin AS mappings/records which have been
+ received from the cache servers and stored in the router. Based on this data,
+ the router validates BGP Updates.
-.. index:: {Command} {show rpki cache-connection} {}
+.. index:: show rpki cache-connection
+.. clicmd:: show rpki cache-connection
-{Command} {show rpki cache-connection} {}
- Display all configured cache servers, whether active or not.
+ Display all configured cache servers, whether active or not.
RPKI Configuration Example
--------------------------
::
- hostname bgpd1
- password zebra
- ! log stdout
- debug bgp updates
- debug bgp keepalives
- debug rpki
- !
- rpki
- rpki polling_period 1000
- rpki timeout 10
- ! SSH Example:
- rpki cache example.com 22 rtr-ssh ./ssh_key/id_rsa ./ssh_key/id_rsa.pub preference 1
- ! TCP Example:
- rpki cache rpki-validator.realmv6.org 8282 preference 2
- exit
- !
- router bgp 60001
- bgp router-id 141.22.28.223
- network 192.168.0.0/16
- neighbor 123.123.123.0 remote-as 60002
- neighbor 123.123.123.0 route-map rpki in
- !
- address-family ipv6
- neighbor 123.123.123.0 activate
- neighbor 123.123.123.0 route-map rpki in
- exit-address-family
- !
- route-map rpki permit 10
- match rpki invalid
- set local-preference 10
- !
- route-map rpki permit 20
- match rpki notfound
- set local-preference 20
- !
- route-map rpki permit 30
- match rpki valid
- set local-preference 30
- !
- route-map rpki permit 40
- !
-
-
+ hostname bgpd1
+ password zebra
+ ! log stdout
+ debug bgp updates
+ debug bgp keepalives
+ debug rpki
+ !
+ rpki
+ rpki polling_period 1000
+ rpki timeout 10
+ ! SSH Example:
+ rpki cache example.com 22 rtr-ssh ./ssh_key/id_rsa ./ssh_key/id_rsa.pub preference 1
+ ! TCP Example:
+ rpki cache rpki-validator.realmv6.org 8282 preference 2
+ exit
+ !
+ router bgp 60001
+ bgp router-id 141.22.28.223
+ network 192.168.0.0/16
+ neighbor 123.123.123.0 remote-as 60002
+ neighbor 123.123.123.0 route-map rpki in
+ !
+ address-family ipv6
+ neighbor 123.123.123.0 activate
+ neighbor 123.123.123.0 route-map rpki in
+ exit-address-family
+ !
+ route-map rpki permit 10
+ match rpki invalid
+ set local-preference 10
+ !
+ route-map rpki permit 20
+ match rpki notfound
+ set local-preference 20
+ !
+ route-map rpki permit 30
+ match rpki valid
+ set local-preference 30
+ !
+ route-map rpki permit 40
+ !
+
+.. [Securing-BGP] `Geoff Huston, Randy Bush: Securing BGP, In: The Internet Protocol Journal, Volume 14, No. 2, 2011. <http://www.cisco.com/web/about/ac123/ac147/archived_issues/ipj_14-2/142_bgp.html>`_
+.. [Resource-Certification] `Geoff Huston: Resource Certification, In: The Internet Protocol Journal, Volume 12, No.1, 2009. <http://www.cisco.com/web/about/ac123/ac147/archived_issues/ipj_12-1/121_resource.html>`_
SNMP Support
************
-:abbr:`SNMP (Simple Network Managing Protocol)` is a widely implemented
-feature for collecting network information from router and/or host.
-FRR itself does not support SNMP agent (server daemon) functionality
-but is able to connect to a SNMP agent using the SMUX protocol
-(:rfc:`1227`) or the AgentX protocol (:rfc:`2741`) and make the
-routing protocol MIBs available through it.
+:abbr:`SNMP (Simple Network Managing Protocol)` is a widely implemented feature
+for collecting network information from router and/or host. FRR itself does
+not support SNMP agent (server daemon) functionality but is able to connect to
+a SNMP agent using the SMUX protocol (:rfc:`1227`) or the AgentX protocol
+(:rfc:`2741`) and make the routing protocol MIBs available through it.
-Note that SNMP Support needs to be enabled at compile-time and loaded as
-module on daemon startup. Refer to :ref:`Loadable_Module_Support` on
-the latter.
+Note that SNMP Support needs to be enabled at compile-time and loaded as module
+on daemon startup. Refer to :ref:`Loadable_Module_Support` on the latter.
.. _Getting_and_installing_an_SNMP_agent:
Getting and installing an SNMP agent
====================================
-There are several SNMP agent which support SMUX or AgentX. We recommend to use the latest
-version of `net-snmp` which was formerly known as `ucd-snmp`.
-It is free and open software and available at `http://www.net-snmp.org/ <http://www.net-snmp.org/>`_
-and as binary package for most Linux distributions.
-`net-snmp` has to be compiled with `--with-mib-modules=agentx` to
-be able to accept connections from FRR using AgentX protocol or with
-`--with-mib-modules=smux` to use SMUX protocol.
+There are several SNMP agent which support SMUX or AgentX. We recommend to use
+the latest version of `net-snmp` which was formerly known as `ucd-snmp`. It is
+free and open software and available at `http://www.net-snmp.org/ <http://www.net-snmp.org/>`_
+and as binary package for most Linux distributions. `net-snmp` has to be
+compiled with `--with-mib-modules=agentx` to be able to accept connections from
+FRR using AgentX protocol or with `--with-mib-modules=smux` to use SMUX
+protocol.
-Nowadays, SMUX is a legacy protocol. The AgentX protocol should be
-preferred for any new deployment. Both protocols have the same coverage.
+Nowadays, SMUX is a legacy protocol. The AgentX protocol should be preferred
+for any new deployment. Both protocols have the same coverage.
.. _AgentX_configuration:
AgentX configuration
====================
+.. program:: configure
+
To enable AgentX protocol support, FRR must have been build with the
-`--enable-snmp` or `--enable-snmp=agentx` option. Both the
-master SNMP agent (snmpd) and each of the FRR daemons must be
-configured. In `/etc/snmp/snmpd.conf`, `master agentx`
-directive should be added. In each of the FRR daemons, `agentx`
-command will enable AgentX support.
+:option:`--enable-snmp` or `--enable-snmp=agentx` option. Both the
+master SNMP agent (snmpd) and each of the FRR daemons must be configured. In
+:file:`/etc/snmp/snmpd.conf`, the ``master agentx`` directive should be added.
+In each of the FRR daemons, ``agentx`` command will enable AgentX support.
::
- /etc/snmp/snmpd.conf:
- #
- # example access restrictions setup
- #
- com2sec readonly default public
- group MyROGroup v1 readonly
- view all included .1 80
- access MyROGroup "" any noauth exact all none none
- #
- # enable master agent for AgentX subagents
- #
- master agentx
-
- /etc/frr/ospfd.conf:
- ! ... the rest of ospfd.conf has been omitted for clarity ...
- !
- agentx
- !
-
-
-Upon successful connection, you should get something like this in the
-log of each FRR daemons:
+ /etc/snmp/snmpd.conf:
+ #
+ # example access restrictions setup
+ #
+ com2sec readonly default public
+ group MyROGroup v1 readonly
+ view all included .1 80
+ access MyROGroup "" any noauth exact all none none
+ #
+ # enable master agent for AgentX subagents
+ #
+ master agentx
+
+ /etc/frr/ospfd.conf:
+ ! ... the rest of ospfd.conf has been omitted for clarity ...
+ !
+ agentx
+ !
+
+
+Upon successful connection, you should get something like this in the log of
+each FRR daemons:
::
[...]
-The AgentX protocol can be transported over a Unix socket or using TCP
-or UDP. It usually defaults to a Unix socket and depends on how NetSNMP
-was built. If need to configure FRR to use another transport, you can
-configure it through `/etc/snmp/frr.conf`:
+The AgentX protocol can be transported over a Unix socket or using TCP or UDP.
+It usually defaults to a Unix socket and depends on how NetSNMP was built. If
+need to configure FRR to use another transport, you can configure it through
+:file:`/etc/snmp/frr.conf`:
::
- /etc/snmp/frr.conf:
- [snmpd]
- # Use a remote master agent
- agentXSocket tcp:192.168.15.12:705
+ /etc/snmp/frr.conf:
+ [snmpd]
+ # Use a remote master agent
+ agentXSocket tcp:192.168.15.12:705
.. _SMUX_configuration:
==================
To enable SMUX protocol support, FRR must have been build with the
-`--enable-snmp=smux` option.
+:option:`--enable-snmp` option.
-A separate connection has then to be established between the
-SNMP agent (snmpd) and each of the FRR daemons. This connections
-each use different OID numbers and passwords. Be aware that this OID
-number is not the one that is used in queries by clients, it is solely
-used for the intercommunication of the daemons.
+A separate connection has then to be established between the SNMP agent (snmpd)
+and each of the FRR daemons. This connections each use different OID numbers
+and passwords. Be aware that this OID number is not the one that is used in
+queries by clients, it is solely used for the intercommunication of the
+daemons.
-In the following example the ospfd daemon will be connected to the
-snmpd daemon using the password "frr_ospfd". For testing it is
-recommending to take exactly the below snmpd.conf as wrong access
-restrictions can be hard to debug.
+In the following example the ospfd daemon will be connected to the snmpd daemon
+using the password "frr_ospfd". For testing it is recommending to take exactly
+the below snmpd.conf as wrong access restrictions can be hard to debug.
::
- /etc/snmp/snmpd.conf:
- #
- # example access restrictions setup
- #
- com2sec readonly default public
- group MyROGroup v1 readonly
- view all included .1 80
- access MyROGroup "" any noauth exact all none none
- #
- # the following line is relevant for FRR
- #
- smuxpeer .1.3.6.1.4.1.3317.1.2.5 frr_ospfd
-
- /etc/frr/ospf:
- ! ... the rest of ospfd.conf has been omitted for clarity ...
- !
- smux peer .1.3.6.1.4.1.3317.1.2.5 frr_ospfd
- !
-
-
-After restarting snmpd and frr, a successful connection can be verified in
-the syslog and by querying the SNMP daemon:
+ /etc/snmp/snmpd.conf:
+ #
+ # example access restrictions setup
+ #
+ com2sec readonly default public
+ group MyROGroup v1 readonly
+ view all included .1 80
+ access MyROGroup "" any noauth exact all none none
+ #
+ # the following line is relevant for FRR
+ #
+ smuxpeer .1.3.6.1.4.1.3317.1.2.5 frr_ospfd
+
+ /etc/frr/ospf:
+ ! ... the rest of ospfd.conf has been omitted for clarity ...
+ !
+ smux peer .1.3.6.1.4.1.3317.1.2.5 frr_ospfd
+ !
+
+
+After restarting snmpd and frr, a successful connection can be verified in the
+syslog and by querying the SNMP daemon:
::
- snmpd[12300]: [smux_accept] accepted fd 12 from 127.0.0.1:36255
- snmpd[12300]: accepted smux peer: \\
- oid GNOME-PRODUCT-ZEBRA-MIB::ospfd, frr-0.96.5
+ snmpd[12300]: [smux_accept] accepted fd 12 from 127.0.0.1:36255
+ snmpd[12300]: accepted smux peer: \\
+ oid GNOME-PRODUCT-ZEBRA-MIB::ospfd, frr-0.96.5
- # snmpwalk -c public -v1 localhost .1.3.6.1.2.1.14.1.1
- OSPF-MIB::ospfRouterId.0 = IpAddress: 192.168.42.109
+ # snmpwalk -c public -v1 localhost .1.3.6.1.2.1.14.1.1
+ OSPF-MIB::ospfRouterId.0 = IpAddress: 192.168.42.109
Be warned that the current version (5.1.1) of the Net-SNMP daemon writes a line
for every SNMP connect to the syslog which can lead to enormous log file sizes.
If that is a problem you should consider to patch snmpd and comment out the
-troublesome `snmp_log()` line in the function
-`netsnmp_agent_check_packet()` in `agent/snmp_agent.c`.
+troublesome `snmp_log()` line in the function `netsnmp_agent_check_packet()` in
+`agent/snmp_agent.c`.
MIB and command reference
=========================
The following OID numbers are used for the interprocess communication of snmpd and
-the FRR daemons with SMUX only.
-::
+the FRR daemons with SMUX only.::
- (OIDs below .iso.org.dod.internet.private.enterprises)
+ . (OIDs below .iso.org.dod.internet.private.enterprises)
zebra .1.3.6.1.4.1.3317.1.2.1 .gnome.gnomeProducts.zebra.zserv
bgpd .1.3.6.1.4.1.3317.1.2.2 .gnome.gnomeProducts.zebra.bgpd
ripd .1.3.6.1.4.1.3317.1.2.3 .gnome.gnomeProducts.zebra.ripd
Sadly, SNMP has not been implemented in all daemons yet. The following
-OID numbers are used for querying the SNMP daemon by a client:
-::
+OID numbers are used for querying the SNMP daemon by a client:::
zebra .1.3.6.1.2.1.4.24 .iso.org.dot.internet.mgmt.mib-2.ip.ipForward
ospfd .1.3.6.1.2.1.14 .iso.org.dot.internet.mgmt.mib-2.ospf
ospf6d .1.3.6.1.3.102 .iso.org.dod.internet.experimental.ospfv3
-The following syntax is understood by the FRR daemons for configuring SNMP using SMUX:
-.. index:: {Command} {smux peer `oid`} {}
-
-{Command} {smux peer `oid`} {}
-.. index:: {Command} {no smux peer `oid`} {}
-
-{Command} {no smux peer `oid`} {}
-
-.. index:: {Command} {smux peer `oid` `password`} {}
+The following syntax is understood by the FRR daemons for configuring SNMP
+using SMUX:
-{Command} {smux peer `oid` `password`} {}
-.. index:: {Command} {no smux peer `oid` `password`} {}
+.. index:: smux peer OID
+.. clicmd:: smux peer OID
+.. index:: no smux peer OID
+.. clicmd:: no smux peer OID
+.. index:: smux peer OID PASSWORD
+.. clicmd:: smux peer OID PASSWORD
+.. index:: no smux peer OID PASSWORD
+.. clicmd:: no smux peer OID PASSWORD
-{Command} {no smux peer `oid` `password`} {}
- Here is the syntax for using AgentX:
-.. index:: {Command} {agentx} {}
+Here is the syntax for using AgentX:
-{Command} {agentx} {}
-.. index:: {Command} {no agentx} {}
+.. index:: agentx
+.. clicmd:: agentx
+.. index:: no agentx
+.. clicmd:: no agentx
-{Command} {no agentx} {}
.. include:: snmptrap.rst
Handling SNMP Traps
===================
-To handle snmp traps make sure your snmp setup of frr works
-correctly as described in the frr documentation in :ref:`SNMP_Support`.
+To handle snmp traps make sure your snmp setup of frr works correctly as
+described in the frr documentation in :ref:`SNMP_Support`.
-The BGP4 mib will send traps on peer up/down events. These should be
-visible in your snmp logs with a message similar to:
+The BGP4 mib will send traps on peer up/down events. These should be visible in
+your snmp logs with a message similar to:
::
snmpd[13733]: Got trap from peer on fd 14
-To react on these traps they should be handled by a trapsink. Configure
-your trapsink by adding the following lines to :file:`/etc/snmpd/snmpd.conf`:
+To react on these traps they should be handled by a trapsink. Configure your
+trapsink by adding the following lines to :file:`/etc/snmpd/snmpd.conf`:
::
trapsink localhost
-This will send all traps to an snmptrapd running on localhost. You can
-of course also use a dedicated management station to catch traps.
-Configure the snmptrapd daemon by adding the following line to
+This will send all traps to an snmptrapd running on localhost. You can of
+course also use a dedicated management station to catch traps. Configure the
+snmptrapd daemon by adding the following line to
:file:`/etc/snmpd/snmptrapd.conf`:
::
This will use the bash script :file:`/etc/snmp/snmptrap_handle.sh` to handle
the BGP4 traps. To add traps for other protocol daemons, lookup their
-appropriate OID from their mib. (For additional information about which
-traps are supported by your mib, lookup the mib on
+appropriate OID from their mib. (For additional information about which traps
+are supported by your mib, lookup the mib on
`http://www.oidview.com/mibs/detail.html <http://www.oidview.com/mibs/detail.html>`_).
-Make sure snmptrapd is started.
+Make sure *snmptrapd* is started.
-The snmptrap_handle.sh script I personally use for handling BGP4 traps
-is below. You can of course do all sorts of things when handling traps,
-like sound a siren, have your display flash, etc., be creative ;).
+The snmptrap_handle.sh script I personally use for handling BGP4 traps is
+below. You can of course do all sorts of things when handling traps, like sound
+a siren, have your display flash, etc., be creative ;).
::
VNC and VNC-GW
**************
-This chapter describes how to use
-Virtual Network Control (:abbr:`VNC`) services,
-including Network Virtualization Authority (:abbr:`NVA`) and
-VNC Gateway (:abbr:`VNC-GW`) functions.
-Background information on NVAs,
-Network Virtualization Edges (:abbr:`NVE`s), underlay networks (:abbr:`UN`s),
-and virtual networks (:abbr:`VN`s) is available from the
+This chapter describes how to use Virtual Network Control (:abbr:`VNC`)
+services, including Network Virtualization Authority (:abbr:`NVA`) and VNC
+Gateway (:abbr:`VNC-GW`) functions. Background information on NVAs, Network
+Virtualization Edges (:abbr:`NVE`s), underlay networks (:abbr:`UN`s), and
+virtual networks (:abbr:`VN`s) is available from the
`IETF Network Virtualization Overlays <https://datatracker.ietf.org/wg/nvo3>`_
-VNC Gateways (:abbr:`VNC-GW`s) support the import/export of routing
-information between VNC and customer edge routers (:abbr:`CE`s)
-operating within a VN. Both IP/Layer 3 (L3) VNs, and IP with
-Ethernet/Layer 2 (L2) VNs are supported.
+:abbr:`VNC-GW (VNC-Gateways)` support the import/export of routing information
+between VNC and customer edge routers (:abbr:`CE` s) operating within a VN.
+Both IP/Layer 3 (L3) VNs, and IP with Ethernet/Layer 2 (L2) VNs are supported.
BGP, with IP VPNs and Tunnel Encapsulation, is used to distribute VN
-information between NVAs. BGP based IP VPN support is defined in
-:rfc:`4364`, and
-:rfc:`4659`. Both the Encapsulation Subsequent Address Family Identifier
+information between NVAs. BGP based IP VPN support is defined in :rfc:`4364`,
+and :rfc:`4659`. Both the Encapsulation Subsequent Address Family Identifier
(SAFI) and the Tunnel Encapsulation Attribute, :rfc:`5512` are supported.
-The protocol that is used to communicate routing and Ethernet / Layer 2
-(L2) forwarding information between NVAs and NVEs is referred to as the
-Remote Forwarder Protocol (RFP). `OpenFlow` is an example
-RFP. Specific RFP implementations may choose to implement either a
-`hard-state` or `soft-state` prefix and address registration
-model. To support a `soft-state` refresh model, a `lifetime`
-in seconds is associated with all registrations and responses.
+The protocol that is used to communicate routing and Ethernet / Layer 2 (L2)
+forwarding information between NVAs and NVEs is referred to as the Remote
+Forwarder Protocol (RFP). `OpenFlow` is an example RFP. Specific RFP
+implementations may choose to implement either a `hard-state` or `soft-state`
+prefix and address registration model. To support a `soft-state` refresh model,
+a `lifetime` in seconds is associated with all registrations and responses.
The chapter also provides sample configurations for basic example scenarios.
-.. _Configuring_VNC:
+.. _configuring-vnc:
Configuring VNC
===============
-Virtual Network Control (:abbr:`VNC`) service configuration commands
-appear in the `router bgp` section of the BGPD configuration file
-(:ref:`BGP_Configuration_Examples`). The commands are broken down into
-the following areas:
+Virtual Network Control (:abbr:`VNC`) service configuration commands appear in
+the `router bgp` section of the BGPD configuration file
+(:ref:`bgp-configuration-examples`). The commands are broken down into the
+following areas:
-`General VNC` configuration applies to general VNC operation and is
-primarily used to control the method used to advertise tunnel
-information.
+- :dfn:`General VNC` configuration applies to general VNC operation and is
+ primarily used to control the method used to advertise tunnel information.
+ - :dfn:`Remote Forwarder Protocol (RFP)` configuration relates to the protocol
+ used between NVAs and NVEs.
+ - :dfn:`VNC Defaults` provides default parameters for registered NVEs.
+ - :dfn:`VNC NVE Group` provides for configuration of a specific set of
+ registered NVEs and overrides default parameters.
+ - :dfn:`Redistribution` and :dfn:`Export` control VNC-GW operation, i.e., the
+ import/export of routing information between VNC and customer edge routers
+ (:abbr:`CE`s) operating within a VN.
-`Remote Forwarder Protocol (RFP)` configuration relates to the
-protocol used between NVAs and NVEs.
-`VNC Defaults` provides default parameters for registered NVEs.
+ .. _General_VNC_Configuration:
-`VNC NVE Group` provides for configuration of a specific set of
-registered NVEs and overrides default parameters.
+ General VNC Configuration
+ -------------------------
-`Redistribution` and `Export` control VNC-GW operation, i.e.,
-the import/export of routing
-information between VNC and customer edge routers (:abbr:`CE`s)
-operating within a VN.
+ .. clicmd:: vnc advertise-un-method encap-safi|encap-attr
-.. _General_VNC_Configuration:
-
-General VNC Configuration
--------------------------
-
-.. index:: {VNC} {vnc advertise-un-method encap-safi|encap-attr} {}
-
-{VNC} {vnc advertise-un-method encap-safi|encap-attr} {}
Advertise NVE underlay-network IP addresses using the encapsulation SAFI
- (`encap-safi`) or the UN address sub-TLV of the Tunnel Encapsulation attribute
- (`encap-attr`). When `encap-safi` is used, neighbors under
- `address-family encap` and/or `address-family encapv6` must be
- configured. The default is `encap-attr`.
+ (`encap-safi`) or the UN address sub-TLV of the Tunnel Encapsulation
+ attribute (`encap-attr`). When `encap-safi` is used, neighbors under
+ `address-family encap` and/or `address-family encapv6` must be configured.
+ The default is `encap-attr`.
-.. _RFP_Related_Configuration:
+ .. _RFP_Related_Configuration:
RFP Related Configuration
-------------------------
-The protocol that is used to communicate routing and Ethernet / L2
-forwarding information between NVAs and NVEs is referred to as the
-Remote Forwarder Protocol (RFP). Currently, only a simple example RFP
-is included in FRR. Developers may use this example as a starting
-point to integrate FRR with an RFP of their choosing, e.g.,
-`OpenFlow`. The example code includes the following sample
-configuration:
+The protocol that is used to communicate routing and Ethernet / L2 forwarding
+information between NVAs and NVEs is referred to as the Remote Forwarder
+Protocol (RFP). Currently, only a simple example RFP is included in FRR.
+Developers may use this example as a starting point to integrate FRR with an
+RFP of their choosing, e.g., `OpenFlow`. The example code includes the
+following sample configuration:
-.. index:: {RFP} {rfp example-config-value `VALUE`}
+.. clicmd:: rfp example-config-value VALUE
-{RFP} {rfp example-config-value `VALUE`}
- This is a simple example configuration parameter included as part of the
- RFP example code. `VALUE` must be in the range of 0 to 4294967295.
+This is a simple example configuration parameter included as part of the RFP
+example code. VALUE must be in the range of 0 to 4294967295.
.. _VNC_Defaults_Configuration:
configuration parameters for all registered NVEs.
Default values are overridden by :ref:`VNC_NVE_Group_Configuration`.
-.. index:: {VNC} {vnc defaults} {}
+.. clicmd:: vnc defaults
-{VNC} {vnc defaults} {}
- Enter VNC configuration mode for specifying VNC default behaviors. Use
- `exit-vnc` to leave VNC configuration mode. `vnc defaults` is optional.
+Enter VNC configuration mode for specifying VNC default behaviors. Use
+`exit-vnc` to leave VNC configuration mode. `vnc defaults` is optional.
::
- vnc defaults
- ... various VNC defaults
- exit-vnc
-
-
-These are the statements that can appear between `vnc defaults`
-and `exit-vnc`.
-
-.. index:: {VNC} {rt import `rt-list`} {}
+vnc defaults
+... various VNC defaults
+exit-vnc
-{VNC} {rt import `rt-list`} {}
-.. index:: {VNC} {rt export `rt-list`} {}
-{VNC} {rt export `rt-list`} {}
-.. index:: {VNC} {rt both `rt-list`} {}
+These are the statements that can appear between ``vnc defaults`` and
+``exit-vnc``.
-{VNC} {rt both `rt-list`} {}
- Specify default route target import and export lists. `rt-list` is a
- space-separated list of route targets, each element of which is
- in one of the following forms:
+.. index:: rt import RT-LIST
+.. clicmd:: rt import RT-LIST
+.. index:: rt export RT-LIST
+.. clicmd:: rt export RT-LIST
-`IPv4-address`:`two-byte-integer`
+.. index:: rt both RT-LIST
+.. clicmd:: rt both RT-LIST
-`four-byte-autonomous-system-number`:`two-byte-integer`
+ Specify default route target import and export lists. `rt-list` is a
+ space-separated list of route targets, each element of which is
+ in one of the following forms:
-`two-byte-autonomous-system-number`:`four-byte-integer`
+ - ``IPv4-address:two-byte-integer``
+ - ``four-byte-autonomous-system-number:two-byte-integer``
+ - ``two-byte-autonomous-system-number:four-byte-integer``
- If no default import RT list is specified, then the default import RT
- list is empty.
- If no default export RT list is specified, then the default export RT
- list is empty.
+ If no default import RT list is specified, then the default import RT list
+ is empty. If no default export RT list is specified, then the default export
+ RT list is empty.
- A complete definition of these parameters is
- given below (:ref:`VNC_NVE_Group_Configuration`).
+ A complete definition of these parameters is given below
+ (:ref:`VNC_NVE_Group_Configuration`).
-.. index:: {VNC} {rd `route-distinguisher`}
+ .. index:: rd route-distinguisher
+ .. clicmd:: rd ROUTE-DISTINGUISHER
-{VNC} {rd `route-distinguisher`}
- Specify the default route distinguisher (RD) for routes advertised via BGP
- VPNs. The route distinguisher must be in one of four forms:
+ Specify the default route distinguisher (RD) for routes advertised via BGP
+ VPNs. The route distinguisher must be in one of four forms:
+ - ``IPv4-address:two-byte-integer``
+ - ``four-byte-autonomous-system-number:two-byte-integer``
+ - ``two-byte-autonomous-system-number:four-byte-integer``
+ - ``auto:vn:two-byte-integer``
-`IPv4-address`:`two-byte-integer`
+ If RD is specified in the defaults section, the default RD value is
+ `two-byte-autonomous-system-number=0`:`four-byte-integer=0`.
-`four-byte-autonomous-system-number`:`two-byte-integer`
+ A complete definition of this parameter is given below
+ (:ref:`VNC_NVE_Group_Configuration`).
-`two-byte-autonomous-system-number`:`four-byte-integer`
+ .. index:: l2rd NVE-ID-VALUE
-auto:vn:`two-byte-integer`
+ .. clicmd:: l2rd NVE-ID-VALUE
- If RD is specified in the defaults section, the default RD
- value is `two-byte-autonomous-system-number=0`:`four-byte-integer=0`.
+ Set the value used to distinguish NVEs connected to the same logical
+ Ethernet segment (i.e., L2VPN). A complete definition of this parameter is
+ given below (:ref:`VNC_NVE_Group_Configuration`).
- A complete definition of this parameter is
- given below (:ref:`VNC_NVE_Group_Configuration`).
+ .. index:: response-lifetime LIFETIME|infinite
+ .. clicmd:: response-lifetime LIFETIME|infinite
-.. index:: {VNC} {l2rd `nve-id-value`}
+ Specify the default lifetime to be included in RFP response messages sent to
+ NVEs.
-{VNC} {l2rd `nve-id-value`}
- Set the value used to distinguish NVEs connected to the same logical
- Ethernet segment (i.e., L2VPN).
+ A complete definition of this parameter is given below
+ (:ref:`VNC_NVE_Group_Configuration`).
- A complete definition of this parameter is
- given below (:ref:`VNC_NVE_Group_Configuration`).
+.. index:: export bgp|zebra route-map MAP-NAME
-.. index:: {VNC} {response-lifetime `lifetime`|infinite} {}
+.. clicmd:: export bgp|zebra route-map MAP-NAME
-{VNC} {response-lifetime `lifetime`|infinite} {}
- Specify the default lifetime to be included in RFP
- response messages sent to NVEs.
+Specify that the named route-map should be applied to routes being exported
+to bgp or zebra.
- A complete definition of this parameter is
- given below (:ref:`VNC_NVE_Group_Configuration`).
+.. index:: export bgp|zebra no route-map
-.. index:: {VNC} {export bgp|zebra route-map MAP-NAME}
+.. clicmd:: export bgp|zebra no route-map
-{VNC} {export bgp|zebra route-map MAP-NAME}
- Specify that the named route-map should be applied to routes
- being exported to bgp or zebra.
+Specify that no route-map should be applied to routes being exported to bgp
+or zebra.
-.. index:: {VNC} {export bgp|zebra no route-map}
+.. index:: exit-vnc
+.. clicmd:: exit-vnc
-{VNC} {export bgp|zebra no route-map}
- Specify that no route-map should be applied to routes
- being exported to bgp or zebra.
+ Exit VNC configuration mode.
-.. index:: {VNC} {export bgp|zebra ipv4|ipv6 prefix-list LIST-NAME}
-
-{VNC} {export bgp|zebra ipv4|ipv6 prefix-list LIST-NAME}
- Specify that the named prefix-list filter should be applied to
- routes being exported to bgp or zebra.
- Prefix-lists for ipv4 and ipv6 are independent of each other.
-
-.. index:: {VNC} {export bgp|zebra no ipv4|ipv6 prefix-list}
-
-{VNC} {export bgp|zebra no ipv4|ipv6 prefix-list}
- Specify that no prefix-list filter should be applied to
- routes being exported to bgp or zebra.
-
-.. index:: {VNC} {exit-vnc} {}
-
-{VNC} {exit-vnc} {}
- Exit VNC configuration mode.
-
-.. _VNC_NVE_Group_Configuration:
+ .. _VNC_NVE_Group_Configuration:
VNC NVE Group Configuration
---------------------------
-A NVE Group corresponds to a specific set of NVEs. A Client NVE is
+A NVE Group corresponds to a specific set of NVEs. A Client NVE is
assigned to an NVE Group based on whether there is a match for either
its virtual or underlay network address against the VN and/or UN address
-prefixes specified in the NVE Group definition. When an NVE Group
+prefixes specified in the NVE Group definition. When an NVE Group
definition specifies both VN and UN address prefixes, then an NVE must
-match both prefixes in order to be assigned to the NVE Group. In the
+match both prefixes in order to be assigned to the NVE Group. In the
event that multiple NVE Groups match based on VN and/or UN addresses,
the NVE is assigned to the first NVE Group listed in the configuration.
If an NVE is not assigned to an NVE Group, its messages will be ignored.
member NVEs and override configuration values specified in the VNC
Defaults section.
-@strong{At least one `nve-group` is mandatory for useful VNC
-operation.}
+**At least one `nve-group` is mandatory for useful VNC operation.**
-.. index:: {VNC} {vnc nve-group `name`} {}
+.. index:: vnc nve-group NAME
+.. clicmd:: vnc nve-group NAME
-{VNC} {vnc nve-group `name`} {}
Enter VNC configuration mode for defining the NVE group `name`.
Use `exit` or `exit-vnc` to exit group configuration mode.
-::
-
- vnc nve-group group1
- ... configuration commands
- exit-vnc
-
-
-.. index:: {VNC} {no vnc nve-group `name`} {}
-
-{VNC} {no vnc nve-group `name`} {}
- Delete the NVE group named `name`.
-
-The following statements are valid in an NVE group definition:
-
-.. index:: {VNC} {l2rd `nve-id-value`}
-
-{VNC} {l2rd `nve-id-value`}
- Set the value used to distinguish NVEs connected to the same physical
- Ethernet segment (i.e., at the same location)@footnote{The nve-id is
- carried in the route
- distinguisher. It is the second octet of the eight-octet route
- distinguisher generated for Ethernet / L2 advertisements.
- The first octet is a constant 0xFF, and the third through eighth
- octets are set to the L2 ethernet address being advertised.}
-
- The nve-id subfield may be specified as either a literal value
- in the range 1-255, or it may be specified as `auto:vn`, which
- means to use the least-significant octet of the originating
- NVE's VN address.
-
-.. index:: {VNC} {prefix vn|un A.B.C.D/M|X:X::X:X/M} {}
-
-{VNC} {prefix vn|un A.B.C.D/M|X:X::X:X/M} {}
- .. _prefix:
-
- Specify the matching prefix for this NVE group by either virtual-network address
- (`vn`) or underlay-network address (`un`). Either or both virtual-network
- and underlay-network prefixes may be specified. Subsequent virtual-network or
- underlay-network values within a `vnc nve-group` `exit-vnc`
- block override their respective previous values.
-
- These prefixes are used only for determining assignments of NVEs
- to NVE Groups.
-
-.. index:: {VNC} {rd `route-distinguisher`}
+ ::
-{VNC} {rd `route-distinguisher`}
- Specify the route distinguisher for routes advertised via BGP
- VPNs. The route distinguisher must be in one of these forms:
+ vnc nve-group group1
+ ... configuration commands
+ exit-vnc
-`IPv4-address`:`two-byte-integer`
+.. index:: no vnc nve-group NAME
+.. clicmd:: no vnc nve-group NAME
-`four-byte-autonomous-system-number`:`two-byte-integer`
+ Delete the NVE group named `name`.
-`two-byte-autonomous-system-number`:`four-byte-integer`
+ The following statements are valid in an NVE group definition:
-auto:vn:`two-byte-integer`
+ .. index:: l2rd NVE-ID-VALUE
+ .. clicmd:: l2rd NVE-ID-VALUE
- Routes originated by NVEs in the NVE group will use
- the group's specified `route-distinguisher` when they are
- advertised via BGP.
- If the `auto` form is specified, it means that a matching NVE has
- its RD set to
- `rd_type=IP=1`:`IPv4-address=VN-address`:`two-byte-integer`,
- for IPv4 VN addresses and
- `rd_type=IP=1`:`IPv4-address=Last-four-bytes-of-VN-address`:`two-byte-integer`,
- for IPv6 VN addresses.
+Set the value used to distinguish NVEs connected to the same physical
+Ethernet segment (i.e., at the same location) [#]_.
- If the NVE group definition does not specify a `route-distinguisher`,
- then the default `route-distinguisher` is used.
- If neither a group nor a default `route-distinguisher` is
- configured, then the advertised RD is set to
- `two-byte-autonomous-system-number=0`:`four-byte-integer=0`.
+The nve-id subfield may be specified as either a literal value in the range
+1-255, or it may be specified as `auto:vn`, which means to use the
+least-significant octet of the originating NVE's VN address.
-.. index:: {VNC} {response-lifetime `lifetime`|infinite} {}
+.. index:: prefix vn|un A.B.C.D/M|X:X::X:X/M
+.. clicmd:: prefix vn|un A.B.C.D/M|X:X::X:X/M
-{VNC} {response-lifetime `lifetime`|infinite} {}
- Specify the response lifetime, in seconds, to be included in RFP
- response messages sent to NVEs. If the value
- 'infinite' is given, an infinite lifetime will be used.
+ Specify the matching prefix for this NVE group by either virtual-network
+ address (`vn`) or underlay-network address (`un`). Either or both
+ virtual-network and underlay-network prefixes may be specified. Subsequent
+ virtual-network or underlay-network values within a `vnc nve-group`
+ `exit-vnc` block override their respective previous values.
- Note that this parameter is not the same as the lifetime supplied by
- NVEs in RFP registration messages. This parameter does not affect
- the lifetime value attached to routes sent by this server via BGP.
+ These prefixes are used only for determining assignments of NVEs to NVE
+ Groups.
- If the NVE group definition does not specify a `response-lifetime`,
- the default `response-lifetime` will be used.
- If neither a group nor a default `response-lifetime` is configured,
- the value 3600 will be used. The maximum response lifetime is 2147483647.
+ .. index:: rd ROUTE-DISTINGUISHER
+ .. clicmd:: rd ROUTE-DISTINGUISHER
-.. index:: {VNC} {rt export `rt-list`} {}
+ Specify the route distinguisher for routes advertised via BGP
+ VPNs. The route distinguisher must be in one of these forms:
-{VNC} {rt export `rt-list`} {}
-.. index:: {VNC} {rt import `rt-list`} {}
+ - ``IPv4-address:two-byte-integer``
+ - ``four-byte-autonomous-system-number:two-byte-integer``
+ - ``two-byte-autonomous-system-number:four-byte-integer``
+ - ``auto:vn:`two-byte-integer`
-{VNC} {rt import `rt-list`} {}
-.. index:: {VNC} {rt both `rt-list`} {}
+ Routes originated by NVEs in the NVE group will use the group's specified
+ `route-distinguisher` when they are advertised via BGP. If the `auto` form
+ is specified, it means that a matching NVE has its RD set to
+ ``rd_type=IP=1:IPv4-address=VN-address:two-byte-integer``, for IPv4 VN
+ addresses and
+ ``rd_type=IP=1`:`IPv4-address=Last-four-bytes-of-VN-address:two-byte-integer``,
+ for IPv6 VN addresses.
-{VNC} {rt both `rt-list`} {}
- Specify route target import and export lists. `rt-list` is a
- space-separated list of route targets, each element of which is
- in one of the following forms:
+ If the NVE group definition does not specify a `route-distinguisher`, then
+ the default `route-distinguisher` is used. If neither a group nor a default
+ `route-distinguisher` is configured, then the advertised RD is set to
+ ``two-byte-autonomous-system-number=0:four-byte-integer=0``.
+ .. index:: response-lifetime LIFETIME|infinite
+ .. clicmd:: response-lifetime LIFETIME|infinite
-`IPv4-address`:`two-byte-integer`
+ Specify the response lifetime, in seconds, to be included in RFP response
+ messages sent to NVEs. If the value 'infinite' is given, an infinite
+ lifetime will be used.
-`four-byte-autonomous-system-number`:`two-byte-integer`
+ Note that this parameter is not the same as the lifetime supplied by NVEs in
+ RFP registration messages. This parameter does not affect the lifetime value
+ attached to routes sent by this server via BGP.
-`two-byte-autonomous-system-number`:`four-byte-integer`
+ If the NVE group definition does not specify a `response-lifetime`, the
+ default `response-lifetime` will be used. If neither a group nor a default
+ `response-lifetime` is configured, the value 3600 will be used. The maximum
+ response lifetime is 2147483647.
- The first form, `rt export`, specifies an `export rt-list`.
- The `export rt-list` will be attached to routes originated by
- NVEs in the NVE group when they are advertised via BGP.
- If the NVE group definition does not specify an `export rt-list`,
- then the default `export rt-list` is used.
- If neither a group nor a default `export rt-list` is configured,
- then no RT list will be sent; in turn, these routes will probably
- not be processed
- by receiving NVAs.
+ .. index:: rt export RT-LIST
+ .. clicmd:: rt export RT-LIST
- The second form, `rt import` specifies an `import rt-list`,
- which is a filter for incoming routes.
- In order to be made available to NVEs in the group,
- incoming BGP VPN and @w{ENCAP} @w{SAFI} (when `vnc advertise-un-method encap-safi` is set) routes must have
- RT lists that have at least one route target in common with the
- group's `import rt-list`.
+ .. index:: rt import RT-LIST
+ .. clicmd:: rt import RT-LIST
- If the NVE group definition does not specify an import filter,
- then the default `import rt-list` is used.
- If neither a group nor a default `import rt-list` is configured,
- there can be no RT intersections when receiving BGP routes and
- therefore no incoming BGP routes will be processed for the group.
+.. index:: rt both RT-LIST
+.. clicmd:: rt both RT-LIST
- The third, `rt both`, is a shorthand way of specifying both
- lists simultaneously, and is equivalent to `rt export `rt-list``
- followed by `rt import `rt-list``.
+ Specify route target import and export lists. `rt-list` is a
+ space-separated list of route targets, each element of which is
+ in one of the following forms:
-.. index:: {VNC} {export bgp|zebra route-map MAP-NAME}
+ ``IPv4-address:two-byte-integer``
+ ``four-byte-autonomous-system-number:two-byte-integer``
+ ``two-byte-autonomous-system-number:four-byte-integer``
-{VNC} {export bgp|zebra route-map MAP-NAME}
- Specify that the named route-map should be applied to routes
- being exported to bgp or zebra.
- This paramter is used in conjunction with
- :ref:`Configuring_Export_of_Routes_to_Other_Routing_Protocols`.
- This item is optional.
+ The first form, `rt export`, specifies an `export rt-list`. The `export
+ rt-list` will be attached to routes originated by NVEs in the NVE group
+ when they are advertised via BGP. If the NVE group definition does not
+ specify an `export rt-list`, then the default `export rt-list` is used.
+ If neither a group nor a default `export rt-list` is configured, then no
+ RT list will be sent; in turn, these routes will probably not be
+ processed by receiving NVAs.
-.. index:: {VNC} {export bgp|zebra no route-map}
+ The second form, `rt import` specifies an `import rt-list`, which is a
+ filter for incoming routes. In order to be made available to NVEs in the
+ group, incoming BGP VPN and `ENCAP` `SAFI` (when `vnc advertise-un-method
+ encap-safi` is set) routes must have RT lists that have at least one
+ route target in common with the group's `import rt-list`.
-{VNC} {export bgp|zebra no route-map}
- Specify that no route-map should be applied to routes
- being exported to bgp or zebra.
- This paramter is used in conjunction with
- :ref:`Configuring_Export_of_Routes_to_Other_Routing_Protocols`.
- This item is optional.
-
-.. index:: {VNC} {export bgp|zebra ipv4|ipv6 prefix-list LIST-NAME}
-
-{VNC} {export bgp|zebra ipv4|ipv6 prefix-list LIST-NAME}
- Specify that the named prefix-list filter should be applied to
- routes being exported to bgp or zebra.
- Prefix-lists for ipv4 and ipv6 are independent of each other.
- This paramter is used in conjunction with
- :ref:`Configuring_Export_of_Routes_to_Other_Routing_Protocols`.
- This item is optional.
-
-.. index:: {VNC} {export bgp|zebra no ipv4|ipv6 prefix-list}
-
-{VNC} {export bgp|zebra no ipv4|ipv6 prefix-list}
- Specify that no prefix-list filter should be applied to
- routes being exported to bgp or zebra.
- This paramter is used in conjunction with
- :ref:`Configuring_Export_of_Routes_to_Other_Routing_Protocols`.
- This item is optional.
+ If the NVE group definition does not specify an import filter, then the
+ default `import rt-list` is used. If neither a group nor a default
+ `import rt-list` is configured, there can be no RT intersections when
+ receiving BGP routes and therefore no incoming BGP routes will be
+ processed for the group.
+
+ The third, `rt both`, is a shorthand way of specifying both lists
+ simultaneously, and is equivalent to `rt export `rt-list`` followed by
+ `rt import `rt-list``.
+
+.. index:: export bgp|zebra route-map MAP-NAME
+.. clicmd:: export bgp|zebra route-map MAP-NAME
+
+ Specify that the named route-map should be applied to routes being exported
+ to bgp or zebra. This paramter is used in conjunction with
+ :ref:`Configuring_Export_of_Routes_to_Other_Routing_Protocols`. This item
+ is optional.
+
+.. index:: export bgp|zebra no route-map
+.. clicmd:: export bgp|zebra no route-map
+
+ Specify that no route-map should be applied to routes being exported to bgp
+ or zebra. This paramter is used in conjunction with
+ :ref:`Configuring_Export_of_Routes_to_Other_Routing_Protocols`. This item
+ is optional.
+
+.. index:: export bgp|zebra ipv4|ipv6 prefix-list LIST-NAME
+.. clicmd:: export bgp|zebra ipv4|ipv6 prefix-list LIST-NAME
+
+ Specify that the named prefix-list filter should be applied to routes being
+ exported to bgp or zebra. Prefix-lists for ipv4 and ipv6 are independent of
+ each other. This paramter is used in conjunction with
+ :ref:`Configuring_Export_of_Routes_to_Other_Routing_Protocols`. This item
+ is optional.
+
+.. index:: export bgp|zebra no ipv4|ipv6 prefix-list
+.. clicmd:: export bgp|zebra no ipv4|ipv6 prefix-list
+
+ Specify that no prefix-list filter should be applied to routes being
+ exported to bgp or zebra. This parameter is used in conjunction with
+ :ref:`Configuring_Export_of_Routes_to_Other_Routing_Protocols`. This item
+ is optional.
.. _VNC_L2_Group_Configuration:
VNC L2 Group Configuration
--------------------------
-The route targets advertised with prefixes and addresses registered by
-an NVE are determined based on the NVE's associated VNC NVE Group
-Configuration, :ref:`VNC_NVE_Group_Configuration`. Layer 2 (L2) Groups
-are used to override the route targets for an NVE's Ethernet
-registrations based on the Logical Network Identifier and label value.
-A Logical Network Identifier is used to uniquely identify a logical
-Ethernet segment and is conceptually similar to the Ethernet Segment
-Identifier defined in :rfc:`7432`. Both
-the Logical Network Identifier and Label are passed to VNC via RFP
-prefix and address registration.
-
-Note that a corresponding NVE group configuration must be present, and
-that other NVE associated configuration information, notably RD, is
-not impacted by L2 Group Configuration.
-
-.. index:: {VNC} {vnc l2-group `name`} {}
-
-{VNC} {vnc l2-group `name`} {}
- Enter VNC configuration mode for defining the L2 group `name`.
- Use `exit` or `exit-vnc` to exit group configuration mode.
+The route targets advertised with prefixes and addresses registered by an NVE
+are determined based on the NVE's associated VNC NVE Group Configuration,
+:ref:`VNC_NVE_Group_Configuration`. Layer 2 (L2) Groups are used to override
+the route targets for an NVE's Ethernet registrations based on the Logical
+Network Identifier and label value. A Logical Network Identifier is used to
+uniquely identify a logical Ethernet segment and is conceptually similar to the
+Ethernet Segment Identifier defined in :rfc:`7432`. Both the Logical Network
+Identifier and Label are passed to VNC via RFP prefix and address registration.
-::
+Note that a corresponding NVE group configuration must be present, and that
+other NVE associated configuration information, notably RD, is not impacted by
+L2 Group Configuration.
+
+.. index:: vnc l2-group NAME
+.. clicmd:: vnc l2-group NAME
+
+ Enter VNC configuration mode for defining the L2 group `name`.
+ Use `exit` or `exit-vnc` to exit group configuration mode.
- vnc l2-group group1
- ... configuration commands
- exit-vnc
+ ::
+ vnc l2-group group1
+ ... configuration commands
+ exit-vnc
-.. index:: {VNC} {no vnc l2-group `name`} {}
-{VNC} {no vnc l2-group `name`} {}
- Delete the L2 group named `name`.
+.. index:: no vnc l2-group NAME
+.. clicmd:: no vnc l2-group NAME
+
+ Delete the L2 group named `name`.
The following statements are valid in a L2 group definition:
-.. index:: {VNC} {logical-network-id `VALUE`}
+.. index:: logical-network-id VALUE
+.. clicmd:: logical-network-id VALUE
-{VNC} {logical-network-id `VALUE`}
- Define the Logical Network Identifier with a value in the range of
- 0-4294967295 that identifies the logical Ethernet segment.
+ Define the Logical Network Identifier with a value in the range of
+ 0-4294967295 that identifies the logical Ethernet segment.
-.. index:: {VNC} {labels `label-list`}
+.. index:: labels LABEL-LIST
+.. clicmd:: labels LABEL-LIST
-{VNC} {labels `label-list`}
-.. index:: {VNC} {no labels `label-list`}
+.. index:: no labels LABEL-LIST
+.. clicmd:: no labels LABEL-LIST
-{VNC} {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.
+ Add or remove labels associated with the group. `label-list` is a
+ space separated list of label values in the range of 0-1048575.
-.. index:: {VNC} {rt import `rt-target`} {}
+.. index:: rt import RT-TARGET
+.. clicmd:: rt import RT-TARGET
-{VNC} {rt import `rt-target`} {}
-.. index:: {VNC} {rt export `rt-target`} {}
+.. index:: rt export RT-TARGET
+.. clicmd:: rt export RT-TARGET
-{VNC} {rt export `rt-target`} {}
-.. index:: {VNC} {rt both `rt-target`} {}
+.. index:: rt both RT-TARGET
+.. clicmd:: rt both RT-TARGET
-{VNC} {rt both `rt-target`} {}
- Specify the route target import and export value associated with the
- group. A complete definition of these parameters is given above,
- :ref:`VNC_NVE_Group_Configuration`.
+ Specify the route target import and export value associated with the group.
+ A complete definition of these parameters is given above,
+ :ref:`VNC_NVE_Group_Configuration`.
.. _Configuring_Redistribution_of_Routes_from_Other_Routing_Protocols:
Configuring Redistribution of Routes from Other Routing Protocols
-----------------------------------------------------------------
-Routes from other protocols (including BGP) can be provided to VNC (both
-for RFP and for redistribution via BGP)
-from three sources: the zebra kernel routing process;
-directly from the main (default) unicast BGP RIB; or directly
+Routes from other protocols (including BGP) can be provided to VNC (both for
+RFP and for redistribution via BGP) from three sources: the zebra kernel
+routing process; directly from the main (default) unicast BGP RIB; or directly
from a designated BGP unicast exterior routing RIB instance.
-The protocol named in the `vnc redistribute` command indicates
-the route source:
-`bgp-direct` routes come directly from the main (default)
-unicast BGP RIB and are available for RFP and are redistributed via BGP;
-`bgp-direct-to-nve-groups` routes come directly from a designated
-BGP unicast routing RIB and are made available only to RFP;
-and routes from other protocols come from the zebra kernel
-routing process.
+The protocol named in the `vnc redistribute` command indicates the route
+source: `bgp-direct` routes come directly from the main (default) unicast BGP
+RIB and are available for RFP and are redistributed via BGP;
+`bgp-direct-to-nve-groups` routes come directly from a designated BGP unicast
+routing RIB and are made available only to RFP; and routes from other protocols
+come from the zebra kernel routing process.
Note that the zebra process does not need to be active if
only `bgp-direct` or `bgp-direct-to-nve-groups` routes are used.
-`zebra` routes
-^^^^^^^^^^^^^^
+zebra routes
+^^^^^^^^^^^^
Routes originating from protocols other than BGP must be obtained
via the zebra routing process.
Redistribution of these routes into VNC does not support policy mechanisms
such as prefix-lists or route-maps.
-`bgp-direct` routes
-^^^^^^^^^^^^^^^^^^^
+bgp-direct routes
+^^^^^^^^^^^^^^^^^
`bgp-direct` redistribution supports policy via
prefix lists and route-maps. This policy is applied to incoming
based on the next hop.
For `bgp-direct` redistribution, the following translations are performed:
-*
- The VN address is set to the original unicast route's next hop address.
-*
- The UN address is NOT set. (VN->UN mapping will occur via
+- The VN address is set to the original unicast route's next hop address.
+- The UN address is NOT set. (VN->UN mapping will occur via
ENCAP route or attribute, based on `vnc advertise-un-method`
setting, generated by the RFP registration of the actual NVE)
-*
- The RD is set to as if auto:vn:0 were specified (i.e.,
+- The RD is set to as if auto:vn:0 were specified (i.e.,
`rd_type=IP=1`:`IPv4-address=VN-address`:`two-byte-integer=0`)
-*
- The RT list is included in the extended community list copied from the
+- The RT list is included in the extended community list copied from the
original unicast route (i.e., it must be set in the original unicast route).
-In `nve-group` mode, routes are registered with VNC as
-if they came from an NVE in the nve-group designated in the
-`vnc redistribute nve-group` command. The following
-translations are performed:
+In `nve-group` mode, routes are registered with VNC as if they came from an NVE
+in the nve-group designated in the `vnc redistribute nve-group` command. The
+following translations are performed:
-*
- The next hop/VN address is set to the VN prefix configured for the
- redistribute nve-group.
-*
- The UN address is set to the UN prefix configured for the
+- The next hop/VN address is set to the VN prefix configured for the
redistribute nve-group.
-*
- The RD is set to the RD configured for the redistribute nve-group.
-*
- The RT list is set to the RT list configured for the redistribute nve-group.
- If `bgp-direct` routes are being redistributed,
- any extended communities present in the original unicast route
- will also be included.
-
-In `resolve-nve` mode, the next hop of the original BGP route is
-typically the address of an NVE connected router (CE) connected by one or
-more NVEs.
-Each of the connected NVEs will register, via RFP, a VNC host route
-to the CE.
-This mode may be though of as a mechanism to proxy RFP registrations
-of BGP unicast routes on behalf of registering NVEs.
+- The UN address is set to the UN prefix configured for the redistribute
+ nve-group.
+- The RD is set to the RD configured for the redistribute nve-group.
+- The RT list is set to the RT list configured for the redistribute nve-group.
+ If `bgp-direct` routes are being redistributed, any extended communities
+ present in the original unicast route will also be included.
+
+In `resolve-nve` mode, the next hop of the original BGP route is typically the
+address of an NVE connected router (CE) connected by one or more NVEs.
+Each of the connected NVEs will register, via RFP, a VNC host route to the CE.
+This mode may be though of as a mechanism to proxy RFP registrations of BGP
+unicast routes on behalf of registering NVEs.
Multiple copies of the BGP route, one per matching NVE host route, will be
-added to VNC.
-In other words, for a given BGP unicast route, each instance of a
-RFP-registered host route to the unicast route's next hop will result
-in an instance of an imported VNC route.
-Each such imported VNC route will have a prefix equal to the original
-BGP unicast route's prefix, and a next hop equal to the next hop of the
-matching RFP-registered host route.
-If there is no RFP-registered host route to the next hop of the BGP unicast
-route, no corresponding VNC route will be imported.
+added to VNC. In other words, for a given BGP unicast route, each instance of
+a RFP-registered host route to the unicast route's next hop will result in an
+instance of an imported VNC route. Each such imported VNC route will have a
+prefix equal to the original BGP unicast route's prefix, and a next hop equal
+to the next hop of the matching RFP-registered host route. If there is no
+RFP-registered host route to the next hop of the BGP unicast route, no
+corresponding VNC route will be imported.
The following translations are applied:
-*
- The Next Hop is set to the next hop of the NVE route (i.e., the
+- The Next Hop is set to the next hop of the NVE route (i.e., the
VN address of the NVE).
-*
- The extended community list in the new route is set to the
+- The extended community list in the new route is set to the
union of:
- *
- Any extended communities in the original BGP route
- *
- Any extended communities in the NVE route
- *
- An added route-origin extended community with the next hop of the
+- Any extended communities in the original BGP route
+
+ - Any extended communities in the NVE route
+ - An added route-origin extended community with the next hop of the
original BGP route
is added to the new route.
The value of the local administrator field defaults 5226 but may
be configured by the user via the `roo-ec-local-admin` parameter.
-*
- The Tunnel Encapsulation attribute is set to the value of the Tunnel
+- The Tunnel Encapsulation attribute is set to the value of the Tunnel
Encapsulation attribute of the NVE route, if any.
-`bgp-direct-to-nve-groups` routes
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+bgp-direct-to-nve-groups routes
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-Unicast routes from the main or a designated instance of BGP
-may be redistributed to VNC as bgp-direct-to-nve-groups routes. These
-routes are NOT announced via BGP,
-but they are made available for local RFP lookup in response to
-queries from NVEs.
+Unicast routes from the main or a designated instance of BGP may be
+redistributed to VNC as bgp-direct-to-nve-groups routes. These routes are NOT
+announced via BGP, but they are made available for local RFP lookup in response
+to queries from NVEs.
-A non-main/default BGP instance is configured using the
-`bgp multiple-instance` and `router bgp AS view NAME`
-commands as described elsewhere in this document.
+A non-main/default BGP instance is configured using the `bgp multiple-instance`
+and `router bgp AS view NAME` commands as described elsewhere in this document.
-In order for a route in the unicast BGP RIB to be made
-available to a querying NVE, there must already be, available to
-that NVE, an (interior) VNC route matching the next hop address
-of the unicast route.
-When the unicast route is provided to the NVE, its next hop
-is replaced by the next hop of the corresponding
-NVE. If there are multiple longest-prefix-match VNC routes,
-the unicast route will be replicated for each.
+In order for a route in the unicast BGP RIB to be made available to a querying
+NVE, there must already be, available to that NVE, an (interior) VNC route
+matching the next hop address of the unicast route. When the unicast route is
+provided to the NVE, its next hop is replaced by the next hop of the
+corresponding NVE. If there are multiple longest-prefix-match VNC routes, the
+unicast route will be replicated for each.
-There is currently no policy (prefix-list or route-map) support
-for `bgp-direct-to-nve-groups` routes.
+There is currently no policy (prefix-list or route-map) support for
+`bgp-direct-to-nve-groups` routes.
Redistribution Command Syntax
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-.. index:: {VNC} {vnc redistribute ipv4|ipv6 bgp|bgp-direct|ipv6 bgp-direct-to-nve-groups|connected|kernel|ospf|rip|static} {}
+.. index:: vnc redistribute ipv4|ipv6 bgp|bgp-direct|ipv6 bgp-direct-to-nve-groups|connected|kernel|ospf|rip|static
+.. clicmd:: vnc redistribute ipv4|ipv6 bgp|bgp-direct|ipv6 bgp-direct-to-nve-groups|connected|kernel|ospf|rip|static
-{VNC} {vnc redistribute ipv4|ipv6 bgp|bgp-direct|ipv6 bgp-direct-to-nve-groups|connected|kernel|ospf|rip|static} {}
-.. index:: {VNC} {vnc redistribute ipv4|ipv6 bgp-direct-to-nve-groups view `VIEWNAME`} {}
+.. index:: vnc redistribute ipv4|ipv6 bgp-direct-to-nve-groups view VIEWNAME
+.. clicmd:: vnc redistribute ipv4|ipv6 bgp-direct-to-nve-groups view VIEWNAME
-{VNC} {vnc redistribute ipv4|ipv6 bgp-direct-to-nve-groups view `VIEWNAME`} {}
-.. index:: {VNC} {no vnc redistribute ipv4|ipv6 bgp|bgp-direct|bgp-direct-to-nve-groups|connected|kernel|ospf|rip|static} {}
+.. index:: no vnc redistribute ipv4|ipv6 bgp|bgp-direct|bgp-direct-to-nve-groups|connected|kernel|ospf|rip|static
+.. clicmd:: no vnc redistribute ipv4|ipv6 bgp|bgp-direct|bgp-direct-to-nve-groups|connected|kernel|ospf|rip|static
-{VNC} {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 (`bgp`, `bgp-direct`,
- `bgp-direct-to-nve-groups`, `connected`,
- `kernel`, `ospf`, `rip`, or `static`). Repeat
- this statement as needed for each combination of address family and
- routing protocol.
- Prefixes from protocol `bgp-direct` are imported from unicast BGP
- in the same bgpd process.
- Prefixes from all other protocols (including `bgp`) are imported
- via the `zebra` kernel routing process.
-.. index:: {VNC} {vnc redistribute mode plain|nve-group|resolve-nve}
+ Import (or do not import) prefixes from another routing protocols. Specify
+ both the address family to import (`ipv4` or `ipv6`) and the protocol
+ (`bgp`, `bgp-direct`, `bgp-direct-to-nve-groups`, `connected`, `kernel`,
+ `ospf`, `rip`, or `static`). Repeat this statement as needed for each
+ combination of address family and routing protocol. Prefixes from protocol
+ `bgp-direct` are imported from unicast BGP in the same bgpd process.
+ Prefixes from all other protocols (including `bgp`) are imported via the
+ `zebra` kernel routing process.
-{VNC} {vnc redistribute mode plain|nve-group|resolve-nve}
- Redistribute routes from other protocols into VNC using the
- specified mode.
- Not all combinations of modes and protocols are supported.
+.. index:: vnc redistribute mode plain|nve-group|resolve-nve
+.. clicmd:: vnc redistribute mode plain|nve-group|resolve-nve
-.. index:: {VNC} {vnc redistribute nve-group `group-name`} {}
-{VNC} {vnc redistribute nve-group `group-name`} {}
-.. index:: {VNC} {no vnc redistribute nve-group `group-name`} {}
+ Redistribute routes from other protocols into VNC using the specified mode.
+ Not all combinations of modes and protocols are supported.
-{VNC} {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. `group-name`
- must be configured using `vnc nve-group`.
+.. index:: vnc redistribute nve-group GROUP-NAME
+.. clicmd:: vnc redistribute nve-group GROUP-NAME
- The VN and UN prefixes of the nve-group must both be configured,
- and each prefix must be specified as a full-length (/32 for IPv4,
- /128 for IPv6) prefix.
+.. index:: no vnc redistribute nve-group GROUP-NAME
+.. clicmd:: no vnc redistribute nve-group GROUP-NAME
-.. index:: {VNC} {vnc redistribute lifetime `lifetime`|infinite} {}
-{VNC} {vnc redistribute lifetime `lifetime`|infinite} {}
- Assign a registration lifetime, either `lifetime` seconds or
- `infinite`, to prefixes redistributed from other routing
- protocols as if they had been received via RFP registration messages
- from an NVE. `lifetime` can be any integer between 1 and
- 4294967295, inclusive.
+ When using `nve-group` mode, assign (or do not assign) the NVE group
+ `group-name` to routes redistributed from another routing protocol.
+ `group-name` must be configured using `vnc nve-group`.
-.. index:: {VNC} {vnc redistribute resolve-nve roo-ec-local-admin `0-65536`}
+ The VN and UN prefixes of the nve-group must both be configured, and each
+ prefix must be specified as a full-length (/32 for IPv4, /128 for IPv6)
+ prefix.
-{VNC} {vnc redistribute resolve-nve roo-ec-local-admin `0-65536`}
- Assign a value to the local-administrator subfield used in the
- Route Origin extended community that is assigned to routes exported
- under the `resolve-nve` mode. The default value is `5226`.
+.. index:: vnc redistribute lifetime LIFETIME|infinite
+.. clicmd:: vnc redistribute lifetime LIFETIME|infinite
- The following four `prefix-list` and `route-map` commands
- may be specified in the context of an nve-group or not.
- If they are specified in the context of an nve-group, they
- apply only if the redistribution mode is `nve-group`,
- and then only for routes being redistributed from
- `bgp-direct`.
- If they are specified outside the context of an nve-group, then
- they apply only for redistribution modes `plain` and `resolve-nve`,
- and then only for routes being redistributed from `bgp-direct`.
-.. index:: {VNC} {vnc redistribute bgp-direct (ipv4|ipv6) prefix-list `LIST-NAME`}
+ Assign a registration lifetime, either `lifetime` seconds or `infinite`, to
+ prefixes redistributed from other routing protocols as if they had been
+ received via RFP registration messages from an NVE. `lifetime` can be any
+ integer between 1 and 4294967295, inclusive.
-{VNC} {vnc redistribute bgp-direct (ipv4|ipv6) prefix-list `LIST-NAME`}
- When redistributing `bgp-direct` routes,
- specifies that the named prefix-list should be applied.
+.. index:: vnc redistribute resolve-nve roo-ec-local-admin 0-65536
+.. clicmd:: vnc redistribute resolve-nve roo-ec-local-admin 0-65536
-.. index:: {VNC} {vnc redistribute bgp-direct no (ipv4|ipv6) prefix-list}
-{VNC} {vnc redistribute bgp-direct no (ipv4|ipv6) prefix-list}
- When redistributing `bgp-direct` routes,
- specifies that no prefix-list should be applied.
+ Assign a value to the local-administrator subfield used in the
+ Route Origin extended community that is assigned to routes exported
+ under the `resolve-nve` mode. The default value is `5226`.
-.. index:: {VNC} {vnc redistribute bgp-direct route-map `MAP-NAME`}
+The following four `prefix-list` and `route-map` commands may be specified
+in the context of an nve-group or not. If they are specified in the context
+of an nve-group, they apply only if the redistribution mode is `nve-group`,
+and then only for routes being redistributed from `bgp-direct`. If they are
+specified outside the context of an nve-group, then they apply only for
+redistribution modes `plain` and `resolve-nve`, and then only for routes
+being redistributed from `bgp-direct`.
-{VNC} {vnc redistribute bgp-direct route-map `MAP-NAME`}
- When redistributing `bgp-direct` routes,
- specifies that the named route-map should be applied.
+.. index:: vnc redistribute bgp-direct (ipv4|ipv6) prefix-list LIST-NAME
+.. clicmd:: vnc redistribute bgp-direct (ipv4|ipv6) prefix-list LIST-NAME
-.. index:: {VNC} {vnc redistribute bgp-direct no route-map}
+ When redistributing `bgp-direct` routes,
+ specifies that the named prefix-list should be applied.
-{VNC} {vnc redistribute bgp-direct no route-map}
- When redistributing `bgp-direct` routes,
- specifies that no route-map should be applied.
+.. index:: vnc redistribute bgp-direct no (ipv4|ipv6) prefix-list
+.. clicmd:: vnc redistribute bgp-direct no (ipv4|ipv6) prefix-list
+
+ When redistributing `bgp-direct` routes,
+ specifies that no prefix-list should be applied.
+
+.. index:: vnc redistribute bgp-direct route-map MAP-NAME
+.. clicmd:: vnc redistribute bgp-direct route-map MAP-NAME
+
+ When redistributing `bgp-direct` routes,
+ specifies that the named route-map should be applied.
+
+.. index:: vnc redistribute bgp-direct no route-map
+.. clicmd:: vnc redistribute bgp-direct no route-map
+
+ When redistributing `bgp-direct` routes,
+ specifies that no route-map should be applied.
.. _Configuring_Export_of_Routes_to_Other_Routing_Protocols:
Configuring Export of Routes to Other Routing Protocols
-------------------------------------------------------
-Routes from VNC (both for RFP and for redistribution via BGP) can be
-provided to other protocols, either via zebra or directly to BGP.
-
-It is important to note that when exporting routes to other protocols,
-the downstream protocol must also be configured to import the routes.
-For example, when VNC routes are exported to unicast BGP, the BGP
-configuration must include a corresponding `redistribute vnc-direct`
-statement.
-
-.. index:: {VNC} {export bgp|zebra mode none|group-nve|registering-nve|ce}
-
-{VNC} {export bgp|zebra mode none|group-nve|registering-nve|ce}
- Specify how routes should be exported to bgp or zebra.
- If the mode is `none`, routes are not exported.
- If the mode is `group-nve`, routes are exported according
- to nve-group or vrf-policy group configuration (:ref:`VNC_NVE_Group_Configuration`): if a group is configured to
- allow export, then each prefix visible to the group is exported
- with next hops set to the currently-registered NVEs.
- If the mode is `registering-nve`, then all VNC routes are
- exported with their original next hops.
- If the mode is `ce`, only VNC routes that have an NVE connected CE Router
- encoded in a Route Origin Extended Community are exported.
- This extended community must have an administrative value that
- matches the configured `roo-ec-local-admin` value.
- The next hop of the exported route is set to the encoded
- NVE connected CE Router.
+Routes from VNC (both for RFP and for redistribution via BGP) can be provided
+to other protocols, either via zebra or directly to BGP.
+
+It is important to note that when exporting routes to other protocols, the
+downstream protocol must also be configured to import the routes. For example,
+when VNC routes are exported to unicast BGP, the BGP configuration must include
+a corresponding `redistribute vnc-direct` statement.
+
+.. index:: export bgp|zebra mode none|group-nve|registering-nve|ce
+.. clicmd:: export bgp|zebra mode none|group-nve|registering-nve|ce
+
+
+ Specify how routes should be exported to bgp or zebra. If the mode is
+ `none`, routes are not exported. If the mode is `group-nve`, routes are
+ exported according to nve-group or vrf-policy group configuration
+ (:ref:`VNC_NVE_Group_Configuration`): if a group is configured to allow
+ export, then each prefix visible to the group is exported with next hops set
+ to the currently-registered NVEs. If the mode is `registering-nve`, then all
+ VNC routes are exported with their original next hops. If the mode is `ce`,
+ only VNC routes that have an NVE connected CE Router encoded in a Route
+ Origin Extended Community are exported. This extended community must have an
+ administrative value that matches the configured `roo-ec-local-admin` value.
+ The next hop of the exported route is set to the encoded NVE connected CE
+ Router.
The default for both bgp and zebra is mode `none`.
-.. index:: {VNC} {vnc export bgp|zebra group-nve group `group-name`}
+.. index:: vnc export bgp|zebra group-nve group GROUP-NAME
+.. clicmd:: vnc export bgp|zebra group-nve group GROUP-NAME
-{VNC} {vnc export bgp|zebra group-nve group `group-name`}
-.. index:: {VNC} {vnc export bgp|zebra group-nve no group `group-name`}
+.. index:: vnc export bgp|zebra group-nve no group GROUP-NAME
+.. clicmd:: vnc export bgp|zebra group-nve no group GROUP-NAME
-{VNC} {vnc export bgp|zebra group-nve no group `group-name`}
- When export mode is `group-nve`,
- export (or do not export) prefixes from the specified nve-group or
- vrf-policy group
- to unicast BGP or to zebra.
- Repeat this statement as needed for each nve-group to be exported.
- Each VNC prefix that is exported will result in N exported routes to the
- prefix, each with a next hop corresponding to one of the N NVEs currently
- associated with the nve-group.
+ When export mode is `group-nve`, export (or do not export) prefixes from the
+ specified nve-group or vrf-policy group to unicast BGP or to zebra. Repeat
+ this statement as needed for each nve-group to be exported. Each VNC prefix
+ that is exported will result in N exported routes to the prefix, each with a
+ next hop corresponding to one of the N NVEs currently associated with the
+ nve-group.
-.. index:: {VNC} export bgp|zebra ipv4|ipv6 prefix-list LIST-NAME
+.. index:: export bgp|zebra ipv4|ipv6 prefix-list LIST-NAME
+.. clicmd:: export bgp|zebra ipv4|ipv6 prefix-list LIST-NAME
-{VNC} export bgp|zebra ipv4|ipv6 prefix-list LIST-NAME
- When export mode is `ce` or `registering-nve`,
- specifies that the named prefix-list should be applied to routes
- being exported to bgp or zebra.
- Prefix-lists for ipv4 and ipv6 are independent of each other.
+ When export mode is `ce` or `registering-nve`,
+ specifies that the named prefix-list should be applied to routes
+ being exported to bgp or zebra.
+ Prefix-lists for ipv4 and ipv6 are independent of each other.
-.. index:: {VNC} export bgp|zebra no ipv4|ipv6 prefix-list
+.. index:: export bgp|zebra no ipv4|ipv6 prefix-list
+.. clicmd:: export bgp|zebra no ipv4|ipv6 prefix-list
-{VNC} export bgp|zebra no ipv4|ipv6 prefix-list
When export mode is `ce` or `registering-nve`,
specifies that no prefix-list should be applied to routes
being exported to bgp or zebra.
-.. index:: {VNC} export bgp|zebra route-map MAP-NAME
+.. index:: export bgp|zebra route-map MAP-NAME
+.. clicmd:: export bgp|zebra route-map MAP-NAME
-{VNC} export bgp|zebra route-map MAP-NAME
- When export mode is `ce` or `registering-nve`,
- specifies that the named route-map should be applied to routes
- being exported to bgp or zebra.
-.. index:: {VNC} export bgp|zebra no route-map
+ When export mode is `ce` or `registering-nve`, specifies that the named
+ route-map should be applied to routes being exported to bgp or zebra.
-{VNC} export bgp|zebra no route-map
- When export mode is `ce` or `registering-nve`,
- specifies that no route-map should be applied to routes
- being exported to bgp or zebra.
+.. index:: export bgp|zebra no route-map
+.. clicmd:: export bgp|zebra no route-map
- When the export mode is `group-nve`, policy for exported
- routes is specified per-NVE-group or vrf-policy group inside a `nve-group` `RFG-NAME` block
- via the following commands(:ref:`VNC_NVE_Group_Configuration`):
+ When export mode is `ce` or `registering-nve`, specifies that no route-map
+ should be applied to routes being exported to bgp or zebra.
-.. index:: {VNC} {export bgp|zebra route-map MAP-NAME}
+ When the export mode is `group-nve`, policy for exported routes is specified
+ per-NVE-group or vrf-policy group inside a `nve-group` `RFG-NAME` block via
+ the following commands(:ref:`VNC_NVE_Group_Configuration`):
-{VNC} {export bgp|zebra route-map MAP-NAME}
- This command is valid inside a `nve-group` `RFG-NAME` block.
- It specifies that the named route-map should be applied to routes
- being exported to bgp or zebra.
+.. index:: export bgp|zebra route-map MAP-NAME
+.. clicmd:: export bgp|zebra route-map MAP-NAME
-.. index:: {VNC} {export bgp|zebra no route-map}
+ This command is valid inside a `nve-group` `RFG-NAME` block. It specifies
+ that the named route-map should be applied to routes being exported to bgp
+ or zebra.
-{VNC} {export bgp|zebra no route-map}
- This command is valid inside a `nve-group` `RFG-NAME` block.
- It specifies that no route-map should be applied to routes
- being exported to bgp or zebra.
+.. index:: export bgp|zebra no route-map
+.. clicmd:: export bgp|zebra no route-map
-.. index:: {VNC} {export bgp|zebra ipv4|ipv6 prefix-list LIST-NAME}
+ This command is valid inside a `nve-group` `RFG-NAME` block. It specifies
+ that no route-map should be applied to routes being exported to bgp or
+ zebra.
-{VNC} {export bgp|zebra ipv4|ipv6 prefix-list LIST-NAME}
- This command is valid inside a `nve-group` `RFG-NAME` block.
- It specifies that the named prefix-list filter should be applied to
- routes being exported to bgp or zebra.
- Prefix-lists for ipv4 and ipv6 are independent of each other.
+.. index:: export bgp|zebra ipv4|ipv6 prefix-list LIST-NAME
+.. clicmd:: export bgp|zebra ipv4|ipv6 prefix-list LIST-NAME
-.. index:: {VNC} {export bgp|zebra no ipv4|ipv6 prefix-list}
+ This command is valid inside a `nve-group` `RFG-NAME` block. It specifies
+ that the named prefix-list filter should be applied to routes being exported
+ to bgp or zebra. Prefix-lists for ipv4 and ipv6 are independent of each
+ other.
-{VNC} {export bgp|zebra no ipv4|ipv6 prefix-list}
- This command is valid inside a `nve-group` `RFG-NAME` block.
- It specifies that no prefix-list filter should be applied to
- routes being exported to bgp or zebra.
+.. index:: export bgp|zebra no ipv4|ipv6 prefix-list
+
+.. clicmd:: export bgp|zebra no ipv4|ipv6 prefix-list
+
+ This command is valid inside a `nve-group` `RFG-NAME` block. It specifies
+ that no prefix-list filter should be applied to routes being exported to
+ bgp or zebra.
.. _Manual_Address_Control:
Manual Address Control
======================
-The commands in this section can be used to augment normal dynamic VNC.
-The `add vnc` commands can be used to manually add IP prefix or
-Ethernet MAC address forwarding information. The `clear vnc`
-commands can be used to remove manually and dynamically added
-information.
-
-.. index:: {Command} {add vnc prefix (A.B.C.D/M|X:X::X:X/M) vn (A.B.C.D|X:X::X:X) un (A.B.C.D|X:X::X:X) [cost (0-255)] [lifetime (infinite|(1-4294967295))] [local-next-hop (A.B.C.D|X:X::X:X) [local-cost (0-255)]]} {}
-
-{Command} {add vnc prefix (A.B.C.D/M|X:X::X:X/M) vn (A.B.C.D|X:X::X:X) un (A.B.C.D|X:X::X:X) [cost (0-255)] [lifetime (infinite|(1-4294967295))] [local-next-hop (A.B.C.D|X:X::X:X) [local-cost (0-255)]]} {}
- Register an IP prefix on behalf of the NVE identified by the VN and UN
- addresses. The `cost` parameter provides the administrative
- preference of the forwarding information for remote advertisement. If
- omitted, it defaults to 255 (lowest preference). The `lifetime`
- parameter identifies the period, in seconds, that the information
- remains valid. If omitted, it defaults to `infinite`. The optional
- `local-next-hop` parameter is used to configure a nexthop to be
- used by an NVE to reach the prefix via a locally connected CE router.
- This information remains local to the NVA, i.e., not passed to other
- NVAs, and is only passed to registered NVEs. When specified, it is also
- possible to provide a `local-cost` parameter to provide a
- forwarding preference. If omitted, it defaults to 255 (lowest
- preference).
-
-.. index:: {Command} {add vnc mac xx:xx:xx:xx:xx:xx virtual-network-identifier (1-4294967295) vn (A.B.C.D|X:X::X:X) un (A.B.C.D|X:X::X:X) [prefix (A.B.C.D/M|X:X::X:X/M)] [cost (0-255)] [lifetime (infinite|(1-4294967295))]} {}
-
-{Command} {add vnc mac xx:xx:xx:xx:xx:xx virtual-network-identifier (1-4294967295) vn (A.B.C.D|X:X::X:X) un (A.B.C.D|X:X::X:X) [prefix (A.B.C.D/M|X:X::X:X/M)] [cost (0-255)] [lifetime (infinite|(1-4294967295))]} {}
- Register a MAC address for a logical Ethernet (L2VPN) on behalf of the
- NVE identified by the VN and UN addresses.
- The optional `prefix` parameter is to support enable IP address
- mediation for the given prefix. The `cost` parameter provides the administrative
- preference of the forwarding information. If omitted, it defaults to
- 255. The `lifetime` parameter identifies the period, in seconds,
- that the information remains valid. If omitted, it defaults to
- `infinite`.
-
-.. index:: {Command} {clear vnc prefix (*|A.B.C.D/M|X:X::X:X/M) (*|[(vn|un) (A.B.C.D|X:X::X:X|*) [(un|vn) (A.B.C.D|X:X::X:X|*)] [mac xx:xx:xx:xx:xx:xx] [local-next-hop (A.B.C.D|X:X::X:X)])} {}
-
-{Command} {clear vnc prefix (*|A.B.C.D/M|X:X::X:X/M) (*|[(vn|un) (A.B.C.D|X:X::X:X|*) [(un|vn) (A.B.C.D|X:X::X:X|*)] [mac xx:xx:xx:xx:xx:xx] [local-next-hop (A.B.C.D|X:X::X:X)])} {}
- Delete the information identified by prefix, VN address, and UN address.
- Any or all of these parameters may be wilcarded to (potentially) match
- more than one registration.
- The optional `mac` parameter specifies a layer-2 MAC address
- that must match the registration(s) to be deleted.
- The optional `local-next-hop` parameter is used to
- delete specific local nexthop information.
-
-.. index:: {Command} {clear vnc mac (*|xx:xx:xx:xx:xx:xx) virtual-network-identifier (*|(1-4294967295)) (*|[(vn|un) (A.B.C.D|X:X::X:X|*) [(un|vn) (A.B.C.D|X:X::X:X|*)] [prefix (*|A.B.C.D/M|X:X::X:X/M)])} {}
-
-{Command} {clear vnc mac (*|xx:xx:xx:xx:xx:xx) virtual-network-identifier (*|(1-4294967295)) (*|[(vn|un) (A.B.C.D|X:X::X:X|*) [(un|vn) (A.B.C.D|X:X::X:X|*)] [prefix (*|A.B.C.D/M|X:X::X:X/M)])} {}
- Delete mac forwarding information.
- Any or all of these parameters may be wilcarded to (potentially) match
- more than one registration.
- The default value for the `prefix` parameter is the wildcard value `*`.
-
-.. index:: {Command} {clear vnc nve (*|((vn|un) (A.B.C.D|X:X::X:X) [(un|vn) (A.B.C.D|X:X::X:X)])) } {}
-
-{Command} {clear vnc nve (*|((vn|un) (A.B.C.D|X:X::X:X) [(un|vn) (A.B.C.D|X:X::X:X)])) } {}
- Delete prefixes associated with the NVE specified by the given VN and UN
- addresses.
- It is permissible to specify only one of VN or UN, in which case
- any matching registration will be deleted.
- It is also permissible to specify `*` in lieu of any VN or UN
- address, in which case all registrations will match.
+The commands in this section can be used to augment normal dynamic VNC. The
+`add vnc` commands can be used to manually add IP prefix or Ethernet MAC
+address forwarding information. The `clear vnc` commands can be used to remove
+manually and dynamically added information.
+
+.. clicmd:: add vnc prefix (A.B.C.D/M|X:X::X:X/M) vn (A.B.C.D|X:X::X:X) un (A.B.C.D|X:X::X:X) [cost (0-255)] [lifetime (infinite|(1-4294967295))] [local-next-hop (A.B.C.D|X:X::X:X) [local-cost (0-255)]]
+
+ Register an IP prefix on behalf of the NVE identified by the VN and UN
+ addresses. The `cost` parameter provides the administrative preference of
+ the forwarding information for remote advertisement. If omitted, it defaults
+ to 255 (lowest preference). The `lifetime` parameter identifies the period,
+ in seconds, that the information remains valid. If omitted, it defaults to
+ `infinite`. The optional `local-next-hop` parameter is used to configure a
+ nexthop to be used by an NVE to reach the prefix via a locally connected CE
+ router. This information remains local to the NVA, i.e., not passed to other
+ NVAs, and is only passed to registered NVEs. When specified, it is also
+ possible to provide a `local-cost` parameter to provide a forwarding
+ preference. If omitted, it defaults to 255 (lowest preference).
+
+.. clicmd:: add vnc mac xx:xx:xx:xx:xx:xx virtual-network-identifier (1-4294967295) vn (A.B.C.D|X:X::X:X) un (A.B.C.D|X:X::X:X) [prefix (A.B.C.D/M|X:X::X:X/M)] [cost (0-255)] [lifetime (infinite|(1-4294967295))]
+
+ Register a MAC address for a logical Ethernet (L2VPN) on behalf of the NVE
+ identified by the VN and UN addresses. The optional `prefix` parameter is to
+ support enable IP address mediation for the given prefix. The `cost`
+ parameter provides the administrative preference of the forwarding
+ information. If omitted, it defaults to 255. The `lifetime` parameter
+ identifies the period, in seconds, that the information remains valid. If
+ omitted, it defaults to `infinite`.
+
+.. clicmd:: clear vnc prefix (\*|A.B.C.D/M|X:X::X:X/M) (\*|[(vn|un) (A.B.C.D|X:X::X:X|\*) [(un|vn) (A.B.C.D|X:X::X:X|\*)] [mac xx:xx:xx:xx:xx:xx] [local-next-hop (A.B.C.D|X:X::X:X)])
+
+ Delete the information identified by prefix, VN address, and UN address.
+ Any or all of these parameters may be wilcarded to (potentially) match more
+ than one registration. The optional `mac` parameter specifies a layer-2 MAC
+ address that must match the registration(s) to be deleted. The optional
+ `local-next-hop` parameter is used to delete specific local nexthop
+ information.
+
+.. index:: clear vnc mac (\\*|xx:xx:xx:xx:xx:xx) virtual-network-identifier (\\*|(1-4294967295)) (\\*|[(vn|un) (A.B.C.D|X:X::X:X|\\*) [(un|vn) (A.B.C.D|X:X::X:X|\*)] [prefix (\\*|A.B.C.D/M|X:X::X:X/M)])
+.. clicmd:: clear vnc mac (\*|xx:xx:xx:xx:xx:xx) virtual-network-identifier (\*|(1-4294967295)) (\*|[(vn|un) (A.B.C.D|X:X::X:X|\*) [(un|vn) (A.B.C.D|X:X::X:X|\*)] [prefix (\*|A.B.C.D/M|X:X::X:X/M)])
+
+ Delete mac forwarding information. Any or all of these parameters may be
+ wilcarded to (potentially) match more than one registration. The default
+ value for the `prefix` parameter is the wildcard value `*`.
+
+.. index:: clear vnc nve (\*|((vn|un) (A.B.C.D|X:X::X:X) [(un|vn) (A.B.C.D|X:X::X:X)]))
+.. clicmd:: clear vnc nve (\*|((vn|un) (A.B.C.D|X:X::X:X) [(un|vn) (A.B.C.D|X:X::X:X)]))
+
+ Delete prefixes associated with the NVE specified by the given VN and UN
+ addresses. It is permissible to specify only one of VN or UN, in which case
+ any matching registration will be deleted. It is also permissible to specify
+ `*` in lieu of any VN or UN address, in which case all registrations will
+ match.
.. _Other_VNC-Related_Commands:
Other VNC-Related Commands
==========================
-Note: VNC-Related configuration can be obtained via the `show running-configuration` command when in `enable` mode.
+Note: VNC-Related configuration can be obtained via the `show
+running-configuration` command when in `enable` mode.
+
+The following commands are used to clear and display Virtual Network Control
+related information:
-The following commands are used to clear and display
-Virtual Network Control related information:
+.. index:: clear vnc counters
+.. clicmd:: clear vnc counters
-.. index:: {COMMAND} {clear vnc counters} {}
+ Reset the counter values stored by the NVA. Counter
+ values can be seen using the `show vnc` commands listed above. This
+ command is only available in `enable` mode.
-{COMMAND} {clear vnc counters} {}
- Reset the counter values stored by the NVA. Counter
- values can be seen using the `show vnc` commands listed above. This
- command is only available in `enable` mode.
+.. index:: show vnc summary
+.. clicmd:: show vnc summary
-.. index:: {Command} {show vnc summary} {}
+ Print counter values and other general information
+ about the NVA. Counter values can be reset
+ using the `clear vnc counters` command listed below.
-{Command} {show vnc summary} {}
- Print counter values and other general information
- about the NVA. Counter values can be reset
- using the `clear vnc counters` command listed below.
+.. index:: show vnc nves
+.. clicmd:: show vnc nves
-.. index:: {Command} {show vnc nves} {}
+.. index:: show vnc nves vn|un ADDRESS
+.. clicmd:: show vnc nves vn|un ADDRESS
-{Command} {show vnc nves} {}
-.. index:: {Command} {show vnc nves vn|un `address`} {}
+ Display the NVA's current clients. Specifying `address` limits the output to
+ the NVEs whose addresses match `address`. The time since the NVA last
+ communicated with the NVE, per-NVE summary counters and each NVE's addresses
+ will be displayed.
-{Command} {show vnc nves vn|un `address`} {}
- Display the NVA's current clients. Specifying `address`
- limits the output to the NVEs whose addresses match `address`.
- The time since the NVA last communicated with the NVE, per-NVE
- summary counters and each NVE's addresses will be displayed.
+.. index:: show vnc queries
+.. clicmd:: show vnc queries
-.. index:: {Command} {show vnc queries} {}
+.. index:: show vnc queries PREFIX
+.. clicmd:: show vnc queries PREFIX
-{Command} {show vnc queries} {}
-.. index:: {Command} {show vnc queries `prefix`} {}
+ Display active Query information. Queries remain valid for the default
+ Response Lifetime (:ref:`VNC_Defaults_Configuration`) or NVE-group Response
+ Lifetime (:ref:`VNC_NVE_Group_Configuration`). Specifying `prefix` limits
+ the output to Query Targets that fall within `prefix`.
-{Command} {show vnc queries `prefix`} {}
- Display active Query information. Queries remain valid for the default
- Response Lifetime (:ref:`VNC_Defaults_Configuration`) or NVE-group
- Response Lifetime (:ref:`VNC_NVE_Group_Configuration`). Specifying
- `prefix` limits the output to Query Targets that fall within
- `prefix`.
+ Query information is provided for each querying NVE, and includes the Query
+ Target and the time remaining before the information is removed.
- Query information is provided for each querying NVE, and includes the
- Query Target and the time remaining before the information is removed.
+.. index:: show vnc registrations [all|local|remote|holddown|imported]
+.. clicmd:: show vnc registrations [all|local|remote|holddown|imported]
-.. index:: {Command} {show vnc registrations [all|local|remote|holddown|imported]} {}
+.. index:: show vnc registrations [all|local|remote|holddown|imported] PREFIX
+.. clicmd:: show vnc registrations [all|local|remote|holddown|imported] PREFIX
-{Command} {show vnc registrations [all|local|remote|holddown|imported]} {}
-.. index:: {Command} {show vnc registrations [all|local|remote|holddown|imported] `prefix`} {}
+ Display local, remote, holddown, and/or imported registration information.
+ Local registrations are routes received via RFP, which are present in the
+ NVA Registrations Cache. Remote registrations are routes received via BGP
+ (VPN SAFIs), which are present in the NVE-group import tables. Holddown
+ registrations are local and remote routes that have been withdrawn but whose
+ holddown timeouts have not yet elapsed. Imported information represents
+ routes that are imported into NVA and are made available to querying NVEs.
+ Depending on configuration, imported routes may also be advertised via BGP.
+ Specifying `prefix` limits the output to the registered prefixes that fall
+ within `prefix`.
-{Command} {show vnc registrations [all|local|remote|holddown|imported] `prefix`} {}
- Display local, remote, holddown, and/or imported registration information.
- Local registrations are routes received via RFP, which are present in the
- NVA Registrations Cache.
- Remote registrations are routes received via BGP (VPN SAFIs), which
- are present in the NVE-group import tables.
- Holddown registrations are local and remote routes that have been
- withdrawn but whose holddown timeouts have not yet elapsed.
- Imported information represents routes that are imported into NVA and
- are made available to querying NVEs. Depending on configuration,
- imported routes may also be advertised via BGP.
- Specifying `prefix` limits the output to the registered prefixes that
- fall within `prefix`.
+ Registration information includes the registered prefix, the registering NVE
+ addresses, the registered administrative cost, the registration lifetime and
+ the time since the information was registered or, in the case of Holddown
+ registrations, the amount of time remaining before the information is
+ removed.
- Registration information includes the registered prefix, the registering
- NVE addresses, the registered administrative cost, the registration
- lifetime and the time since the information was registered or, in the
- case of Holddown registrations, the amount of time remaining before the
- information is removed.
+.. index:: show vnc responses [active|removed]
+.. clicmd:: show vnc responses [active|removed]
-.. index:: {Command} {show vnc responses [active|removed]} {}
+.. index:: show vnc responses [active|removed] PREFIX
+.. clicmd:: show vnc responses [active|removed] PREFIX
-{Command} {show vnc responses [active|removed]} {}
-.. index:: {Command} {show vnc responses [active|removed] `prefix`} {}
+ Display all, active and/or removed response information which are
+ present in the NVA Responses Cache. Responses remain valid for the
+ default Response Lifetime (:ref:`VNC_Defaults_Configuration`) or
+ NVE-group Response Lifetime (:ref:`VNC_NVE_Group_Configuration`.)
+ When Removal Responses are enabled (:ref:`General_VNC_Configuration`),
+ such responses are listed for the Response Lifetime. Specifying
+ `prefix` limits the output to the addresses that fall within
+ `prefix`.
-{Command} {show vnc responses [active|removed] `prefix`} {}
- Display all, active and/or removed response information which are
- present in the NVA Responses Cache. Responses remain valid for the
- default Response Lifetime (:ref:`VNC_Defaults_Configuration`) or
- NVE-group Response Lifetime (:ref:`VNC_NVE_Group_Configuration`.)
- When Removal Responses are enabled (:ref:`General_VNC_Configuration`),
- such responses are listed for the Response Lifetime. Specifying
- `prefix` limits the output to the addresses that fall within
- `prefix`.
+ Response information is provided for each querying NVE, and includes
+ the response prefix, the prefix-associated registering NVE addresses,
+ the administrative cost, the provided response lifetime and the time
+ remaining before the information is to be removed or will become inactive.
- Response information is provided for each querying NVE, and includes
- the response prefix, the prefix-associated registering NVE addresses,
- the administrative cost, the provided response lifetime and the time
- remaining before the information is to be removed or will become inactive.
+.. index:: show memory vnc
+.. clicmd:: show memory vnc
-.. index:: {Command} {show memory vnc} {}
-{Command} {show memory vnc} {}
- Print the number of memory items allocated by the NVA.
+ Print the number of memory items allocated by the NVA.
.. _Example_VNC_and_VNC-GW_Configurations:
Example VNC and VNC-GW Configurations
=====================================
+.. [#] The nve-id is carriedin the route distinguisher. It is the second octet
+ of the eight-octet route distinguisher generated for Ethernet / L2
+ advertisements. The first octet is a constant 0xFF, and the third
+ through eighth octets are set to the L2
+ ethernet address being advertised.
VTY shell
*********
-*vtysh* provides a combined frontend to all FRR daemons in a
-single combined session. It is enabled by default at build time, but can
-be disabled through the *--disable-vtysh* option to
-*./configure*.
-
-*vtysh* has a configuration file, :file:`vtysh.conf`. The location
-of that file cannot be changed from :file:`|INSTALL_PREFIX_ETC|` since
-it contains options controlling authentication behavior. This file will
-also not be written by configuration-save commands, it is intended to be
-updated manually by an administrator with an external editor.
-
-@quotation Warning
-This also means the *hostname* and *banner motd* commands
-(which both do have effect for vtysh) need to be manually updated in
-:file:`vtysh.conf`.
-@end quotation
+.. program:: configure
+
+*vtysh* provides a combined frontend to all FRR daemons in a single combined
+session. It is enabled by default at build time, but can be disabled through
+the :option:`--disable-vtysh` option to the configure script.
+
+*vtysh* has a configuration file, :file:`vtysh.conf`. The location of that
+file cannot be changed from |INSTALL_PREFIX_ETC| since it contains options
+controlling authentication behavior. This file will also not be written by
+configuration-save commands, it is intended to be updated manually by an
+administrator with an external editor.
+
+.. warning::
+
+ This also means the ``hostname`` and ``banner motd`` commands (which both do
+ have effect for vtysh) need to be manually updated in :file:`vtysh.conf`.
+
Permissions and setup requirements
==================================
*vtysh* connects to running daemons through Unix sockets located in
-:file:`|INSTALL_PREFIX_STATE|`. Running vtysh thus requires access to
-that directory, plus membership in the *|INSTALL_VTY_GROUP|*
-group (which is the group that the daemons will change ownership of their
-sockets to).
+|INSTALL_PREFIX_STATE|. Running vtysh thus requires access to that directory,
+plus membership in the |INSTALL_VTY_GROUP| group (which is the group that the
+daemons will change ownership of their sockets to).
-To restrict access to FRR configuration, make sure no unauthorized users
-are members of the *|INSTALL_VTY_GROUP|* group.
+To restrict access to FRR configuration, make sure no unauthorized users are
+members of the |INSTALL_VTY_GROUP| group.
PAM support (experimental)
--------------------------
-vtysh has working (but rather useless) PAM support. It will perform
-an "authenticate" PAM call using *|PACKAGE_NAME|* as service
-name. No other (accounting, session, password change) calls will be
-performed by vtysh.
+vtysh has working (but rather useless) PAM support. It will perform an
+"authenticate" PAM call using |PACKAGE_NAME| as service name. No other
+(accounting, session, password change) calls will be performed by vtysh.
+
+Users using vtysh still need to have appropriate access to the daemons' VTY
+sockets, usually by being member of the |INSTALL_VTY_GROUP| group. If they
+have this membership, PAM support is useless since they can connect to daemons
+and issue commands using some other tool. Alternatively, the *vtysh* binary
+could be made SGID (set group ID) to the |INSTALL_VTY_GROUP| group.
+
+.. warning::
+
+ No security guarantees are made for this configuration.
-Users using vtysh still need to have appropriate access to the daemons'
-VTY sockets, usually by being member of the *|INSTALL_VTY_GROUP|*
-group. If they have this membership, PAM support is useless since they can
-connect to daemons and issue commands using some other tool. Alternatively,
-the *vtysh* binary could be made SGID (set group ID) to the
-*|INSTALL_VTY_GROUP|* group. @strong{No security guarantees are
-made for this configuration}.
-.. index:: {Command} {username `username` nopassword} {}
+.. index:: username USERNAME nopassword
+.. clicmd:: username USERNAME nopassword
-{Command} {username `username` nopassword} {}
If PAM support is enabled at build-time, this command allows disabling the
- use of PAM on a per-user basis. If vtysh finds that an user is trying to
+ use of PAM on a per-user basis. If vtysh finds that an user is trying to
use vtysh and a "nopassword" entry is found, no calls to PAM will be made
at all.
=============================
Integrated configuration mode uses a single configuration file,
-:file:`frr.conf`, for all daemons. This replaces the individual files like
+:file:`frr.conf`, for all daemons. This replaces the individual files like
:file:`zebra.conf` or :file:`bgpd.conf`.
-:file:`frr.conf` is located in :file:`|INSTALL_PREFIX_ETC|`. All
-daemons check for the existence of this file at startup, and if it exists
-will not load their individual configuration files. Instead,
-*vtysh -b* must be invoked to process :file:`frr.conf` and apply
-its settings to the individual daemons.
+:file:`frr.conf` is located in |INSTALL_PREFIX_ETC|. All daemons check for the
+existence of this file at startup, and if it exists will not load their
+individual configuration files. Instead, ``vtysh -b`` must be invoked to
+process :file:`frr.conf` and apply its settings to the individual daemons.
+
+.. warning::
+
+ *vtysh -b* must also be executed after restarting any daemon.
-@quotation Warning
-*vtysh -b* must also be executed after restarting any daemon.
-@end quotation
Configuration saving, file ownership and permissions
----------------------------------------------------
-The :file:`frr.conf` file is not written by any of the daemons; instead
-*vtysh* contains the neccessary logic to collect configuration from
-all of the daemons, combine it and write it out.
+The :file:`frr.conf` file is not written by any of the daemons; instead *vtysh*
+contains the neccessary logic to collect configuration from all of the daemons,
+combine it and write it out.
-@quotation Warning
-Daemons must be running for *vtysh* to be able to collect their
-configuration. Any configuration from non-running daemons is permanently
-lost after doing a configuration save.
-@end quotation
+.. warning::
-Since the *vtysh* command may be running as ordinary user on the
-system, configuration writes will be tried through *watchfrr*,
-using the *write integrated* command internally. Since
-*watchfrr* is running as superuser, *vtysh* is able to
-ensure correct ownership and permissions on :file:`frr.conf`.
+ Daemons must be running for *vtysh* to be able to collect their
+ configuration. Any configuration from non-running daemons is permanently
+ lost after doing a configuration save.
-If *watchfrr* is not running or the configuration write fails,
-*vtysh* will attempt to directly write to the file. This is likely
-to fail if running as unprivileged user; alternatively it may leave the
-file with incorrect owner or permissions.
+Since the *vtysh* command may be running as ordinary user on the system,
+configuration writes will be tried through *watchfrr*, using the ``write
+integrated`` command internally. Since *watchfrr* is running as superuser,
+*vtysh* is able to ensure correct ownership and permissions on
+:file:`frr.conf`.
-Writing the configuration can be triggered directly by invoking
-*vtysh -w*. This may be useful for scripting. Note this command
-should be run as either the superuser or the FRR user.
+If *watchfrr* is not running or the configuration write fails, *vtysh* will
+attempt to directly write to the file. This is likely to fail if running as
+unprivileged user; alternatively it may leave the file with incorrect owner or
+permissions.
-We recommend you do not mix the use of the two types of files. Further, it
-is better not to use the integrated frr.conf file, as any syntax error in
-it can lead to /all/ of your daemons being unable to start up. Per daemon
-files are more robust as impact of errors in configuration are limited to
-the daemon in whose file the error is made.
+Writing the configuration can be triggered directly by invoking *vtysh -w*.
+This may be useful for scripting. Note this command should be run as either the
+superuser or the FRR user.
-.. index:: {Command} {service integrated-vtysh-config} {}
+We recommend you do not mix the use of the two types of files. Further, it is
+better not to use the integrated :file:`frr.conf` file, as any syntax error in
+it can lead to /all/ of your daemons being unable to start up. Per daemon files
+are more robust as impact of errors in configuration are limited to the daemon
+in whose file the error is made.
-{Command} {service integrated-vtysh-config} {}
-.. index:: {Command} {no service integrated-vtysh-config} {}
+.. index:: service integrated-vtysh-config
+.. clicmd:: service integrated-vtysh-config
-{Command} {no service integrated-vtysh-config} {}
- Control whether integrated :file:`frr.conf` file is written when
- 'write file' is issued.
+.. index:: no service integrated-vtysh-config
+.. clicmd:: no service integrated-vtysh-config
- These commands need to be placed in :file:`vtysh.conf` to have any effect.
- Note that since :file:`vtysh.conf` is not written by FRR itself, they
- therefore need to be manually placed in that file.
+ Control whether integrated :file:`frr.conf` file is written when
+ 'write file' is issued.
- This command has 3 states:
+ These commands need to be placed in :file:`vtysh.conf` to have any effect.
+ Note that since :file:`vtysh.conf` is not written by FRR itself, they
+ therefore need to be manually placed in that file.
+ This command has 3 states:
-``
- *service integrated-vtysh-config*
+ service integrated-vtysh-config
*vtysh* will always write :file:`frr.conf`.
-``
- *no service integrated-vtysh-config*
-
+ no service integrated-vtysh-config
*vtysh* will never write :file:`frr.conf`; instead it will ask
daemons to write their individual configuration files.
-
-``
- Neither option present (default)
-
- *vtysh* will check whether :file:`frr.conf` exists. If it does,
- configuration writes will update that file. Otherwise, writes are performed
+ Neither option present (default)
+ *vtysh* will check whether :file:`frr.conf` exists. If it does,
+ configuration writes will update that file. Otherwise, writes are performed
through the individual daemons.
- This command is primarily intended for packaging/distribution purposes, to
- preset one of the two operating modes and ensure consistent operation across
- installations.
-
-.. index:: {Command} {write integrated} {}
-
-{Command} {write integrated} {}
- Unconditionally (regardless of *service integrated-vtysh-config*
- setting) write out integrated :file:`frr.conf` file through
- *watchfrr*. If *watchfrr* is not running, this command
- is unavailable.
+ This command is primarily intended for packaging/distribution purposes, to
+ preset one of the two operating modes and ensure consistent operation across
+ installations.
+.. index:: write integrated
+.. clicmd:: write integrated
-Caveats
-=======
+ Unconditionally (regardless of ``service integrated-vtysh-config`` setting)
+ write out integrated :file:`frr.conf` file through *watchfrr*. If *watchfrr*
+ is not running, this command is unavailable.
-Configuration changes made while some daemon is not running will be invisible
-to that daemon. The daemon will start up with its saved configuration
-(either in its individual configuration file, or in :file:`frr.conf`).
-This is particularly troublesome for route-maps and prefix lists, which would
-otherwise be synchronized between daemons.
+.. warning::
+ Configuration changes made while some daemon is not running will be
+ invisible to that daemon. The daemon will start up with its saved
+ configuration (either in its individual configuration file, or in
+ :file:`frr.conf`). This is particularly troublesome for route-maps and
+ prefix lists, which would otherwise be synchronized between daemons.
+
projects / mirror_frr.git / commitdiff