diff options
Diffstat (limited to 'docs/configuration/protocols/ospf.rst')
| -rw-r--r-- | docs/configuration/protocols/ospf.rst | 204 |
1 files changed, 190 insertions, 14 deletions
diff --git a/docs/configuration/protocols/ospf.rst b/docs/configuration/protocols/ospf.rst index 60f9c149..9891c77d 100644 --- a/docs/configuration/protocols/ospf.rst +++ b/docs/configuration/protocols/ospf.rst @@ -38,12 +38,12 @@ starts when the first ospf enabled interface is configured. specified in decimal notation in the range from 0 to 4294967295. Or it can be specified in dotted decimal notation similar to ip address. - Prefix length in interface must be equal or bigger (i.e. smaller network) + Prefix length in interface must be equal or bigger (i.e. 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 + enable ospf on interface with address 192.168.1.1/23, but it does on interface with address 192.168.1.129/25. - In some cases it may be more convenient to enable OSPF on a per + In some cases it may be more convenient to enable OSPF on a per interface/subnet basis :cfgcmd:`set protocols ospf interface <interface> area <x.x.x.x | x>` @@ -190,6 +190,29 @@ Optional :cfgcmd:`max-holdtime` sets the maximum wait time between two consecutive SPF calculations. The default value is 10000 ms. +.. cfgcmd:: set protocols ospf ldp-sync + + This command will enable IGP-LDP synchronization globally for OSPF. This + requires for LDP to be functional. This is described in :rfc:`5443`. By + default all interfaces operational in OSPF are enabled for synchronization. + Loopbacks are exempt. + +.. cfgcmd:: set protocols ospf ldp-sync holddown <seconds> + + This command will change the hold down value globally for IGP-LDP + synchronization during convergence/interface flap events. + +.. cfgcmd:: set protocols ospf capability opaque + + ospfd supports Opaque LSA :rfc:`2370` as partial support for MPLS Traffic + Engineering LSAs. The opaque-lsa capability must be enabled in the + configuration. + + An alternate command could be "mpls-te on" (Traffic Engineering) + + .. note:: FRR offers only partial support for some of the routing + protocol extensions that are used with MPLS-TE; it does not + support a complete RSVP-TE solution. Area Configuration ------------------ @@ -278,15 +301,15 @@ Area Configuration intra area paths from this range are not advertised into other areas. This command makes sense in ABR only. -.. cfgcmd:: set protocols ospf area <number> export-list <acl_number> +.. cfgcmd:: set protocols ospf area <number> export-list <acl_number> - Filter Type-3 summary-LSAs announced to other areas originated from + Filter Type-3 summary-LSAs announced to other areas originated from intra- area paths from specified area. This command makes sense in ABR only. -.. cfgcmd:: set protocols ospf area <number> import-list <acl_number> +.. cfgcmd:: set protocols ospf area <number> import-list <acl_number> - Same as export-list, but it applies to paths announced into specified + Same as export-list, but it applies to paths announced into specified area as Type-3 summary-LSAs. This command makes sense in ABR only. @@ -437,6 +460,78 @@ Interface Configuration synchronizing process of the router's database with all neighbors. The default value is 1 seconds. The interval range is 3 to 65535. +.. cfgcmd:: set protocols ospf interface <interface> ldp-sync disable + + This command disables IGP-LDP sync for this specific interface. + +.. cfgcmd:: set protocols ospf interface <interface> ldp-sync holddown + <seconds> + + This command will change the hold down value for IGP-LDP synchronization + during convergence/interface flap events, but for this interface only. + +External Route Summarisation +---------------------------- + +This feature summarises originated external LSAs (Type-5 and Type-7). Summary +Route will be originated on-behalf of all matched external LSAs. + +.. cfgcmd:: set protocols ospf aggregation timer <seconds> + + Configure aggregation delay timer interval. + + Summarisation starts only after this delay timer expiry. + +.. cfgcmd:: set protocols ospf summary-address x.x.x.x/y [tag (1-4294967295)] + + This command enable/disables summarisation for the configured address range. + + Tag is the optional parameter. If tag configured Summary route will be + originated with the configured tag. + +.. cfgcmd:: set protocols ospf summary-address x.x.x.x/y no-advertise + + This command to ensure not advertise the summary lsa for the matched + external LSAs. + +Graceful Restart +---------------- + +.. cfgcmd:: set protocols ospf graceful-restart [grace-period (1-1800)] + + Configure Graceful Restart :rfc:`3623` restarting support. When enabled, + the default grace period is 120 seconds. + + To perform a graceful shutdown, the FRR ``graceful-restart prepare ip + ospf`` EXEC-level command needs to be issued before restarting the + ospfd daemon. + +.. cfgcmd:: set protocols ospf graceful-restart helper enable [router-id A.B.C.D] + + Configure Graceful Restart :rfc:`3623` helper support. By default, helper support + is disabled for all neighbours. This config enables/disables helper support + on this router for all neighbours. + + To enable/disable helper support for a specific neighbour, the router-id + (A.B.C.D) has to be specified. + +.. cfgcmd:: set protocols ospf graceful-restart helper no-strict-lsa-checking + + By default `strict-lsa-checking` is configured then the helper will abort + the Graceful Restart when a LSA change occurs which affects the restarting + router. + + This command disables it. + +.. cfgcmd:: set protocols ospf graceful-restart helper supported-grace-time + + Supports as HELPER for configured grace period. + +.. cfgcmd:: set protocols ospf graceful-restart helper planned-only + + It helps to support as HELPER only for planned restarts. + + By default, it supports both planned and unplanned outages. Manual Neighbor Configuration ----------------------------- @@ -603,10 +698,11 @@ Operational Mode Commands Hello due in 4.563s Neighbor Count is 1, Adjacent neighbor count is 1 -.. opcmd:: show ip ospf route +.. opcmd:: show ip ospf route [detail] This command displays the OSPF routing table, as determined by the most - recent SPF calculation. + recent SPF calculation. With the optional :cfgcmd:`detail` argument, + each route item's advertiser router and network attribute will be shown. .. code-block:: none @@ -846,6 +942,43 @@ Enable OSPF with route redistribution of the loopback and default originate: set policy route-map CONNECT rule 10 match interface lo +Enable OSPF and IGP-LDP synchronization: +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +**Node 1:** + +.. code-block:: none + + set interfaces loopback lo address 10.1.1.1/32 + set interfaces ethernet eth0 address 192.168.0.1/24 + + set protocols ospf area 0 network '192.168.0.0/24' + set protocols ospf area 0 network '10.1.1.1/32' + set protocols ospf parameters router-id '10.1.1.1' + set protocols ospf ldp-sync + + set protocols mpls interface eth0 + set protocols mpls ldp discovery transport-ipv4-address 10.1.1.1 + set protocols mpls ldp interface lo + set protocols mpls ldp interface eth0 + set protocols mpls ldp parameters transport-prefer-ipv4 + set protocols mpls ldp router-id 10.1.1.1 + + +This gives us IGP-LDP synchronization for all non-loopback interfaces with +a holddown timer of zero seconds: + + +.. code-block:: none + + Node-1@vyos:~$ show ip ospf mpls ldp-sync + eth0 + LDP-IGP Synchronization enabled: yes + Holddown timer in seconds: 0 + State: Sync achieved + + + Enable OSPF with Segment Routing (Experimental): ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -855,6 +988,7 @@ Enable OSPF with Segment Routing (Experimental): set interfaces loopback lo address 10.1.1.1/32 set interfaces ethernet eth0 address 192.168.0.1/24 + set protocols ospf area 0 network '192.168.0.0/24' set protocols ospf area 0 network '10.1.1.1/32' set protocols ospf parameters opaque-lsa @@ -870,6 +1004,7 @@ Enable OSPF with Segment Routing (Experimental): set interfaces loopback lo address 10.1.1.2/32 set interfaces ethernet eth0 address 192.168.0.2/24 + set protocols ospf area 0 network '192.168.0.0/24' set protocols ospf area 0 network '10.1.1.2/32' set protocols ospf parameters opaque-lsa @@ -948,7 +1083,7 @@ General VyOS does not have a special command to start the OSPFv3 process. The OSPFv3 process starts when the first ospf enabled interface is configured. -.. cfgcmd:: set protocols ospfv3 interface <interface> area <number> +.. cfgcmd:: set protocols ospfv3 interface <interface> area <number> This command specifies the OSPFv3 enabled interface. This command is also used to enable the OSPF process. The area number can be specified in @@ -1069,6 +1204,47 @@ Interface Configuration synchronizing process of the router's database with all neighbors. The default value is 1 seconds. The interval range is 3 to 65535. +.. _ospf:v3_graceful_restart: + +Graceful Restart +---------------- + +.. cfgcmd:: set protocols ospfv3 graceful-restart [grace-period (1-1800)] + + Configure Graceful Restart :rfc:`3623` restarting support. When enabled, + the default grace period is 120 seconds. + + To perform a graceful shutdown, the FRR ``graceful-restart prepare ip + ospf`` EXEC-level command needs to be issued before restarting the + ospfd daemon. + +.. cfgcmd:: set protocols ospfv3 graceful-restart helper enable [router-id A.B.C.D] + + Configure Graceful Restart :rfc:`3623` helper support. By default, helper support + is disabled for all neighbours. This config enables/disables helper support + on this router for all neighbours. + + To enable/disable helper support for a specific neighbour, the router-id + (A.B.C.D) has to be specified. + +.. cfgcmd:: set protocols ospfv3 graceful-restart helper lsa-check-disable + + By default `strict-lsa-checking` is configured then the helper will abort + the Graceful Restart when a LSA change occurs which affects the restarting + router. + + This command disables it. + +.. cfgcmd:: set protocols ospfv3 graceful-restart helper supported-grace-time + + Supports as HELPER for configured grace period. + +.. cfgcmd:: set protocols ospfv3 graceful-restart helper planned-only + + It helps to support as HELPER only for planned restarts. + + By default, it supports both planned and unplanned outages. + .. _ospf:v3_redistribution_config: Redistribution Configuration @@ -1145,7 +1321,7 @@ A typical configuration using 2 nodes. .. code-block:: none - set protocols ospfv3 interface eth1 area 0.0.0.0 + set protocols ospfv3 interface eth1 area 0.0.0.0 set protocols ospfv3 area 0.0.0.0 range 2001:db8:1::/64 set protocols ospfv3 parameters router-id 192.168.1.1 set protocols ospfv3 redistribute connected @@ -1154,7 +1330,7 @@ A typical configuration using 2 nodes. .. code-block:: none - set protocols ospfv3 interface eth1 area 0.0.0.0 + set protocols ospfv3 interface eth1 area 0.0.0.0 set protocols ospfv3 area 0.0.0.0 range 2001:db8:2::/64 set protocols ospfv3 parameters router-id 192.168.2.1 set protocols ospfv3 redistribute connected @@ -1183,7 +1359,7 @@ Example configuration for WireGuard interfaces: set interfaces wireguard wg01 peer ospf02 pubkey 'ie3...=' set interfaces wireguard wg01 port '12345' set protocols ospfv3 parameters router-id 192.168.1.1 - set protocols ospfv3 interface 'wg01' area 0.0.0.0 + set protocols ospfv3 interface 'wg01' area 0.0.0.0 set protocols ospfv3 interface 'lo' area 0.0.0.0 **Node 2** @@ -1198,7 +1374,7 @@ Example configuration for WireGuard interfaces: set interfaces wireguard wg01 peer ospf01 pubkey 'NHI...=' set interfaces wireguard wg01 port '12345' set protocols ospfv3 parameters router-id 192.168.1.2 - set protocols ospfv3 interface 'wg01' area 0.0.0.0 + set protocols ospfv3 interface 'wg01' area 0.0.0.0 set protocols ospfv3 interface 'lo' area 0.0.0.0 **Status** |