]>
Commit | Line | Data |
---|---|---|
11ab5329 | 1 | .. _ospfv2: |
42fc5d26 QY |
2 | |
3 | ****** | |
4 | OSPFv2 | |
5 | ****** | |
6 | ||
c1a54c05 QY |
7 | :abbr:`OSPF (Open Shortest Path First)` version 2 is a routing protocol which |
8 | is described in :rfc:`2328`. OSPF is an :abbr:`IGP (Interior Gateway | |
9 | Protocol)`. Compared with :abbr:`RIP`, :abbr:`OSPF` can provide scalable | |
10 | network support and faster convergence times. OSPF is widely used in large | |
11 | networks such as :abbr:`ISP (Internet Service Provider)` backbone and | |
12 | enterprise networks. | |
42fc5d26 | 13 | |
c1a54c05 | 14 | .. include:: ospf_fundamentals.rst |
42fc5d26 | 15 | |
c1a54c05 | 16 | .. _configuring-ospfd: |
42fc5d26 | 17 | |
e6f1b831 QY |
18 | Configuring OSPF |
19 | ================ | |
42fc5d26 | 20 | |
e6f1b831 QY |
21 | *ospfd* accepts all :ref:`common-invocation-options`. |
22 | ||
23 | .. option:: -n, --instance | |
24 | ||
25 | Specify the instance number for this invocation of *ospfd*. | |
26 | ||
27 | .. option:: -a, --apiserver | |
28 | ||
37f92f22 | 29 | Enable the OSPF API server. This is required to use ``ospfclient``. |
e6f1b831 QY |
30 | |
31 | *ospfd* must acquire interface information from *zebra* in order to function. | |
32 | Therefore *zebra* must be running before invoking *ospfd*. Also, if *zebra* is | |
33 | restarted then *ospfd* must be too. | |
42fc5d26 | 34 | |
c1a54c05 | 35 | Like other daemons, *ospfd* configuration is done in :abbr:`OSPF` specific |
e6f1b831 QY |
36 | configuration file :file:`ospfd.conf` when the integrated config is not used. |
37 | ||
38 | .. _ospf-multi-instance: | |
39 | ||
40 | Multi-instance Support | |
41 | ---------------------- | |
42 | ||
43 | OSPF supports multiple instances. Each instance is identified by a positive | |
44 | nonzero integer that must be provided when adding configuration items specific | |
45 | to that instance. Enabling instances is done with :file:`/etc/frr/daemons` in | |
46 | the following manner: | |
47 | ||
48 | :: | |
49 | ||
50 | ... | |
51 | ospfd=yes | |
52 | ospfd_instances=1,5,6 | |
53 | ... | |
54 | ||
55 | The ``ospfd_instances`` variable controls which instances are started and what | |
56 | their IDs are. In this example, after starting FRR you should see the following | |
57 | processes: | |
58 | ||
59 | .. code-block:: shell | |
60 | ||
61 | # ps -ef | grep "ospfd" | |
62 | frr 11816 1 0 17:30 ? 00:00:00 /usr/lib/frr/ospfd --daemon -A 127.0.0.1 -n 1 | |
63 | frr 11822 1 0 17:30 ? 00:00:00 /usr/lib/frr/ospfd --daemon -A 127.0.0.1 -n 2 | |
64 | frr 11828 1 0 17:30 ? 00:00:00 /usr/lib/frr/ospfd --daemon -A 127.0.0.1 -n 3 | |
65 | ||
66 | ||
67 | The instance number should be specified in the config when addressing a particular instance: | |
68 | ||
69 | .. code-block:: frr | |
70 | ||
71 | router ospf 5 | |
349ee664 | 72 | ospf router-id 1.2.3.4 |
e6f1b831 QY |
73 | area 0.0.0.0 authentication message-digest |
74 | ... | |
42fc5d26 | 75 | |
0efdf0fe | 76 | .. _ospf-router: |
42fc5d26 | 77 | |
e6f1b831 QY |
78 | Routers |
79 | ------- | |
42fc5d26 | 80 | |
e6f1b831 | 81 | To start OSPF process you have to specify the OSPF router. |
42fc5d26 | 82 | |
e6f1b831 QY |
83 | .. index:: router ospf [(1-65535)] vrf NAME |
84 | .. clicmd:: router ospf [(1-65535)] vrf NAME | |
42fc5d26 | 85 | |
3d13052d | 86 | .. index:: router ospf [(1-65535)] vrf NAME |
e6f1b831 | 87 | .. clicmd:: no router ospf [(1-65535)] vrf NAME |
42fc5d26 | 88 | |
e6f1b831 | 89 | Enable or disable the OSPF process. |
42fc5d26 | 90 | |
c1a54c05 QY |
91 | .. index:: ospf router-id A.B.C.D |
92 | .. clicmd:: ospf router-id A.B.C.D | |
42fc5d26 | 93 | |
3d13052d | 94 | .. index:: ospf router-id [A.B.C.D] |
e6f1b831 | 95 | .. clicmd:: no ospf router-id [A.B.C.D] |
42fc5d26 | 96 | |
e6f1b831 QY |
97 | This sets the router-ID of the OSPF process. The router-ID may be an IP |
98 | address of the router, but need not be - it can be any arbitrary 32bit | |
99 | number. However it MUST be unique within the entire OSPF domain to the OSPF | |
100 | speaker - bad things will happen if multiple OSPF speakers are configured | |
101 | with the same router-ID! If one is not specified then *ospfd* will obtain a | |
102 | router-ID automatically from *zebra*. | |
42fc5d26 | 103 | |
c1a54c05 QY |
104 | .. index:: ospf abr-type TYPE |
105 | .. clicmd:: ospf abr-type TYPE | |
106 | ||
3d13052d | 107 | .. index:: ospf abr-type TYPE |
c1a54c05 QY |
108 | .. clicmd:: no ospf abr-type TYPE |
109 | ||
6ee602cd QY |
110 | `type` can be cisco|ibm|shortcut|standard. The "Cisco" and "IBM" types |
111 | are equivalent. | |
112 | ||
113 | The OSPF standard for ABR behaviour does not allow an ABR to consider | |
114 | routes through non-backbone areas when its links to the backbone are | |
115 | down, even when there are other ABRs in attached non-backbone areas | |
116 | which still can reach the backbone - this restriction exists primarily | |
117 | to ensure routing-loops are avoided. | |
118 | ||
d1e7591e QY |
119 | With the "Cisco" or "IBM" ABR type, the default in this release of FRR, this |
120 | restriction is lifted, allowing an ABR to consider summaries learned from | |
121 | other ABRs through non-backbone areas, and hence route via non-backbone | |
122 | areas as a last resort when, and only when, backbone links are down. | |
6ee602cd QY |
123 | |
124 | Note that areas with fully-adjacent virtual-links are considered to be | |
125 | "transit capable" and can always be used to route backbone traffic, and | |
126 | hence are unaffected by this setting (:clicmd:`area A.B.C.D virtual-link A.B.C.D`). | |
127 | ||
128 | More information regarding the behaviour controlled by this command can | |
129 | be found in :rfc:`3509`, and :t:`draft-ietf-ospf-shortcut-abr-02.txt`. | |
130 | ||
131 | Quote: "Though the definition of the :abbr:`ABR (Area Border Router)` | |
132 | in the OSPF specification does not require a router with multiple | |
133 | attached areas to have a backbone connection, it is actually | |
134 | necessary to provide successful routing to the inter-area and | |
135 | external destinations. If this requirement is not met, all traffic | |
136 | destined for the areas not connected to such an ABR or out of the | |
137 | OSPF domain, is dropped. This document describes alternative ABR | |
138 | behaviors implemented in Cisco and IBM routers." | |
42fc5d26 | 139 | |
c1a54c05 QY |
140 | .. index:: ospf rfc1583compatibility |
141 | .. clicmd:: ospf rfc1583compatibility | |
a8c90e15 | 142 | |
3d13052d | 143 | .. index:: ospf rfc1583compatibility |
c1a54c05 | 144 | .. clicmd:: no ospf rfc1583compatibility |
42fc5d26 | 145 | |
d1e7591e | 146 | :rfc:`2328`, the successor to :rfc:`1583`, suggests according |
c1a54c05 QY |
147 | to section G.2 (changes) in section 16.4 a change to the path |
148 | preference algorithm that prevents possible routing loops that were | |
149 | possible in the old version of OSPFv2. More specifically it demands | |
150 | that inter-area paths and intra-area backbone path are now of equal preference | |
151 | but still both preferred to external paths. | |
152 | ||
153 | This command should NOT be set normally. | |
154 | ||
155 | .. index:: log-adjacency-changes [detail] | |
156 | .. clicmd:: log-adjacency-changes [detail] | |
157 | ||
3d13052d | 158 | .. index:: log-adjacency-changes [detail] |
c1a54c05 QY |
159 | .. clicmd:: no log-adjacency-changes [detail] |
160 | ||
161 | Configures ospfd to log changes in adjacency. With the optional | |
162 | detail argument, all changes in adjacency status are shown. Without detail, | |
163 | only changes to full or regressions are shown. | |
164 | ||
165 | .. index:: passive-interface INTERFACE | |
166 | .. clicmd:: passive-interface INTERFACE | |
167 | ||
3d13052d | 168 | .. index:: passive-interface INTERFACE |
c1a54c05 | 169 | .. clicmd:: no passive-interface INTERFACE |
42fc5d26 | 170 | |
6ee602cd QY |
171 | Do not speak OSPF interface on the |
172 | given interface, but do advertise the interface as a stub link in the | |
173 | router-:abbr:`LSA (Link State Advertisement)` for this router. This | |
174 | allows one to advertise addresses on such connected interfaces without | |
175 | having to originate AS-External/Type-5 LSAs (which have global flooding | |
176 | scope) - as would occur if connected addresses were redistributed into | |
177 | OSPF (:ref:`redistribute-routes-to-ospf`). This is the only way to | |
178 | advertise non-OSPF links into stub areas. | |
c1a54c05 | 179 | |
fc0a7cad RZ |
180 | .. index:: timers throttle spf (0-600000) (0-600000) (0-600000) |
181 | .. clicmd:: timers throttle spf (0-600000) (0-600000) (0-600000) | |
c1a54c05 | 182 | |
3d13052d | 183 | .. index:: timers throttle spf |
c1a54c05 QY |
184 | .. clicmd:: no timers throttle spf |
185 | ||
186 | This command sets the initial `delay`, the `initial-holdtime` | |
187 | and the `maximum-holdtime` between when SPF is calculated and the | |
188 | event which triggered the calculation. The times are specified in | |
189 | milliseconds and must be in the range of 0 to 600000 milliseconds. | |
190 | ||
191 | The `delay` specifies the minimum amount of time to delay SPF | |
192 | calculation (hence it affects how long SPF calculation is delayed after | |
193 | an event which occurs outside of the holdtime of any previous SPF | |
194 | calculation, and also serves as a minimum holdtime). | |
195 | ||
d1e7591e | 196 | Consecutive SPF calculations will always be separated by at least |
c1a54c05 QY |
197 | 'hold-time' milliseconds. The hold-time is adaptive and initially is |
198 | set to the `initial-holdtime` configured with the above command. | |
199 | Events which occur within the holdtime of the previous SPF calculation | |
200 | will cause the holdtime to be increased by `initial-holdtime`, bounded | |
201 | by the `maximum-holdtime` configured with this command. If the adaptive | |
d1e7591e | 202 | hold-time elapses without any SPF-triggering event occurring then |
c1a54c05 | 203 | the current holdtime is reset to the `initial-holdtime`. The current |
6ee602cd | 204 | holdtime can be viewed with :clicmd:`show ip ospf`, where it is expressed as |
c1a54c05 | 205 | a multiplier of the `initial-holdtime`. |
42fc5d26 | 206 | |
9eb95b3b | 207 | .. code-block:: frr |
c1a54c05 QY |
208 | |
209 | router ospf | |
210 | timers throttle spf 200 400 10000 | |
211 | ||
212 | ||
213 | In this example, the `delay` is set to 200ms, the initial holdtime is set to | |
214 | 400ms and the `maximum holdtime` to 10s. Hence there will always be at least | |
215 | 200ms between an event which requires SPF calculation and the actual SPF | |
d1e7591e | 216 | calculation. Further consecutive SPF calculations will always be separated |
c1a54c05 QY |
217 | by between 400ms to 10s, the hold-time increasing by 400ms each time an |
218 | SPF-triggering event occurs within the hold-time of the previous SPF | |
219 | calculation. | |
42fc5d26 | 220 | |
56f0bea7 | 221 | This command supersedes the *timers spf* command in previous FRR |
c1a54c05 | 222 | releases. |
42fc5d26 | 223 | |
c1a54c05 QY |
224 | .. index:: max-metric router-lsa [on-startup|on-shutdown] (5-86400) |
225 | .. clicmd:: max-metric router-lsa [on-startup|on-shutdown] (5-86400) | |
42fc5d26 | 226 | |
c1a54c05 QY |
227 | .. index:: max-metric router-lsa administrative |
228 | .. clicmd:: max-metric router-lsa administrative | |
229 | ||
3d13052d | 230 | .. index:: max-metric router-lsa [on-startup|on-shutdown|administrative] |
c1a54c05 | 231 | .. clicmd:: no max-metric router-lsa [on-startup|on-shutdown|administrative] |
42fc5d26 | 232 | |
c1a54c05 QY |
233 | This enables :rfc:`3137` support, where the OSPF process describes its |
234 | transit links in its router-LSA as having infinite distance so that other | |
235 | routers will avoid calculating transit paths through the router while still | |
236 | being able to reach networks through the router. | |
42fc5d26 | 237 | |
c1a54c05 QY |
238 | This support may be enabled administratively (and indefinitely) or |
239 | conditionally. Conditional enabling of max-metric router-lsas can be for a | |
240 | period of seconds after startup and/or for a period of seconds prior to | |
241 | shutdown. | |
42fc5d26 | 242 | |
c1a54c05 QY |
243 | Enabling this for a period after startup allows OSPF to converge fully first |
244 | without affecting any existing routes used by other routers, while still | |
245 | allowing any connected stub links and/or redistributed routes to be | |
246 | reachable. Enabling this for a period of time in advance of shutdown allows | |
247 | the router to gracefully excuse itself from the OSPF domain. | |
42fc5d26 | 248 | |
c1a54c05 QY |
249 | Enabling this feature administratively allows for administrative |
250 | intervention for whatever reason, for an indefinite period of time. Note | |
251 | that if the configuration is written to file, this administrative form of | |
252 | the stub-router command will also be written to file. If *ospfd* is | |
253 | restarted later, the command will then take effect until manually | |
254 | deconfigured. | |
42fc5d26 | 255 | |
c1a54c05 QY |
256 | Configured state of this feature as well as current status, such as the |
257 | number of second remaining till on-startup or on-shutdown ends, can be | |
6ee602cd | 258 | viewed with the :clicmd:`show ip ospf` command. |
42fc5d26 | 259 | |
c1a54c05 QY |
260 | .. index:: auto-cost reference-bandwidth (1-4294967) |
261 | .. clicmd:: auto-cost reference-bandwidth (1-4294967) | |
42fc5d26 | 262 | |
3d13052d | 263 | .. index:: auto-cost reference-bandwidth |
c1a54c05 | 264 | .. clicmd:: no auto-cost reference-bandwidth |
42fc5d26 | 265 | |
c1a54c05 QY |
266 | This sets the reference |
267 | bandwidth for cost calculations, where this bandwidth is considered | |
268 | equivalent to an OSPF cost of 1, specified in Mbits/s. The default is | |
269 | 100Mbit/s (i.e. a link of bandwidth 100Mbit/s or higher will have a | |
270 | cost of 1. Cost of lower bandwidth links will be scaled with reference | |
271 | to this cost). | |
42fc5d26 | 272 | |
c1a54c05 QY |
273 | This configuration setting MUST be consistent across all routers within the |
274 | OSPF domain. | |
42fc5d26 | 275 | |
c1a54c05 QY |
276 | .. index:: network A.B.C.D/M area A.B.C.D |
277 | .. clicmd:: network A.B.C.D/M area A.B.C.D | |
42fc5d26 | 278 | |
c1a54c05 QY |
279 | .. index:: network A.B.C.D/M area (0-4294967295) |
280 | .. clicmd:: network A.B.C.D/M area (0-4294967295) | |
42fc5d26 | 281 | |
3d13052d | 282 | .. index:: network A.B.C.D/M area A.B.C.D |
c1a54c05 | 283 | .. clicmd:: no network A.B.C.D/M area A.B.C.D |
42fc5d26 | 284 | |
3d13052d | 285 | .. index:: network A.B.C.D/M area (0-4294967295) |
c1a54c05 | 286 | .. clicmd:: no network A.B.C.D/M area (0-4294967295) |
42fc5d26 | 287 | |
c1a54c05 QY |
288 | This command specifies the OSPF enabled interface(s). If the interface has |
289 | an address from range 192.168.1.0/24 then the command below enables ospf | |
290 | on this interface so router can provide network information to the other | |
291 | ospf routers via this interface. | |
42fc5d26 | 292 | |
9eb95b3b | 293 | .. code-block:: frr |
a8c90e15 | 294 | |
9eb95b3b QY |
295 | router ospf |
296 | network 192.168.1.0/24 area 0.0.0.0 | |
42fc5d26 | 297 | |
d1e7591e | 298 | Prefix length in interface must be equal or bigger (i.e. smaller network) than |
c1a54c05 QY |
299 | prefix length in network statement. For example statement above doesn't enable |
300 | ospf on interface with address 192.168.1.1/23, but it does on interface with | |
301 | address 192.168.1.129/25. | |
42fc5d26 | 302 | |
c1a54c05 QY |
303 | Note that the behavior when there is a peer address |
304 | defined on an interface changed after release 0.99.7. | |
305 | Currently, if a peer prefix has been configured, | |
306 | then we test whether the prefix in the network command contains | |
307 | the destination prefix. Otherwise, we test whether the network command prefix | |
308 | contains the local address prefix of the interface. | |
42fc5d26 | 309 | |
c1a54c05 | 310 | In some cases it may be more convenient to enable OSPF on a per |
6ee602cd | 311 | interface/subnet basis (:clicmd:`ip ospf area AREA [ADDR]`). |
42fc5d26 | 312 | |
dfb2ee85 JU |
313 | .. index:: proactive-arp |
314 | .. clicmd:: proactive-arp | |
315 | ||
3d13052d | 316 | .. index:: proactive-arp |
dfb2ee85 JU |
317 | .. clicmd:: no proactive-arp |
318 | ||
319 | This command enables or disables sending ARP requests to update neighbor | |
320 | table entries. It speeds up convergence for /32 networks on a P2P | |
321 | connection. | |
322 | ||
323 | This feature is enabled by default. | |
42fc5d26 | 324 | |
f91ce319 MR |
325 | .. index:: clear ip ospf [(1-65535)] process |
326 | .. clicmd:: clear ip ospf [(1-65535)] process | |
327 | ||
328 | This command can be used to clear the ospf process data structures. This | |
329 | will clear the ospf neighborship as well and it will get re-established. | |
330 | This will clear the LSDB too. This will be helpful when there is a change | |
331 | in router-id and if user wants the router-id change to take effect, user can | |
332 | use this cli instead of restarting the ospfd daemon. | |
333 | ||
334 | .. index:: clear ip ospf [(1-65535)] neighbor | |
335 | .. clicmd:: clear ip ospf [(1-65535)] neighbor | |
336 | ||
337 | This command can be used to clear the ospf neighbor data structures. This | |
338 | will clear the ospf neighborship and it will get re-established. This | |
339 | command can be used when the neighbor state get stuck at some state and | |
340 | this can be used to recover it from that state. | |
341 | ||
0efdf0fe | 342 | .. _ospf-area: |
42fc5d26 | 343 | |
e6f1b831 QY |
344 | Areas |
345 | ----- | |
42fc5d26 | 346 | |
c1a54c05 QY |
347 | .. index:: area A.B.C.D range A.B.C.D/M |
348 | .. clicmd:: area A.B.C.D range A.B.C.D/M | |
42fc5d26 | 349 | |
c1a54c05 QY |
350 | .. index:: area (0-4294967295) range A.B.C.D/M |
351 | .. clicmd:: area (0-4294967295) range A.B.C.D/M | |
42fc5d26 | 352 | |
3d13052d | 353 | .. index:: area A.B.C.D range A.B.C.D/M |
c1a54c05 | 354 | .. clicmd:: no area A.B.C.D range A.B.C.D/M |
42fc5d26 | 355 | |
3d13052d | 356 | .. index:: area (0-4294967295) range A.B.C.D/M |
c1a54c05 | 357 | .. clicmd:: no area (0-4294967295) range A.B.C.D/M |
42fc5d26 | 358 | |
9eb95b3b QY |
359 | Summarize intra area paths from specified area into one Type-3 summary-LSA |
360 | announced to other areas. This command can be used only in ABR and ONLY | |
d1e7591e | 361 | router-LSAs (Type-1) and network-LSAs (Type-2) (i.e. LSAs with scope area) can |
9eb95b3b QY |
362 | be summarized. Type-5 AS-external-LSAs can't be summarized - their scope is AS. |
363 | Summarizing Type-7 AS-external-LSAs isn't supported yet by FRR. | |
42fc5d26 | 364 | |
9eb95b3b | 365 | .. code-block:: frr |
42fc5d26 | 366 | |
9eb95b3b QY |
367 | router ospf |
368 | network 192.168.1.0/24 area 0.0.0.0 | |
369 | network 10.0.0.0/8 area 0.0.0.10 | |
370 | area 0.0.0.10 range 10.0.0.0/8 | |
a8c90e15 | 371 | |
42fc5d26 | 372 | |
9eb95b3b QY |
373 | With configuration above one Type-3 Summary-LSA with routing info 10.0.0.0/8 is |
374 | announced into backbone area if area 0.0.0.10 contains at least one intra-area | |
d1e7591e | 375 | network (i.e. described with router or network LSA) from this range. |
42fc5d26 | 376 | |
c1a54c05 QY |
377 | .. index:: area A.B.C.D range IPV4_PREFIX not-advertise |
378 | .. clicmd:: area A.B.C.D range IPV4_PREFIX not-advertise | |
42fc5d26 | 379 | |
3d13052d | 380 | .. index:: area A.B.C.D range IPV4_PREFIX not-advertise |
c1a54c05 | 381 | .. clicmd:: no area A.B.C.D range IPV4_PREFIX not-advertise |
42fc5d26 | 382 | |
d1e7591e | 383 | Instead of summarizing intra area paths filter them - i.e. intra area paths from this |
c1a54c05 QY |
384 | range are not advertised into other areas. |
385 | This command makes sense in ABR only. | |
42fc5d26 | 386 | |
c1a54c05 QY |
387 | .. index:: area A.B.C.D range IPV4_PREFIX substitute IPV4_PREFIX |
388 | .. clicmd:: area A.B.C.D range IPV4_PREFIX substitute IPV4_PREFIX | |
42fc5d26 | 389 | |
3d13052d | 390 | .. index:: area A.B.C.D range IPV4_PREFIX substitute IPV4_PREFIX |
c1a54c05 | 391 | .. clicmd:: no area A.B.C.D range IPV4_PREFIX substitute IPV4_PREFIX |
42fc5d26 | 392 | |
c1a54c05 | 393 | Substitute summarized prefix with another prefix. |
42fc5d26 | 394 | |
9eb95b3b | 395 | .. code-block:: frr |
42fc5d26 | 396 | |
9eb95b3b QY |
397 | router ospf |
398 | network 192.168.1.0/24 area 0.0.0.0 | |
399 | network 10.0.0.0/8 area 0.0.0.10 | |
400 | area 0.0.0.10 range 10.0.0.0/8 substitute 11.0.0.0/8 | |
a8c90e15 | 401 | |
42fc5d26 | 402 | |
c1a54c05 | 403 | One Type-3 summary-LSA with routing info 11.0.0.0/8 is announced into backbone area if |
d1e7591e | 404 | area 0.0.0.10 contains at least one intra-area network (i.e. described with router-LSA or |
c1a54c05 QY |
405 | network-LSA) from range 10.0.0.0/8. |
406 | This command makes sense in ABR only. | |
42fc5d26 | 407 | |
c1a54c05 QY |
408 | .. index:: area A.B.C.D virtual-link A.B.C.D |
409 | .. clicmd:: area A.B.C.D virtual-link A.B.C.D | |
42fc5d26 | 410 | |
c1a54c05 QY |
411 | .. index:: area (0-4294967295) virtual-link A.B.C.D |
412 | .. clicmd:: area (0-4294967295) virtual-link A.B.C.D | |
42fc5d26 | 413 | |
3d13052d | 414 | .. index:: area A.B.C.D virtual-link A.B.C.D |
c1a54c05 | 415 | .. clicmd:: no area A.B.C.D virtual-link A.B.C.D |
42fc5d26 | 416 | |
3d13052d | 417 | .. index:: area (0-4294967295) virtual-link A.B.C.D |
c1a54c05 | 418 | .. clicmd:: no area (0-4294967295) virtual-link A.B.C.D |
42fc5d26 | 419 | |
c1a54c05 QY |
420 | .. index:: area A.B.C.D shortcut |
421 | .. clicmd:: area A.B.C.D shortcut | |
42fc5d26 | 422 | |
c1a54c05 QY |
423 | .. index:: area (0-4294967295) shortcut |
424 | .. clicmd:: area (0-4294967295) shortcut | |
42fc5d26 | 425 | |
3d13052d | 426 | .. index:: area A.B.C.D shortcut |
c1a54c05 | 427 | .. clicmd:: no area A.B.C.D shortcut |
42fc5d26 | 428 | |
3d13052d | 429 | .. index:: area (0-4294967295) shortcut |
c1a54c05 | 430 | .. clicmd:: no area (0-4294967295) shortcut |
42fc5d26 | 431 | |
c1a54c05 QY |
432 | Configure the area as Shortcut capable. See :rfc:`3509`. This requires |
433 | that the 'abr-type' be set to 'shortcut'. | |
42fc5d26 | 434 | |
c1a54c05 QY |
435 | .. index:: area A.B.C.D stub |
436 | .. clicmd:: area A.B.C.D stub | |
42fc5d26 | 437 | |
c1a54c05 QY |
438 | .. index:: area (0-4294967295) stub |
439 | .. clicmd:: area (0-4294967295) stub | |
42fc5d26 | 440 | |
3d13052d | 441 | .. index:: area A.B.C.D stub |
c1a54c05 | 442 | .. clicmd:: no area A.B.C.D stub |
42fc5d26 | 443 | |
3d13052d | 444 | .. index:: area (0-4294967295) stub |
c1a54c05 | 445 | .. clicmd:: no area (0-4294967295) stub |
42fc5d26 | 446 | |
c1a54c05 QY |
447 | Configure the area to be a stub area. That is, an area where no router |
448 | originates routes external to OSPF and hence an area where all external | |
449 | routes are via the ABR(s). Hence, ABRs for such an area do not need | |
450 | to pass AS-External LSAs (type-5s) or ASBR-Summary LSAs (type-4) into the | |
451 | area. They need only pass Network-Summary (type-3) LSAs into such an area, | |
452 | along with a default-route summary. | |
42fc5d26 | 453 | |
c1a54c05 QY |
454 | .. index:: area A.B.C.D stub no-summary |
455 | .. clicmd:: area A.B.C.D stub no-summary | |
42fc5d26 | 456 | |
c1a54c05 QY |
457 | .. index:: area (0-4294967295) stub no-summary |
458 | .. clicmd:: area (0-4294967295) stub no-summary | |
42fc5d26 | 459 | |
3d13052d | 460 | .. index:: area A.B.C.D stub no-summary |
c1a54c05 | 461 | .. clicmd:: no area A.B.C.D stub no-summary |
42fc5d26 | 462 | |
3d13052d | 463 | .. index:: area (0-4294967295) stub no-summary |
c1a54c05 | 464 | .. clicmd:: no area (0-4294967295) stub no-summary |
42fc5d26 | 465 | |
c1a54c05 QY |
466 | Prevents an *ospfd* ABR from injecting inter-area |
467 | summaries into the specified stub area. | |
42fc5d26 | 468 | |
c1a54c05 QY |
469 | .. index:: area A.B.C.D default-cost (0-16777215) |
470 | .. clicmd:: area A.B.C.D default-cost (0-16777215) | |
42fc5d26 | 471 | |
3d13052d | 472 | .. index:: area A.B.C.D default-cost (0-16777215) |
c1a54c05 | 473 | .. clicmd:: no area A.B.C.D default-cost (0-16777215) |
42fc5d26 | 474 | |
c1a54c05 | 475 | Set the cost of default-summary LSAs announced to stubby areas. |
42fc5d26 | 476 | |
c1a54c05 QY |
477 | .. index:: area A.B.C.D export-list NAME |
478 | .. clicmd:: area A.B.C.D export-list NAME | |
42fc5d26 | 479 | |
c1a54c05 QY |
480 | .. index:: area (0-4294967295) export-list NAME |
481 | .. clicmd:: area (0-4294967295) export-list NAME | |
42fc5d26 | 482 | |
3d13052d | 483 | .. index:: area A.B.C.D export-list NAME |
c1a54c05 | 484 | .. clicmd:: no area A.B.C.D export-list NAME |
42fc5d26 | 485 | |
3d13052d | 486 | .. index:: area (0-4294967295) export-list NAME |
c1a54c05 | 487 | .. clicmd:: no area (0-4294967295) export-list NAME |
42fc5d26 | 488 | |
c1a54c05 QY |
489 | Filter Type-3 summary-LSAs announced to other areas originated from intra- |
490 | area paths from specified area. | |
42fc5d26 | 491 | |
9eb95b3b | 492 | .. code-block:: frr |
a8c90e15 | 493 | |
9eb95b3b QY |
494 | router ospf |
495 | network 192.168.1.0/24 area 0.0.0.0 | |
496 | network 10.0.0.0/8 area 0.0.0.10 | |
497 | area 0.0.0.10 export-list foo | |
498 | ! | |
499 | access-list foo permit 10.10.0.0/16 | |
500 | access-list foo deny any | |
42fc5d26 | 501 | |
c1a54c05 QY |
502 | With example above any intra-area paths from area 0.0.0.10 and from range |
503 | 10.10.0.0/16 (for example 10.10.1.0/24 and 10.10.2.128/30) are announced into | |
504 | other areas as Type-3 summary-LSA's, but any others (for example 10.11.0.0/16 | |
505 | or 10.128.30.16/30) aren't. | |
42fc5d26 | 506 | |
c1a54c05 QY |
507 | This command is only relevant if the router is an ABR for the specified |
508 | area. | |
42fc5d26 | 509 | |
c1a54c05 QY |
510 | .. index:: area A.B.C.D import-list NAME |
511 | .. clicmd:: area A.B.C.D import-list NAME | |
42fc5d26 | 512 | |
c1a54c05 QY |
513 | .. index:: area (0-4294967295) import-list NAME |
514 | .. clicmd:: area (0-4294967295) import-list NAME | |
42fc5d26 | 515 | |
3d13052d | 516 | .. index:: area A.B.C.D import-list NAME |
c1a54c05 | 517 | .. clicmd:: no area A.B.C.D import-list NAME |
42fc5d26 | 518 | |
3d13052d | 519 | .. index:: area (0-4294967295) import-list NAME |
c1a54c05 | 520 | .. clicmd:: no area (0-4294967295) import-list NAME |
42fc5d26 | 521 | |
9eb95b3b QY |
522 | Same as export-list, but it applies to paths announced into specified area |
523 | as Type-3 summary-LSAs. | |
42fc5d26 | 524 | |
c1a54c05 QY |
525 | .. index:: area A.B.C.D filter-list prefix NAME in |
526 | .. clicmd:: area A.B.C.D filter-list prefix NAME in | |
42fc5d26 | 527 | |
c1a54c05 QY |
528 | .. index:: area A.B.C.D filter-list prefix NAME out |
529 | .. clicmd:: area A.B.C.D filter-list prefix NAME out | |
42fc5d26 | 530 | |
c1a54c05 QY |
531 | .. index:: area (0-4294967295) filter-list prefix NAME in |
532 | .. clicmd:: area (0-4294967295) filter-list prefix NAME in | |
42fc5d26 | 533 | |
c1a54c05 QY |
534 | .. index:: area (0-4294967295) filter-list prefix NAME out |
535 | .. clicmd:: area (0-4294967295) filter-list prefix NAME out | |
42fc5d26 | 536 | |
3d13052d | 537 | .. index:: area A.B.C.D filter-list prefix NAME in |
c1a54c05 | 538 | .. clicmd:: no area A.B.C.D filter-list prefix NAME in |
42fc5d26 | 539 | |
3d13052d | 540 | .. index:: area A.B.C.D filter-list prefix NAME out |
c1a54c05 | 541 | .. clicmd:: no area A.B.C.D filter-list prefix NAME out |
42fc5d26 | 542 | |
3d13052d | 543 | .. index:: area (0-4294967295) filter-list prefix NAME in |
c1a54c05 | 544 | .. clicmd:: no area (0-4294967295) filter-list prefix NAME in |
42fc5d26 | 545 | |
3d13052d | 546 | .. index:: area (0-4294967295) filter-list prefix NAME out |
c1a54c05 | 547 | .. clicmd:: no area (0-4294967295) filter-list prefix NAME out |
42fc5d26 | 548 | |
9eb95b3b QY |
549 | Filtering Type-3 summary-LSAs to/from area using prefix lists. This command |
550 | makes sense in ABR only. | |
42fc5d26 | 551 | |
c1a54c05 QY |
552 | .. index:: area A.B.C.D authentication |
553 | .. clicmd:: area A.B.C.D authentication | |
42fc5d26 | 554 | |
c1a54c05 QY |
555 | .. index:: area (0-4294967295) authentication |
556 | .. clicmd:: area (0-4294967295) authentication | |
42fc5d26 | 557 | |
3d13052d | 558 | .. index:: area A.B.C.D authentication |
c1a54c05 | 559 | .. clicmd:: no area A.B.C.D authentication |
42fc5d26 | 560 | |
3d13052d | 561 | .. index:: area (0-4294967295) authentication |
c1a54c05 | 562 | .. clicmd:: no area (0-4294967295) authentication |
42fc5d26 | 563 | |
9eb95b3b QY |
564 | Specify that simple password authentication should be used for the given |
565 | area. | |
42fc5d26 | 566 | |
c1a54c05 QY |
567 | .. index:: area A.B.C.D authentication message-digest |
568 | .. clicmd:: area A.B.C.D authentication message-digest | |
42fc5d26 | 569 | |
c1a54c05 QY |
570 | .. index:: area (0-4294967295) authentication message-digest |
571 | .. clicmd:: area (0-4294967295) authentication message-digest | |
42fc5d26 | 572 | |
6ee602cd QY |
573 | Specify that OSPF packets must be authenticated with MD5 HMACs within the |
574 | given area. Keying material must also be configured on a per-interface basis | |
575 | (:clicmd:`ip ospf message-digest-key`). | |
42fc5d26 | 576 | |
6ee602cd QY |
577 | MD5 authentication may also be configured on a per-interface basis |
578 | (:clicmd:`ip ospf authentication message-digest`). Such per-interface | |
579 | settings will override any per-area authentication setting. | |
42fc5d26 | 580 | |
0efdf0fe | 581 | .. _ospf-interface: |
42fc5d26 | 582 | |
e6f1b831 QY |
583 | Interfaces |
584 | ---------- | |
42fc5d26 | 585 | |
c1a54c05 QY |
586 | .. index:: ip ospf area AREA [ADDR] |
587 | .. clicmd:: ip ospf area AREA [ADDR] | |
42fc5d26 | 588 | |
3d13052d | 589 | .. index:: ip ospf area [ADDR] |
c1a54c05 | 590 | .. clicmd:: no ip ospf area [ADDR] |
42fc5d26 | 591 | |
c1a54c05 | 592 | Enable OSPF on the interface, optionally restricted to just the IP address |
6ee602cd QY |
593 | given by `ADDR`, putting it in the `AREA` area. Per interface area settings |
594 | take precedence to network commands | |
595 | (:clicmd:`network A.B.C.D/M area A.B.C.D`). | |
42fc5d26 | 596 | |
c1a54c05 QY |
597 | If you have a lot of interfaces, and/or a lot of subnets, then enabling OSPF |
598 | via this command may result in a slight performance improvement. | |
42fc5d26 | 599 | |
c1a54c05 QY |
600 | .. index:: ip ospf authentication-key AUTH_KEY |
601 | .. clicmd:: ip ospf authentication-key AUTH_KEY | |
42fc5d26 | 602 | |
3d13052d | 603 | .. index:: ip ospf authentication-key |
c1a54c05 | 604 | .. clicmd:: no ip ospf authentication-key |
42fc5d26 | 605 | |
c1a54c05 QY |
606 | Set OSPF authentication key to a simple password. After setting `AUTH_KEY`, |
607 | all OSPF packets are authenticated. `AUTH_KEY` has length up to 8 chars. | |
42fc5d26 | 608 | |
c1a54c05 | 609 | Simple text password authentication is insecure and deprecated in favour of |
6ee602cd | 610 | MD5 HMAC authentication. |
42fc5d26 | 611 | |
c1a54c05 QY |
612 | .. index:: ip ospf authentication message-digest |
613 | .. clicmd:: ip ospf authentication message-digest | |
42fc5d26 | 614 | |
6ee602cd QY |
615 | Specify that MD5 HMAC authentication must be used on this interface. MD5 |
616 | keying material must also be configured. Overrides any authentication | |
617 | enabled on a per-area basis | |
618 | (:clicmd:`area A.B.C.D authentication message-digest`) | |
42fc5d26 | 619 | |
c1a54c05 QY |
620 | Note that OSPF MD5 authentication requires that time never go backwards |
621 | (correct time is NOT important, only that it never goes backwards), even | |
d1e7591e | 622 | across resets, if ospfd is to be able to promptly reestablish adjacencies |
6ee602cd | 623 | with its neighbours after restarts/reboots. The host should have system time |
d1e7591e | 624 | be set at boot from an external or non-volatile source (e.g. battery backed |
6ee602cd | 625 | clock, NTP, etc.) or else the system clock should be periodically saved to |
d1e7591e | 626 | non-volatile storage and restored at boot if MD5 authentication is to be |
6ee602cd | 627 | expected to work reliably. |
42fc5d26 | 628 | |
c1a54c05 QY |
629 | .. index:: ip ospf message-digest-key KEYID md5 KEY |
630 | .. clicmd:: ip ospf message-digest-key KEYID md5 KEY | |
42fc5d26 | 631 | |
3d13052d | 632 | .. index:: ip ospf message-digest-key |
c1a54c05 | 633 | .. clicmd:: no ip ospf message-digest-key |
42fc5d26 | 634 | |
6ee602cd QY |
635 | Set OSPF authentication key to a cryptographic password. The cryptographic |
636 | algorithm is MD5. | |
42fc5d26 | 637 | |
9eb95b3b QY |
638 | KEYID identifies secret key used to create the message digest. This ID is |
639 | part of the protocol and must be consistent across routers on a link. | |
42fc5d26 | 640 | |
9eb95b3b QY |
641 | KEY is the actual message digest key, of up to 16 chars (larger strings will |
642 | be truncated), and is associated with the given KEYID. | |
42fc5d26 | 643 | |
c1a54c05 QY |
644 | .. index:: ip ospf cost (1-65535) |
645 | .. clicmd:: ip ospf cost (1-65535) | |
42fc5d26 | 646 | |
3d13052d | 647 | .. index:: ip ospf cost |
c1a54c05 | 648 | .. clicmd:: no ip ospf cost |
42fc5d26 | 649 | |
9eb95b3b QY |
650 | Set link cost for the specified interface. The cost value is set to |
651 | router-LSA's metric field and used for SPF calculation. | |
42fc5d26 | 652 | |
c1a54c05 QY |
653 | .. index:: ip ospf dead-interval (1-65535) |
654 | .. clicmd:: ip ospf dead-interval (1-65535) | |
42fc5d26 | 655 | |
c1a54c05 QY |
656 | .. index:: ip ospf dead-interval minimal hello-multiplier (2-20) |
657 | .. clicmd:: ip ospf dead-interval minimal hello-multiplier (2-20) | |
42fc5d26 | 658 | |
3d13052d | 659 | .. index:: ip ospf dead-interval |
c1a54c05 | 660 | .. clicmd:: no ip ospf dead-interval |
42fc5d26 | 661 | |
6ee602cd QY |
662 | Set number of seconds for RouterDeadInterval timer value used for Wait Timer |
663 | and Inactivity Timer. This value must be the same for all routers attached | |
664 | to a common network. The default value is 40 seconds. | |
42fc5d26 | 665 | |
6ee602cd QY |
666 | If 'minimal' is specified instead, then the dead-interval is set to 1 second |
667 | and one must specify a hello-multiplier. The hello-multiplier specifies how | |
668 | many Hellos to send per second, from 2 (every 500ms) to 20 (every 50ms). | |
669 | Thus one can have 1s convergence time for OSPF. If this form is specified, | |
670 | then the hello-interval advertised in Hello packets is set to 0 and the | |
671 | hello-interval on received Hello packets is not checked, thus the | |
672 | hello-multiplier need NOT be the same across multiple routers on a common | |
673 | link. | |
42fc5d26 | 674 | |
c1a54c05 QY |
675 | .. index:: ip ospf hello-interval (1-65535) |
676 | .. clicmd:: ip ospf hello-interval (1-65535) | |
42fc5d26 | 677 | |
3d13052d | 678 | .. index:: ip ospf hello-interval |
c1a54c05 | 679 | .. clicmd:: no ip ospf hello-interval |
42fc5d26 | 680 | |
c1a54c05 QY |
681 | Set number of seconds for HelloInterval timer value. Setting this value, |
682 | Hello packet will be sent every timer value seconds on the specified interface. | |
683 | This value must be the same for all routers attached to a common network. | |
684 | The default value is 10 seconds. | |
42fc5d26 | 685 | |
6ee602cd QY |
686 | This command has no effect if |
687 | :clicmd:`ip ospf dead-interval minimal hello-multiplier (2-20)` is also | |
c1a54c05 | 688 | specified for the interface. |
42fc5d26 | 689 | |
c1a54c05 QY |
690 | .. index:: ip ospf network (broadcast|non-broadcast|point-to-multipoint|point-to-point) |
691 | .. clicmd:: ip ospf network (broadcast|non-broadcast|point-to-multipoint|point-to-point) | |
42fc5d26 | 692 | |
56f9b9bf DS |
693 | When configuring a point-to-point network on an interface and the interface |
694 | has a /32 address associated with then OSPF will treat the interface | |
695 | as being `unnumbered`. If you are doing this you *must* set the | |
696 | net.ipv4.conf.<interface name>.rp_filter value to 0. In order for | |
697 | the ospf multicast packets to be delivered by the kernel. | |
698 | ||
3d13052d | 699 | .. index:: ip ospf network |
c1a54c05 | 700 | .. clicmd:: no ip ospf network |
42fc5d26 | 701 | |
d1e7591e | 702 | Set explicitly network type for specified interface. |
42fc5d26 | 703 | |
c1a54c05 QY |
704 | .. index:: ip ospf priority (0-255) |
705 | .. clicmd:: ip ospf priority (0-255) | |
42fc5d26 | 706 | |
3d13052d | 707 | .. index:: ip ospf priority |
c1a54c05 | 708 | .. clicmd:: no ip ospf priority |
42fc5d26 | 709 | |
9eb95b3b QY |
710 | Set RouterPriority integer value. The router with the highest priority will |
711 | be more eligible to become Designated Router. Setting the value to 0, makes | |
712 | the router ineligible to become Designated Router. The default value is 1. | |
42fc5d26 | 713 | |
c1a54c05 QY |
714 | .. index:: ip ospf retransmit-interval (1-65535) |
715 | .. clicmd:: ip ospf retransmit-interval (1-65535) | |
42fc5d26 | 716 | |
3d13052d | 717 | .. index:: ip ospf retransmit interval |
c1a54c05 | 718 | .. clicmd:: no ip ospf retransmit interval |
42fc5d26 | 719 | |
9eb95b3b QY |
720 | Set number of seconds for RxmtInterval timer value. This value is used when |
721 | retransmitting Database Description and Link State Request packets. The | |
722 | default value is 5 seconds. | |
42fc5d26 | 723 | |
7db1c0f0 RZ |
724 | .. index:: ip ospf transmit-delay (1-65535) [A.B.C.D] |
725 | .. clicmd:: ip ospf transmit-delay (1-65535) [A.B.C.D] | |
42fc5d26 | 726 | |
3d13052d | 727 | .. index:: ip ospf transmit-delay [(1-65535)] [A.B.C.D] |
7db1c0f0 | 728 | .. clicmd:: no ip ospf transmit-delay [(1-65535)] [A.B.C.D] |
42fc5d26 | 729 | |
c1a54c05 | 730 | Set number of seconds for InfTransDelay value. LSAs' age should be |
9eb95b3b | 731 | incremented by this value when transmitting. The default value is 1 second. |
42fc5d26 | 732 | |
c1a54c05 QY |
733 | .. index:: ip ospf area (A.B.C.D|(0-4294967295)) |
734 | .. clicmd:: ip ospf area (A.B.C.D|(0-4294967295)) | |
42fc5d26 | 735 | |
3d13052d | 736 | .. index:: ip ospf area |
c1a54c05 | 737 | .. clicmd:: no ip ospf area |
42fc5d26 | 738 | |
9eb95b3b | 739 | Enable ospf on an interface and set associated area. |
42fc5d26 | 740 | |
243892e0 DA |
741 | OSPF route-map |
742 | ============== | |
743 | ||
744 | Usage of *ospfd*'s route-map support. | |
745 | ||
746 | .. index:: set metric [+|-](0-4294967295) | |
747 | .. clicmd:: set metric [+|-](0-4294967295) | |
748 | ||
749 | Set a metric for matched route when sending announcement. Use plus (+) sign | |
750 | to add a metric value to an existing metric. Use minus (-) sign to | |
751 | substract a metric value from an existing metric. | |
752 | ||
0efdf0fe | 753 | .. _redistribute-routes-to-ospf: |
42fc5d26 | 754 | |
e6f1b831 QY |
755 | Redistribution |
756 | -------------- | |
42fc5d26 | 757 | |
c1a54c05 QY |
758 | .. index:: redistribute (kernel|connected|static|rip|bgp) |
759 | .. clicmd:: redistribute (kernel|connected|static|rip|bgp) | |
42fc5d26 | 760 | |
c1a54c05 QY |
761 | .. index:: redistribute (kernel|connected|static|rip|bgp) ROUTE-MAP |
762 | .. clicmd:: redistribute (kernel|connected|static|rip|bgp) ROUTE-MAP | |
42fc5d26 | 763 | |
c1a54c05 QY |
764 | .. index:: redistribute (kernel|connected|static|rip|bgp) metric-type (1|2) |
765 | .. clicmd:: redistribute (kernel|connected|static|rip|bgp) metric-type (1|2) | |
42fc5d26 | 766 | |
c1a54c05 QY |
767 | .. index:: redistribute (kernel|connected|static|rip|bgp) metric-type (1|2) route-map WORD |
768 | .. clicmd:: redistribute (kernel|connected|static|rip|bgp) metric-type (1|2) route-map WORD | |
42fc5d26 | 769 | |
c1a54c05 QY |
770 | .. index:: redistribute (kernel|connected|static|rip|bgp) metric (0-16777214) |
771 | .. clicmd:: redistribute (kernel|connected|static|rip|bgp) metric (0-16777214) | |
42fc5d26 | 772 | |
c1a54c05 QY |
773 | .. index:: redistribute (kernel|connected|static|rip|bgp) metric (0-16777214) route-map WORD |
774 | .. clicmd:: redistribute (kernel|connected|static|rip|bgp) metric (0-16777214) route-map WORD | |
42fc5d26 | 775 | |
c1a54c05 QY |
776 | .. index:: redistribute (kernel|connected|static|rip|bgp) metric-type (1|2) metric (0-16777214) |
777 | .. clicmd:: redistribute (kernel|connected|static|rip|bgp) metric-type (1|2) metric (0-16777214) | |
42fc5d26 | 778 | |
c1a54c05 QY |
779 | .. index:: redistribute (kernel|connected|static|rip|bgp) metric-type (1|2) metric (0-16777214) route-map WORD |
780 | .. clicmd:: redistribute (kernel|connected|static|rip|bgp) metric-type (1|2) metric (0-16777214) route-map WORD | |
42fc5d26 | 781 | |
3d13052d | 782 | .. index:: redistribute (kernel|connected|static|rip|bgp) |
c1a54c05 | 783 | .. clicmd:: no redistribute (kernel|connected|static|rip|bgp) |
42fc5d26 | 784 | |
0efdf0fe | 785 | .. _ospf-redistribute: |
42fc5d26 | 786 | |
9eb95b3b QY |
787 | Redistribute routes of the specified protocol or kind into OSPF, with the |
788 | metric type and metric set if specified, filtering the routes using the | |
789 | given route-map if specified. Redistributed routes may also be filtered | |
790 | with distribute-lists, see | |
11ab5329 | 791 | :ref:`ospf distribute-list configuration <ospf-distribute-list>`. |
42fc5d26 | 792 | |
9eb95b3b QY |
793 | Redistributed routes are distributed as into OSPF as Type-5 External LSAs |
794 | into links to areas that accept external routes, Type-7 External LSAs for | |
795 | NSSA areas and are not redistributed at all into Stub areas, where external | |
796 | routes are not permitted. | |
42fc5d26 | 797 | |
62333307 QY |
798 | Note that for connected routes, one may instead use the `passive-interface` |
799 | configuration. | |
6ee602cd QY |
800 | |
801 | .. seealso:: | |
802 | ||
803 | clicmd:`passive-interface INTERFACE`. | |
42fc5d26 | 804 | |
c1a54c05 QY |
805 | .. index:: default-information originate |
806 | .. clicmd:: default-information originate | |
42fc5d26 | 807 | |
c1a54c05 QY |
808 | .. index:: default-information originate metric (0-16777214) |
809 | .. clicmd:: default-information originate metric (0-16777214) | |
42fc5d26 | 810 | |
c1a54c05 QY |
811 | .. index:: default-information originate metric (0-16777214) metric-type (1|2) |
812 | .. clicmd:: default-information originate metric (0-16777214) metric-type (1|2) | |
42fc5d26 | 813 | |
c1a54c05 QY |
814 | .. index:: default-information originate metric (0-16777214) metric-type (1|2) route-map WORD |
815 | .. clicmd:: default-information originate metric (0-16777214) metric-type (1|2) route-map WORD | |
42fc5d26 | 816 | |
c1a54c05 QY |
817 | .. index:: default-information originate always |
818 | .. clicmd:: default-information originate always | |
42fc5d26 | 819 | |
c1a54c05 QY |
820 | .. index:: default-information originate always metric (0-16777214) |
821 | .. clicmd:: default-information originate always metric (0-16777214) | |
42fc5d26 | 822 | |
c1a54c05 QY |
823 | .. index:: default-information originate always metric (0-16777214) metric-type (1|2) |
824 | .. clicmd:: default-information originate always metric (0-16777214) metric-type (1|2) | |
42fc5d26 | 825 | |
c1a54c05 QY |
826 | .. index:: default-information originate always metric (0-16777214) metric-type (1|2) route-map WORD |
827 | .. clicmd:: default-information originate always metric (0-16777214) metric-type (1|2) route-map WORD | |
42fc5d26 | 828 | |
3d13052d | 829 | .. index:: default-information originate |
c1a54c05 | 830 | .. clicmd:: no default-information originate |
42fc5d26 | 831 | |
9eb95b3b QY |
832 | Originate an AS-External (type-5) LSA describing a default route into all |
833 | external-routing capable areas, of the specified metric and metric type. If | |
834 | the 'always' keyword is given then the default is always advertised, even | |
835 | when there is no default present in the routing table. | |
42fc5d26 | 836 | |
c1a54c05 QY |
837 | .. index:: distribute-list NAME out (kernel|connected|static|rip|ospf |
838 | .. clicmd:: distribute-list NAME out (kernel|connected|static|rip|ospf | |
42fc5d26 | 839 | |
3d13052d | 840 | .. index:: distribute-list NAME out (kernel|connected|static|rip|ospf |
c1a54c05 | 841 | .. clicmd:: no distribute-list NAME out (kernel|connected|static|rip|ospf |
42fc5d26 | 842 | |
0efdf0fe | 843 | .. _ospf-distribute-list: |
42fc5d26 | 844 | |
9eb95b3b QY |
845 | Apply the access-list filter, NAME, to redistributed routes of the given |
846 | type before allowing the routes to redistributed into OSPF | |
847 | (:ref:`ospf redistribution <ospf-redistribute>`). | |
42fc5d26 | 848 | |
c1a54c05 QY |
849 | .. index:: default-metric (0-16777214) |
850 | .. clicmd:: default-metric (0-16777214) | |
42fc5d26 | 851 | |
3d13052d | 852 | .. index:: default-metric |
c1a54c05 | 853 | .. clicmd:: no default-metric |
42fc5d26 | 854 | |
c1a54c05 QY |
855 | .. index:: distance (1-255) |
856 | .. clicmd:: distance (1-255) | |
42fc5d26 | 857 | |
3d13052d | 858 | .. index:: distance (1-255) |
c1a54c05 | 859 | .. clicmd:: no distance (1-255) |
42fc5d26 | 860 | |
c1a54c05 QY |
861 | .. index:: distance ospf (intra-area|inter-area|external) (1-255) |
862 | .. clicmd:: distance ospf (intra-area|inter-area|external) (1-255) | |
42fc5d26 | 863 | |
3d13052d | 864 | .. index:: distance ospf |
c1a54c05 | 865 | .. clicmd:: no distance ospf |
42fc5d26 | 866 | |
c1a54c05 QY |
867 | .. index:: router zebra |
868 | .. clicmd:: router zebra | |
42fc5d26 | 869 | |
3d13052d | 870 | .. index:: router zebra |
c1a54c05 | 871 | .. clicmd:: no router zebra |
42fc5d26 | 872 | |
cc1a92d8 | 873 | Graceful Restart Helper |
874 | ======================= | |
875 | ||
876 | .. index:: graceful-restart helper-only [A.B.C.D] | |
877 | .. clicmd:: graceful-restart helper-only [A.B.C.D] | |
878 | ||
3d13052d | 879 | .. index:: graceful-restart helper-only [A.B.C.D] |
cc1a92d8 | 880 | .. clicmd:: no graceful-restart helper-only [A.B.C.D] |
881 | ||
882 | Configure Graceful Restart (RFC 3623) helper support. | |
883 | By default, helper support is disabled for all neighbours. | |
884 | This config enables/disables helper support on this router | |
885 | for all neighbours. | |
886 | To enable/disable helper support for a specific | |
887 | neighbour, the router-id (A.B.C.D) has to be specified. | |
888 | ||
889 | .. index:: graceful-restart helper strict-lsa-checking | |
890 | .. clicmd:: graceful-restart helper strict-lsa-checking | |
891 | ||
3d13052d | 892 | .. index:: graceful-restart helper strict-lsa-checking |
cc1a92d8 | 893 | .. clicmd:: no graceful-restart helper strict-lsa-checking |
894 | ||
895 | If 'strict-lsa-checking' is configured then the helper will | |
896 | abort the Graceful Restart when a LSA change occurs which | |
897 | affects the restarting router. | |
898 | By default 'strict-lsa-checking' is enabled" | |
899 | ||
900 | .. index:: graceful-restart helper supported-grace-time | |
901 | .. clicmd:: graceful-restart helper supported-grace-time | |
902 | ||
3d13052d | 903 | .. index:: graceful-restart helper supported-grace-time |
cc1a92d8 | 904 | .. clicmd:: no graceful-restart helper supported-grace-time |
905 | ||
906 | Supports as HELPER for configured grace period. | |
907 | ||
908 | .. index:: graceful-restart helper planned-only | |
909 | .. clicmd:: graceful-restart helper planned-only | |
910 | ||
3d13052d | 911 | .. index:: graceful-restart helper planned-only |
cc1a92d8 | 912 | .. clicmd:: no graceful-restart helper planned-only |
913 | ||
914 | It helps to support as HELPER only for planned | |
915 | restarts. By default, it supports both planned and | |
916 | unplanned outages. | |
42fc5d26 | 917 | |
0efdf0fe | 918 | .. _showing-ospf-information: |
42fc5d26 | 919 | |
e6f1b831 QY |
920 | Showing Information |
921 | =================== | |
42fc5d26 | 922 | |
0efdf0fe | 923 | .. _show-ip-ospf: |
42fc5d26 | 924 | |
f328dc60 | 925 | .. index:: show ip ospf [json] |
926 | .. clicmd:: show ip ospf [json] | |
42fc5d26 | 927 | |
c1a54c05 QY |
928 | Show information on a variety of general OSPF and area state and |
929 | configuration information. | |
42fc5d26 | 930 | |
f328dc60 | 931 | .. index:: show ip ospf interface [INTERFACE] [json] |
932 | .. clicmd:: show ip ospf interface [INTERFACE] [json] | |
42fc5d26 | 933 | |
c1a54c05 QY |
934 | Show state and configuration of OSPF the specified interface, or all |
935 | interfaces if no interface is given. | |
42fc5d26 | 936 | |
f328dc60 | 937 | .. index:: show ip ospf neighbor [json] |
938 | .. clicmd:: show ip ospf neighbor [json] | |
42fc5d26 | 939 | |
f328dc60 | 940 | .. index:: show ip ospf neighbor INTERFACE [json] |
941 | .. clicmd:: show ip ospf neighbor INTERFACE [json] | |
42fc5d26 | 942 | |
f328dc60 | 943 | .. index:: show ip ospf neighbor detail [json] |
944 | .. clicmd:: show ip ospf neighbor detail [json] | |
42fc5d26 | 945 | |
f328dc60 | 946 | .. index:: show ip ospf neighbor INTERFACE detail [json] |
947 | .. clicmd:: show ip ospf neighbor INTERFACE detail [json] | |
42fc5d26 | 948 | |
f328dc60 | 949 | Display lsa information of LSDB. |
950 | Json o/p of this command covers base route information | |
951 | i.e all LSAs except opaque lsa info. | |
42fc5d26 | 952 | |
f328dc60 | 953 | .. index:: show ip ospf database [json] |
954 | .. clicmd:: show ip ospf database [json] | |
42fc5d26 | 955 | |
f328dc60 | 956 | .. index:: show ip ospf database (asbr-summary|external|network|router|summary) [json] |
957 | .. clicmd:: show ip ospf database (asbr-summary|external|network|router|summary) [json] | |
42fc5d26 | 958 | |
f328dc60 | 959 | .. index:: show ip ospf database (asbr-summary|external|network|router|summary) LINK-STATE-ID [json] |
960 | .. clicmd:: show ip ospf database (asbr-summary|external|network|router|summary) LINK-STATE-ID [json] | |
42fc5d26 | 961 | |
f328dc60 | 962 | .. index:: show ip ospf database (asbr-summary|external|network|router|summary) LINK-STATE-ID adv-router ADV-ROUTER [json] |
963 | .. clicmd:: show ip ospf database (asbr-summary|external|network|router|summary) LINK-STATE-ID adv-router ADV-ROUTER [json] | |
42fc5d26 | 964 | |
f328dc60 | 965 | .. index:: show ip ospf database (asbr-summary|external|network|router|summary) adv-router ADV-ROUTER [json] |
966 | .. clicmd:: show ip ospf database (asbr-summary|external|network|router|summary) adv-router ADV-ROUTER [json] | |
42fc5d26 | 967 | |
f328dc60 | 968 | .. index:: show ip ospf database (asbr-summary|external|network|router|summary) LINK-STATE-ID self-originate [json] |
969 | .. clicmd:: show ip ospf database (asbr-summary|external|network|router|summary) LINK-STATE-ID self-originate [json] | |
42fc5d26 | 970 | |
f328dc60 | 971 | .. index:: show ip ospf database (asbr-summary|external|network|router|summary) self-originate [json] |
972 | .. clicmd:: show ip ospf database (asbr-summary|external|network|router|summary) self-originate [json] | |
42fc5d26 | 973 | |
f328dc60 | 974 | .. index:: show ip ospf database max-age [json] |
975 | .. clicmd:: show ip ospf database max-age [json] | |
42fc5d26 | 976 | |
f328dc60 | 977 | .. index:: show ip ospf database self-originate [json] |
978 | .. clicmd:: show ip ospf database self-originate [json] | |
979 | ||
980 | .. index:: show ip ospf route [json] | |
981 | .. clicmd:: show ip ospf route [json] | |
42fc5d26 | 982 | |
9eb95b3b QY |
983 | Show the OSPF routing table, as determined by the most recent SPF |
984 | calculation. | |
42fc5d26 | 985 | |
cc1a92d8 | 986 | .. index:: show ip ospf graceful-restart helper [detail] [json] |
987 | .. clicmd:: show ip ospf graceful-restart helper [detail] [json] | |
988 | ||
989 | Displays the Grcaeful Restart Helper details including helper | |
990 | config changes. | |
991 | ||
0efdf0fe | 992 | .. _opaque-lsa: |
42fc5d26 QY |
993 | |
994 | Opaque LSA | |
995 | ========== | |
996 | ||
c1a54c05 QY |
997 | .. index:: ospf opaque-lsa |
998 | .. clicmd:: ospf opaque-lsa | |
42fc5d26 | 999 | |
c1a54c05 QY |
1000 | .. index:: capability opaque |
1001 | .. clicmd:: capability opaque | |
42fc5d26 | 1002 | |
3d13052d | 1003 | .. index:: ospf opaque-lsa |
c1a54c05 | 1004 | .. clicmd:: no ospf opaque-lsa |
42fc5d26 | 1005 | |
3d13052d | 1006 | .. index:: capability opaque |
c1a54c05 | 1007 | .. clicmd:: no capability opaque |
42fc5d26 | 1008 | |
85400b29 MS |
1009 | *ospfd* supports Opaque LSA (:rfc:`2370`) as partial support for |
1010 | MPLS Traffic Engineering LSAs. The opaque-lsa capability must be | |
1011 | enabled in the configuration. An alternate command could be | |
1012 | "mpls-te on" (:ref:`ospf-traffic-engineering`). Note that FRR | |
1013 | offers only partial support for some of the routing protocol | |
1014 | extensions that are used with MPLS-TE; it does not support a | |
1015 | complete RSVP-TE solution. | |
42fc5d26 | 1016 | |
c1a54c05 QY |
1017 | .. index:: show ip ospf database (opaque-link|opaque-area|opaque-external) |
1018 | .. clicmd:: show ip ospf database (opaque-link|opaque-area|opaque-external) | |
42fc5d26 | 1019 | |
c1a54c05 QY |
1020 | .. index:: show ip ospf database (opaque-link|opaque-area|opaque-external) LINK-STATE-ID |
1021 | .. clicmd:: show ip ospf database (opaque-link|opaque-area|opaque-external) LINK-STATE-ID | |
42fc5d26 | 1022 | |
c1a54c05 QY |
1023 | .. index:: show ip ospf database (opaque-link|opaque-area|opaque-external) LINK-STATE-ID adv-router ADV-ROUTER |
1024 | .. clicmd:: show ip ospf database (opaque-link|opaque-area|opaque-external) LINK-STATE-ID adv-router ADV-ROUTER | |
42fc5d26 | 1025 | |
c1a54c05 QY |
1026 | .. index:: show ip ospf database (opaque-link|opaque-area|opaque-external) adv-router ADV-ROUTER |
1027 | .. clicmd:: show ip ospf database (opaque-link|opaque-area|opaque-external) adv-router ADV-ROUTER | |
42fc5d26 | 1028 | |
c1a54c05 QY |
1029 | .. index:: show ip ospf database (opaque-link|opaque-area|opaque-external) LINK-STATE-ID self-originate |
1030 | .. clicmd:: show ip ospf database (opaque-link|opaque-area|opaque-external) LINK-STATE-ID self-originate | |
42fc5d26 | 1031 | |
c1a54c05 QY |
1032 | .. index:: show ip ospf database (opaque-link|opaque-area|opaque-external) self-originate |
1033 | .. clicmd:: show ip ospf database (opaque-link|opaque-area|opaque-external) self-originate | |
42fc5d26 | 1034 | |
c1a54c05 | 1035 | Show Opaque LSA from the database. |
42fc5d26 | 1036 | |
c1a54c05 | 1037 | .. _ospf-traffic-engineering: |
42fc5d26 QY |
1038 | |
1039 | Traffic Engineering | |
1040 | =================== | |
1041 | ||
85400b29 MS |
1042 | .. note:: |
1043 | ||
1044 | At this time, FRR offers partial support for some of the routing | |
1045 | protocol extensions that can be used with MPLS-TE. FRR does not | |
1046 | support a complete RSVP-TE solution currently. | |
1047 | ||
c1a54c05 QY |
1048 | .. index:: mpls-te on |
1049 | .. clicmd:: mpls-te on | |
42fc5d26 | 1050 | |
3d13052d | 1051 | .. index:: mpls-te |
c1a54c05 | 1052 | .. clicmd:: no mpls-te |
42fc5d26 | 1053 | |
c1a54c05 | 1054 | Enable Traffic Engineering LSA flooding. |
42fc5d26 | 1055 | |
c1a54c05 QY |
1056 | .. index:: mpls-te router-address <A.B.C.D> |
1057 | .. clicmd:: mpls-te router-address <A.B.C.D> | |
42fc5d26 | 1058 | |
c1a54c05 QY |
1059 | Configure stable IP address for MPLS-TE. This IP address is then advertise |
1060 | in Opaque LSA Type-10 TLV=1 (TE) option 1 (Router-Address). | |
42fc5d26 | 1061 | |
c1a54c05 QY |
1062 | .. index:: mpls-te inter-as area <area-id>|as |
1063 | .. clicmd:: mpls-te inter-as area <area-id>|as | |
42fc5d26 | 1064 | |
3d13052d | 1065 | .. index:: mpls-te inter-as |
c1a54c05 | 1066 | .. clicmd:: no mpls-te inter-as |
42fc5d26 | 1067 | |
c1a54c05 QY |
1068 | Enable :rfc:`5392` support - Inter-AS TE v2 - to flood Traffic Engineering |
1069 | parameters of Inter-AS link. 2 modes are supported: AREA and AS; LSA are | |
1070 | flood in AREA <area-id> with Opaque Type-10, respectively in AS with Opaque | |
1071 | Type-11. In all case, Opaque-LSA TLV=6. | |
42fc5d26 | 1072 | |
c1a54c05 QY |
1073 | .. index:: show ip ospf mpls-te interface |
1074 | .. clicmd:: show ip ospf mpls-te interface | |
42fc5d26 | 1075 | |
c1a54c05 QY |
1076 | .. index:: show ip ospf mpls-te interface INTERFACE |
1077 | .. clicmd:: show ip ospf mpls-te interface INTERFACE | |
42fc5d26 | 1078 | |
c1a54c05 | 1079 | Show MPLS Traffic Engineering parameters for all or specified interface. |
42fc5d26 | 1080 | |
c1a54c05 QY |
1081 | .. index:: show ip ospf mpls-te router |
1082 | .. clicmd:: show ip ospf mpls-te router | |
42fc5d26 | 1083 | |
c1a54c05 | 1084 | Show Traffic Engineering router parameters. |
42fc5d26 | 1085 | |
0efdf0fe | 1086 | .. _router-information: |
42fc5d26 QY |
1087 | |
1088 | Router Information | |
1089 | ================== | |
1090 | ||
ddd73a96 OD |
1091 | .. index:: router-info [as | area] |
1092 | .. clicmd:: router-info [as | area] | |
42fc5d26 | 1093 | |
3d13052d | 1094 | .. index:: router-info |
c1a54c05 | 1095 | .. clicmd:: no router-info |
42fc5d26 | 1096 | |
c1a54c05 | 1097 | Enable Router Information (:rfc:`4970`) LSA advertisement with AS scope |
ddd73a96 OD |
1098 | (default) or Area scope flooding when area is specified. Old syntax |
1099 | `router-info area <A.B.C.D>` is always supported but mark as deprecated | |
1100 | as the area ID is no more necessary. Indeed, router information support | |
1101 | multi-area and detect automatically the areas. | |
42fc5d26 | 1102 | |
c1a54c05 QY |
1103 | .. index:: pce address <A.B.C.D> |
1104 | .. clicmd:: pce address <A.B.C.D> | |
42fc5d26 | 1105 | |
3d13052d | 1106 | .. index:: pce address |
c1a54c05 | 1107 | .. clicmd:: no pce address |
42fc5d26 | 1108 | |
c1a54c05 QY |
1109 | .. index:: pce domain as (0-65535) |
1110 | .. clicmd:: pce domain as (0-65535) | |
42fc5d26 | 1111 | |
3d13052d | 1112 | .. index:: pce domain as (0-65535) |
c1a54c05 | 1113 | .. clicmd:: no pce domain as (0-65535) |
42fc5d26 | 1114 | |
c1a54c05 QY |
1115 | .. index:: pce neighbor as (0-65535) |
1116 | .. clicmd:: pce neighbor as (0-65535) | |
42fc5d26 | 1117 | |
3d13052d | 1118 | .. index:: pce neighbor as (0-65535) |
c1a54c05 | 1119 | .. clicmd:: no pce neighbor as (0-65535) |
42fc5d26 | 1120 | |
c1a54c05 QY |
1121 | .. index:: pce flag BITPATTERN |
1122 | .. clicmd:: pce flag BITPATTERN | |
42fc5d26 | 1123 | |
3d13052d | 1124 | .. index:: pce flag |
c1a54c05 | 1125 | .. clicmd:: no pce flag |
42fc5d26 | 1126 | |
c1a54c05 QY |
1127 | .. index:: pce scope BITPATTERN |
1128 | .. clicmd:: pce scope BITPATTERN | |
42fc5d26 | 1129 | |
3d13052d | 1130 | .. index:: pce scope |
c1a54c05 | 1131 | .. clicmd:: no pce scope |
42fc5d26 | 1132 | |
9eb95b3b | 1133 | The commands are conform to :rfc:`5088` and allow OSPF router announce Path |
d1e7591e QY |
1134 | Computation Element (PCE) capabilities through the Router Information (RI) |
1135 | LSA. Router Information must be enable prior to this. The command set/unset | |
1136 | respectively the PCE IP address, Autonomous System (AS) numbers of | |
9eb95b3b QY |
1137 | controlled domains, neighbor ASs, flag and scope. For flag and scope, please |
1138 | refer to :rfc`5088` for the BITPATTERN recognition. Multiple 'pce neighbor' | |
1139 | command could be specified in order to specify all PCE neighbours. | |
42fc5d26 | 1140 | |
c1a54c05 QY |
1141 | .. index:: show ip ospf router-info |
1142 | .. clicmd:: show ip ospf router-info | |
42fc5d26 | 1143 | |
c1a54c05 | 1144 | Show Router Capabilities flag. |
9eb95b3b | 1145 | |
c1a54c05 QY |
1146 | .. index:: show ip ospf router-info pce |
1147 | .. clicmd:: show ip ospf router-info pce | |
42fc5d26 | 1148 | |
c1a54c05 | 1149 | Show Router Capabilities PCE parameters. |
42fc5d26 | 1150 | |
0efdf0fe | 1151 | .. _debugging-ospf: |
42fc5d26 | 1152 | |
50cc7127 QY |
1153 | Segment Routing |
1154 | =============== | |
1155 | ||
6f751f14 OD |
1156 | This is an EXPERIMENTAL support of Segment Routing as per `RFC 8665` for MPLS |
1157 | dataplane. | |
50cc7127 | 1158 | |
3d13052d | 1159 | .. index:: segment-routing on |
50cc7127 QY |
1160 | .. clicmd:: [no] segment-routing on |
1161 | ||
1162 | Enable Segment Routing. Even if this also activate routing information | |
1163 | support, it is preferable to also activate routing information, and set | |
1164 | accordingly the Area or AS flooding. | |
1165 | ||
3d13052d | 1166 | .. index:: segment-routing global-block (0-1048575) (0-1048575) |
50cc7127 QY |
1167 | .. clicmd:: [no] segment-routing global-block (0-1048575) (0-1048575) |
1168 | ||
1169 | Fix the Segment Routing Global Block i.e. the label range used by MPLS to | |
6f751f14 OD |
1170 | store label in the MPLS FIB for Prefix SID. |
1171 | ||
3d13052d | 1172 | .. index:: segment-routing local-block (0-1048575) (0-1048575) |
6f751f14 OD |
1173 | .. clicmd:: [no] segment-routing local-block (0-1048575) (0-1048575) |
1174 | ||
1175 | Fix the Segment Routing Local Block i.e. the label range used by MPLS to | |
1176 | store label in the MPLS FIB for Adjacency SID. | |
50cc7127 | 1177 | |
3d13052d | 1178 | .. index:: segment-routing node-msd (1-16) |
50cc7127 QY |
1179 | .. clicmd:: [no] segment-routing node-msd (1-16) |
1180 | ||
1181 | Fix the Maximum Stack Depth supported by the router. The value depend of the | |
1182 | MPLS dataplane. E.g. for Linux kernel, since version 4.13 it is 32. | |
1183 | ||
3d13052d | 1184 | .. index:: segment-routing prefix A.B.C.D/M index (0-65535) [no-php-flag|explicit-null] |
f786c4d7 | 1185 | .. clicmd:: [no] segment-routing prefix A.B.C.D/M [index (0-65535)|no-php-flag|explicit-null] |
50cc7127 | 1186 | |
d1e7591e | 1187 | Set the Segment Routing index for the specified prefix. Note that, only |
9eb95b3b QY |
1188 | prefix with /32 corresponding to a loopback interface are currently |
1189 | supported. The 'no-php-flag' means NO Penultimate Hop Popping that allows SR | |
f786c4d7 OD |
1190 | node to request to its neighbor to not pop the label. The 'explicit-null' means that |
1191 | neighbor nodes must swap the incoming label by the MPLS Explicit Null label | |
1192 | before delivering the packet. | |
50cc7127 | 1193 | |
e3e3afff QY |
1194 | .. index:: show ip ospf database segment-routing <adv-router ADVROUTER|self-originate> [json] |
1195 | .. clicmd:: show ip ospf database segment-routing <adv-router ADVROUTER|self-originate> [json] | |
50cc7127 | 1196 | |
d1e7591e | 1197 | Show Segment Routing Data Base, all SR nodes, specific advertised router or |
e3e3afff QY |
1198 | self router. Optional JSON output can be obtained by appending 'json' to the |
1199 | end of the command. | |
50cc7127 | 1200 | |
077abf3b | 1201 | External Route Summarisation |
1202 | ============================ | |
1203 | This feature summarises originated external LSAs(Type-5 and Type-7). | |
1204 | Summary Route will be originated on-behalf of all matched external LSAs. | |
1205 | ||
3d13052d | 1206 | .. index:: summary-address A.B.C.D/M [tag (1-4294967295)] |
077abf3b | 1207 | .. clicmd:: [no] summary-address A.B.C.D/M [tag (1-4294967295)] |
1208 | ||
1209 | This command enable/disables summarisation for the configured address | |
1210 | range. Tag is the optional parameter. If tag configured Summary route | |
1211 | will be originated with the configured tag. | |
1212 | ||
3d13052d | 1213 | .. index:: summary-address A.B.C.D/M no-advertise |
077abf3b | 1214 | .. clicmd:: [no] summary-address A.B.C.D/M no-advertise |
1215 | ||
1216 | This command to ensure not advertise the summary lsa for the matched | |
1217 | external LSAs. | |
1218 | ||
1219 | .. index:: aggregation timer (5-1800) | |
1220 | .. clicmd:: aggregation timer (5-1800) | |
1221 | ||
1222 | Configure aggregation delay timer interval. Summarisation starts only after | |
1223 | this delay timer expiry. By default, delay interval is 5 secs. | |
1224 | ||
3d13052d | 1225 | .. index:: aggregation timer |
077abf3b | 1226 | .. clicmd:: no aggregation timer |
1227 | ||
1228 | Resetting the aggregation delay interval to default value. | |
1229 | ||
1230 | .. index:: show ip ospf [vrf <NAME|all>] summary-address [detail] [json] | |
1231 | .. clicmd:: show ip ospf [vrf <NAME|all>] summary-address [detail] [json] | |
1232 | ||
1233 | Show configuration for display all configured summary routes with | |
1234 | matching external LSA information. | |
1235 | ||
7fd0729f G |
1236 | TI-LFA |
1237 | ====== | |
1238 | ||
1239 | Experimental support for Topology Independent LFA (Loop-Free Alternate), see | |
1240 | for example 'draft-bashandy-rtgwg-segment-routing-ti-lfa-05'. Note that | |
1241 | TI-LFA requires a proper Segment Routing configuration. | |
1242 | ||
385a1e07 G |
1243 | .. index:: fast-reroute ti-lfa [node-protection] |
1244 | .. clicmd:: fast-reroute ti-lfa [node-protection] | |
7fd0729f G |
1245 | |
1246 | Configured on the router level. Activates TI-LFA for all interfaces. | |
7fd0729f | 1247 | |
42fc5d26 QY |
1248 | Debugging OSPF |
1249 | ============== | |
1250 | ||
c1a54c05 QY |
1251 | .. index:: debug ospf packet (hello|dd|ls-request|ls-update|ls-ack|all) (send|recv) [detail] |
1252 | .. clicmd:: debug ospf packet (hello|dd|ls-request|ls-update|ls-ack|all) (send|recv) [detail] | |
42fc5d26 | 1253 | |
3d13052d | 1254 | .. index:: debug ospf packet (hello|dd|ls-request|ls-update|ls-ack|all) (send|recv) [detail] |
c1a54c05 | 1255 | .. clicmd:: no debug ospf packet (hello|dd|ls-request|ls-update|ls-ack|all) (send|recv) [detail] |
42fc5d26 | 1256 | |
c1a54c05 | 1257 | Dump Packet for debugging |
42fc5d26 | 1258 | |
c1a54c05 QY |
1259 | .. index:: debug ospf ism |
1260 | .. clicmd:: debug ospf ism | |
42fc5d26 | 1261 | |
c1a54c05 QY |
1262 | .. index:: debug ospf ism (status|events|timers) |
1263 | .. clicmd:: debug ospf ism (status|events|timers) | |
42fc5d26 | 1264 | |
3d13052d | 1265 | .. index:: debug ospf ism |
c1a54c05 | 1266 | .. clicmd:: no debug ospf ism |
42fc5d26 | 1267 | |
3d13052d | 1268 | .. index:: debug ospf ism (status|events|timers) |
c1a54c05 | 1269 | .. clicmd:: no debug ospf ism (status|events|timers) |
42fc5d26 | 1270 | |
c1a54c05 | 1271 | Show debug information of Interface State Machine |
42fc5d26 | 1272 | |
c1a54c05 QY |
1273 | .. index:: debug ospf nsm |
1274 | .. clicmd:: debug ospf nsm | |
42fc5d26 | 1275 | |
c1a54c05 QY |
1276 | .. index:: debug ospf nsm (status|events|timers) |
1277 | .. clicmd:: debug ospf nsm (status|events|timers) | |
42fc5d26 | 1278 | |
3d13052d | 1279 | .. index:: debug ospf nsm |
c1a54c05 | 1280 | .. clicmd:: no debug ospf nsm |
42fc5d26 | 1281 | |
3d13052d | 1282 | .. index:: debug ospf nsm (status|events|timers) |
c1a54c05 | 1283 | .. clicmd:: no debug ospf nsm (status|events|timers) |
42fc5d26 | 1284 | |
c1a54c05 | 1285 | Show debug information of Network State Machine |
42fc5d26 | 1286 | |
c1a54c05 QY |
1287 | .. index:: debug ospf event |
1288 | .. clicmd:: debug ospf event | |
42fc5d26 | 1289 | |
3d13052d | 1290 | .. index:: debug ospf event |
c1a54c05 | 1291 | .. clicmd:: no debug ospf event |
42fc5d26 | 1292 | |
c1a54c05 | 1293 | Show debug information of OSPF event |
42fc5d26 | 1294 | |
c1a54c05 QY |
1295 | .. index:: debug ospf nssa |
1296 | .. clicmd:: debug ospf nssa | |
42fc5d26 | 1297 | |
3d13052d | 1298 | .. index:: debug ospf nssa |
c1a54c05 | 1299 | .. clicmd:: no debug ospf nssa |
42fc5d26 | 1300 | |
c1a54c05 | 1301 | Show debug information about Not So Stub Area |
42fc5d26 | 1302 | |
c1a54c05 QY |
1303 | .. index:: debug ospf lsa |
1304 | .. clicmd:: debug ospf lsa | |
42fc5d26 | 1305 | |
c1a54c05 QY |
1306 | .. index:: debug ospf lsa (generate|flooding|refresh) |
1307 | .. clicmd:: debug ospf lsa (generate|flooding|refresh) | |
42fc5d26 | 1308 | |
3d13052d | 1309 | .. index:: debug ospf lsa |
c1a54c05 | 1310 | .. clicmd:: no debug ospf lsa |
42fc5d26 | 1311 | |
3d13052d | 1312 | .. index:: debug ospf lsa (generate|flooding|refresh) |
c1a54c05 | 1313 | .. clicmd:: no debug ospf lsa (generate|flooding|refresh) |
42fc5d26 | 1314 | |
c1a54c05 | 1315 | Show debug detail of Link State messages |
42fc5d26 | 1316 | |
c1a54c05 QY |
1317 | .. index:: debug ospf te |
1318 | .. clicmd:: debug ospf te | |
42fc5d26 | 1319 | |
3d13052d | 1320 | .. index:: debug ospf te |
c1a54c05 | 1321 | .. clicmd:: no debug ospf te |
42fc5d26 | 1322 | |
c1a54c05 | 1323 | Show debug information about Traffic Engineering LSA |
42fc5d26 | 1324 | |
c1a54c05 QY |
1325 | .. index:: debug ospf zebra |
1326 | .. clicmd:: debug ospf zebra | |
42fc5d26 | 1327 | |
c1a54c05 QY |
1328 | .. index:: debug ospf zebra (interface|redistribute) |
1329 | .. clicmd:: debug ospf zebra (interface|redistribute) | |
42fc5d26 | 1330 | |
3d13052d | 1331 | .. index:: debug ospf zebra |
c1a54c05 | 1332 | .. clicmd:: no debug ospf zebra |
42fc5d26 | 1333 | |
3d13052d | 1334 | .. index:: debug ospf zebra (interface|redistribute) |
c1a54c05 | 1335 | .. clicmd:: no debug ospf zebra (interface|redistribute) |
42fc5d26 | 1336 | |
c1a54c05 | 1337 | Show debug information of ZEBRA API |
42fc5d26 | 1338 | |
cc1a92d8 | 1339 | .. index:: debug ospf graceful-restart helper |
1340 | .. clicmd:: debug ospf graceful-restart helper | |
1341 | ||
3d13052d | 1342 | .. index:: debug ospf graceful-restart helper |
cc1a92d8 | 1343 | .. clicmd:: no debug ospf graceful-restart helper |
1344 | ||
1345 | Enable/disable debug information for OSPF Graceful Restart Helper | |
1346 | ||
c1a54c05 QY |
1347 | .. index:: show debugging ospf |
1348 | .. clicmd:: show debugging ospf | |
42fc5d26 | 1349 | |
3d13052d | 1350 | .. index:: debug ospf lsa aggregate |
077abf3b | 1351 | .. clicmd:: [no] debug ospf lsa aggregate |
1352 | ||
1353 | Debug commnd to enable/disable external route summarisation specific debugs. | |
1354 | ||
42fc5d26 QY |
1355 | OSPF Configuration Examples |
1356 | =========================== | |
1357 | ||
1358 | A simple example, with MD5 authentication enabled: | |
1359 | ||
9eb95b3b | 1360 | .. code-block:: frr |
42fc5d26 | 1361 | |
c1a54c05 QY |
1362 | ! |
1363 | interface bge0 | |
1364 | ip ospf authentication message-digest | |
1365 | ip ospf message-digest-key 1 md5 ABCDEFGHIJK | |
1366 | ! | |
1367 | router ospf | |
1368 | network 192.168.0.0/16 area 0.0.0.1 | |
1369 | area 0.0.0.1 authentication message-digest | |
a8c90e15 | 1370 | |
42fc5d26 | 1371 | |
d50b2aa0 | 1372 | An :abbr:`ABR` router, with MD5 authentication and performing summarisation |
42fc5d26 QY |
1373 | of networks between the areas: |
1374 | ||
9eb95b3b | 1375 | .. code-block:: frr |
42fc5d26 | 1376 | |
c1a54c05 QY |
1377 | ! |
1378 | password ABCDEF | |
1379 | log file /var/log/frr/ospfd.log | |
1380 | service advanced-vty | |
1381 | ! | |
1382 | interface eth0 | |
1383 | ip ospf authentication message-digest | |
1384 | ip ospf message-digest-key 1 md5 ABCDEFGHIJK | |
1385 | ! | |
1386 | interface ppp0 | |
1387 | ! | |
1388 | interface br0 | |
1389 | ip ospf authentication message-digest | |
1390 | ip ospf message-digest-key 2 md5 XYZ12345 | |
1391 | ! | |
1392 | router ospf | |
1393 | ospf router-id 192.168.0.1 | |
1394 | redistribute connected | |
1395 | passive interface ppp0 | |
1396 | network 192.168.0.0/24 area 0.0.0.0 | |
1397 | network 10.0.0.0/16 area 0.0.0.0 | |
1398 | network 192.168.1.0/24 area 0.0.0.1 | |
1399 | area 0.0.0.0 authentication message-digest | |
1400 | area 0.0.0.0 range 10.0.0.0/16 | |
1401 | area 0.0.0.0 range 192.168.0.0/24 | |
1402 | area 0.0.0.1 authentication message-digest | |
1403 | area 0.0.0.1 range 10.2.0.0/16 | |
1404 | ! | |
a8c90e15 | 1405 | |
42fc5d26 QY |
1406 | |
1407 | A Traffic Engineering configuration, with Inter-ASv2 support. | |
1408 | ||
9eb95b3b QY |
1409 | First, the :file:`zebra.conf` part: |
1410 | ||
1411 | .. code-block:: frr | |
c1a54c05 | 1412 | |
c1a54c05 QY |
1413 | interface eth0 |
1414 | ip address 198.168.1.1/24 | |
612b3314 QY |
1415 | link-params |
1416 | enable | |
1417 | admin-grp 0xa1 | |
1418 | metric 100 | |
1419 | max-bw 1.25e+07 | |
1420 | max-rsv-bw 1.25e+06 | |
1421 | unrsv-bw 0 1.25e+06 | |
1422 | unrsv-bw 1 1.25e+06 | |
1423 | unrsv-bw 2 1.25e+06 | |
1424 | unrsv-bw 3 1.25e+06 | |
1425 | unrsv-bw 4 1.25e+06 | |
1426 | unrsv-bw 5 1.25e+06 | |
1427 | unrsv-bw 6 1.25e+06 | |
1428 | unrsv-bw 7 1.25e+06 | |
c1a54c05 QY |
1429 | ! |
1430 | interface eth1 | |
1431 | ip address 192.168.2.1/24 | |
612b3314 QY |
1432 | link-params |
1433 | enable | |
1434 | metric 10 | |
1435 | max-bw 1.25e+07 | |
1436 | max-rsv-bw 1.25e+06 | |
1437 | unrsv-bw 0 1.25e+06 | |
1438 | unrsv-bw 1 1.25e+06 | |
1439 | unrsv-bw 2 1.25e+06 | |
1440 | unrsv-bw 3 1.25e+06 | |
1441 | unrsv-bw 4 1.25e+06 | |
1442 | unrsv-bw 5 1.25e+06 | |
1443 | unrsv-bw 6 1.25e+06 | |
1444 | unrsv-bw 7 1.25e+06 | |
1445 | neighbor 192.168.2.2 as 65000 | |
1446 | hostname HOSTNAME | |
1447 | password PASSWORD | |
1448 | log file /var/log/zebra.log | |
1449 | ! | |
1450 | interface eth0 | |
1451 | ip address 198.168.1.1/24 | |
50cc7127 QY |
1452 | link-params |
1453 | enable | |
1454 | admin-grp 0xa1 | |
1455 | metric 100 | |
1456 | max-bw 1.25e+07 | |
1457 | max-rsv-bw 1.25e+06 | |
1458 | unrsv-bw 0 1.25e+06 | |
1459 | unrsv-bw 1 1.25e+06 | |
1460 | unrsv-bw 2 1.25e+06 | |
1461 | unrsv-bw 3 1.25e+06 | |
1462 | unrsv-bw 4 1.25e+06 | |
1463 | unrsv-bw 5 1.25e+06 | |
1464 | unrsv-bw 6 1.25e+06 | |
1465 | unrsv-bw 7 1.25e+06 | |
612b3314 QY |
1466 | ! |
1467 | interface eth1 | |
1468 | ip address 192.168.2.1/24 | |
50cc7127 QY |
1469 | link-params |
1470 | enable | |
1471 | metric 10 | |
1472 | max-bw 1.25e+07 | |
1473 | max-rsv-bw 1.25e+06 | |
1474 | unrsv-bw 0 1.25e+06 | |
1475 | unrsv-bw 1 1.25e+06 | |
1476 | unrsv-bw 2 1.25e+06 | |
1477 | unrsv-bw 3 1.25e+06 | |
1478 | unrsv-bw 4 1.25e+06 | |
1479 | unrsv-bw 5 1.25e+06 | |
1480 | unrsv-bw 6 1.25e+06 | |
1481 | unrsv-bw 7 1.25e+06 | |
1482 | neighbor 192.168.2.2 as 65000 | |
c1a54c05 | 1483 | |
9eb95b3b QY |
1484 | Then the :file:`ospfd.conf` itself: |
1485 | ||
1486 | .. code-block:: frr | |
c1a54c05 QY |
1487 | |
1488 | hostname HOSTNAME | |
1489 | password PASSWORD | |
1490 | log file /var/log/ospfd.log | |
1491 | ! | |
1492 | ! | |
1493 | interface eth0 | |
1494 | ip ospf hello-interval 60 | |
1495 | ip ospf dead-interval 240 | |
1496 | ! | |
1497 | interface eth1 | |
1498 | ip ospf hello-interval 60 | |
1499 | ip ospf dead-interval 240 | |
1500 | ! | |
1501 | ! | |
1502 | router ospf | |
1503 | ospf router-id 192.168.1.1 | |
1504 | network 192.168.0.0/16 area 1 | |
1505 | ospf opaque-lsa | |
42fc5d26 QY |
1506 | mpls-te |
1507 | mpls-te router-address 192.168.1.1 | |
1508 | mpls-te inter-as area 1 | |
c1a54c05 QY |
1509 | ! |
1510 | line vty | |
a8c90e15 | 1511 | |
d1e7591e | 1512 | A router information example with PCE advertisement: |
42fc5d26 | 1513 | |
9eb95b3b | 1514 | .. code-block:: frr |
42fc5d26 | 1515 | |
c1a54c05 QY |
1516 | ! |
1517 | router ospf | |
1518 | ospf router-id 192.168.1.1 | |
1519 | network 192.168.0.0/16 area 1 | |
1520 | capability opaque | |
42fc5d26 QY |
1521 | mpls-te |
1522 | mpls-te router-address 192.168.1.1 | |
c1a54c05 | 1523 | router-info area 0.0.0.1 |
42fc5d26 QY |
1524 | pce address 192.168.1.1 |
1525 | pce flag 0x80 | |
1526 | pce domain as 65400 | |
1527 | pce neighbor as 65500 | |
1528 | pce neighbor as 65200 | |
1529 | pce scope 0x80 | |
c1a54c05 | 1530 | ! |