Took the changes from these and applied in previous commits. Bye bye.
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
+++ /dev/null
-@c -*-texinfo-*-
-@c This is part of the Frr Manual.
-@c @value{COPYRIGHT_STR}
-@c Portions:
-@c Copyright @copyright{} 2015 Hewlett Packard Enterprise Development LP
-@c See file frr.texi for copying conditions.
-@node BGP
-@chapter BGP
-
-@acronym{BGP} stands for a Border Gateway Protocol. The lastest BGP version
-is 4. It is referred as BGP-4. BGP-4 is one of the Exterior Gateway
-Protocols and de-fact standard of Inter Domain routing protocol.
-BGP-4 is described in @cite{RFC1771, A Border Gateway Protocol
-4 (BGP-4)}.
-
-Many extensions have been added to @cite{RFC1771}. @cite{RFC2858,
-Multiprotocol Extensions for BGP-4} provides multiprotocol support to
-BGP-4.
-
-@menu
-* Starting BGP::
-* BGP router::
-* BGP MED::
-* BGP network::
-* BGP Peer::
-* BGP Peer Group::
-* BGP Address Family::
-* Autonomous System::
-* BGP Communities Attribute::
-* BGP Extended Communities Attribute::
-* BGP Large Communities Attribute::
-* Displaying BGP information::
-* Capability Negotiation::
-* Route Reflector::
-* Route Server::
-* BGP Regular Expressions::
-* How to set up a 6-Bone connection::
-* Dump BGP packets and table::
-* BGP Configuration Examples::
-* Prefix Origin Validation Using RPKI::
-@end menu
-
-@node Starting BGP
-@section Starting BGP
-
-Default configuration file of @command{bgpd} is @file{bgpd.conf}.
-@command{bgpd} searches the current directory first then
-@value{INSTALL_PREFIX_ETC}/bgpd.conf. All of bgpd's command must be
-configured in @file{bgpd.conf}.
-
-@command{bgpd} specific invocation options are described below. Common
-options may also be specified (@pxref{Common Invocation Options}).
-
-@table @samp
-@item -p @var{PORT}
-@itemx --bgp_port=@var{PORT}
-Set the bgp protocol's port number.
-
-@item -r
-@itemx --retain
-When program terminates, retain BGP routes added by zebra.
-
-@item -l
-@itemx --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.
-
-@end table
-
-@node BGP router
-@section BGP router
-
- First of all you must configure BGP router with @command{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.
-
-@deffn Command {router bgp @var{asn}} {}
-Enable a BGP protocol process with the specified @var{asn}. After
-this statement you can input any @code{BGP Commands}. You can not
-create different BGP process under different @var{asn} without
-specifying @code{multiple-instance} (@pxref{Multiple instance}).
-@end deffn
-
-@deffn Command {no router bgp @var{asn}} {}
-Destroy a BGP protocol process with the specified @var{asn}.
-@end deffn
-
-@deffn {BGP} {bgp router-id @var{A.B.C.D}} {}
-This command specifies the router-ID. If @command{bgpd} connects to @command{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
-@code{router zebra} is not enabled @command{bgpd} can't get interface information
-so @code{router-id} is set to 0.0.0.0. So please set router-id by hand.
-@end deffn
-
-@menu
-* BGP distance::
-* BGP decision process::
-* BGP route flap dampening::
-@end menu
-
-@node BGP distance
-@subsection BGP distance
-
-@deffn {BGP} {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.
-@end deffn
-
-@deffn {BGP} {distance <1-255> @var{A.B.C.D/M}} {}
-@deffnx {BGP} {distance <1-255> @var{A.B.C.D/M} @var{word}} {}
-This command set distance value to
-@end deffn
-
-@node BGP decision process
-@subsection BGP decision process
-
-The decision process Frr BGP uses to select routes is as follows:
-
-@table @asis
-@item 1. Weight check
-prefer higher local weight routes to lower routes.
-
-@item 2. Local preference check
-prefer higher local preference routes to lower.
-
-@item 3. Local route check
-Prefer local routes (statics, aggregates, redistributed) to received routes.
-
-@item 4. AS path length check
-Prefer shortest hop-count AS_PATHs.
-
-@item 5. Origin check
-Prefer the lowest origin type route. That is, prefer IGP origin routes to
-EGP, to Incomplete routes.
-
-@item 6. MED check
-Where routes with a MED were received from the same AS,
-prefer the route with the lowest MED. @xref{BGP MED}.
-
-@item 7. External check
-Prefer the route received from an external, eBGP peer
-over routes received from other types of peers.
-
-@item 8. IGP cost check
-Prefer the route with the lower IGP cost.
-
-@item 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.
-
-@item 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.
-
-@item 11. Router-ID check
-Prefer the route with the lowest @w{router-ID}. If the
-route has an @w{ORIGINATOR_ID} attribute, through iBGP reflection, then that
-router ID is used, otherwise the @w{router-ID} of the peer the route was
-received from is used.
-
-@item 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.
-
-@item 13. Peer address
-Prefer the route received from the peer with the higher
-transport layer address, as a last-resort tie-breaker.
-
-@end table
-
-@deffn {BGP} {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.
-@end deffn
-
-@deffn {BGP} {bgp bestpath as-path multipath-relax} {}
-@anchor{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.
-@end deffn
-
-@deffn {BGP} {bgp bestpath compare-routerid} {}
-@anchor{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.
-
-If this option is enabled, then the already-selected check, where
-already selected eBGP routes are preferred, is skipped.
-
-If a route has an @w{ORIGINATOR_ID} attribute because it has been reflected,
-that @w{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.
-
-@end deffn
-
-
-@node BGP route flap dampening
-@subsection BGP route flap dampening
-
-@deffn {BGP} {bgp dampening @var{<1-45>} @var{<1-20000>} @var{<1-20000>} @var{<1-255>}} {}
-This command enables BGP route-flap dampening and specifies dampening parameters.
-
-@table @asis
-@item @asis{half-life}
-Half-life time for the penalty
-@item @asis{reuse-threshold}
-Value to start reusing a route
-@item @asis{suppress-threshold}
-Value to start suppressing a route
-@item @asis{max-suppress}
-Maximum duration to suppress a stable route
-@end table
-
-The route-flap damping algorithm is compatible with @cite{RFC2439}. The use of this command
-is not recommended nowadays, see @uref{http://www.ripe.net/ripe/docs/ripe-378,,RIPE-378}.
-@end deffn
-
-@node BGP MED
-@section BGP MED
-
-The BGP 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 @acronym{MED, Multi_Exit_Discriminator} 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.
-
-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.
-
-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.
-
-@c TeXInfo uses the old, non-UTF-8 capable, pdftex, and so
-@c doesn't render TeX the unicode precedes character correctly in PDF, etc.
-@c Using a TeX code on the other hand doesn't work for non-TeX outputs
-@c (plaintext, e.g.). So, use an output-conditional macro.
-
-@iftex
-@macro mprec{}
-@math{\\prec}
-@end macro
-@end iftex
-
-@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 @emph{must} be some binary ordering relation that is defined
-for @emph{every} combination of those objects, and that relation @emph{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 @emph{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.
-
-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.
-
-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.
-
-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.
-
-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 .
-
-This first issue can be fixed with a more deterministic route selection that
-ensures routes are ordered by the neighbouring AS during selection.
-@xref{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 @emph{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:
-
-@example
-
- /---------------\
- X:2------|--A:4-------A:5--|-Y:1:200
- Y:3:100--|-/ |
- \---------------/
-
-@end example
-
-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
-preferences between the routes:
-
-@example
-
- /---> X:2 ---beats---> Y:3:100 --\
- | |
- | |
- \---beats--- Y:1:200 <---beats---/
-
-@end example
-
-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}, .
-
-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 @emph{no} known way to use MED for its original
-purpose; @emph{and} reduce routing information in iBGP topologies;
-@emph{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:
-
-@itemize
-
-@item
-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.
-
-@item
-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.
-
-@end itemize
-
-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.
-
-@deffn {BGP} {bgp deterministic-med} {}
-@anchor{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.
-
-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.
-@end deffn
-
-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, @xref{BGP decision process}.
-
-@deffn {BGP} {bgp always-compare-med} {}
-@anchor{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.
-
-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.
-@end deffn
-
-
-
-@node BGP network
-@section BGP network
-
-@menu
-* BGP route::
-* Route Aggregation::
-* Redistribute to BGP::
-@end menu
-
-@node BGP route
-@subsection BGP route
-
-@deffn {BGP} {network @var{A.B.C.D/M}} {}
-This command adds the announcement network.
-@example
-@group
-router bgp 1
- address-family ipv4 unicast
- network 10.0.0.0/8
- exit-address-family
-@end group
-@end example
-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; @code{bgpd}
-doesn't care about IGP routes when announcing its routes.
-@end deffn
-
-@deffn {BGP} {no network @var{A.B.C.D/M}} {}
-@end deffn
-
-@node Route Aggregation
-@subsection Route Aggregation
-
-@deffn {BGP} {aggregate-address @var{A.B.C.D/M}} {}
-This command specifies an aggregate address.
-@end deffn
-
-@deffn {BGP} {aggregate-address @var{A.B.C.D/M} as-set} {}
-This command specifies an aggregate address. Resulting routes include
-AS set.
-@end deffn
-
-@deffn {BGP} {aggregate-address @var{A.B.C.D/M} summary-only} {}
-This command specifies an aggregate address. Aggreated routes will
-not be announce.
-@end deffn
-
-@deffn {BGP} {no aggregate-address @var{A.B.C.D/M}} {}
-@end deffn
-
-@node Redistribute to BGP
-@subsection Redistribute to BGP
-
-@deffn {BGP} {redistribute kernel} {}
-Redistribute kernel route to BGP process.
-@end deffn
-
-@deffn {BGP} {redistribute static} {}
-Redistribute static route to BGP process.
-@end deffn
-
-@deffn {BGP} {redistribute connected} {}
-Redistribute connected route to BGP process.
-@end deffn
-
-@deffn {BGP} {redistribute rip} {}
-Redistribute RIP route to BGP process.
-@end deffn
-
-@deffn {BGP} {redistribute ospf} {}
-Redistribute OSPF route to BGP process.
-@end deffn
-
-@deffn {BGP} {redistribute vpn} {}
-Redistribute VNC routes to BGP process.
-@end deffn
-
-@deffn {BGP} {update-delay @var{max-delay}} {}
-@deffnx {BGP} {update-delay @var{max-delay} @var{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.
-
-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.
-
-Default max-delay is 0, i.e. the feature is off by default.
-@end deffn
-
-@deffn {BGP} {table-map @var{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.
-
-Supported for ipv4 and ipv6 address families. It works on multi-paths as well,
-however, metric setting is based on the best-path only.
-@end deffn
-
-@node BGP Peer
-@section BGP Peer
-
-@menu
-* Defining Peer::
-* BGP Peer commands::
-* Peer filtering::
-@end menu
-
-@node Defining Peer
-@subsection Defining Peer
-
-@deffn {BGP} {neighbor @var{peer} remote-as @var{asn}} {}
-Creates a new neighbor whose remote-as is @var{asn}. @var{peer}
-can be an IPv4 address or an IPv6 address.
-@example
-@group
-router bgp 1
- neighbor 10.0.0.1 remote-as 2
-@end group
-@end example
-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, @command{bgpd} will complain like this:
-@example
-can't find neighbor 10.0.0.1
-@end example
-@end deffn
-
-@node BGP Peer commands
-@subsection BGP Peer commands
-
-In a @code{router bgp} clause there are neighbor specific configurations
-required.
-
-@deffn {BGP} {neighbor @var{peer} shutdown} {}
-@deffnx {BGP} {no neighbor @var{peer} shutdown} {}
-Shutdown the peer. We can delete the neighbor's configuration by
-@code{no neighbor @var{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.
-@end deffn
-
-@deffn {BGP} {neighbor @var{peer} ebgp-multihop} {}
-@deffnx {BGP} {no neighbor @var{peer} ebgp-multihop} {}
-@end deffn
-
-@deffn {BGP} {neighbor @var{peer} description ...} {}
-@deffnx {BGP} {no neighbor @var{peer} description ...} {}
-Set description of the peer.
-@end deffn
-
-@deffn {BGP} {neighbor @var{peer} version @var{version}} {}
-Set up the neighbor's BGP version. @var{version} can be @var{4},
-@var{4+} or @var{4-}. BGP version @var{4} is the default value used for
-BGP peering. BGP version @var{4+} means that the neighbor supports
-Multiprotocol Extensions for BGP-4. BGP version @var{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.
-@end deffn
-
-@deffn {BGP} {neighbor @var{peer} interface @var{ifname}} {}
-@deffnx {BGP} {no neighbor @var{peer} interface @var{ifname}} {}
-When you connect to a BGP peer over an IPv6 link-local address, you
-have to specify the @var{ifname} of the interface used for the
-connection. To specify IPv4 session addresses, see the
-@code{neighbor @var{peer} update-source} command below.
-
-This command is deprecated and may be removed in a future release. Its
-use should be avoided.
-@end deffn
-
-@deffn {BGP} {neighbor @var{peer} next-hop-self [all]} {}
-@deffnx {BGP} {no neighbor @var{peer} next-hop-self [all]} {}
-This command specifies an announced route's nexthop as being equivalent
-to the address of the bgp router if it is learned via eBGP.
-If the optional keyword @code{all} is specified the modifiation is done
-also for routes learned via iBGP.
-@end deffn
-
-@deffn {BGP} {neighbor @var{peer} update-source @var{<ifname|address>}} {}
-@deffnx {BGP} {no neighbor @var{peer} update-source} {}
-Specify the IPv4 source address to use for the @acronym{BGP} session to this
-neighbour, may be specified as either an IPv4 address directly or
-as an interface name (in which case the @command{zebra} daemon MUST be running
-in order for @command{bgpd} to be able to retrieve interface state).
-@example
-@group
-router bgp 64555
- neighbor foo update-source 192.168.0.1
- neighbor bar update-source lo0
-@end group
-@end example
-@end deffn
-
-@deffn {BGP} {neighbor @var{peer} default-originate} {}
-@deffnx {BGP} {no neighbor @var{peer} default-originate} {}
-@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.
-@end deffn
-
-@deffn {BGP} {neighbor @var{peer} port @var{port}} {}
-@deffnx {BGP} {neighbor @var{peer} port @var{port}} {}
-@end deffn
-
-@deffn {BGP} {neighbor @var{peer} send-community} {}
-@deffnx {BGP} {neighbor @var{peer} send-community} {}
-@end deffn
-
-@deffn {BGP} {neighbor @var{peer} weight @var{weight}} {}
-@deffnx {BGP} {no neighbor @var{peer} weight @var{weight}} {}
-This command specifies a default @var{weight} value for the neighbor's
-routes.
-@end deffn
-
-@deffn {BGP} {neighbor @var{peer} maximum-prefix @var{number}} {}
-@deffnx {BGP} {no neighbor @var{peer} maximum-prefix @var{number}} {}
-@end deffn
-
-@deffn {BGP} {neighbor @var{peer} local-as @var{as-number}} {}
-@deffnx {BGP} {neighbor @var{peer} local-as @var{as-number} no-prepend} {}
-@deffnx {BGP} {neighbor @var{peer} local-as @var{as-number} no-prepend replace-as} {}
-@deffnx {BGP} {no neighbor @var{peer} local-as} {}
-Specify an alternate AS for this BGP process when interacting with the
-specified peer. With no modifiers, the specified local-as is prepended to
-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.
-@end deffn
-
-@deffn {BGP} {neighbor @var{peer} ttl-security hops @var{number}} {}
-@deffnx {BGP} {no neighbor @var{peer} ttl-security hops @var{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 @command{ebgp-multihop}.
-@end deffn
-
-@node Peer filtering
-@subsection Peer filtering
-
-@deffn {BGP} {neighbor @var{peer} distribute-list @var{name} [in|out]} {}
-This command specifies a distribute-list for the peer. @var{direct} is
-@samp{in} or @samp{out}.
-@end deffn
-
-@deffn {BGP command} {neighbor @var{peer} prefix-list @var{name} [in|out]} {}
-@end deffn
-
-@deffn {BGP command} {neighbor @var{peer} filter-list @var{name} [in|out]} {}
-@end deffn
-
-@deffn {BGP} {neighbor @var{peer} route-map @var{name} [in|out]} {}
-Apply a route-map on the neighbor. @var{direct} must be @code{in} or
-@code{out}.
-@end deffn
-
-@deffn {BGP} {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.
-@end deffn
-
-@c -----------------------------------------------------------------------
-@node BGP Peer Group
-@section BGP Peer Group
-
-@deffn {BGP} {neighbor @var{word} peer-group} {}
-This command defines a new peer group.
-@end deffn
-
-@deffn {BGP} {neighbor @var{peer} peer-group @var{word}} {}
-This command bind specific peer to peer group @var{word}.
-@end deffn
-
-@node BGP Address Family
-@section 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
-@cite{RFC4364} and @cite{RFC4659}, and Encapsulation attribute
-@cite{RFC5512} is supported.
-
-@deffn {Command} {show ip bgp ipv4 vpn} {}
-@deffnx {Command} {show ipv6 bgp ipv6 vpn} {}
-Print active IPV4 or IPV6 routes advertised via the VPN SAFI.
-@end deffn
-
-@deffn {Command} {show bgp ipv4 vpn summary} {}
-@deffnx {Command} {show bgp ipv6 vpn summary} {}
-Print a summary of neighbor connections for the specified AFI/SAFI combination.
-@end deffn
-
-@c -----------------------------------------------------------------------
-@node Autonomous System
-@section Autonomous System
-
-The @acronym{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 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.
-
-@menu
-* Display BGP Routes by AS Path::
-* AS Path Access List::
-* Using AS Path in Route Map::
-* Private AS Numbers::
-@end menu
-
-@node Display BGP Routes by AS Path
-@subsection Display BGP Routes by AS Path
-
-To show BGP routes which has specific AS path information @code{show
-ip bgp} command can be used.
-
-@deffn Command {show bgp @{ipv4|ipv6@} regexp @var{line}} {}
-This commands displays BGP routes that matches a regular
-expression @var{line} (@pxref{BGP Regular Expressions}).
-@end deffn
-
-@node AS Path Access List
-@subsection AS Path Access List
-
-AS path access list is user defined AS path.
-
-@deffn {Command} {ip as-path access-list @var{word} @{permit|deny@} @var{line}} {}
-This command defines a new AS path access list.
-@end deffn
-
-@deffn {Command} {no ip as-path access-list @var{word}} {}
-@deffnx {Command} {no ip as-path access-list @var{word} @{permit|deny@} @var{line}} {}
-@end deffn
-
-@node Using AS Path in Route Map
-@subsection Using AS Path in Route Map
-
-@deffn {Route Map} {match as-path @var{word}} {}
-@end deffn
-
-@deffn {Route Map} {set as-path prepend @var{as-path}} {}
-Prepend the given string of AS numbers to the AS_PATH.
-@end deffn
-
-@deffn {Route Map} {set as-path prepend last-as @var{num}} {}
-Prepend the existing last AS number (the leftmost ASN) to the AS_PATH.
-@end deffn
-
-@node Private AS Numbers
-@subsection Private AS Numbers
-
-@c -----------------------------------------------------------------------
-@node BGP Communities Attribute
-@section 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 @cite{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.
-
-@table @code
-@item AS:VAL
-This format represents 4 octet communities value. @code{AS} is high
-order 2 octet in digit format. @code{VAL} is low order 2 octet in
-digit format. This format is useful to define AS oriented policy
-value. For example, @code{7675:80} can be used when AS 7675 wants to
-pass local policy value 80 to neighboring peer.
-@item internet
-@code{internet} represents well-known communities value 0.
-@item no-export
-@code{no-export} represents well-known communities value @code{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.
-@item no-advertise
-@code{no-advertise} represents well-known communities value
-@code{NO_ADVERTISE}@*@r{(0xFFFFFF02)}. All routes carry this value
-must not be advertise to other BGP peers.
-@item local-AS
-@code{local-AS} represents well-known communities value
-@code{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.
-@end table
-
- When BGP communities attribute is received, duplicated communities
-value in the communities attribute is ignored and each communities
-values are sorted in numerical order.
-
-@menu
-* BGP Community Lists::
-* Numbered BGP Community Lists::
-* BGP Community in Route Map::
-* Display BGP Routes by Community::
-* Using BGP Communities Attribute::
-@end menu
-
-@node BGP Community Lists
-@subsection 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
-expanded community list.
-
-@deffn Command {ip community-list standard @var{name} @{permit|deny@} @var{community}} {}
-This command defines a new standard community list. @var{community}
-is communities value. The @var{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 @var{community} is
-empty it matches to any routes.
-@end deffn
-
-@deffn Command {ip community-list expanded @var{name} @{permit|deny@} @var{line}} {}
-This command defines a new expanded community list. @var{line} is a
-string expression of communities attribute. @var{line} can be a
-regular expression (@pxref{BGP Regular Expressions}) to match
-the communities attribute in BGP updates.
-@end deffn
-
-@deffn Command {no ip community-list @var{name}} {}
-@deffnx Command {no ip community-list standard @var{name}} {}
-@deffnx Command {no ip community-list expanded @var{name}} {}
-These commands delete community lists specified by @var{name}. All of
-community lists shares a single name space. So community lists can be
-removed simpley specifying community lists name.
-@end deffn
-
-@deffn {Command} {show ip community-list} {}
-@deffnx {Command} {show ip community-list @var{name}} {}
-This command displays current community list information. When
-@var{name} is specified the specified community list's information is
-shown.
-
-@example
-# 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
-@end example
-@end deffn
-
-@node Numbered BGP Community Lists
-@subsection Numbered BGP Community Lists
-
-When number is used for BGP community list name, the number has
-special meanings. Community list number in the range from 1 and 99 is
-standard community list. Community list number in the range from 100
-to 199 is expanded community list. These community lists are called
-as numbered community lists. On the other hand normal community lists
-is called as named community lists.
-
-@deffn Command {ip community-list <1-99> @{permit|deny@} @var{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 @var{community} is empty it matches to
-any routes.
-@end deffn
-
-@deffn Command {ip community-list <100-199> @{permit|deny@} @var{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.
-@end deffn
-
-@deffn Command {ip community-list @var{name} @{permit|deny@} @var{community}} {}
-When community list type is not specifed, the community list type is
-automatically detected. If @var{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.
-@end deffn
-
-@node BGP Community in Route Map
-@subsection BGP Community in Route Map
-
-In Route Map (@pxref{Route Map}), we can match or set BGP
-communities attribute. Using this feature network operator can
-implement their network policy based on BGP communities attribute.
-
-Following commands can be used in Route Map.
-
-@deffn {Route Map} {match community @var{word}} {}
-@deffnx {Route Map} {match community @var{word} exact-match} {}
-This command perform match to BGP updates using community list
-@var{word}. When the one of BGP communities value match to the one of
-communities value in community list, it is match. When
-@code{exact-match} keyword is spcified, match happen only when BGP
-updates have completely same communities value specified in the
-community list.
-@end deffn
-
-@deffn {Route Map} {set community none} {}
-@deffnx {Route Map} {set community @var{community}} {}
-@deffnx {Route Map} {set community @var{community} additive} {}
-This command manipulate communities value in BGP updates. When
-@code{none} is specified as communities value, it removes entire
-communities attribute from BGP updates. When @var{community} is not
-@code{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 @var{community} value.
-When @code{additive} keyword is specified, @var{community} is appended
-to the existing communities value.
-@end deffn
-
-@deffn {Route Map} {set comm-list @var{word} delete} {}
-This command remove communities value from BGP communities attribute.
-The @var{word} is community list name. When BGP route's communities
-value matches to the community list @var{word}, the communities value
-is removed. When all of communities value is removed eventually, the
-BGP update's communities attribute is completely removed.
-@end deffn
-
-@node Display BGP Routes by Community
-@subsection Display BGP Routes by Community
-
-To show BGP routes which has specific BGP communities attribute,
-@code{show bgp @{ipv4|ipv6@}} command can be used. The
-@var{community} and @var{community-list} subcommand can be used.
-
-@deffn Command {show bgp @{ipv4|ipv6@} community} {}
-@deffnx Command {show bgp @{ipv4|ipv6@} community @var{community}} {}
-@deffnx Command {show bgp @{ipv4|ipv6@} community @var{community} exact-match} {}
-@code{show bgp @{ipv4|ipv6@} community} displays BGP routes which has communities
-attribute. Where the address family can be IPv4 or IPv6 among others. When
-@var{community} is specified, BGP routes that matches @var{community} value is
-displayed. For this command, @code{internet} keyword can't be used for
-@var{community} value. When @code{exact-match} is specified, it display only
-routes that have an exact match.
-@end deffn
-
-@deffn Command {show bgp @{ipv4|ipv6@} community-list @var{word}} {}
-@deffnx Command {show bgp @{ipv4|ipv6@} community-list @var{word} exact-match} {}
-This commands display BGP routes for the address family specified that matches
-community list @var{word}. When @code{exact-match} is specified, display only
-routes that have an exact match.
-@end deffn
-
-@node Using BGP Communities Attribute
-@subsection Using BGP Communities Attribute
-
-Following configuration is the most typical usage of BGP communities
-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.
-
-@example
-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
-@end example
-
-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.
-
-@example
-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
-@end example
-
-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.
-
-@example
-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
-@end example
-
-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.
-
-@example
-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
-@end example
-
-Communities value keyword @code{internet} has special meanings in
-standard community lists. In below example @code{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 @code{INTERNET}
-is same as above example's @code{FILTER}.
-
-@example
-ip community-list standard INTERNET deny 1:1
-ip community-list standard INTERNET permit internet
-@end example
-
-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 @code{permit}
-community-list is used. @code{deny} community-list is ignored.
-
-@example
-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
-@end example
-
-@c -----------------------------------------------------------------------
-@node BGP Extended Communities Attribute
-@section 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 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.
-
-@table @code
-@item AS:VAL
-This is a format to define AS based Extended Community value.
-@code{AS} part is 2 octets Global Administrator subfield in Extended
-Community value. @code{VAL} part is 4 octets Local Administrator
-subfield. @code{7675:100} represents AS 7675 policy value 100.
-@item IP-Address:VAL
-This is a format to define IP address based Extended Community value.
-@code{IP-Address} part is 4 octets Global Administrator subfield.
-@code{VAL} part is 2 octets Local Administrator subfield.
-@code{10.0.0.1:100} represents
-@end table
-
-@menu
-* BGP Extended Community Lists::
-* BGP Extended Communities in Route Map::
-@end menu
-
-@node BGP Extended Community Lists
-@subsection BGP Extended Community Lists
-
-Expanded Community Lists is a user defined BGP Expanded Community
-Lists.
-
-@deffn Command {ip extcommunity-list standard @var{name} @{permit|deny@} @var{extcommunity}} {}
-This command defines a new standard extcommunity-list.
-@var{extcommunity} is extended communities value. The
-@var{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
-@var{extcommunity} is empty it matches to any routes.
-@end deffn
-
-@deffn Command {ip extcommunity-list expanded @var{name} @{permit|deny@} @var{line}} {}
-This command defines a new expanded extcommunity-list. @var{line} is
-a string expression of extended communities attribute. @var{line} can
-be a regular expression (@pxref{BGP Regular Expressions}) to match an
-extended communities attribute in BGP updates.
-@end deffn
-
-@deffn Command {no ip extcommunity-list @var{name}} {}
-@deffnx Command {no ip extcommunity-list standard @var{name}} {}
-@deffnx Command {no ip extcommunity-list expanded @var{name}} {}
-These commands delete extended community lists specified by
-@var{name}. All of extended community lists shares a single name
-space. So extended community lists can be removed simpley specifying
-the name.
-@end deffn
-
-@deffn {Command} {show ip extcommunity-list} {}
-@deffnx {Command} {show ip extcommunity-list @var{name}} {}
-This command displays current extcommunity-list information. When
-@var{name} is specified the community list's information is shown.
-
-@example
-# show ip extcommunity-list
-@end example
-@end deffn
-
-@node BGP Extended Communities in Route Map
-@subsection BGP Extended Communities in Route Map
-
-@deffn {Route Map} {match extcommunity @var{word}} {}
-@end deffn
-
-@deffn {Route Map} {set extcommunity rt @var{extcommunity}} {}
-This command set Route Target value.
-@end deffn
-
-@deffn {Route Map} {set extcommunity soo @var{extcommunity}} {}
-This command set Site of Origin value.
-@end deffn
-
-@c -----------------------------------------------------------------------
-@node BGP Large Communities Attribute
-@section BGP Large Communities Attribute
-
-The BGP Large Communities attribute was introduced in Feb 2017 with
-@cite{RFC8092, BGP Large Communities Attribute}.
-
-The BGP Large Communities Attribute is similar to the BGP Communities
-Attribute except that it has 3 components instead of two and each of
-which are 4 octets in length. Large Communities bring additional
-functionality and convenience over traditional communities, specifically
-the fact that the @code{GLOBAL} part below is now 4 octets wide allowing
-AS4 operators seamless use.
-
-@table @code
-@item GLOBAL:LOCAL1:LOCAL2
-This is the format to define Large Community values. Referencing
-@cite{RFC8195, Use of BGP Large Communities} the values are commonly
-referred to as follows.
-The @code{GLOBAL} part is a 4 octet Global Administrator field, common
-use of this field is the operators AS number.
-The @code{LOCAL1} part is a 4 octet Local Data Part 1 subfield referred
-to as a function.
-The @code{LOCAL2} part is a 4 octet Local Data Part 2 field and referred
-to as the parameter subfield. @code{65551:1:10} represents AS 65551
-function 1 and parameter 10.
-The referenced RFC above gives some guidelines on recommended usage.
-@end table
-
-@menu
-* BGP Large Community Lists::
-* BGP Large Communities in Route Map::
-@end menu
-
-@node BGP Large Community Lists
-@subsection BGP Large Community Lists
-
-Two types of large community lists are supported, namely @code{standard} and
-@code{expanded}.
-
-@deffn Command {ip large-community-list standard @var{name} @{permit|deny@} @var{large-community}} {}
-This command defines a new standard large-community-list.
-@var{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 @var{large-community}
-is empty it matches any routes.
-@end deffn
-
-@deffn Command {ip large-community-list expanded @var{name} @{permit|deny@} @var{line}} {}
-This command defines a new expanded large-community-list. Where @var{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.
-@var{line} can also be a regular expression which matches this Large
-Community attribute.
-@end deffn
-
-@deffn Command {no ip large-community-list @var{name}} {}
-@deffnx Command {no ip large-community-list standard @var{name}} {}
-@deffnx Command {no ip large-community-list expanded @var{name}} {}
-These commands delete Large Community lists specified by
-@var{name}. All Large Community lists share a single namespace.
-This means Large Community lists can be removed by simply specifying the name.
-@end deffn
-
-@deffn {Command} {show ip large-community-list} {}
-@deffnx {Command} {show ip large-community-list @var{name}} {}
-This command display current large-community-list information. When
-@var{name} is specified the community list information is shown.
-@end deffn
-
-@deffn {Command} {show ip bgp large-community-info} {}
-This command displays the current large communities in use.
-@end deffn
-
-@node BGP Large Communities in Route Map
-@subsection BGP Large Communities in Route Map
-
-@deffn {Route Map} {match large-community @var{line}} {}
-Where @var{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.
-@end deffn
-
-@deffn {Route Map} {set large-community @var{large-community}} {}
-@deffnx {Route Map} {set large-community @var{large-community} @var{large-community}} {}
-@deffnx {Route Map} {set large-community @var{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.
-@end deffn
-
-@c -----------------------------------------------------------------------
-
-@node Displaying BGP information
-@section Displaying BGP information
-
-@menu
-* Showing BGP information::
-* Other BGP commands::
-@end menu
-
-@node Showing BGP information
-@subsection Showing BGP information
-
-@deffn {Command} {show ip bgp} {}
-@deffnx {Command} {show ip bgp @var{A.B.C.D}} {}
-@deffnx {Command} {show ip bgp @var{X:X::X:X}} {}
-This command displays BGP routes. When no route is specified it
-display all of IPv4 BGP routes.
-@end deffn
-
-@example
-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
-@end example
-
-@deffn {Command} {show ip bgp regexp @var{line}} {}
-This command displays BGP routes using AS path regular expression
-(@pxref{BGP Regular Expressions}).
-@end deffn
-
-@deffn Command {show ip bgp community @var{community}} {}
-@deffnx Command {show ip bgp community @var{community} exact-match} {}
-This command displays BGP routes using @var{community} (@pxref{Display
-BGP Routes by Community}).
-@end deffn
-
-@deffn Command {show ip bgp community-list @var{word}} {}
-@deffnx Command {show ip bgp community-list @var{word} exact-match} {}
-This command displays BGP routes using community list (@pxref{Display
-BGP Routes by Community}).
-@end deffn
-
-@deffn {Command} {show bgp @{ipv4|ipv6@} summary} {}
-Show a bgp peer summary for the specified address family.
-@end deffn
-
-@deffn {Command} {show bgp @{ipv4|ipv6@} neighbor [@var{peer}]} {}
-This command shows information on a specific BGP @var{peer}.
-@end deffn
-
-@deffn {Command} {show bgp @{ipv4|ipv6@} dampening dampened-paths} {}
-Display paths suppressed due to dampening.
-@end deffn
-
-@deffn {Command} {show bgp @{ipv4|ipv6@} dampening flap-statistics} {}
-Display flap statistics of routes.
-@end deffn
-
-@node Other BGP commands
-@subsection Other BGP commands
-
-@deffn {Command} {clear bgp @{ipv4|ipv6@} *} {}
-Clear all address family peers.
-@end deffn
-
-@deffn {Command} {clear bgp @{ipv4|ipv6@} @var{peer}} {}
-Clear peers which have addresses of X.X.X.X
-@end deffn
-
-@deffn {Command} {clear bgp @{ipv4|ipv6@} @var{peer} soft in} {}
-Clear peer using soft reconfiguration.
-@end deffn
-
-@deffn {Command} {show debug} {}
-@end deffn
-
-@deffn {Command} {debug event} {}
-@end deffn
-
-@deffn {Command} {debug update} {}
-@end deffn
-
-@deffn {Command} {debug keepalive} {}
-@end deffn
-
-@deffn {Command} {no debug event} {}
-@end deffn
-
-@deffn {Command} {no debug update} {}
-@end deffn
-
-@deffn {Command} {no debug keepalive} {}
-@end deffn
-
-@node Capability Negotiation
-@section Capability Negotiation
-
-When adding IPv6 routing information exchange feature to BGP. There
-were some proposals. @acronym{IETF,Internet Engineering Task Force}
-@acronym{IDR, Inter Domain Routing} @acronym{WG, Working group} adopted
-a proposal called Multiprotocol Extension for BGP. The specification
-is described in @cite{RFC2283}. The protocol does not define new protocols.
-It defines new attributes to existing BGP. When it is used exchanging
-IPv6 routing information it is called BGP-4+. When it is used for
-exchanging multicast routing information it is called MBGP.
-
-@command{bgpd} supports Multiprotocol Extension for BGP. So if remote
-peer supports the protocol, @command{bgpd} can exchange IPv6 and/or
-multicast routing information.
-
-Traditional BGP did not have the feature to detect remote peer's
-capabilities, e.g. whether it can handle prefix types other than IPv4
-unicast routes. This was a big problem using Multiprotocol Extension
-for BGP to operational network. @cite{RFC2842, Capabilities
-Advertisement with BGP-4} adopted a feature called Capability
-Negotiation. @command{bgpd} use this Capability Negotiation to detect
-the remote peer's capabilities. If the peer is only configured as IPv4
-unicast neighbor, @command{bgpd} does not send these Capability
-Negotiation packets (at least not unless other optional BGP features
-require capability negotation).
-
-By default, Frr will bring up peering with minimal common capability
-for the both sides. For example, local router has unicast and
-multicast capabilitie and remote router has unicast capability. In
-this case, the local router will establish the connection with unicast
-only capability. When there are no common capabilities, Frr sends
-Unsupported Capability error and then resets the connection.
-
-If you want to completely match capabilities with remote peer. Please
-use @command{strict-capability-match} command.
-
-@deffn {BGP} {neighbor @var{peer} strict-capability-match} {}
-@deffnx {BGP} {no neighbor @var{peer} strict-capability-match} {}
-Strictly compares remote capabilities and local capabilities. If capabilities
-are different, send Unsupported Capability error then reset connection.
-@end deffn
-
-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 @command{dont-capability-negotiate}
-command to disable the feature.
-
-@deffn {BGP} {neighbor @var{peer} dont-capability-negotiate} {}
-@deffnx {BGP} {no neighbor @var{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.
-@end deffn
-
-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 @command{override-capability}, @command{bgpd} ignores
-received capabilities then override negotiated capabilities with
-configured values.
-
-@deffn {BGP} {neighbor @var{peer} override-capability} {}
-@deffnx {BGP} {no neighbor @var{peer} override-capability} {}
-Override the result of Capability Negotiation with local configuration.
-Ignore remote peer's capability value.
-@end deffn
-
-@node Route Reflector
-@section Route Reflector
-
-@deffn {BGP} {bgp cluster-id @var{a.b.c.d}} {}
-@end deffn
-
-@deffn {BGP} {neighbor @var{peer} route-reflector-client} {}
-@deffnx {BGP} {no neighbor @var{peer} route-reflector-client} {}
-@end deffn
-
-@node Route Server
-@section 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
-@samp{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).
-
-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 @code{view}s. @command{bgpd} can work as
-normal BGP router or Route Server or both at the same time.
-
-@menu
-* Multiple instance::
-* BGP instance and view::
-* Routing policy::
-* Viewing the view::
-@end menu
-
-@node Multiple instance
-@subsection Multiple instance
-
-To enable multiple view function of @code{bgpd}, you must turn on
-multiple instance feature beforehand.
-
-@deffn {Command} {bgp multiple-instance} {}
-Enable BGP multiple instance feature. After this feature is enabled,
-you can make multiple BGP instances or multiple BGP views.
-@end deffn
-
-@deffn {Command} {no bgp multiple-instance} {}
-Disable BGP multiple instance feature. You can not disable this feature
-when BGP multiple instances or views exist.
-@end deffn
-
-When you want to make configuration more Cisco like one,
-
-@deffn {Command} {bgp config-type cisco} {}
-Cisco compatible BGP configuration output.
-@end deffn
-
-When bgp config-type cisco is specified,
-
-``no synchronization'' is displayed.
-``no auto-summary'' is displayed.
-
-``network'' and ``aggregate-address'' argument is displayed as
-``A.B.C.D M.M.M.M''
-
-Frr: network 10.0.0.0/8
-Cisco: network 10.0.0.0
-
-Frr: aggregate-address 192.168.0.0/24
-Cisco: aggregate-address 192.168.0.0 255.255.255.0
-
-Community attribute handling is also different. If there is no
-configuration is specified community attribute and extended community
-attribute are sent to neighbor. When user manually disable the
-feature community attribute is not sent to the neighbor. In case of
-@command{bgp config-type cisco} is specified, community attribute is not
-sent to the neighbor by default. To send community attribute user has
-to specify @command{neighbor A.B.C.D send-community} command.
-
-@example
-!
-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
-!
-@end example
-
-@deffn {Command} {bgp config-type zebra} {}
-Frr style BGP configuration. This is default.
-@end deffn
-
-@node BGP instance and view
-@subsection BGP instance and view
-
-BGP instance is a normal BGP process. The result of route selection
-goes to the kernel routing table. You can setup different AS at the
-same time when BGP multiple instance feature is enabled.
-
-@deffn {Command} {router bgp @var{as-number}} {}
-Make a new BGP instance. You can use arbitrary word for the @var{name}.
-@end deffn
-
-@example
-@group
-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
-@end group
-@end example
-
-BGP view is almost same as normal BGP process. The result of
-route selection does not go to the kernel routing table. BGP view is
-only for exchanging BGP routing information.
-
-@deffn {Command} {router bgp @var{as-number} view @var{name}} {}
-Make a new BGP view. You can use arbitrary word for the @var{name}. This
-view's route selection result does not go to the kernel routing table.
-@end deffn
-
-With this command, you can setup Route Server like below.
-
-@example
-@group
-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
-@end group
-@end example
-
-@node Routing policy
-@subsection Routing policy
-
-You can set different routing policy for a peer. For example, you can
-set different filter for a peer.
-
-@example
-@group
-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
-@end group
-@end example
-
-This means BGP update from a peer 10.0.0.1 goes to both BGP view 1 and view
-2. When the update is inserted into view 1, distribute-list 1 is
-applied. On the other hand, when the update is inserted into view 2,
-distribute-list 2 is applied.
-
-@node Viewing the view
-@subsection Viewing the view
-
-To display routing table of BGP view, you must specify view name.
-
-@deffn {Command} {show ip bgp view @var{name}} {}
-Display routing table of BGP view @var{name}.
-@end deffn
-
-@node BGP Regular Expressions
-@section BGP Regular Expressions
-
-BGP regular expressions are based on @code{POSIX 1003.2} regular
-expressions. The following description is just a quick subset of the
-@code{POSIX} regular expressions. Adding to that, the special character
-'_' is added.
-
-@table @code
-@item .
-Matches any single character.
-@item *
-Matches 0 or more occurrences of pattern.
-@item +
-Matches 1 or more occurrences of pattern.
-@item ?
-Match 0 or 1 occurrences of pattern.
-@item ^
-Matches the beginning of the line.
-@item $
-Matches the end of the line.
-@item _
-Character @code{_} has special meanings in BGP regular expressions.
-It matches to space and comma , and AS set delimiter @{ and @} and AS
-confederation delimiter @code{(} and @code{)}. And it also matches to
-the beginning of the line and the end of the line. So @code{_} can be
-used for AS value boundaries match. This character technically evaluates
-to @code{(^|[,@{@}() ]|$)}.
-@end table
-
-@node How to set up a 6-Bone connection
-@section How to set up a 6-Bone connection
-
-
-@example
-@group
-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 @var{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 @var{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
-!
-@end group
-@end example
-
-@node Dump BGP packets and table
-@section Dump BGP packets and table
-
-@deffn Command {dump bgp all @var{path} [@var{interval}]} {}
-@deffnx Command {dump bgp all-et @var{path} [@var{interval}]} {}
-@deffnx Command {no dump bgp all [@var{path}] [@var{interval}]} {}
-Dump all BGP packet and events to @var{path} file.
-If @var{interval} is set, a new file will be created for echo @var{interval} of seconds.
-The path @var{path} can be set with date and time formatting (strftime).
-The type ‘all-et’ enables support for Extended Timestamp Header (@pxref{Packet Binary Dump Format}).
-(@pxref{Packet Binary Dump Format})
-@end deffn
-
-@deffn Command {dump bgp updates @var{path} [@var{interval}]} {}
-@deffnx Command {dump bgp updates-et @var{path} [@var{interval}]} {}
-@deffnx Command {no dump bgp updates [@var{path}] [@var{interval}]} {}
-Dump only BGP updates messages to @var{path} file.
-If @var{interval} is set, a new file will be created for echo @var{interval} of seconds.
-The path @var{path} can be set with date and time formatting (strftime).
-The type ‘updates-et’ enables support for Extended Timestamp Header (@pxref{Packet Binary Dump Format}).
-@end deffn
-
-@deffn Command {dump bgp routes-mrt @var{path}} {}
-@deffnx Command {dump bgp routes-mrt @var{path} @var{interval}} {}
-@deffnx Command {no dump bgp route-mrt [@var{path}] [@var{interval}]} {}
-Dump whole BGP routing table to @var{path}. This is heavy process.
-The path @var{path} can be set with date and time formatting (strftime).
-If @var{interval} is set, a new file will be created for echo @var{interval} of seconds.
-@end deffn
-
-Note: the interval variable can also be set using hours and minutes: 04h20m00.
-
-
-@node BGP Configuration Examples
-@section BGP Configuration Examples
-
-Example of a session to an upstream, advertising only one prefix to it.
-
-@example
-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
-
-@end example
-
-A more complex example. With upstream, peer and customer sessions.
-Advertising global prefixes and NO_EXPORT prefixes and providing
-actions for customer routes based on community values. Extensive use of
-route-maps and the 'call' feature to support selective advertising of
-prefixes. This example is intended as guidance only, it has NOT been
-tested and almost certainly containts silly mistakes, if not serious
-flaws.
-
-@example
-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
-@end example
-
-@include rpki.texi
+++ /dev/null
-@node Installation
-@chapter Installation
-
-@cindex How to install Frr
-@cindex Installation
-@cindex Installing Frr
-@cindex Building the system
-@cindex Making Frr
-
-There are three steps for installing the software: configuration,
-compilation, and installation.
-
-@menu
-* Configure the Software::
-* Build the Software::
-* Install the Software::
-@end menu
-
-The easiest way to get Frr running is to issue the following
-commands:
-
-@example
-% configure
-% make
-% make install
-@end example
-
-@node Configure the Software
-@section Configure the Software
-
-@menu
-* The Configure script and its options::
-* Least-Privilege support::
-* Linux notes::
-@end menu
-
-@node The Configure script and its options
-@subsection The Configure script and its options
-
-@cindex Configuration options
-@cindex Options for configuring
-@cindex Build options
-@cindex Distribution configuration
-@cindex Options to @code{./configure}
-
-Frr has an excellent configure script which automatically detects most
-host configurations. There are several additional configure options to
-customize the build to include or exclude specific features and dependencies.
-
-@table @option
-@item --disable-zebra
-Do not build zebra daemon.
-@item --disable-ripd
-Do not build ripd.
-@item --disable-ripngd
-Do not build ripngd.
-@item --disable-ospfd
-Do not build ospfd.
-@item --disable-ospf6d
-Do not build ospf6d.
-@item --disable-bgpd
-Do not build bgpd.
-@item --disable-bgp-announce
-Make @command{bgpd} which does not make bgp announcements at all. This
-feature is good for using @command{bgpd} as a BGP announcement listener.
-@item --enable-datacenter
-Enable system defaults to work as if in a Data Center. See defaults.h
-for what is changed by this configure option.
-@item --enable-snmp
-Enable SNMP support. By default, SNMP support is disabled.
-@item --disable-ospfapi
-Disable support for OSPF-API, an API to interface directly with ospfd.
-OSPF-API is enabled if --enable-opaque-lsa is set.
-@item --disable-ospfclient
-Disable building of the example OSPF-API client.
-@item --disable-ospf-ri
-Disable support for OSPF Router Information (RFC4970 & RFC5088) this
-requires support for Opaque LSAs and Traffic Engineering.
-@item --disable-isisd
-Do not build isisd.
-@item --enable-isis-topology
-Enable IS-IS topology generator.
-@item --enable-isis-te
-Enable Traffic Engineering Extension for ISIS (RFC5305)
-@item --enable-multipath=@var{ARG}
-Enable support for Equal Cost Multipath. @var{ARG} is the maximum number
-of ECMP paths to allow, set to 0 to allow unlimited number of paths.
-@item --enable-realms
-Enable the support of linux Realms. Convert tag values from 1-255
-into a realm value when inserting into the linux kernel. Then
-routing policy can be assigned to the realm. See the tc man page.
-@item --disable-rtadv
-Disable support IPV6 router advertisement in zebra.
-@item --enable-gcc-rdynamic
-Pass the @command{-rdynamic} option to the linker driver. This is in most
-cases neccessary for getting usable backtraces. This option defaults to on
-if the compiler is detected as gcc, but giving an explicit enable/disable is
-suggested.
-@item --disable-backtrace
-Controls backtrace support for the crash handlers. This is autodetected by
-default. Using the switch will enforce the requested behaviour, failing with
-an error if support is requested but not available. On BSD systems, this
-needs libexecinfo, while on glibc support for this is part of libc itself.
-@item --enable-dev-build
-Turn on some options for compiling FRR within a development environment in
-mind. Specifically turn on -g3 -O0 for compiling options and add inclusion
-of grammar sandbox.
-@item --enable-fuzzing
-Turn on some compile options to allow you to run fuzzing tools
-against the system. This tools is intended as a developer
-only tool and should not be used for normal operations
-@end table
-
-You may specify any combination of the above options to the configure
-script. By default, the executables are placed in @file{/usr/local/sbin}
-and the configuration files in @file{/usr/local/etc}. The @file{/usr/local/}
-installation prefix and other directories may be changed using the following
-options to the configuration script.
-
-@table @option
-@item --prefix=@var{prefix}
-Install architecture-independent files in @var{prefix} [/usr/local].
-@item --sysconfdir=@var{dir}
-Look for configuration files in @var{dir} [@var{prefix}/etc]. Note
-that sample configuration files will be installed here.
-@item --localstatedir=@var{dir}
-Configure zebra to use @var{dir} for local state files, such
-as pid files and unix sockets.
-@end table
-
-@example
-% ./configure --disable-snmp
-@end example
-
-This command will configure zebra and the routing daemons.
-
-@node Least-Privilege support
-@subsection Least-Privilege support
-
-@cindex Frr Least-Privileges
-@cindex Frr Privileges
-
-Additionally, you may configure zebra to drop its elevated privileges
-shortly after startup and switch to another user. The configure script will
-automatically try to configure this support. There are three configure
-options to control the behaviour of Frr daemons.
-
-@table @option
-@item --enable-user=@var{user}
-Switch to user @var{ARG} shortly after startup, and run as user @var{ARG}
-in normal operation.
-@item --enable-group=@var{group}
-Switch real and effective group to @var{group} shortly after
-startup.
-@item --enable-vty-group=@var{group}
-Create Unix Vty sockets (for use with vtysh) with group owndership set to
-@var{group}. This allows one to create a seperate group which is
-restricted to accessing only the Vty sockets, hence allowing one to
-delegate this group to individual users, or to run vtysh setgid to
-this group.
-@end table
-
-The default user and group which will be configured is 'frr' if no user
-or group is specified. Note that this user or group requires write access to
-the local state directory (see --localstatedir) and requires at least read
-access, and write access if you wish to allow daemons to write out their
-configuration, to the configuration directory (see --sysconfdir).
-
-On systems which have the 'libcap' capabilities manipulation library
-(currently only linux), the frr system will retain only minimal
-capabilities required, further it will only raise these capabilities for
-brief periods. On systems without libcap, frr will run as the user
-specified and only raise its uid back to uid 0 for brief periods.
-
-@node Linux notes
-@subsection Linux Notes
-
-@cindex Configuring Frr
-@cindex Building on Linux boxes
-@cindex Linux configurations
-
-There are several options available only to @sc{gnu}/Linux systems:
-@footnote{@sc{gnu}/Linux has very flexible kernel configuration features}. If
-you use @sc{gnu}/Linux, make sure that the current kernel configuration is
-what you want. Frr will run with any kernel configuration but some
-recommendations do exist.
-
-@table @var
-
-@item CONFIG_NETLINK
-Kernel/User netlink socket. This is a brand new feature which enables an
-advanced interface between the Linux kernel and zebra (@pxref{Kernel Interface}).
-
-@item CONFIG_RTNETLINK
-Routing messages.
-This makes it possible to receive netlink routing messages. If you
-specify this option, @command{zebra} can detect routing information
-updates directly from the kernel (@pxref{Kernel Interface}).
-
-@item CONFIG_IP_MULTICAST
-IP: multicasting.
-This option should be specified when you use @command{ripd} (@pxref{RIP}) or
-@command{ospfd} (@pxref{OSPFv2}) because these protocols use multicast.
-
-@end table
-
-IPv6 support has been added in @sc{gnu}/Linux kernel version 2.2. If you
-try to use the Frr IPv6 feature on a @sc{gnu}/Linux kernel, please
-make sure the following libraries have been installed. Please note that
-these libraries will not be needed when you uses @sc{gnu} C library 2.1
-or upper.
-
-@table @code
-
-@item inet6-apps
-The @code{inet6-apps} package includes basic IPv6 related libraries such
-as @code{inet_ntop} and @code{inet_pton}. Some basic IPv6 programs such
-as @command{ping}, @command{ftp}, and @command{inetd} are also
-included. The @code{inet-apps} can be found at
-@uref{ftp://ftp.inner.net/pub/ipv6/}.
-
-@item net-tools
-The @code{net-tools} package provides an IPv6 enabled interface and
-routing utility. It contains @command{ifconfig}, @command{route},
-@command{netstat}, and other tools. @code{net-tools} may be found at
-@uref{http://www.tazenda.demon.co.uk/phil/net-tools/}.
-
-@end table
-@c A - end of footnote
-
-@node Build the Software
-@section Build the Software
-
-After configuring the software, you will need to compile it for your
-system. Simply issue the command @command{make} in the root of the source
-directory and the software will be compiled. Cliff Note versions of
-different compilation examples can be found in the doc/Building_FRR_on_XXX.md
-files. If you have *any* problems at this stage, be certain to send a
-bug report @xref{Bug Reports}.
-
-@example
-% ./bootstrap.sh
-% ./configure <appropriate to your system>
-% make
-@end example
-@c A - End of node, Building the Software
-
-
-@node Install the Software
-@comment node-name, next, previous, up
-@section Install the Software
-
-Installing the software to your system consists of copying the compiled
-programs and supporting files to a standard location. After the
-installation process has completed, these files have been copied
-from your work directory to @file{/usr/local/bin}, and @file{/usr/local/etc}.
-
-To install the Frr suite, issue the following command at your shell
-prompt: @command{make install}.
-
-@example
-%
-% make install
-%
-@end example
-
-Frr daemons have their own terminal interface or VTY. After
-installation, you have to setup each beast's port number to connect to
-them. Please add the following entries to @file{/etc/services}.
-
-@example
-zebrasrv 2600/tcp # zebra service
-zebra 2601/tcp # zebra vty
-ripd 2602/tcp # RIPd vty
-ripngd 2603/tcp # RIPngd vty
-ospfd 2604/tcp # OSPFd vty
-bgpd 2605/tcp # BGPd vty
-ospf6d 2606/tcp # OSPF6d vty
-ospfapi 2607/tcp # ospfapi
-isisd 2608/tcp # ISISd vty
-nhrpd 2610/tcp # nhrpd vty
-pimd 2611/tcp # PIMd vty
-@end example
-
-If you use a FreeBSD newer than 2.2.8, the above entries are already
-added to @file{/etc/services} so there is no need to add it. If you
-specify a port number when starting the daemon, these entries may not be
-needed.
-
-You may need to make changes to the config files in
-@file{@value{INSTALL_PREFIX_ETC}/*.conf}. @xref{Config Commands}.
+++ /dev/null
-@cindex ISIS
-@node ISIS
-@chapter ISIS
-
-@acronym{ISIS,Intermediate System to Intermediate System} is a routing protocol
-which is described in @cite{ISO10589, RFC1195, RFC5308}. ISIS is an
-@acronym{IGP,Interior Gateway Protocol}. Compared with @acronym{RIP},
-@acronym{ISIS} can provide scalable network support and faster
-convergence times like @acronym{OSPF}. ISIS is widely used in large networks such as
-@acronym{ISP,Internet Service Provider} and carrier backbone networks.
-
-@menu
-* Configuring isisd::
-* ISIS router::
-* ISIS Timer::
-* ISIS region::
-* ISIS interface::
-* Showing ISIS information::
-* ISIS Traffic Engineering::
-* Debugging ISIS::
-* ISIS Configuration Examples::
-@end menu
-
-@node Configuring isisd
-@section Configuring isisd
-
-There are no @command{isisd} specific options. Common options can be
-specified (@pxref{Common Invocation Options}) to @command{isisd}.
-@command{isisd} needs to acquire interface information from
-@command{zebra} in order to function. Therefore @command{zebra} must be
-running before invoking @command{isisd}. Also, if @command{zebra} is
-restarted then @command{isisd} must be too.
-
-Like other daemons, @command{isisd} configuration is done in @acronym{ISIS}
-specific configuration file @file{isisd.conf}.
-
-@node ISIS router
-@section ISIS router
-
-To start ISIS process you have to specify the ISIS router. As of this
-writing, @command{isisd} does not support multiple ISIS processes.
-
-@deffn Command {router isis WORD} {}
-@deffnx Command {no router isis WORD} {}
-@anchor{router isis WORD}Enable or disable the ISIS process by specifying the ISIS domain with 'WORD'.
-@command{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}).
-@end deffn
-
-@deffn {ISIS Command} {net XX.XXXX. ... .XXX.XX} {}
-@deffnx {ISIS Command} {no net XX.XXXX. ... .XXX.XX} {}
-Set/Unset network entity title (NET) provided in ISO format.
-@end deffn
-
-@deffn {ISIS Command} {hostname dynamic} {}
-@deffnx {ISIS Command} {no hostname dynamic} {}
-Enable support for dynamic hostname.
-@end deffn
-
-@deffn {ISIS Command} {area-password [clear | md5] <password>} {}
-@deffnx {ISIS Command} {domain-password [clear | md5] <password>} {}
-@deffnx {ISIS Command} {no area-password} {}
-@deffnx {ISIS Command} {no domain-password} {}
-Configure the authentication password for an area, respectively a domain,
-as clear text or md5 one.
-@end deffn
-
-@deffn {ISIS Command} {log-adjacency-changes} {}
-@deffnx {ISIS Command} {no log-adjacency-changes} {}
-Log changes in adjacency state.
-@end deffn
-
-@deffn {ISIS Command} {metric-style [narrow | transition | wide]} {}
-@deffnx {ISIS Command} {no metric-style} {}
-@anchor{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
-@end deffn
-
-@deffn {ISIS Command} {set-overload-bit} {}
-@deffnx {ISIS Command} {no set-overload-bit} {}
-Set overload bit to avoid any transit traffic.
-@end deffn
-
-@node ISIS Timer
-@section ISIS Timer
-
-@deffn {ISIS Command} {lsp-gen-interval <1-120>} {}
-@deffnx {ISIS Command} {lsp-gen-interval [level-1 | level-2] <1-120>} {}
-@deffnx {ISIS Command} {no lsp-gen-interval} {}
-@deffnx {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).
-@end deffn
-
-@deffn {ISIS Command} {lsp-refresh-interval <1-65235>} {}
-@deffnx {ISIS Command} {lsp-refresh-interval [level-1 | level-2] <1-65235>} {}
-@deffnx {ISIS Command} {no lsp-refresh-interval} {}
-@deffnx {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).
-@end deffn
-
-@deffn {ISIS Command} {lsp-refresh-interval <1-65235>} {}
-@deffnx {ISIS Command} {lsp-refresh-interval [level-1 | level-2] <1-65235>} {}
-@deffnx {ISIS Command} {no lsp-refresh-interval} {}
-@deffnx {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).
-@end deffn
-
-@deffn {ISIS Command} {max-lsp-lifetime <360-65535>} {}
-@deffnx {ISIS Command} {max-lsp-lifetime [level-1 | level-2] <360-65535>} {}
-@deffnx {ISIS Command} {no max-lsp-lifetime} {}
-@deffnx {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).
-@end deffn
-
-@deffn {ISIS Command} {spf-interval <1-120>} {}
-@deffnx {ISIS Command} {spf-interval [level-1 | level-2] <1-120>} {}
-@deffnx {ISIS Command} {no spf-interval} {}
-@deffnx {ISIS Command} {no spf-interval [level-1 | level-2]} {}
-Set minimum interval between consecutive SPF calculations in seconds.
-@end deffn
-
-@node ISIS region
-@section ISIS region
-
-@deffn {ISIS Command} {is-type [level-1 | level-1-2 | level-2-only]} {}
-@deffnx {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
-@end deffn
-
-@node ISIS interface
-@section ISIS interface
-
-@deffn {Interface Command} {ip router isis WORD} {}
-@deffnx {Interface Command} {no ip router isis WORD} {}
-@anchor{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}).
-@end deffn
-
-@deffn {Interface Command} {isis circuit-type [level-1 | level-1-2 | level-2]} {}
-@deffnx {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
-@end deffn
-
-@deffn {Interface Command} {isis csnp-interval <1-600>} {}
-@deffnx {Interface Command} {isis csnp-interval <1-600> [level-1 | level-2]} {}
-@deffnx {Interface Command} {no isis csnp-interval} {}
-@deffnx {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).
-@end deffn
-
-@deffn {Interface Command} {isis hello padding} {}
-Add padding to IS-IS hello packets.
-@end deffn
-
-@deffn {Interface Command} {isis hello-interval <1-600>} {}
-@deffnx {Interface Command} {isis hello-interval <1-600> [level-1 | level-2]} {}
-@deffnx {Interface Command} {no isis hello-interval} {}
-@deffnx {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).
-@end deffn
-
-@deffn {Interface Command} {isis hello-multiplier <2-100>} {}
-@deffnx {Interface Command} {isis hello-multiplier <2-100> [level-1 | level-2]} {}
-@deffnx {Interface Command} {no isis hello-multiplier} {}
-@deffnx {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).
-@end deffn
-
-@deffn {Interface Command} {isis metric [<0-255> | <0-16777215>]} {}
-@deffnx {Interface Command} {isis metric [<0-255> | <0-16777215>] [level-1 | level-2]} {}
-@deffnx {Interface Command} {no isis metric} {}
-@deffnx {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}).
-@end deffn
-
-@deffn {Interface Command} {isis network point-to-point} {}
-@deffnx {Interface Command} {no isis network point-to-point} {}
-Set network type to 'Point-to-Point' (broadcast by default).
-@end deffn
-
-@deffn {Interface Command} {isis passive} {}
-@deffnx {Interface Command} {no isis passive} {}
-Configure the passive mode for this interface.
-@end deffn
-
-@deffn {Interface Command} {isis password [clear | md5] <password>} {}
-@deffnx {Interface Command} {no isis password} {}
-Configure the authentication password (clear or encoded text) for the interface.
-@end deffn
-
-@deffn {Interface Command} {isis priority <0-127>} {}
-@deffnx {Interface Command} {isis priority <0-127> [level-1 | level-2]} {}
-@deffnx {Interface Command} {no isis priority} {}
-@deffnx {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).
-@end deffn
-
-@deffn {Interface Command} {isis psnp-interval <1-120>} {}
-@deffnx {Interface Command} {isis psnp-interval <1-120> [level-1 | level-2]} {}
-@deffnx {Interface Command} {no isis psnp-interval} {}
-@deffnx {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).
-@end deffn
-
-@node Showing ISIS information
-@section Showing ISIS information
-
-@deffn {Command} {show isis summary} {}
-Show summary information about ISIS.
-@end deffn
-
-@deffn {Command} {show isis hostname} {}
-Show information about ISIS node.
-@end deffn
-
-@deffn {Command} {show isis interface} {}
-@deffnx {Command} {show isis interface detail} {}
-@deffnx {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.
-@end deffn
-
-@deffn {Command} {show isis neighbor} {}
-@deffnx {Command} {show isis neighbor <System Id>} {}
-@deffnx {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.
-@end deffn
-
-@deffn {Command} {show isis database} {}
-@deffnx {Command} {show isis database [detail]} {}
-@deffnx {Command} {show isis database <LSP id> [detail]} {}
-@deffnx {Command} {show isis database detail <LSP id>} {}
-Show the ISIS database globally, for a specific LSP id without or with details.
-@end deffn
-
-@deffn {Command} {show isis topology} {}
-@deffnx {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).
-@end deffn
-
-@deffn {Command} {show ip route isis} {}
-Show the ISIS routing table, as determined by the most recent SPF calculation.
-@end deffn
-
-@node ISIS Traffic Engineering
-@section Traffic Engineering
-
-@deffn {ISIS Command} {mpls-te on} {}
-@deffnx {ISIS Command} {no mpls-te} {}
-Enable Traffic Engineering LSP flooding.
-@end deffn
-
-@deffn {ISIS Command} {mpls-te router-address <A.B.C.D>} {}
-@deffnx {ISIS Command} {no mpls-te router-address} {}
-Configure stable IP address for MPLS-TE.
-@end deffn
-
-@deffn {Command} {show isis mpls-te interface} {}
-@deffnx {Command} {show isis mpls-te interface @var{interface}} {}
-Show MPLS Traffic Engineering parameters for all or specified interface.
-@end deffn
-
-@deffn {Command} {show isis mpls-te router} {}
-Show Traffic Engineering router parameters.
-@end deffn
-
-@node Debugging ISIS
-@section Debugging ISIS
-
-@deffn {Command} {debug isis adj-packets} {}
-@deffnx {Command} {no debug isis adj-packets} {}
-IS-IS Adjacency related packets.
-@end deffn
-
-@deffn {Command} {debug isis checksum-errors} {}
-@deffnx {Command} {no debug isis checksum-errors} {}
-IS-IS LSP checksum errors.
-@end deffn
-
-@deffn {Command} {debug isis events} {}
-@deffnx {Command} {no debug isis events} {}
-IS-IS Events.
-@end deffn
-
-@deffn {Command} {debug isis local-updates} {}
-@deffnx {Command} {no debug isis local-updates} {}
-IS-IS local update packets.
-@end deffn
-
-@deffn {Command} {debug isis packet-dump} {}
-@deffnx {Command} {no debug isis packet-dump} {}
-IS-IS packet dump.
-@end deffn
-
-@deffn {Command} {debug isis protocol-errors} {}
-@deffnx {Command} {no debug isis protocol-errors} {}
-IS-IS LSP protocol errors.
-@end deffn
-
-@deffn {Command} {debug isis route-events} {}
-@deffnx {Command} {no debug isis route-events} {}
-IS-IS Route related events.
-@end deffn
-
-@deffn {Command} {debug isis snp-packets} {}
-@deffnx {Command} {no debug isis snp-packets} {}
-IS-IS CSNP/PSNP packets.
-@end deffn
-
-@deffn {Command} {debug isis spf-events} {}
-@deffnx {Command} {debug isis spf-statistics} {}
-@deffnx {Command} {debug isis spf-triggers} {}
-@deffnx {Command} {no debug isis spf-events} {}
-@deffnx {Command} {no debug isis spf-statistics} {}
-@deffnx {Command} {no debug isis spf-triggers} {}
-IS-IS Shortest Path First Events, Timing and Statistic Data
-and triggering events.
-@end deffn
-
-@deffn {Command} {debug isis update-packets} {}
-@deffnx {Command} {no debug isis update-packets} {}
-Update related packets.
-@end deffn
-
-@deffn {Command} {show debugging isis} {}
-Print which ISIS debug level is activate.
-@end deffn
-
-@node ISIS Configuration Examples
-@section ISIS Configuration Examples
-A simple example, with MD5 authentication enabled:
-
-@example
-@group
-!
-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
-@end group
-@end example
-
-
-A Traffic Engineering configuration, with Inter-ASv2 support.
-
- - First, the 'zebra.conf' part:
-
-@example
-@group
-hostname HOSTNAME
-password PASSWORD
-log file /var/log/zebra.log
-!
-interface eth0
- ip address 10.2.2.2/24
- link-params
- enable
- metric 100
- max-bw 1.25e+07
- max-rsv-bw 1.25e+06
- unrsv-bw 0 1.25e+06
- unrsv-bw 1 1.25e+06
- unrsv-bw 2 1.25e+06
- unrsv-bw 3 1.25e+06
- unrsv-bw 4 1.25e+06
- unrsv-bw 5 1.25e+06
- unrsv-bw 6 1.25e+06
- unrsv-bw 7 1.25e+06
- admin-grp 0xab
-!
-interface eth1
- ip address 10.1.1.1/24
- link-params
- enable
- metric 100
- max-bw 1.25e+07
- max-rsv-bw 1.25e+06
- unrsv-bw 0 1.25e+06
- unrsv-bw 1 1.25e+06
- unrsv-bw 2 1.25e+06
- unrsv-bw 3 1.25e+06
- unrsv-bw 4 1.25e+06
- unrsv-bw 5 1.25e+06
- unrsv-bw 6 1.25e+06
- unrsv-bw 7 1.25e+06
- neighbor 10.1.1.2 as 65000
-@end group
-@end example
-
- - Then the 'isisd.conf' itself:
-
-@example
-@group
-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
-@end group
-@end example
+++ /dev/null
-
-@cindex OSPFv2
-@node OSPFv2
-@chapter OSPFv2
-
-@acronym{OSPF,Open Shortest Path First} version 2 is a routing protocol
-which is described in @cite{RFC2328, OSPF Version 2}. OSPF is an
-@acronym{IGP,Interior Gateway Protocol}. Compared with @acronym{RIP},
-@acronym{OSPF} can provide scalable network support and faster
-convergence times. OSPF is widely used in large networks such as
-@acronym{ISP,Internet Service Provider} backbone and enterprise
-networks.
-
-@menu
-* OSPF Fundamentals::
-* Configuring ospfd::
-* OSPF router::
-* OSPF area::
-* OSPF interface::
-* Redistribute routes to OSPF::
-* Showing OSPF information::
-* Opaque LSA::
-* OSPF Traffic Engineering::
-* Router Information::
-* Debugging OSPF::
-* OSPF Configuration Examples::
-@end menu
-
-@include ospf_fundamentals.texi
-
-@node Configuring ospfd
-@section Configuring ospfd
-
-There are no @command{ospfd} specific options. Common options can be
-specified (@pxref{Common Invocation Options}) to @command{ospfd}.
-@command{ospfd} needs to acquire interface information from
-@command{zebra} in order to function. Therefore @command{zebra} must be
-running before invoking @command{ospfd}. Also, if @command{zebra} is
-restarted then @command{ospfd} must be too.
-
-Like other daemons, @command{ospfd} configuration is done in @acronym{OSPF}
-specific configuration file @file{ospfd.conf}.
-
-@node OSPF router
-@section OSPF router
-
-To start OSPF process you have to specify the OSPF router. As of this
-writing, @command{ospfd} does not support multiple OSPF processes.
-
-@deffn Command {router ospf} {}
-@deffnx Command {no router ospf} {}
-Enable or disable the OSPF process. @command{ospfd} does not yet
-support multiple OSPF processes. So you can not specify an OSPF process
-number.
-@end deffn
-
-@deffn {OSPF Command} {ospf router-id @var{a.b.c.d}} {}
-@deffnx {OSPF Command} {no ospf router-id} {}
-@anchor{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 @command{ospfd} will obtain a router-ID
-automatically from @command{zebra}.
-@end deffn
-
-@deffn {OSPF Command} {ospf abr-type @var{type}} {}
-@deffnx {OSPF Command} {no ospf abr-type @var{type}} {}
-@var{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 (@pxref{OSPF virtual-link}).
-
-More information regarding the behaviour controlled by this command can
-be found in @cite{RFC 3509, Alternative Implementations of OSPF Area
-Border Routers}, and @cite{draft-ietf-ospf-shortcut-abr-02.txt}.
-
-Quote: "Though the definition of the @acronym{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."
-@end deffn
-
-@deffn {OSPF Command} {ospf rfc1583compatibility} {}
-@deffnx {OSPF Command} {no ospf rfc1583compatibility} {}
-@cite{RFC2328}, the sucessor to @cite{RFC1583}, 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.
-@end deffn
-
-@deffn {OSPF Command} {log-adjacency-changes [detail]} {}
-@deffnx {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.
-@end deffn
-
-@deffn {OSPF Command} {passive-interface @var{interface}} {}
-@deffnx {OSPF Command} {no passive-interface @var{interface}} {}
-@anchor{OSPF passive-interface} Do not speak OSPF interface on the
-given interface, but do advertise the interface as a stub link in the
-router-@acronym{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 (@pxref{Redistribute routes to OSPF})@. This is the only way to
-advertise non-OSPF links into stub areas.
-@end deffn
-
-@deffn {OSPF Command} {timers throttle spf @var{delay} @var{initial-holdtime} @var{max-holdtime}} {}
-@deffnx {OSPF Command} {no timers throttle spf} {}
-This command sets the initial @var{delay}, the @var{initial-holdtime}
-and the @var{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 @var{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 @var{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 @var{initial-holdtime}, bounded
-by the @var{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 @var{initial-holdtime}. The current
-holdtime can be viewed with @ref{show ip ospf}, where it is expressed as
-a multiplier of the @var{initial-holdtime}.
-
-@example
-@group
-router ospf
- timers throttle spf 200 400 10000
-@end group
-@end example
-
-In this example, the @var{delay} is set to 200ms, the @var{initial
-holdtime} is set to 400ms and the @var{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.
-
-This command supercedes the @command{timers spf} command in previous Frr
-releases.
-@end deffn
-
-@deffn {OSPF Command} {max-metric router-lsa [on-startup|on-shutdown] <5-86400>} {}
-@deffnx {OSPF Command} {max-metric router-lsa administrative} {}
-@deffnx {OSPF Command} {no max-metric router-lsa [on-startup|on-shutdown|administrative]} {}
-This enables @cite{RFC3137, OSPF Stub Router Advertisement} 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.
-
-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 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.
-
-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
-@command{ospfd} is restarted later, the command will then take effect
-until manually deconfigured.
-
-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.
-@end deffn
-
-@deffn {OSPF Command} {auto-cost reference-bandwidth <1-4294967>} {}
-@deffnx {OSPF Command} {no auto-cost reference-bandwidth} {}
-@anchor{OSPF 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 configuration setting MUST be consistent across all routers within the
-OSPF domain.
-@end deffn
-
-@deffn {OSPF Command} {network @var{a.b.c.d/m} area @var{a.b.c.d}} {}
-@deffnx {OSPF Command} {network @var{a.b.c.d/m} area @var{<0-4294967295>}} {}
-@deffnx {OSPF Command} {no network @var{a.b.c.d/m} area @var{a.b.c.d}} {}
-@deffnx {OSPF Command} {no network @var{a.b.c.d/m} area @var{<0-4294967295>}} {}
-@anchor{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.
-
-@example
-@group
-router ospf
- network 192.168.1.0/24 area 0.0.0.0
-@end group
-@end example
-
-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.
-
-In some cases it may be more convenient to enable OSPF on a per
-interface/subnet basis (@pxref{OSPF ip ospf area command}).
-
-@end deffn
-
-@node OSPF area
-@section OSPF area
-
-@deffn {OSPF Command} {area @var{a.b.c.d} range @var{a.b.c.d/m}} {}
-@deffnx {OSPF Command} {area <0-4294967295> range @var{a.b.c.d/m}} {}
-@deffnx {OSPF Command} {no area @var{a.b.c.d} range @var{a.b.c.d/m}} {}
-@deffnx {OSPF Command} {no area <0-4294967295> range @var{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.
-
-@example
-@group
-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
-@end group
-@end example
-
-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.
-@end deffn
-
-@deffn {OSPF Command} {area @var{a.b.c.d} range IPV4_PREFIX not-advertise} {}
-@deffnx {OSPF Command} {no area @var{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.
-@end deffn
-
-@deffn {OSPF Command} {area @var{a.b.c.d} range IPV4_PREFIX substitute IPV4_PREFIX} {}
-@deffnx {OSPF Command} {no area @var{a.b.c.d} range IPV4_PREFIX substitute IPV4_PREFIX} {}
-Substitute summarized prefix with another prefix.
-
-@example
-@group
-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
-@end group
-@end example
-
-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.
-@end deffn
-
-@deffn {OSPF Command} {area @var{a.b.c.d} virtual-link @var{a.b.c.d}} {}
-@deffnx {OSPF Command} {area <0-4294967295> virtual-link @var{a.b.c.d}} {}
-@deffnx {OSPF Command} {no area @var{a.b.c.d} virtual-link @var{a.b.c.d}} {}
-@deffnx {OSPF Command} {no area <0-4294967295> virtual-link @var{a.b.c.d}} {}
-@anchor{OSPF virtual-link}
-@end deffn
-
-@deffn {OSPF Command} {area @var{a.b.c.d} shortcut} {}
-@deffnx {OSPF Command} {area <0-4294967295> shortcut} {}
-@deffnx {OSPF Command} {no area @var{a.b.c.d} shortcut} {}
-@deffnx {OSPF Command} {no area <0-4294967295> shortcut} {}
-Configure the area as Shortcut capable. See @cite{RFC3509}. This requires
-that the 'abr-type' be set to 'shortcut'.
-@end deffn
-
-@deffn {OSPF Command} {area @var{a.b.c.d} stub} {}
-@deffnx {OSPF Command} {area <0-4294967295> stub} {}
-@deffnx {OSPF Command} {no area @var{a.b.c.d} stub} {}
-@deffnx {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.
-@end deffn
-
-@deffn {OSPF Command} {area @var{a.b.c.d} stub no-summary} {}
-@deffnx {OSPF Command} {area <0-4294967295> stub no-summary} {}
-@deffnx {OSPF Command} {no area @var{a.b.c.d} stub no-summary} {}
-@deffnx {OSPF Command} {no area <0-4294967295> stub no-summary} {}
-Prevents an @command{ospfd} ABR from injecting inter-area
-summaries into the specified stub area.
-@end deffn
-
-@deffn {OSPF Command} {area @var{a.b.c.d} default-cost <0-16777215>} {}
-@deffnx {OSPF Command} {no area @var{a.b.c.d} default-cost <0-16777215>} {}
-Set the cost of default-summary LSAs announced to stubby areas.
-@end deffn
-
-@deffn {OSPF Command} {area @var{a.b.c.d} export-list NAME} {}
-@deffnx {OSPF Command} {area <0-4294967295> export-list NAME} {}
-@deffnx {OSPF Command} {no area @var{a.b.c.d} export-list NAME} {}
-@deffnx {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.
-
-@example
-@group
-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
-@end group
-@end example
-
-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.
-@end deffn
-
-@deffn {OSPF Command} {area @var{a.b.c.d} import-list NAME} {}
-@deffnx {OSPF Command} {area <0-4294967295> import-list NAME} {}
-@deffnx {OSPF Command} {no area @var{a.b.c.d} import-list NAME} {}
-@deffnx {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.
-@end deffn
-
-@deffn {OSPF Command} {area @var{a.b.c.d} filter-list prefix NAME in} {}
-@deffnx {OSPF Command} {area @var{a.b.c.d} filter-list prefix NAME out} {}
-@deffnx {OSPF Command} {area <0-4294967295> filter-list prefix NAME in} {}
-@deffnx {OSPF Command} {area <0-4294967295> filter-list prefix NAME out} {}
-@deffnx {OSPF Command} {no area @var{a.b.c.d} filter-list prefix NAME in} {}
-@deffnx {OSPF Command} {no area @var{a.b.c.d} filter-list prefix NAME out} {}
-@deffnx {OSPF Command} {no area <0-4294967295> filter-list prefix NAME in} {}
-@deffnx {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.
-@end deffn
-
-@deffn {OSPF Command} {area @var{a.b.c.d} authentication} {}
-@deffnx {OSPF Command} {area <0-4294967295> authentication} {}
-@deffnx {OSPF Command} {no area @var{a.b.c.d} authentication} {}
-@deffnx {OSPF Command} {no area <0-4294967295> authentication} {}
-Specify that simple password authentication should be used for the given
-area.
-@end deffn
-
-@deffn {OSPF Command} {area @var{a.b.c.d} authentication message-digest} {}
-@deffnx {OSPF Command} {area <0-4294967295> authentication message-digest} {}
-
-@anchor{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 (@pxref{ip
-ospf message-digest-key}).
-
-MD5 authentication may also be configured on a per-interface basis
-(@pxref{ip ospf authentication message-digest}). Such per-interface
-settings will override any per-area authentication setting.
-@end deffn
-
-@node OSPF interface
-@section OSPF interface
-
-@deffn {Interface Command} {ip ospf area @var{AREA} [@var{ADDR}]} {}
-@deffnx {Interface Command} {no ip ospf area [@var{ADDR}]} {}
-@anchor{OSPF ip ospf area command}
-
-Enable OSPF on the interface, optionally restricted to just the IP address
-given by @var{ADDR}, putting it in the @var{AREA} area. Per interface area
-settings take precedence to network commands (@pxref{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.
-
-@end deffn
-
-@deffn {Interface Command} {ip ospf authentication-key @var{AUTH_KEY}} {}
-@deffnx {Interface Command} {no ip ospf authentication-key} {}
-Set OSPF authentication key to a simple password. After setting @var{AUTH_KEY},
-all OSPF packets are authenticated. @var{AUTH_KEY} has length up to 8 chars.
-
-Simple text password authentication is insecure and deprecated in favour of
-MD5 HMAC authentication (@pxref{ip ospf authentication message-digest}).
-@end deffn
-
-@deffn {Interface Command} {ip ospf authentication message-digest} {}
-@anchor{ip ospf authentication message-digest}Specify that MD5 HMAC
-authentication must be used on this interface. MD5 keying material must
-also be configured (@pxref{ip ospf message-digest-key}). Overrides any
-authentication enabled on a per-area basis (@pxref{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.
-@end deffn
-
-@deffn {Interface Command} {ip ospf message-digest-key KEYID md5 KEY} {}
-@deffnx {Interface Command} {no ip ospf message-digest-key} {}
-@anchor{ip ospf message-digest-key}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.
-
-KEY is the actual message digest key, of up to 16 chars (larger strings
-will be truncated), and is associated with the given KEYID.
-@end deffn
-
-@deffn {Interface Command} {ip ospf cost <1-65535>} {}
-@deffnx {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.
-@end deffn
-
-@deffn {Interface Command} {ip ospf dead-interval <1-65535>} {}
-@deffnx {Interface Command} {ip ospf dead-interval minimal hello-multiplier <2-20>} {}
-@deffnx {Interface Command} {no ip ospf dead-interval} {}
-@anchor{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.
-
-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.
-@end deffn
-
-@deffn {Interface Command} {ip ospf hello-interval <1-65535>} {}
-@deffnx {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.
-
-This command has no effect if @ref{ip ospf dead-interval minimal} is also
-specified for the interface.
-@end deffn
-
-@deffn {Interface Command} {ip ospf network (broadcast|non-broadcast|point-to-multipoint|point-to-point)} {}
-@deffnx {Interface Command} {no ip ospf network} {}
-Set explicitly network type for specifed interface.
-@end deffn
-
-@deffn {Interface Command} {ip ospf priority <0-255>} {}
-@deffnx {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.
-@end deffn
-
-@deffn {Interface Command} {ip ospf retransmit-interval <1-65535>} {}
-@deffnx {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.
-@end deffn
-
-@deffn {Interface Command} {ip ospf transmit-delay} {}
-@deffnx {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.
-@end deffn
-
-@deffn {Interface Command} {ip ospf area (A.B.C.D|<0-4294967295>)} {}
-@deffnx {Interface Command} {no ip ospf area} {}
-Enable ospf on an interface and set associated area.
-@end deffn
-
-@node Redistribute routes to OSPF
-@section Redistribute routes to OSPF
-
-@deffn {OSPF Command} {redistribute (kernel|connected|static|rip|bgp)} {}
-@deffnx {OSPF Command} {redistribute (kernel|connected|static|rip|bgp) @var{route-map}} {}
-@deffnx {OSPF Command} {redistribute (kernel|connected|static|rip|bgp) metric-type (1|2)} {}
-@deffnx {OSPF Command} {redistribute (kernel|connected|static|rip|bgp) metric-type (1|2) route-map @var{word}} {}
-@deffnx {OSPF Command} {redistribute (kernel|connected|static|rip|bgp) metric <0-16777214>} {}
-@deffnx {OSPF Command} {redistribute (kernel|connected|static|rip|bgp) metric <0-16777214> route-map @var{word}} {}
-@deffnx {OSPF Command} {redistribute (kernel|connected|static|rip|bgp) metric-type (1|2) metric <0-16777214>} {}
-@deffnx {OSPF Command} {redistribute (kernel|connected|static|rip|bgp) metric-type (1|2) metric <0-16777214> route-map @var{word}} {}
-@deffnx {OSPF Command} {no redistribute (kernel|connected|static|rip|bgp)} {}
-@anchor{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}.
-
-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
-@dfn{passive-interface}, see @ref{OSPF passive-interface}.
-@end deffn
-
-@deffn {OSPF Command} {default-information originate} {}
-@deffnx {OSPF Command} {default-information originate metric <0-16777214>} {}
-@deffnx {OSPF Command} {default-information originate metric <0-16777214> metric-type (1|2)} {}
-@deffnx {OSPF Command} {default-information originate metric <0-16777214> metric-type (1|2) route-map @var{word}} {}
-@deffnx {OSPF Command} {default-information originate always} {}
-@deffnx {OSPF Command} {default-information originate always metric <0-16777214>} {}
-@deffnx {OSPF Command} {default-information originate always metric <0-16777214> metric-type (1|2)} {}
-@deffnx {OSPF Command} {default-information originate always metric <0-16777214> metric-type (1|2) route-map @var{word}} {}
-@deffnx {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.
-@end deffn
-
-@deffn {OSPF Command} {distribute-list NAME out (kernel|connected|static|rip|ospf} {}
-@deffnx {OSPF Command} {no distribute-list NAME out (kernel|connected|static|rip|ospf} {}
-@anchor{ospf distribute-list}Apply the access-list filter, NAME, to
-redistributed routes of the given type before allowing the routes to
-redistributed into OSPF (@pxref{OSPF redistribute}).
-@end deffn
-
-@deffn {OSPF Command} {default-metric <0-16777214>} {}
-@deffnx {OSPF Command} {no default-metric} {}
-@end deffn
-
-@deffn {OSPF Command} {distance <1-255>} {}
-@deffnx {OSPF Command} {no distance <1-255>} {}
-@end deffn
-
-@deffn {OSPF Command} {distance ospf (intra-area|inter-area|external) <1-255>} {}
-@deffnx {OSPF Command} {no distance ospf} {}
-@end deffn
-
-@deffn {Command} {router zebra} {}
-@deffnx {Command} {no router zebra} {}
-@end deffn
-
-@node Showing OSPF information
-@section Showing OSPF information
-
-@deffn {Command} {show ip ospf} {}
-@anchor{show ip ospf}Show information on a variety of general OSPF and
-area state and configuration information.
-@end deffn
-
-@deffn {Command} {show ip ospf interface [INTERFACE]} {}
-Show state and configuration of OSPF the specified interface, or all
-interfaces if no interface is given.
-@end deffn
-
-@deffn {Command} {show ip ospf neighbor} {}
-@deffnx {Command} {show ip ospf neighbor INTERFACE} {}
-@deffnx {Command} {show ip ospf neighbor detail} {}
-@deffnx {Command} {show ip ospf neighbor INTERFACE detail} {}
-@end deffn
-
-@deffn {Command} {show ip ospf database} {}
-@end deffn
-
-@deffn {Command} {show ip ospf database (asbr-summary|external|network|router|summary)} {}
-@deffnx {Command} {show ip ospf database (asbr-summary|external|network|router|summary) @var{link-state-id}} {}
-@deffnx {Command} {show ip ospf database (asbr-summary|external|network|router|summary) @var{link-state-id} adv-router @var{adv-router}} {}
-@deffnx {Command} {show ip ospf database (asbr-summary|external|network|router|summary) adv-router @var{adv-router}} {}
-@deffnx {Command} {show ip ospf database (asbr-summary|external|network|router|summary) @var{link-state-id} self-originate} {}
-@deffnx {Command} {show ip ospf database (asbr-summary|external|network|router|summary) self-originate} {}
-@end deffn
-
-@deffn {Command} {show ip ospf database max-age} {}
-@end deffn
-
-@deffn {Command} {show ip ospf database self-originate} {}
-@end deffn
-
-@deffn {Command} {show ip ospf route} {}
-Show the OSPF routing table, as determined by the most recent SPF calculation.
-@end deffn
-
-@node Opaque LSA
-@section Opaque LSA
-
-@deffn {OSPF Command} {ospf opaque-lsa} {}
-@deffnx {OSPF Command} {capability opaque} {}
-@deffnx {OSPF Command} {no ospf opaque-lsa} {}
-@deffnx {OSPF Command} {no capability opaque} {}
-@command{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}).
-@end deffn
-
-@deffn {Command} {show ip ospf database (opaque-link|opaque-area|opaque-external)} {}
-@deffnx {Command} {show ip ospf database (opaque-link|opaque-area|opaque-external) @var{link-state-id}} {}
-@deffnx {Command} {show ip ospf database (opaque-link|opaque-area|opaque-external) @var{link-state-id} adv-router @var{adv-router}} {}
-@deffnx {Command} {show ip ospf database (opaque-link|opaque-area|opaque-external) adv-router @var{adv-router}} {}
-@deffnx {Command} {show ip ospf database (opaque-link|opaque-area|opaque-external) @var{link-state-id} self-originate} {}
-@deffnx {Command} {show ip ospf database (opaque-link|opaque-area|opaque-external) self-originate} {}
-Show Opaque LSA from the database.
-@end deffn
-
-@node OSPF Traffic Engineering
-@section Traffic Engineering
-
-@deffn {OSPF Command} {mpls-te on} {}
-@deffnx {OSPF Command} {no mpls-te} {}
-Enable Traffic Engineering LSA flooding.
-@end deffn
-
-@deffn {OSPF Command} {mpls-te router-address <A.B.C.D>} {}
-@deffnx {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).
-@end deffn
-
-@deffn {OSPF Command} {mpls-te inter-as area <area-id>|as} {}
-@deffnx {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.
-@end deffn
-
-@deffn {Command} {show ip ospf mpls-te interface} {}
-@deffnx {Command} {show ip ospf mpls-te interface @var{interface}} {}
-Show MPLS Traffic Engineering parameters for all or specified interface.
-@end deffn
-
-@deffn {Command} {show ip ospf mpls-te router} {}
-Show Traffic Engineering router parameters.
-@end deffn
-
-@node Router Information
-@section Router Information
-
-@deffn {OSPF Command} {router-info [as | area <A.B.C.D>]} {}
-@deffnx {OSPF Command} {no router-info} {}
-Enable Router Information (RFC4970) LSA advertisement with AS scope (default) or Area scope flooding
-when area is specified.
-@end deffn
-
-@deffn {OSPF Command} {pce address <A.B.C.D>} {}
-@deffnx {OSPF Command} {no pce address} {}
-@deffnx {OSPF Command} {pce domain as <0-65535>} {}
-@deffnx {OSPF Command} {no pce domain as <0-65535>} {}
-@deffnx {OSPF Command} {pce neighbor as <0-65535>} {}
-@deffnx {OSPF Command} {no pce neighbor as <0-65535>} {}
-@deffnx {OSPF Command} {pce flag BITPATTERN} {}
-@deffnx {OSPF Command} {no pce flag} {}
-@deffnx {OSPF Command} {pce scope BITPATTERN} {}
-@deffnx {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.
-@end deffn
-
-@deffn {Command} {show ip ospf router-info} {}
-Show Router Capabilities flag.
-@end deffn
-@deffn {Command} {show ip ospf router-info pce} {}
-Show Router Capabilities PCE parameters.
-@end deffn
-
-@node Debugging OSPF
-@section Debugging OSPF
-
-@deffn {Command} {debug ospf packet (hello|dd|ls-request|ls-update|ls-ack|all) (send|recv) [detail]} {}
-@deffnx {Command} {no debug ospf packet (hello|dd|ls-request|ls-update|ls-ack|all) (send|recv) [detail]} {}
-Dump Packet for debugging
-@end deffn
-
-@deffn {Command} {debug ospf ism} {}
-@deffnx {Command} {debug ospf ism (status|events|timers)} {}
-@deffnx {Command} {no debug ospf ism} {}
-@deffnx {Command} {no debug ospf ism (status|events|timers)} {}
-Show debug information of Interface State Machine
-@end deffn
-
-@deffn {Command} {debug ospf nsm} {}
-@deffnx {Command} {debug ospf nsm (status|events|timers)} {}
-@deffnx {Command} {no debug ospf nsm} {}
-@deffnx {Command} {no debug ospf nsm (status|events|timers)} {}
-Show debug information of Network State Machine
-@end deffn
-
-@deffn {Command} {debug ospf event} {}
-@deffnx {Command} {no debug ospf event} {}
-Show debug information of OSPF event
-@end deffn
-
-@deffn {Command} {debug ospf nssa} {}
-@deffnx {Command} {no debug ospf nssa} {}
-Show debug information about Not So Stub Area
-@end deffn
-
-@deffn {Command} {debug ospf lsa} {}
-@deffnx {Command} {debug ospf lsa (generate|flooding|refresh)} {}
-@deffnx {Command} {no debug ospf lsa} {}
-@deffnx {Command} {no debug ospf lsa (generate|flooding|refresh)} {}
-Show debug detail of Link State messages
-@end deffn
-
-@deffn {Command} {debug ospf te} {}
-@deffnx {Command} {no debug ospf te} {}
-Show debug information about Traffic Engineering LSA
-@end deffn
-
-@deffn {Command} {debug ospf zebra} {}
-@deffnx {Command} {debug ospf zebra (interface|redistribute)} {}
-@deffnx {Command} {no debug ospf zebra} {}
-@deffnx {Command} {no debug ospf zebra (interface|redistribute)} {}
-Show debug information of ZEBRA API
-@end deffn
-
-@deffn {Command} {show debugging ospf} {}
-@end deffn
-
-@node OSPF Configuration Examples
-@section OSPF Configuration Examples
-A simple example, with MD5 authentication enabled:
-
-@example
-@group
-!
-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
-@end group
-@end example
-
-An @acronym{ABR} router, with MD5 authentication and performing summarisation
-of networks between the areas:
-
-@example
-@group
-!
-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
-!
-@end group
-@end example
-
-A Traffic Engineering configuration, with Inter-ASv2 support.
-
- - First, the 'zebra.conf' part:
-
-@example
-@group
-hostname HOSTNAME
-password PASSWORD
-log file /var/log/zebra.log
-!
-interface eth0
- ip address 198.168.1.1/24
- link-params
- enable
- admin-grp 0xa1
- metric 100
- max-bw 1.25e+07
- max-rsv-bw 1.25e+06
- unrsv-bw 0 1.25e+06
- unrsv-bw 1 1.25e+06
- unrsv-bw 2 1.25e+06
- unrsv-bw 3 1.25e+06
- unrsv-bw 4 1.25e+06
- unrsv-bw 5 1.25e+06
- unrsv-bw 6 1.25e+06
- unrsv-bw 7 1.25e+06
-!
-interface eth1
- ip address 192.168.2.1/24
- link-params
- enable
- metric 10
- max-bw 1.25e+07
- max-rsv-bw 1.25e+06
- unrsv-bw 0 1.25e+06
- unrsv-bw 1 1.25e+06
- unrsv-bw 2 1.25e+06
- unrsv-bw 3 1.25e+06
- unrsv-bw 4 1.25e+06
- unrsv-bw 5 1.25e+06
- unrsv-bw 6 1.25e+06
- unrsv-bw 7 1.25e+06
- neighbor 192.168.2.2 as 65000
-@end group
-@end example
-
- - Then the 'ospfd.conf' itself:
-
-@example
-@group
-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
-@end group
-@end example
-
-A router information example with PCE advsertisement:
-
-@example
-@group
-!
-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
- pce address 192.168.1.1
- pce flag 0x80
- pce domain as 65400
- pce neighbor as 65500
- pce neighbor as 65200
- pce scope 0x80
-!
-@end group
-@end example
+++ /dev/null
-@c -*-texinfo-*-
-@c This is part of the Frr Manual.
-@c @value{COPYRIGHT_STR}
-@c See file frr.texi for copying conditions.
-@node PIM
-@chapter PIM
-
-PIM -- Protocol Independent Multicast
-
-@command{pimd} supports pim-sm as well as igmp v2 and v3. pim is
-vrf aware and can work within the context of vrf's in order to
-do S,G mrouting.
-
-@menu
-* Starting and Stopping pimd::
-* PIM Configuration::
-* PIM Interface Configuration::
-* PIM Multicast RIB insertion::
-* Show PIM Information::
-* PIM Debug Commands::
-@end menu
-
-@node Starting and Stopping pimd
-@section Starting and Stopping pimd
-
-The default configuration file name of @command{pimd}'s is
-@file{pimd.conf}. When invocation @command{pimd} searches directory
-@value{INSTALL_PREFIX_ETC}. If @file{pimd.conf} is not there
-then next search current directory.
-
-@command{pimd} requires zebra for proper operation. Additionally
-@command{pimd} depends on routing properly setup and working
-in the network that it is working on.
-
-@example
-@group
-# zebra -d
-# pimd -d
-@end group
-@end example
-
-Please note that @command{zebra} must be invoked before @command{pimd}.
-
-To stop @command{pimd}. Please use @command{kill `cat
-/var/run/pimd.pid`}. Certain signals have special meanings to @command{pimd}.
-
-@table @samp
-@item SIGUSR1
-Rotate @command{pimd} logfile.
-@item SIGINT
-@itemx SIGTERM
-@command{pimd} sweeps all installed PIM mroutes then terminates properly.
-@end table
-
-@command{pimd} invocation options. Common options that can be specified
-(@pxref{Common Invocation Options}).
-
-@node PIM Configuration
-
-@deffn Command {ip pim rp A.B.C.D A.B.C.D/M} {}
-In order to use pim, it is necessary to configure a RP for join
-messages to be sent to. Currently the only methodology to
-do this is via static rp commands. All routers in the
-pim network must agree on these values. The first ip address
-is the RP's address and the second value is the matching
-prefix of group ranges covered. This command is vrf aware,
-to configure for a vrf, enter the vrf submode.
-@end deffn
-
-@deffn Command {ip pim spt-switchover infinity-and-beyond} {}
-On the last hop router if it is desired to not switch over
-to the SPT tree. Configure this command. This command is
-vrf aware, to configure for a vrf, enter the vrf submode.
-#end deffn
-
-@deffn Comand {ip pim ecmp} {}
-If pim has the a choice of ECMP nexthops for a particular
-RPF, pim will cause S,G flows to be spread out amongst
-the nexthops. If this command is not specified then
-the first nexthop found will be used. This command
-is vrf aware, to configure for a vrf, enter the vrf submode.
-@end deffn
-
-@deffn Command {ip pim ecmp rebalance} {}
-If pim is using ECMP and an interface goes down, cause
-pim to rebalance all S,G flows aross the remaining
-nexthops. If this command is not configured pim only
-modifies those S,G flows that were using the interface
-that went down. This command is vrf aware, to configure
-for a vrf, enter the vrf submode.
-@end deffn
-
-@deffn Command {ip pim join-prune-interval (60-600)} {}
-Modify the join/prune interval that pim uses to the
-new value. Time is specified in seconds. This command
-is vrf aware, to configure for a vrf, enter the vrf submode.
-@end deffn
-
-@deffn Command {ip pim keep-alive-timer (31-60000)} {}
-Modify the time out value for a S,G flow from 31-60000
-seconds. 31 seconds is choosen for a lower bound
-because some hardware platforms cannot see data flowing
-in better than 30 second chunks. This comand is vrf
-aware, to configure for a vrf, enter the vrf submode.
-@end deffn
-
-@deffn Command {ip pim packets (1-100)} {}
-When processing packets from a neighbor process the
-number of packets incoming at one time before moving
-on to the next task. The default value is 3 packets.
-This command is only useful at scale when you can
-possibly have a large number of pim control packets
-flowing. This command is vrf aware, to configure for
-a vrf, enter the vrf submode.
-@end deffn
-
-@deffn Command {ip pim register-suppress-time (5-60000)} {}
-Modify the time that pim will register suppress a FHR
-will send register notifications to the kernel. This command
-is vrf aware, to configure for a vrf, enter the vrf submode.
-@end deffn
-
-@deffn Command {ip pim send-v6-secondary} {}
-When sending pim hello packets tell pim to send
-any v6 secondary addresses on the interface. This
-information is used to allow pim to use v6 nexthops
-in it's decision for RPF lookup. This command
-is vrf aware, to configure for a vrf, enter the vrf submode.
-@end deffn
-
-@deffn Command {ip pim ssm prefix-list WORD} {}
-Specify a range of group addresses via a prefix-list
-that forces pim to never do SM over. This command
-is vrf aware, to configure for a vrf, enter the vrf submode.
-@end deffn
-
-@deffn Command {ip multicast rpf-lookup-mode WORD} {}
-Modify how PIM does RPF lookups in the zebra routing table.
-You can use these choices:
-@table @lookup_modes
-@item longer-prefix
-Lookup the RPF in both tables using the longer prefix as a match
-@item lower-distance
-Lookup the RPF in both tables using the lower distance as a match
-@item mrib-only
-Lookup in the Multicast RIB only
-@item mrib-then-urib
-Lookup in the Multicast RIB then the Unicast Rib, returning first found.
-This is the default value for lookup if this command is not entered
-@item urib-only
-Lookup in the Unicast Rib only.
-@end table
-@end deffn
-
-@node PIM Interface Configuration
-@section PIM Interface Configuration
-
-PIM interface commands allow you to configure an
-interface as either a Receiver or a interface
-that you would like to form pim neighbors on. If the
-interface is in a vrf, enter the interface command with
-the vrf keyword at the end.
-
-@deffn {PIM Interface Command] {ip pim bfd} {}
-Turns on BFD support for PIM for this interface.
-@end deffn
-
-@deffn {PIM Interface Command} {ip pim drpriority (1-4294967295)} {}
-Set the DR Priority for the interface. This command is useful
-to allow the user to influence what node becomes the DR for a
-lan segment.
-@end deffn
-
-@deffn {PIM Interface Command} {ip pim hello (1-180) (1-180)} {}
-Set the pim hello and hold interval for a interface.
-@end deffn
-
-@deffn {PIM Interface Command} {ip pim sm} {}
-Tell pim that we would like to use this interface to form
-pim neighbors over. Please note we will *not* accept
-igmp reports over this interface with this command.
-@end deffn
-
-@deffn {PIM Interface Command} {ip igmp} {}
-Tell pim to receive IGMP reports and Query on this
-interface. The default version is v3. This command
-is useful on the LHR.
-@end deffn
-
-@deffn {PIM Interface Command} {ip igmp query-interval (1-1800)} {}
-Set the IGMP query interval that PIM will use.
-@end deffn
-
-@deffn {PIM Interface Command} {ip igmp query-max-response-time (10-250)} {}
-Set the IGMP query response timeout value. If an report is not returned
-in the specified time we will assume the S,G or *,G has timed out.
-@end deffn
-
-@deffn {PIM Interface Command} {ip igmp version (2-3)} {}
-Set the IGMP version used on this interface. The default value
-is 3.
-@end deffn
-
-@deffn {PIM Interface Command} {ip multicat boundary oil WORD} {}
-Set a pim multicast boundary, based upon the WORD prefix-list. If
-a pim join or IGMP report is received on this interface and the Group
-is denyed by the prefix-list, PIM will ignore the join or report.
-@end deffn
-
-@node PIM Multicast RIB insertion::
-@section PIM Multicast RIB insertion::
-
-In order to influence Multicast RPF lookup, it is possible to insert
-into zebra routes for the Multicast RIB. These routes are only
-used for RPF lookup and will not be used by zebra for insertion
-into the kernel *or* for normal rib processing. As such it is
-possible to create weird states with these commands. Use with
-caution. Most of the time this will not be necessary.
-
-@deffn {PIM Multicast RIB insertion} {ip mroute A.B.C.D/M A.B.C.D (1-255)} {}
-Insert into the Multicast Rib Route A.B.C.D/M with specified nexthop. The distance can be specified as well if desired.
-@end deffn
-
-@deffn {PIM Multicast RIB insertion} {ip mroute A.B.C.D/M INTERFACE (1-255)} {}
-Insert into the Multicast Rib Route A.B.C.D/M using the specified INTERFACE.
-The distance can be specified as well if desired.
-@end deffn
-
-@node Show PIM Information::
-@section Show PIM Information
-
-All PIM show commands are vrf aware and typically allow you to insert
-a specified vrf command if information is desired about a specific vrf.
-If no vrf is specified then the default vrf is assumed. Finally
-the special keyword 'all' allows you to look at all vrfs for the command.
-Naming a vrf 'all' will cause great confusion.
-
-@deffn {Show PIM Information} {show ip multicast}
-Display various information about the interfaces used in this pim
-instance.
-@end deffn
-
-@deffn {Show PIM Information} {show ip mroute}
-Display information about installed into the kernel S,G mroutes.
-@end deffn
-
-@deffn {Show PIM Information} {show ip mroute count}
-Display information about installed into the kernel S,G mroutes
-and in addition display data about packet flow for the mroutes.
-@end deffn
-
-@deffn {Show PIM Information} {show ip pim assert}
-Display information about asserts in the PIM system for S,G mroutes.
-@end deffn
-
-@deffn {Show PIM Information} {show ip pim assert-internal}
-Display internal assert state for S,G mroutes
-@end deffn
-
-@deffn {Show PIM Information} {show ip pim assert-metric}
-Display metric information about assert state for S,G mroutes
-@end deffn
-
-@deffn {Show PIM Information} {show ip pim assert-winner-metric}
-Display winner metric for assert state for S,G mroutes
-@end deffn
-
-@deffn {Show PIM Information} {show ip pim group-type}
-Display SSM group ranges
-@end deffn
-
-@deffn {Show PIM Information} {show ip pim interface}
-Display information about interfaces PIM is using.
-@end deffn
-
-@deffn {Show PIM Information} {show ip pim join}
-Display information about PIM joins received.
-@end deffn
-
-@deffn {Show PIM Information} {show ip pim local-membership} {}
-Display information about PIM interface local-membership
-@end deffn
-
-@deffn {Show PIM Information} {show ip pim neighbor} {}
-Display information about PIM neighbors
-@end deffn
-
-@deffn {Show PIM Information} {show ip pim nexthop} {}
-Display information about pim nexthops that are being
-used
-@end deffn
-
-@deffn {Show PIM Information} {show ip pim nexthop-lookup} {}
-Display information about a S,G pair and how the RPF would
-be choosen. This is especially useful if there are ECMP's
-available from the RPF lookup.
-@end deffn
-
-@deffn {Show PIM Information} {show ip pim rp-info} {}
-Display information about RP's that are configured on
-this router
-@end deffn
-
-@deffn {Show PIM Information} {show ip pim rpf} {}
-Display information about currently being used S,G's
-and their RPF lookup information. Additionally display
-some statistics about what has been happening on the
-router
-@end deffn
-
-@deffn {show PIM Information} {show ip pim secondary} {}
-Display information about an interface and all the
-secondary addresses associated with it
-@end deffn
-
-@deffn {show PIM Information} {show ip pim state} {}
-Display information about known S,G's and incoming
-interface as well as the OIL and how they were choosen
-@end deffn
-
-@deffn {show PIM Information} {show ip pim upstream} {}
-Display upstream information about a S,G mroute
-@end deffn
-
-@deffn {show PIM Information} {show ip pim upstream-join-desired} {}
-Display upstream information for S,G's and if we desire to
-join the mcast tree
-@end deffn
-
-@deffn {show PIM Information} {show ip pim upstream-rpf} {}
-Display upstream information for S,G's and the RPF data
-associated with them
-@end deffn
-
-@deffn {show PIM Information} {show ip rpf} {}
-Display the multicast RIB created in zebra
-@end deffn
-
-@node PIM Debug Commands
-@section PIM Debug Commands
-
-The debugging subsystem for PIM behaves in accordance with how FRR handles debugging. You can specify debugging at the enable cli mode as well as the configure cli mode. If you specify debug commands in the configuration cli mode, the debug commands can be persistent across restarts of the FRR pimd if the config was written out.
-
-@deffn {PIM Debug Commands} {debug pim events}
-This turns on debugging for PIM system events. Especially timers.
-@end deffn
-
-@deffn {PIM Debug Commands} {debug pim nht}
-This turns on debugging for PIM nexthop tracking. It will display information about RPF lookups and information about when a nexthop changes.
-@end deffn
-
-@deffn {PIM Debug Commands} {debug pim packet-dump}
-This turns on an extraordinary amount of data. Each pim packet sent and received is dumped for debugging purposes. This should be considered a developer only command
-@end deffn
-
-@deffn {PIM Debug Commands} {debug pim packets}
-This turns on information about packet generation for sending and about packet handling from a received packet
-@end deffn
-
-@deffn {PIM Debug Commands} {debug pim trace}
-This traces pim code and how it is running.
-@end deffn
-
-@deffn {PIM Debug Commands} {debug pim zebra}
-This gathers data about events from zebra that come up through the zapi
-@end deffn
+++ /dev/null
-@node Route Map
-@chapter Route Map
-
-Route maps provide a means to both filter and/or apply actions to
-route, hence allowing policy to be applied to routes.
-
-@menu
-* Route Map Command::
-* Route Map Match Command::
-* Route Map Set Command::
-* Route Map Call Command::
-* Route Map Exit Action Command::
-* Route Map Examples::
-@end menu
-
-Route-maps are an ordered list of route-map entries. Each entry may
-specify up to four distincts sets of clauses:
-
-@table @samp
-@item Matching Policy
-
-This specifies the policy implied if the @samp{Matching Conditions} are
-met or not met, and which actions of the route-map are to be taken, if
-any. The two possibilities are:
-
-@itemize @minus
-@item
-@samp{permit}: If the entry matches, then carry out the @samp{Set
-Actions}. Then finish processing the route-map, permitting the route,
-unless an @samp{Exit Action} indicates otherwise.
-
-@item
-@samp{deny}: If the entry matches, then finish processing the route-map and
-deny the route (return @samp{deny}).
-@end itemize
-
-The @samp{Matching Policy} is specified as part of the command which
-defines the ordered entry in the route-map. See below.
-
-@item Matching Conditions
-
-A route-map entry may, optionally, specify one or more conditions which
-must be matched if the entry is to be considered further, as governed
-by the Match Policy. If a route-map entry does not explicitely specify
-any matching conditions, then it always matches.
-
-@item Set Actions
-
-A route-map entry may, optionally, specify one or more @samp{Set
-Actions} to set or modify attributes of the route.
-
-@item Call Action
-
-Call to another route-map, after any @samp{Set Actions} have been
-carried out. If the route-map called returns @samp{deny} then
-processing of the route-map finishes and the route is denied,
-regardless of the @samp{Matching Policy} or the @samp{Exit Policy}. If
-the called route-map returns @samp{permit}, then @samp{Matching Policy}
-and @samp{Exit Policy} govern further behaviour, as normal.
-
-@item Exit Policy
-
-An entry may, optionally, specify an alternative @samp{Exit Policy} to
-take if the entry matched, rather than the normal policy of exiting the
-route-map and permitting the route. The two possibilities are:
-
-@itemize @minus
-@item
-@samp{next}: Continue on with processing of the route-map entries.
-
-@item
-@samp{goto N}: Jump ahead to the first route-map entry whose order in
-the route-map is >= N. Jumping to a previous entry is not permitted.
-@end itemize
-@end table
-
-The default action of a route-map, if no entries match, is to deny.
-I.e. a route-map essentially has as its last entry an empty @samp{deny}
-entry, which matches all routes. To change this behaviour, one must
-specify an empty @samp{permit} entry as the last entry in the route-map.
-
-To summarise the above:
-
-@multitable {permit} {action} {No Match}
-@headitem @tab Match @tab No Match
-@item @emph{Permit} @tab action @tab cont
-@item @emph{Deny} @tab deny @tab cont
-@end multitable
-
-@table @samp
-
-@item action
-@itemize @minus
-@item
-Apply @emph{set} statements
-
-@item
-If @emph{call} is present, call given route-map. If that returns a @samp{deny}, finish
-processing and return @samp{deny}.
-
-@item
-If @samp{Exit Policy} is @emph{next}, goto next route-map entry
-
-@item
-If @samp{Exit Policy} is @emph{goto}, goto first entry whose order in the list
-is >= the given order.
-
-@item
-Finish processing the route-map and permit the route.
-@end itemize
-
-@item deny
-@itemize @minus
-@item
-The route is denied by the route-map (return @samp{deny}).
-@end itemize
-
-@item cont
-@itemize @minus
-@item
-goto next route-map entry
-@end itemize
-@end table
-
-@node Route Map Command
-@section Route Map Command
-
-@deffn {Command} {route-map @var{route-map-name} (permit|deny) @var{order}} {}
-
-Configure the @var{order}'th entry in @var{route-map-name} with
-@samp{Match Policy} of either @emph{permit} or @emph{deny}.
-
-@end deffn
-
-@node Route Map Match Command
-@section Route Map Match Command
-
-@deffn {Route-map Command} {match ip address @var{access_list}} {}
-Matches the specified @var{access_list}
-@end deffn
-
-@deffn {Route-map Command} {match ip address @var{prefix-list}} {}
-Matches the specified @var{prefix-list}
-@end deffn
-
-@deffn {Route-map Command} {match ip address prefix-len @var{0-32}} {}
-Matches the specified @var{prefix-len}. This is a Zebra specific command.
-@end deffn
-
-@deffn {Route-map Command} {match ipv6 address @var{access_list}} {}
-Matches the specified @var{access_list}
-@end deffn
-
-@deffn {Route-map Command} {match ipv6 address @var{prefix-list}} {}
-Matches the specified @var{prefix-list}
-@end deffn
-
-@deffn {Route-map Command} {match ipv6 address prefix-len @var{0-128}} {}
-Matches the specified @var{prefix-len}. This is a Zebra specific command.
-@end deffn
-
-@deffn {Route-map Command} {match ip next-hop @var{ipv4_addr}} {}
-Matches the specified @var{ipv4_addr}.
-@end deffn
-
-@deffn {Route-map Command} {match aspath @var{as_path}} {}
-Matches the specified @var{as_path}.
-@end deffn
-
-@deffn {Route-map Command} {match metric @var{metric}} {}
-Matches the specified @var{metric}.
-@end deffn
-
-@deffn {Route-map Command} {match tag @var{tag}} {}
-Matches the specified tag value associated with the route.
-This tag value can be in the range of (1-4294967295).
-@end deffn
-
-@deffn {Route-map Command} {match local-preference @var{metric}} {}
-Matches the specified @var{local-preference}.
-@end deffn
-
-@deffn {Route-map Command} {match community @var{community_list}} {}
-Matches the specified @var{community_list}
-@end deffn
-
-@deffn {Route-map Command} {match peer @var{ipv4_addr}} {}
-This is a BGP specific match command. Matches the peer ip address
-if the neighbor was specified in this manner.
-@end deffn
-
-@deffn {Route-map Command} {match peer @var{ipv6_addr}} {}
-This is a BGP specific match command. Matches the peer ipv6
-address if the neighbor was specified in this manner.
-@end deffn
-
-@deffn {Route-map Command} {match peer @var{interface_name}} {}
-This is a BGP specific match command. Matches the peer
-interface name specified if the neighbor was specified
-in this manner.
-@end deffn
-
-@node Route Map Set Command
-@section Route Map Set Command
-
-@deffn {Route-map Command} {set tag @var{tag}} {}
-Set a tag on the matched route. This tag value can be from
-(1-4294967295). Additionally if you have compiled with
-the --enable-realms configure option. Tag values from (1-255)
-are sent to the linux kernel as a realm value. Then route
-policy can be applied. See the tc man page.
-@end deffn
-
-@deffn {Route-map Command} {set ip next-hop @var{ipv4_address}} {}
-Set the BGP nexthop address.
-@end deffn
-
-@deffn {Route-map Command} {set local-preference @var{local_pref}} {}
-Set the BGP local preference to @var{local_pref}.
-@end deffn
-
-@deffn {Route-map Command} {set weight @var{weight}} {}
-Set the route's weight.
-@end deffn
-
-@deffn {Route-map Command} {set metric @var{metric}} {}
-@anchor{routemap set metric}
-Set the BGP attribute MED.
-@end deffn
-
-@deffn {Route-map Command} {set as-path prepend @var{as_path}} {}
-Set the BGP AS path to prepend.
-@end deffn
-
-@deffn {Route-map Command} {set community @var{community}} {}
-Set the BGP community attribute.
-@end deffn
-
-@deffn {Route-map Command} {set ipv6 next-hop global @var{ipv6_address}} {}
-Set the BGP-4+ global IPv6 nexthop address.
-@end deffn
-
-@deffn {Route-map Command} {set ipv6 next-hop local @var{ipv6_address}} {}
-Set the BGP-4+ link local IPv6 nexthop address.
-@end deffn
-
-@node Route Map Call Command
-@section Route Map Call Command
-
-@deffn {Route-map Command} {call @var{name}} {}
-Call route-map @var{name}. If it returns deny, deny the route and
-finish processing the route-map.
-@end deffn
-
-@node Route Map Exit Action Command
-@section Route Map Exit Action Command
-
-@deffn {Route-map Command} {on-match next} {}
-@deffnx {Route-map Command} {continue} {}
-Proceed on to the next entry in the route-map.
-@end deffn
-
-@deffn {Route-map Command} {on-match goto @var{N}} {}
-@deffnx {Route-map Command} {continue @var{N}} {}
-Proceed processing the route-map at the first entry whose order is >= N
-@end deffn
-
-@node Route Map Examples
-@section Route Map Examples
-
-A simple example of a route-map:
-
-@example
-@group
-route-map test permit 10
- match ip address 10
- set local-preference 200
-@end group
-@end example
-
-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
-useage of route-maps, including of the @samp{call} action.
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
+ link-params
+ enable
+ admin-grp 0xa1
+ metric 100
+ max-bw 1.25e+07
+ max-rsv-bw 1.25e+06
+ unrsv-bw 0 1.25e+06
+ unrsv-bw 1 1.25e+06
+ unrsv-bw 2 1.25e+06
+ unrsv-bw 3 1.25e+06
+ unrsv-bw 4 1.25e+06
+ unrsv-bw 5 1.25e+06
+ unrsv-bw 6 1.25e+06
+ unrsv-bw 7 1.25e+06
!
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
-
+ link-params
+ enable
+ metric 10
+ max-bw 1.25e+07
+ max-rsv-bw 1.25e+06
+ unrsv-bw 0 1.25e+06
+ unrsv-bw 1 1.25e+06
+ unrsv-bw 2 1.25e+06
+ unrsv-bw 3 1.25e+06
+ unrsv-bw 4 1.25e+06
+ unrsv-bw 5 1.25e+06
+ unrsv-bw 6 1.25e+06
+ unrsv-bw 7 1.25e+06
+ neighbor 192.168.2.2 as 65000
+ 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:::
+++ /dev/null
-@c -*-texinfo-*-
-@c This is part of the Frr Manual.
-@c @value{COPYRIGHT_STR}
-@c See file frr.texi for copying conditions.
-
-@node VNC and VNC-GW
-@chapter VNC and VNC-GW
-This chapter describes how to use
-Virtual Network Control (@acronym{VNC}) services,
-including Network Virtualization Authority (@acronym{NVA}) and
-VNC Gateway (@acronym{VNC-GW}) functions.
-Background information on NVAs,
-Network Virtualization Edges (@acronym{NVE}s), underlay networks (@acronym{UN}s),
-and virtual networks (@acronym{VN}s) is available from the
-@url{https://datatracker.ietf.org/wg/nvo3,IETF Network Virtualization Overlays (@acronym{NVO3}) Working Group}.
-VNC Gateways (@acronym{VNC-GW}s) support the import/export of routing
-information between VNC and customer edge routers (@acronym{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
-@cite{RFC4364, BGP/MPLS IP Virtual Private Networks (VPNs)}, and
-@cite{RFC4659, BGP-MPLS IP Virtual Private Network (VPN) Extension for
-IPv6 VPN }. Encapsulation information is provided via
-the Tunnel Encapsulation Attribute, @cite{RFC5512, The BGP
-Encapsulation Subsequent Address Family Identifier (SAFI) and the BGP
-Tunnel Encapsulation Attribute}, 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). @code{OpenFlow} is an example
-RFP. Specific RFP implementations may choose to implement either a
-@code{hard-state} or @code{soft-state} prefix and address registration
-model. To support a @code{soft-state} refresh model, a @var{lifetime}
-in seconds is associated with all registrations and responses.
-
-The chapter also provides sample configurations for basic example scenarios.
-
-@menu
-* Configuring VNC Services::
-* Manual Address Control::
-* Other VNC-Related Commands::
-* Example VNC and VNC-GW Configurations::
-* Release Notes::
-@end menu
-
-@node Configuring VNC Services
-@section Configuring VNC
-
-Virtual Network Control (@acronym{VNC}) service configuration commands
-appear in the @code{router bgp} section of the BGPD configuration file
-(@pxref{BGP Configuration Examples}). The commands are broken down into
-the following areas:
-
-@menu
-* General VNC Configuration::
-* RFP Related Configuration::
-* VNC Defaults Configuration::
-* VNC NVE Group Configuration::
-* VNC L2 Group Configuration::
-* Configuring Redistribution of Routes from Other Routing Protocols::
-* Configuring Export of Routes to Other Routing Protocols::
-@end menu
-
-@code{General VNC} configuration applies to general VNC operation and is
-primarily used to control the method used to advertise tunnel
-information.
-
-@code{Remote Forwarder Protocol (RFP)} configuration relates to the
-protocol used between NVAs and NVEs.
-
-@code{VNC Defaults} provides default parameters for registered NVEs.
-
-@code{VNC NVE Group} provides for configuration of a specific set of
-registered NVEs and overrides default parameters.
-
-@code{Redistribution} and @code{Export} control VNC-GW operation, i.e.,
-the import/export of routing
-information between VNC and customer edge routers (@acronym{CE}s)
-operating within a VN.
-
-@node General VNC Configuration
-@subsection General VNC Configuration
-
-@deffn {VNC} {vnc advertise-un-method encap-attr} {}
-Advertise NVE underlay-network IP addresses using
-the UN address sub-TLV of the Tunnel Encapsulation attribute
-(@code{encap-attr}). The default is @code{encap-attr}.
-@end deffn
-
-@node RFP Related Configuration
-@subsection 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.,
-@code{OpenFlow}. The example code includes the following sample
-configuration:
-
-@deffn {RFP} {rfp example-config-value @var{VALUE}}
-This is a simple example configuration parameter included as part of the
-RFP example code. @code{VALUE} must be in the range of 0 to 4294967295.
-@end deffn
-
-@node VNC Defaults Configuration
-@subsection VNC Defaults Configuration
-
-The VNC Defaults section allows the user to specify default values for
-configuration parameters for all registered NVEs.
-Default values are overridden by @ref{VNC NVE Group Configuration}.
-
-@deffn {VNC} {vnc defaults} {}
-Enter VNC configuration mode for specifying VNC default behaviors. Use
-@code{exit-vnc} to leave VNC configuration mode. @code{vnc
-defaults} is optional.
-
-@example
-vnc defaults
- ... various VNC defaults
-exit-vnc
-@end example
-@end deffn
-
-These are the statements that can appear between @code{vnc defaults}
-and @code{exit-vnc}.
-
-@deffn {VNC} {rt import @var{rt-list}} {}
-@deffnx {VNC} {rt export @var{rt-list}} {}
-@deffnx {VNC} {rt both @var{rt-list}} {}
-
-Specify default route target import and export lists. @var{rt-list} is a
-space-separated list of route targets, each element of which is
-in one of the following forms:
-@itemize
-@item @var{IPv4-address}:@var{two-byte-integer}
-@item @var{four-byte-autonomous-system-number}:@var{two-byte-integer}
-@item @var{two-byte-autonomous-system-number}:@var{four-byte-integer}
-@end itemize
-
-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 (@pxref{VNC NVE Group Configuration}).
-
-@end deffn
-
-@deffn {VNC} {rd @var{route-distinguisher}}
-
-Specify the default route distinguisher (RD) for routes advertised via BGP
-VPNs. The route distinguisher must be in one of four forms:
-@itemize
-@item @var{IPv4-address}:@var{two-byte-integer}
-@item @var{four-byte-autonomous-system-number}:@var{two-byte-integer}
-@item @var{two-byte-autonomous-system-number}:@var{four-byte-integer}
-@item auto:vn:@var{two-byte-integer}
-@end itemize
-
-If RD is specified in the defaults section, the default RD
-value is @var{two-byte-autonomous-system-number=0}:@var{four-byte-integer=0}.
-
-A complete definition of this parameter is
-given below (@pxref{VNC NVE Group Configuration}).
-@end deffn
-
-@deffn {VNC} {l2rd @var{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 (@pxref{VNC NVE Group Configuration}).
-@end deffn
-
-@deffn {VNC} {response-lifetime @var{lifetime}|infinite} {}
-Specify the default lifetime to be included in RFP
-response messages sent to NVEs.
-
-A complete definition of this parameter is
-given below (@pxref{VNC NVE Group Configuration}).
-
-@end deffn
-
-@deffn {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.
-@end deffn
-
-@deffn {VNC} {export bgp|zebra no route-map}
-Specify that no route-map should be applied to routes
-being exported to bgp or zebra.
-@end deffn
-
-@deffn {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.
-@end deffn
-
-@deffn {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.
-@end deffn
-
-@deffn {VNC} {exit-vnc} {}
-Exit VNC configuration mode.
-@end deffn
-
-@c The following example @code{vnc defaults} defines a route target import-export
-@c list for the route targets 1000:1 and 1000:2; a default route
-@c distinguisher, 4444:10; and a default response lifetime of 500
-@c seconds.
-@c
-@c @example
-@c vnc defaults
-@c rt both 1000:1 1000:2
-@c rd 4444:10
-@c response-lifetime 500
-@c exit-vnc
-@c @end example
-
-@node VNC NVE Group Configuration
-@subsection VNC NVE Group Configuration
-
-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
-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
-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.
-
-Configuration values specified for an NVE group apply to all
-member NVEs and override configuration values specified in the VNC
-Defaults section.
-
-@strong{At least one @code{nve-group} is mandatory for useful VNC
-operation.}
-
-@deffn {VNC} {vnc nve-group @var{name}} {}
-Enter VNC configuration mode for defining the NVE group @var{name}.
-Use @code{exit} or @code{exit-vnc} to exit group configuration mode.
-
-@example
-vnc nve-group group1
- ... configuration commands
-exit-vnc
-@end example
-@end deffn
-
-@deffn {VNC} {no vnc nve-group @var{name}} {}
-Delete the NVE group named @var{name}.
-@end deffn
-
-The following statements are valid in an NVE group definition:
-
-@deffn {VNC} {l2rd @var{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 @code{auto:vn}, which
-means to use the least-significant octet of the originating
-NVE's VN address.
-@end deffn
-
-@deffn {VNC} {prefix vn|un A.B.C.D/M|X:X::X:X/M} {}
-@anchor{prefix}
-Specify the matching prefix for this NVE group by either virtual-network address
-(@code{vn}) or underlay-network address (@code{un}). Either or both virtual-network
-and underlay-network prefixes may be specified. Subsequent virtual-network or
-underlay-network values within a @code{vnc nve-group} @code{exit-vnc}
-block override their respective previous values.
-
-These prefixes are used only for determining assignments of NVEs
-to NVE Groups.
-@end deffn
-
-@deffn {VNC} {rd @var{route-distinguisher}}
-Specify the route distinguisher for routes advertised via BGP
-VPNs. The route distinguisher must be in one of these forms:
-@itemize
-@item @var{IPv4-address}:@var{two-byte-integer}
-@item @var{four-byte-autonomous-system-number}:@var{two-byte-integer}
-@item @var{two-byte-autonomous-system-number}:@var{four-byte-integer}
-@item auto:vn:@var{two-byte-integer}
-@end itemize
-
-Routes originated by NVEs in the NVE group will use
-the group's specified @var{route-distinguisher} when they are
-advertised via BGP.
-If the @code{auto} form is specified, it means that a matching NVE has
-its RD set to
-@var{rd_type=IP=1}:@var{IPv4-address=VN-address}:@var{two-byte-integer},
-for IPv4 VN addresses and
-@var{rd_type=IP=1}:@var{IPv4-address=Last-four-bytes-of-VN-address}:@var{two-byte-integer},
-for IPv6 VN addresses.
-
-If the NVE group definition does not specify a @var{route-distinguisher},
-then the default @var{route-distinguisher} is used.
-If neither a group nor a default @var{route-distinguisher} is
-configured, then the advertised RD is set to
-@var{two-byte-autonomous-system-number=0}:@var{four-byte-integer=0}.
-@end deffn
-
-@deffn {VNC} {response-lifetime @var{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.
-
-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.
-
-If the NVE group definition does not specify a @var{response-lifetime},
-the default @var{response-lifetime} will be used.
-If neither a group nor a default @var{response-lifetime} is configured,
-the value 3600 will be used. The maximum response lifetime is 2147483647.
-@end deffn
-
-@deffn {VNC} {rt export @var{rt-list}} {}
-@deffnx {VNC} {rt import @var{rt-list}} {}
-@deffnx {VNC} {rt both @var{rt-list}} {}
-Specify route target import and export lists. @var{rt-list} is a
-space-separated list of route targets, each element of which is
-in one of the following forms:
-@itemize
-@item @var{IPv4-address}:@var{two-byte-integer}
-@item @var{four-byte-autonomous-system-number}:@var{two-byte-integer}
-@item @var{two-byte-autonomous-system-number}:@var{four-byte-integer}
-@end itemize
-
-The first form, @code{rt export}, specifies an @var{export rt-list}.
-The @var{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 @var{export rt-list},
-then the default @var{export rt-list} is used.
-If neither a group nor a default @var{export rt-list} is configured,
-then no RT list will be sent; in turn, these routes will probably
-not be processed
-by receiving NVAs.
-
-The second form, @code{rt import} specifies an @var{import rt-list},
-which is a filter for incoming routes.
-In order to be made available to NVEs in the group,
-incoming BGP VPN @w{SAFI} routes must have
-RT lists that have at least one route target in common with the
-group's @var{import rt-list}.
-
-If the NVE group definition does not specify an import filter,
-then the default @var{import rt-list} is used.
-If neither a group nor a default @var{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, @code{rt both}, is a shorthand way of specifying both
-lists simultaneously, and is equivalent to @code{rt export @var{rt-list}}
-followed by @code{rt import @var{rt-list}}.
-@end deffn
-
-@deffn {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.
-@end deffn
-
-@deffn {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.
-@end deffn
-
-@deffn {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.
-@end deffn
-
-@deffn {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.
-@end deffn
-
-@c The following example shows two @code{vnc nve-group} definitions. The first one,
-@c ``group1'', applies to the IPV4 virtual-network route prefix 172.16/16. It
-@c sets the response lifetime to 200 seconds. It defines a route target
-@c import-export filter for the route targets 1000:1 and 1000:2
-@c
-@c The second @code{vnc nve-group} definition, ``group2'', applies to the IPV6
-@c underlay-network route prefix 10.0.2/24. It defines the same response
-@c lifetime and import-export filter as ``group1''.
-@c
-@c @example
-@c vnc nve-group group1
-@c prefix vn 172.16/16
-@c response-lifetime 200
-@c rt both 1000:1 1000:2
-@c exit-vnc
-@c
-@c vnc nve-group group2
-@c prefix un 10.0.2/24
-@c response-lifetime 200
-@c rt both 1000:1 1000:2
-@c exit-vnc
-@c @end example
-
-@node VNC L2 Group Configuration
-@subsection 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, @pxref{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 @cite{RFC7432, BGP MPLS-Based Ethernet VPN}. 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.
-
-@deffn {VNC} {vnc l2-group @var{name}} {}
-Enter VNC configuration mode for defining the L2 group @var{name}.
-Use @code{exit} or @code{exit-vnc} to exit group configuration mode.
-
-@example
-vnc l2-group group1
- ... configuration commands
-exit-vnc
-@end example
-@end deffn
-
-@deffn {VNC} {no vnc l2-group @var{name}} {}
-Delete the L2 group named @var{name}.
-@end deffn
-
-The following statements are valid in a L2 group definition:
-
-@deffn {VNC} {logical-network-id @var{VALUE}}
-Define the Logical Network Identifier with a value in the range of
-0-4294967295 that identifies the logical Ethernet segment.
-@end deffn
-
-@deffn {VNC} {labels @var{label-list}}
-@deffnx {VNC} {no labels @var{label-list}}
-Add or remove labels associated with the group. @var{label-list} is a
-space separated list of label values in the range of 0-1048575.
-@end deffn
-
-@deffn {VNC} {rt import @var{rt-target}} {}
-@deffnx {VNC} {rt export @var{rt-target}} {}
-@deffnx {VNC} {rt both @var{rt-target}} {}
-Specify the route target import and export value associated with the
-group. A complete definition of these parameters is given above,
-@pxref{VNC NVE Group Configuration}.
-@end deffn
-
-
-@node Configuring Redistribution of Routes from Other Routing Protocols
-@subsection 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
-from a designated BGP unicast exterior routing RIB instance.
-
-The protocol named in the @code{vnc redistribute} command indicates
-the route source:
-@code{bgp-direct} routes come directly from the main (default)
-unicast BGP RIB and are available for RFP and are redistributed via BGP;
-@code{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 @code{bgp-direct} or @code{bgp-direct-to-nve-groups} routes are used.
-
-@subsubsection @code{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.
-
-@subsubsection @code{bgp-direct} routes
-
-@code{bgp-direct} redistribution supports policy via
-prefix lists and route-maps. This policy is applied to incoming
-original unicast routes before the redistribution translations
-(described below) are performed.
-
-Redistribution of @code{bgp-direct} routes is performed in one of three
-possible modes: @code{plain}, @code{nve-group}, or @code{resolve-nve}.
-The default mode is @code{plain}.
-These modes indicate the kind of translations applied to routes before
-they are added to the VNC RIB.
-
-In @code{plain} mode, the route's next hop is unchanged and the RD is set
-based on the next hop.
-For @code{bgp-direct} redistribution, the following translations are performed:
-@itemize @bullet
-@item
-The VN address is set to the original unicast route's next hop address.
-@item
-The UN address is NOT set. (VN->UN mapping will occur via
-ENCAP route or attribute, based on @code{vnc advertise-un-method}
-setting, generated by the RFP registration of the actual NVE)
-@item
-The RD is set to as if auto:vn:0 were specified (i.e.,
-@var{rd_type=IP=1}:@var{IPv4-address=VN-address}:@var{two-byte-integer=0})
-@item
-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).
-@end itemize
-
-
-
-In @code{nve-group} mode, routes are registered with VNC as
-if they came from an NVE in the nve-group designated in the
-@code{vnc redistribute nve-group} command. The following
-translations are performed:
-
-@itemize @bullet
-@item
-The next hop/VN address is set to the VN prefix configured for the
-redistribute nve-group.
-@item
-The UN address is set to the UN prefix configured for the
-redistribute nve-group.
-@item
-The RD is set to the RD configured for the redistribute nve-group.
-@item
-The RT list is set to the RT list configured for the redistribute nve-group.
-If @code{bgp-direct} routes are being redistributed,
-any extended communities present in the original unicast route
-will also be included.
-@end itemize
-
-
-In @code{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.
-
-The following translations are applied:
-
-@itemize @bullet
-@item
-The Next Hop is set to the next hop of the NVE route (i.e., the
-VN address of the NVE).
-
-@item
-The extended community list in the new route is set to the
-union of:
-@itemize @minus
-@item
-Any extended communities in the original BGP route
-@item
-Any extended communities in the NVE route
-@item
-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 @code{roo-ec-local-admin} parameter.
-@end itemize
-
-@item
-The Tunnel Encapsulation attribute is set to the value of the Tunnel
-Encapsulation attribute of the NVE route, if any.
-
-@end itemize
-
-@subsubsection @code{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.
-
-A non-main/default BGP instance is configured using the
-@code{bgp multiple-instance} and @code{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.
-
-There is currently no policy (prefix-list or route-map) support
-for @code{bgp-direct-to-nve-groups} routes.
-
-@subsubsection Redistribution Command Syntax
-
-@deffn {VNC} {vnc redistribute ipv4|ipv6 bgp|bgp-direct|ipv6 bgp-direct-to-nve-groups|connected|kernel|ospf|rip|static} {}
-@deffnx {VNC} {vnc redistribute ipv4|ipv6 bgp-direct-to-nve-groups view @var{VIEWNAME}} {}
-@deffnx {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 (@code{ipv4} or
-@code{ipv6}) and the protocol (@code{bgp}, @code{bgp-direct},
-@code{bgp-direct-to-nve-groups}, @code{connected},
-@code{kernel}, @code{ospf}, @code{rip}, or @code{static}). Repeat
-this statement as needed for each combination of address family and
-routing protocol.
-Prefixes from protocol @code{bgp-direct} are imported from unicast BGP
-in the same bgpd process.
-Prefixes from all other protocols (including @code{bgp}) are imported
-via the @code{zebra} kernel routing process.
-@end deffn
-
-@deffn {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.
-@end deffn
-
-@deffn {VNC} {vnc redistribute nve-group @var{group-name}} {}
-@deffnx {VNC} {no vnc redistribute nve-group @var{group-name}} {}
-When using @code{nve-group} mode,
-assign (or do not assign) the NVE group @var{group-name} to routes
-redistributed from another routing protocol. @var{group-name}
-must be configured using @code{vnc nve-group}.
-
-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.
-@end deffn
-
-@deffn {VNC} {vnc redistribute lifetime @var{lifetime}|infinite} {}
-Assign a registration lifetime, either @var{lifetime} seconds or
-@code{infinite}, to prefixes redistributed from other routing
-protocols as if they had been received via RFP registration messages
-from an NVE. @var{lifetime} can be any integer between 1 and
-4294967295, inclusive.
-@end deffn
-
-@deffn {VNC} {vnc redistribute resolve-nve roo-ec-local-admin @var{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 @code{resolve-nve} mode. The default value is @var{5226}.
-@end deffn
-
-The following four @code{prefix-list} and @code{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 @code{nve-group},
-and then only for routes being redistributed from
-@code{bgp-direct}.
-If they are specified outside the context of an nve-group, then
-they apply only for redistribution modes @code{plain} and @code{resolve-nve},
-and then only for routes being redistributed from @code{bgp-direct}.
-
-@deffn {VNC} {vnc redistribute bgp-direct (ipv4|ipv6) prefix-list @var{LIST-NAME}}
-When redistributing @code{bgp-direct} routes,
-specifies that the named prefix-list should be applied.
-@end deffn
-
-@deffn {VNC} {vnc redistribute bgp-direct no (ipv4|ipv6) prefix-list}
-When redistributing @code{bgp-direct} routes,
-specifies that no prefix-list should be applied.
-@end deffn
-
-@deffn {VNC} {vnc redistribute bgp-direct route-map @var{MAP-NAME}}
-When redistributing @code{bgp-direct} routes,
-specifies that the named route-map should be applied.
-@end deffn
-
-@deffn {VNC} {vnc redistribute bgp-direct no route-map}
-When redistributing @code{bgp-direct} routes,
-specifies that no route-map should be applied.
-@end deffn
-
-@node Configuring Export of Routes to Other Routing Protocols
-@subsection 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 @code{redistribute vnc-direct}
-statement.
-
-@deffn {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 @code{none}, routes are not exported.
-If the mode is @code{group-nve}, routes are exported according
-to nve-group or vrf-policy group configuration (@pxref{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 @code{registering-nve}, then all VNC routes are
-exported with their original next hops.
-If the mode is @code{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 @code{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 @code{none}.
-@end deffn
-
-@deffn {VNC} {vnc export bgp|zebra group-nve group @var{group-name}}
-@deffnx {VNC} {vnc export bgp|zebra group-nve no group @var{group-name}}
-When export mode is @code{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.
-@end deffn
-
-@deffn {VNC} export bgp|zebra ipv4|ipv6 prefix-list LIST-NAME
-When export mode is @code{ce} or @code{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.
-@end deffn
-
-@deffn {VNC} export bgp|zebra no ipv4|ipv6 prefix-list
-When export mode is @code{ce} or @code{registering-nve},
-specifies that no prefix-list should be applied to routes
-being exported to bgp or zebra.
-@end deffn
-
-@deffn {VNC} export bgp|zebra route-map MAP-NAME
-When export mode is @code{ce} or @code{registering-nve},
-specifies that the named route-map should be applied to routes
-being exported to bgp or zebra.
-@end deffn
-
-@deffn {VNC} export bgp|zebra no route-map
-When export mode is @code{ce} or @code{registering-nve},
-specifies that no route-map should be applied to routes
-being exported to bgp or zebra.
-@end deffn
-
-When the export mode is @code{group-nve}, policy for exported
-routes is specified per-NVE-group or vrf-policy group inside a @code{nve-group} @var{RFG-NAME} block
-via the following commands(@pxref{VNC NVE Group Configuration}):
-
-@deffn {VNC} {export bgp|zebra route-map MAP-NAME}
-This command is valid inside a @code{nve-group} @var{RFG-NAME} block.
-It specifies that the named route-map should be applied to routes
-being exported to bgp or zebra.
-@end deffn
-
-@deffn {VNC} {export bgp|zebra no route-map}
-This command is valid inside a @code{nve-group} @var{RFG-NAME} block.
-It specifies that no route-map should be applied to routes
-being exported to bgp or zebra.
-@end deffn
-
-@deffn {VNC} {export bgp|zebra ipv4|ipv6 prefix-list LIST-NAME}
-This command is valid inside a @code{nve-group} @var{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.
-@end deffn
-
-@deffn {VNC} {export bgp|zebra no ipv4|ipv6 prefix-list}
-This command is valid inside a @code{nve-group} @var{RFG-NAME} block.
-It specifies that no prefix-list filter should be applied to
-routes being exported to bgp or zebra.
-@end deffn
-
-@node Manual Address Control
-@section Manual Address Control
-
-The commands in this section can be used to augment normal dynamic VNC.
-The @code{add vnc} commands can be used to manually add IP prefix or
-Ethernet MAC address forwarding information. The @code{clear vnc}
-commands can be used to remove manually and dynamically added
-information.
-
-@deffn {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 @code{cost} parameter provides the administrative
-preference of the forwarding information for remote advertisement. If
-omitted, it defaults to 255 (lowest preference). The @code{lifetime}
-parameter identifies the period, in seconds, that the information
-remains valid. If omitted, it defaults to @var{infinite}. The optional
-@code{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 @code{local-cost} parameter to provide a
-forwarding preference. If omitted, it defaults to 255 (lowest
-preference).
-@end deffn
-
-
-@deffn {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 @code{prefix} parameter is to support enable IP address
-mediation for the given prefix. The @code{cost} parameter provides the administrative
-preference of the forwarding information. If omitted, it defaults to
-255. The @code{lifetime} parameter identifies the period, in seconds,
-that the information remains valid. If omitted, it defaults to
-@var{infinite}.
-@end deffn
-
-@deffn {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 @code{mac} parameter specifies a layer-2 MAC address
-that must match the registration(s) to be deleted.
-The optional @code{local-next-hop} parameter is used to
-delete specific local nexthop information.
-@end deffn
-
-@deffn {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 @code{prefix} parameter is the wildcard value @var{*}.
-@end deffn
-
-@deffn {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 @code{*} in lieu of any VN or UN
-address, in which case all registrations will match.
-@end deffn
-
-@node Other VNC-Related Commands
-@section Other VNC-Related Commands
-
-Note: VNC-Related configuration can be obtained via the @code{show
-running-configuration} command when in @code{enable} mode.
-
-The following commands are used to clear and display
-Virtual Network Control related information:
-
-@deffn {COMMAND} {clear vnc counters} {}
-Reset the counter values stored by the NVA. Counter
-values can be seen using the @code{show vnc} commands listed above. This
-command is only available in @code{enable} mode.
-@end deffn
-
-@deffn {Command} {show vnc summary} {}
-Print counter values and other general information
-about the NVA. Counter values can be reset
-using the @code{clear vnc counters} command listed below.
-@end deffn
-
-@deffn {Command} {show vnc nves} {}
-@deffnx {Command} {show vnc nves vn|un @var{address}} {}
-Display the NVA's current clients. Specifying @var{address}
-limits the output to the NVEs whose addresses match @var{address}.
-The time since the NVA last communicated with the NVE, per-NVE
-summary counters and each NVE's addresses will be displayed.
-@end deffn
-
-@deffn {Command} {show vnc queries} {}
-@deffnx {Command} {show vnc queries @var{prefix}} {}
-Display active Query information. Queries remain valid for the default
-Response Lifetime (@pxref{VNC Defaults Configuration}) or NVE-group
-Response Lifetime (@pxref{VNC NVE Group Configuration}). Specifying
-@var{prefix} limits the output to Query Targets that fall within
-@var{prefix}.
-
-Query information is provided for each querying NVE, and includes the
-Query Target and the time remaining before the information is removed.
-@end deffn
-
-@deffn {Command} {show vnc registrations [all|local|remote|holddown|imported]} {}
-@deffnx {Command} {show vnc registrations [all|local|remote|holddown|imported] @var{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 @var{prefix} limits the output to the registered prefixes that
-fall within @var{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.
-@end deffn
-
-@deffn {Command} {show vnc responses [active|removed]} {}
-@deffnx {Command} {show vnc responses [active|removed] @var{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 (@pxref{VNC Defaults Configuration}) or
-NVE-group Response Lifetime (@pxref{VNC NVE Group Configuration}.)
-When Removal Responses are enabled (@pxref{General VNC Configuration}),
-such responses are listed for the Response Lifetime. Specifying
-@var{prefix} limits the output to the addresses that fall within
-@var{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.
-@end deffn
-
-@deffn {Command} {show memory vnc} {}
-Print the number of memory items allocated by the NVA.
-@end deffn
-
-@node Example VNC and VNC-GW Configurations
-@section Example VNC and VNC-GW Configurations
-
-@menu
-* Mesh NVA Configuration::
-* Mesh NVA and VNC-GW Configuration::
-* VNC with Frr Route Reflector Configuration::
-* VNC with Commercial Route Reflector Configuration::
-* VNC with Redundant Route Reflectors Configuration::
-@c * Interfacing VNC to an IGP::
-@end menu
-
-@node Mesh NVA Configuration
-@subsection Mesh NVA Configuration
-
-This example includes three NVAs, nine NVEs, and two NVE groups. Note
-that while not shown, a single physical device may support multiple
-logical NVEs. @ref{fig:fig-vnc-mesh} shows @code{NVA 1}
-(192.168.1.100), @code{NVA 2} (192.168.1.101), and @code{NVA 3}
-(192.168.1.102), which are connected in a full mesh. Each is a
-member of the autonomous system 64512. Each NVA provides VNC
-services to three NVE clients in the 172.16.0.0/16 virtual-network
-address range. The 172.16.0.0/16 address range is partitioned into
-two NVE groups, @code{group1} (172.16.0.0/17) and @code{group2}
-(172.16.128.0/17).
-
-Each NVE belongs to either NVE group @code{group1} or NVE group
-@code{group2}. The NVEs @code{NVE 1}, @code{NVE 2}, @code{NVE
-4}, @code{NVE 7}, and @code{NVE 8} are members of the NVE group
-@code{group1}. The NVEs @code{NVE 3}, @code{NVE 5}, @code{NVE
-6}, and @code{NVE 9} are members of the NVE group @code{group2}.
-
-Each NVA advertises NVE underlay-network IP addresses using the
-Tunnel Encapsulation Attribute.
-
-@float Figure,fig:fig-vnc-mesh
-@center @image{fig-vnc-mesh,400pt,,Three-way Mesh}
-@caption{A three-way full mesh with three NVEs per NVA}
-@end float
-
-@file{bgpd.conf} for @code{NVA 1} (192.168.1.100)
-@verbatim
-router bgp 64512
-
- bgp router-id 192.168.1.100
-
- neighbor 192.168.1.101 remote-as 64512
- neighbor 192.168.1.102 remote-as 64512
-
- address-family ipv4 vpn
- neighbor 192.168.1.101 activate
- neighbor 192.168.1.102 activate
- exit-address-family
-
- vnc defaults
- rd 64512:1
- response-lifetime 200
- rt both 1000:1 1000:2
- exit-vnc
-
- vnc nve-group group1
- prefix vn 172.16.0.0/17
- rt both 1000:1
- exit-vnc
-
- vnc nve-group group2
- prefix vn 172.16.128.0/17
- rt both 1000:2
- exit-vnc
-
-exit
-@end verbatim
-
-@file{bgpd.conf} for @code{NVA 2} (192.168.1.101):
-@verbatim
-router bgp 64512
-
- bgp router-id 192.168.1.101
-
- neighbor 192.168.1.100 remote-as 64512
- neighbor 192.168.1.102 remote-as 64512
-
- address-family ipv4 vpn
- neighbor 192.168.1.100 activate
- neighbor 192.168.1.102 activate
- exit-address-family
-
- vnc nve-group group1
- prefix vn 172.16.0.0/17
- rd 64512:1
- response-lifetime 200
- rt both 1000:1 1000:2
- exit-vnc
-exit
-@end verbatim
-
-@file{bgpd.conf} for @code{NVA 3} (192.168.1.102):
-@verbatim
-router bgp 64512
-
- bgp router-id 192.168.1.102
-
- neighbor 192.168.1.101 remote-as 64512
- neighbor 192.168.1.102 remote-as 64512
-
- address-family ipv4 vpn
- neighbor 192.168.1.100 activate
- neighbor 192.168.1.101 activate
- exit-address-family
-
- vnc defaults
- rd 64512:1
- response-lifetime 200
- rt both 1000:1 1000:2
- exit-vnc
-
- vnc nve-group group1
- prefix vn 172.16.128.0/17
- exit-vnc
-exit
-@end verbatim
-
-@node Mesh NVA and VNC-GW Configuration
-@subsection Mesh NVA and VNC-GW Configuration
-
-This example includes two NVAs, each with two associated NVEs, and two
-VNC-GWs, each supporting two CE routers physically attached to the four
-NVEs. Note that this example is showing a more complex configuration
-where VNC-GW is separated from normal NVA functions; it is equally
-possible to simplify the configuration and combine NVA and VNC-GW
-functions in a single frr instance.
-
-@float Figure,fig:fig-vnc-gw
-@center @image{fig-vnc-gw,400pt,,Frr VNC Gateway}
-@caption{Meshed NVEs and VNC-GWs}
-@end float
-
-As shown in @ref{fig:fig-vnc-gw}, NVAs and VNC-GWs are connected in a
-full iBGP mesh. The VNC-GWs each have two CEs configured as
-route-reflector clients. Each client provides BGP updates with unicast
-routes that the VNC-GW reflects to the other client. The VNC-GW also
-imports these unicast routes into VPN routes to be shared with the other
-VNC-GW and the two NVAs. This route importation is controlled with the
-@code{vnc redistribute} statements shown in the configuration.
-Similarly, registrations sent by NVEs via RFP to the NVAs are exported
-by the VNC-GWs to the route-reflector clients as unicast routes. RFP
-registrations exported this way have a next-hop address of the CE behind
-the connected (registering) NVE. Exporting VNC routes as IPv4 unicast
-is enabled with the @code{vnc export} command below.
-
-The configuration for @code{VNC-GW 1} is shown below.
-@verbatim
-router bgp 64512
- bgp router-id 192.168.1.101
- bgp cluster-id 1.2.3.4
- neighbor 192.168.1.102 remote-as 64512
- neighbor 192.168.1.103 remote-as 64512
- neighbor 192.168.1.104 remote-as 64512
- neighbor 172.16.1.2 remote-as 64512
- neighbor 172.16.2.2 remote-as 64512
- !
- address-family ipv4 unicast
- redistribute vnc-direct
- no neighbor 192.168.1.102 activate
- no neighbor 192.168.1.103 activate
- no neighbor 192.168.1.104 activate
- neighbor 172.16.1.2 route-reflector-client
- neighbor 172.16.2.2 route-reflector-client
- exit-address-family
- !
- address-family ipv4 vpn
- neighbor 192.168.1.102 activate
- neighbor 192.168.1.103 activate
- neighbor 192.168.1.104 activate
- exit-address-family
- vnc export bgp mode ce
- vnc redistribute mode resolve-nve
- vnc redistribute ipv4 bgp-direct
- exit
-@end verbatim
-
-Note that in the VNC-GW configuration, the neighboring VNC-GW and
-NVAs each have a statement disabling the IPv4 unicast address family.
-IPv4 unicast is on by default and this prevents the other VNC-GW and
-NVAs from learning unicast routes advertised by the route-reflector clients.
-
-Configuration for @code{NVA 2}:
-@verbatim
-router bgp 64512
- bgp router-id 192.168.1.104
- neighbor 192.168.1.101 remote-as 64512
- neighbor 192.168.1.102 remote-as 64512
- neighbor 192.168.1.103 remote-as 64512
- !
- address-family ipv4 unicast
- no neighbor 192.168.1.101 activate
- no neighbor 192.168.1.102 activate
- no neighbor 192.168.1.103 activate
- exit-address-family
- !
- address-family ipv4 vpn
- neighbor 192.168.1.101 activate
- neighbor 192.168.1.102 activate
- neighbor 192.168.1.103 activate
- exit-address-family
- !
- vnc defaults
- response-lifetime 3600
- exit-vnc
- vnc nve-group nve1
- prefix vn 172.16.1.1/32
- response-lifetime 3600
- rt both 1000:1 1000:2
- exit-vnc
- vnc nve-group nve2
- prefix vn 172.16.2.1/32
- response-lifetime 3600
- rt both 1000:1 1000:2
- exit-vnc
- exit
-@end verbatim
-
-@c TBD make this its own example:
-@c
-@c @float Figure,fig:fig-vnc-gw-rr
-@c @center @image{fig-vnc-gw-rr,400pt,,Frr VNC Gateway with RR}
-@c @end float
-@c An NVA can also import unicast routes from BGP without advertising the
-@c imported routes as VPN routes. Such imported routes, while not
-@c distributed to other NVAs or VNC-GWs, are are available to NVEs via
-@c RFP query messages sent to the NVA. @ref{fig:fig-vnc-gw-rr}
-@c shows an example topology where unicast routes are imported into NVAs
-@c from a Route Reflector. (@pxref{Route Reflector} for route reflector
-@c configuration details.) The following three lines can be added to the
-@c @code{NVA 1} and @code{NVA 2} configurations to import routes into VNC
-@c for local VNC use:
-@c
-@c @verbatim
-@c neighbor 192.168.1.105 remote-as 64512
-@c vnc redistribute mode plain
-@c vnc redistribute ipv4 bgp-direct-to-nve-groups
-@c @end verbatim
-
-@node VNC with Frr Route Reflector Configuration
-@subsection VNC with Frr Route Reflector Configuration
-A route reflector eliminates the need for a fully meshed NVA
-network by acting as the hub between NVAs.
-@ref{fig:fig-vnc-frr-route-reflector} shows BGP route reflector
-@code{BGP Route Reflector 1} (192.168.1.100) as a route reflector for
-NVAs @code{NVA 2}(192.168.1.101) and @code{NVA 3}
-(192.168.1.102).
-
-@float Figure,fig:fig-vnc-frr-route-reflector
-@center @image{fig-vnc-frr-route-reflector,400pt,,Frr Route Reflector}
-@caption{Two NVAs and a BGP Route Reflector}
-@end float
-
-@code{NVA 2} and @code{NVA 3}
-advertise NVE underlay-network IP addresses using the Tunnel Encapsulation Attribute.
-@code{BGP Route Reflector 1} ``reflects'' advertisements from
-@code{NVA 2} to @code{NVA 3} and vice versa.
-
-As in the example of @ref{Mesh NVA Configuration}, there are two NVE groups.
-The 172.16.0.0/16 address range is partitioned into two NVE groups,
-@code{group1} (172.16.0.0/17) and @code{group2} (172.16.128.0/17).
-The NVE @code{NVE 4}, @code{NVE 7}, and @code{NVE 8} are
-members of the NVE group @code{group1}. The NVEs @code{NVE 5},
-@code{NVE 6}, and @code{NVE 9} are members of the NVE group
-@code{group2}.
-
-@file{bgpd.conf} for @code{BGP Route Reflector 1} on 192.168.1.100:
-@verbatim
-router bgp 64512
-
- bgp router-id 192.168.1.100
-
- neighbor 192.168.1.101 remote-as 64512
- neighbor 192.168.1.101 port 7179
- neighbor 192.168.1.101 description iBGP-client-192-168-1-101
-
- neighbor 192.168.1.102 remote-as 64512
- neighbor 192.168.1.102 port 7179
- neighbor 192.168.1.102 description iBGP-client-192-168-1-102
-
- address-family ipv4 unicast
- neighbor 192.168.1.101 route-reflector-client
- neighbor 192.168.1.102 route-reflector-client
- exit-address-family
-
- address-family ipv4 vpn
- neighbor 192.168.1.101 activate
- neighbor 192.168.1.102 activate
-
- neighbor 192.168.1.101 route-reflector-client
- neighbor 192.168.1.102 route-reflector-client
- exit-address-family
-
-exit
-@end verbatim
-
-@file{bgpd.conf} for @code{NVA 2} on 192.168.1.101:
-@verbatim
-router bgp 64512
-
- bgp router-id 192.168.1.101
-
- neighbor 192.168.1.100 remote-as 64512
-
- address-family ipv4 vpn
- neighbor 192.168.1.100 activate
- exit-address-family
-
- vnc nve-group group1
- prefix vn 172.16.0.0/17
- rd 64512:1
- response-lifetime 200
- rt both 1000:1 1000:2
- exit-vnc
-exit
-@end verbatim
-
-@file{bgpd.conf} for @code{NVA 2} on 192.168.1.102:
-@verbatim
-router bgp 64512
-
- bgp router-id 192.168.1.102
-
- neighbor 192.168.1.100 remote-as 64512
-
- address-family ipv4 vpn
- neighbor 192.168.1.100 activate
- exit-address-family
-
- vnc defaults
- rd 64512:1
- response-lifetime 200
- rt both 1000:1 1000:2
- exit-vnc
-
- vnc nve-group group1
- prefix vn 172.16.128.0/17
- exit-vnc
-exit
-@end verbatim
-
-While not shown, an NVA can also be configured as a route reflector.
-
-@node VNC with Commercial Route Reflector Configuration
-@subsection VNC with Commercial Route Reflector Configuration
-This example is identical to @ref{VNC with Frr Route Reflector
-Configuration} with the exception that the route reflector is a
-commercial router. Only the
-VNC-relevant configuration is provided.
-
-@float Figure,fig:fig-vnc-commercial-route-reflector
-@center @image{fig-vnc-commercial-route-reflector,400pt,,Commercial Route Reflector}
-@caption{Two NVAs with a commercial route reflector}
-@end float
-
-@file{bgpd.conf} for BGP route reflector @code{Commercial Router} on 192.168.1.104:
-@verbatim
-version 8.5R1.13;
-routing-options {
- rib inet.0 {
- static {
- route 172.16.0.0/16 next-hop 192.168.1.104;
- }
- }
- autonomous-system 64512;
- resolution {
- rib inet.3 {
- resolution-ribs inet.0;
- }
- rib bgp.l3vpn.0 {
- resolution-ribs inet.0;
- }
- }
-}
-protocols {
- bgp {
- advertise-inactive;
- family inet {
- labeled-unicast;
- }
- group 1 {
- type internal;
- advertise-inactive;
- advertise-peer-as;
- import h;
- family inet {
- unicast;
- }
- family inet-vpn {
- unicast;
- }
- cluster 192.168.1.104;
- neighbor 192.168.1.101;
- neighbor 192.168.1.102;
- }
- }
-}
-policy-options {
- policy-statement h {
- from protocol bgp;
- then {
- as-path-prepend 64512;
- accept;
- }
- }
-}
-@end verbatim
-
-@file{bgpd.conf} for @code{NVA 2} on 192.168.1.101:
-@verbatim
-router bgp 64512
-
- bgp router-id 192.168.1.101
-
- neighbor 192.168.1.100 remote-as 64512
-
- address-family ipv4 vpn
- neighbor 192.168.1.100 activate
- exit-address-family
-
- vnc nve-group group1
- prefix vn 172.16.0.0/17
- rd 64512:1
- response-lifetime 200
- rt both 1000:1 1000:2
- exit-vnc
-exit
-@end verbatim
-
-@file{bgpd.conf} for @code{NVA 3} on 192.168.1.102:
-@verbatim
-router bgp 64512
-
- bgp router-id 192.168.1.102
-
- neighbor 192.168.1.100 remote-as 64512
-
- address-family ipv4 vpn
- neighbor 192.168.1.100 activate
- exit-address-family
-
- vnc defaults
- rd 64512:1
- response-lifetime 200
- rt both 1000:1 1000:2
- exit-vnc
-
- vnc nve-group group1
- prefix vn 172.16.128.0/17
- exit-vnc
-exit
-@end verbatim
-
-@node VNC with Redundant Route Reflectors Configuration
-@subsection VNC with Redundant Route Reflectors Configuration
-This example combines the previous two (@ref{VNC with Frr Route
-Reflector Configuration} and @ref{VNC with Commercial Route Reflector
-Configuration}) into a redundant route reflector configuration. BGP
-route reflectors @code{BGP Route Reflector 1} and @code{Commercial Router}
-are the route reflectors for NVAs @code{NVA 2} and
-@code{NVA 3}. The two NVAs have connections to both
-route reflectors.
-
-@float Figure,fig:fig-vnc-redundant-route-reflectors
-@center @image{fig-vnc-redundant-route-reflectors,400pt,,Redundant Route Reflectors}
-@caption{Frr-based NVA with redundant route reflectors}
-@end float
-
-@file{bgpd.conf} for @code{Bgpd Route Reflector 1} on 192.168.1.100:
-@verbatim
-router bgp 64512
-
- bgp router-id 192.168.1.100
- bgp cluster-id 192.168.1.100
-
- neighbor 192.168.1.104 remote-as 64512
-
- neighbor 192.168.1.101 remote-as 64512
- neighbor 192.168.1.101 description iBGP-client-192-168-1-101
- neighbor 192.168.1.101 route-reflector-client
-
- neighbor 192.168.1.102 remote-as 64512
- neighbor 192.168.1.102 description iBGP-client-192-168-1-102
- neighbor 192.168.1.102 route-reflector-client
-
- address-family ipv4 vpn
- neighbor 192.168.1.101 activate
- neighbor 192.168.1.102 activate
- neighbor 192.168.1.104 activate
-
- neighbor 192.168.1.101 route-reflector-client
- neighbor 192.168.1.102 route-reflector-client
- exit-address-family
-exit
-@end verbatim
-
-@file{bgpd.conf} for @code{NVA 2} on 192.168.1.101:
-@verbatim
-router bgp 64512
-
- bgp router-id 192.168.1.101
-
- neighbor 192.168.1.100 remote-as 64512
- neighbor 192.168.1.104 remote-as 64512
-
- address-family ipv4 vpn
- neighbor 192.168.1.100 activate
- neighbor 192.168.1.104 activate
- exit-address-family
-
- vnc nve-group group1
- prefix vn 172.16.0.0/17
- rd 64512:1
- response-lifetime 200
- rt both 1000:1 1000:2
- exit-vnc
-exit
-@end verbatim
-
-@file{bgpd.conf} for @code{NVA 3} on 192.168.1.102:
-@verbatim
-router bgp 64512
-
- bgp router-id 192.168.1.102
-
- neighbor 192.168.1.100 remote-as 64512
- neighbor 192.168.1.104 remote-as 64512
-
- address-family ipv4 vpn
- neighbor 192.168.1.100 activate
- neighbor 192.168.1.104 activate
- exit-address-family
-
- vnc defaults
- rd 64512:1
- response-lifetime 200
- rt both 1000:1 1000:2
- exit-vnc
-
- vnc nve-group group1
- prefix vn 172.16.128.0/17
- exit-vnc
-exit
-@end verbatim
-
-@file{bgpd.conf} for the Commercial Router route reflector on
-192.168.1.104:
-@verbatim
-routing-options {
- rib inet.0 {
- static {
- route 172.16.0.0/16 next-hop 192.168.1.104;
- }
- }
- autonomous-system 64512;
- resolution {
- rib inet.3 {
- resolution-ribs inet.0;
- }
- rib bgp.l3vpn.0 {
- resolution-ribs inet.0;
- }
- }
-}
-protocols {
- bgp {
- advertise-inactive;
- family inet {
- labeled-unicast;
- }
- group 1 {
- type internal;
- advertise-inactive;
- advertise-peer-as;
- import h;
- family inet {
- unicast;
- }
- family inet-vpn {
- unicast;
- }
- cluster 192.168.1.104;
- neighbor 192.168.1.101;
- neighbor 192.168.1.102;
- }
-
- group 2 {
- type internal;
- advertise-inactive;
- advertise-peer-as;
- import h;
- family inet {
- unicast;
- }
- family inet-vpn {
- unicast;
- }
- neighbor 192.168.1.100;
- }
-
- }
-}
-policy-options {
- policy-statement h {
- from protocol bgp;
- then {
- as-path-prepend 64512;
- accept;
- }
- }
-}
-@end verbatim
-
-@node Release Notes
-@section Release Notes
-
-@c A paragraph that introduces our release notes.
-
-@c outer list, one item per VNC release, items preceded by bullet
-@itemize @bullet
-@item
-
-@c @item
-@end itemize
-
-@evenheading @thispage@|@|@thistitle
-@oddheading @thischapter@|@|@thispage
-@everyfooting
-
projects / mirror / frr.git / commitdiff