From 8943fc9f877cbee3301a8261ddd27b4b1f15f174 Mon Sep 17 00:00:00 2001 From: rebortg Date: Mon, 30 Nov 2020 20:53:36 +0100 Subject: arrange services and protocols --- docs/configuration/protocols/ospf.rst | 70 +++++++++++++++++++++++++++++++++++ 1 file changed, 70 insertions(+) create mode 100644 docs/configuration/protocols/ospf.rst (limited to 'docs/configuration/protocols/ospf.rst') diff --git a/docs/configuration/protocols/ospf.rst b/docs/configuration/protocols/ospf.rst new file mode 100644 index 00000000..ff7c5e64 --- /dev/null +++ b/docs/configuration/protocols/ospf.rst @@ -0,0 +1,70 @@ +.. include:: /_include/need_improvement.txt + +.. _routing-ospf: + +#### +OSPF +#### + +:abbr:`OSPF (Open Shortest Path First)` is a routing protocol for Internet +Protocol (IP) networks. It uses a link state routing (LSR) algorithm and falls +into the group of interior gateway protocols (IGPs), operating within a single +autonomous system (AS). It is defined as OSPF Version 2 in :rfc:`2328` (1998) +for IPv4. Updates for IPv6 are specified as OSPF Version 3 in :rfc:`5340` +(2008). OSPF supports the :abbr:`CIDR (Classless Inter-Domain Routing)` +addressing model. + +OSPF is a widely used IGP in large enterprise networks. + +OSPFv2 (IPv4) +############# + +In order to have a VyOS system exchanging routes with OSPF neighbors, you will +at least need to configure an OSPF area and some network. + +.. code-block:: none + + set protocols ospf area 0 network 192.168.0.0/24 + +That is the minimum configuration you will need. +It is a good practice to define the router ID too. + +.. code-block:: none + + set protocols ospf parameters router-id 10.1.1.1 + + +Below you can see a typical configuration using 2 nodes, redistribute loopback +address and the node 1 sending the default route: + +**Node 1** + +.. code-block:: none + + set interfaces loopback lo address 10.1.1.1/32 + set protocols ospf area 0 network 192.168.0.0/24 + set protocols ospf default-information originate always + set protocols ospf default-information originate metric 10 + set protocols ospf default-information originate metric-type 2 + set protocols ospf log-adjacency-changes + set protocols ospf parameters router-id 10.1.1.1 + set protocols ospf redistribute connected metric-type 2 + set protocols ospf redistribute connected route-map CONNECT + + set policy route-map CONNECT rule 10 action permit + set policy route-map CONNECT rule 10 match interface lo + +**Node 2** + +.. code-block:: none + + set interfaces loopback lo address 10.2.2.2/32 + set protocols ospf area 0 network 192.168.0.0/24 + set protocols ospf log-adjacency-changes + set protocols ospf parameters router-id 10.2.2.2 + set protocols ospf redistribute connected metric-type 2 + set protocols ospf redistribute connected route-map CONNECT + + set policy route-map CONNECT rule 10 action permit + set policy route-map CONNECT rule 10 match interface lo + -- cgit v1.2.3 From b599646995d2f805709e5eb975ef14eb4ce28a2e Mon Sep 17 00:00:00 2001 From: Christian Poessinger Date: Thu, 10 Dec 2020 18:23:01 +0100 Subject: ospf: combine v3/v3 in one chapter --- docs/configuration/protocols/ospf.rst | 72 +++++++++++++++++++++++++++++++++ docs/configuration/protocols/ospfv3.rst | 71 -------------------------------- 2 files changed, 72 insertions(+), 71 deletions(-) delete mode 100644 docs/configuration/protocols/ospfv3.rst (limited to 'docs/configuration/protocols/ospf.rst') diff --git a/docs/configuration/protocols/ospf.rst b/docs/configuration/protocols/ospf.rst index ff7c5e64..ee6753c5 100644 --- a/docs/configuration/protocols/ospf.rst +++ b/docs/configuration/protocols/ospf.rst @@ -68,3 +68,75 @@ address and the node 1 sending the default route: set policy route-map CONNECT rule 10 action permit set policy route-map CONNECT rule 10 match interface lo + +OSPFv3 (IPv6) +############# + +A typical configuration using 2 nodes. + +**Node 1:** + +.. code-block:: none + + set protocols ospfv3 area 0.0.0.0 interface eth1 + 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 + +**Node 2:** + +.. code-block:: none + + set protocols ospfv3 area 0.0.0.0 interface eth1 + 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 + +.. note:: You can not easily redistribute IPv6 routes via OSPFv3 on a WireGuard + interface link. This requires you to configure link-local addresses manually + on the WireGuard interfaces, see :vytask:`T1483`. + +Example configuration for WireGuard interfaces: + +**Node 1** + +.. code-block:: none + + set interfaces wireguard wg01 address 'fe80::216:3eff:fe51:fd8c/64' + set interfaces wireguard wg01 address '192.168.0.1/24' + set interfaces wireguard wg01 peer ospf02 allowed-ips '::/0' + set interfaces wireguard wg01 peer ospf02 allowed-ips '0.0.0.0/0' + set interfaces wireguard wg01 peer ospf02 endpoint '10.1.1.101:12345' + 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 area 0.0.0.0 interface 'wg01' + set protocols ospfv3 area 0.0.0.0 interface 'lo' + +**Node 2** + +.. code-block:: none + + set interfaces wireguard wg01 address 'fe80::216:3eff:fe0a:7ada/64' + set interfaces wireguard wg01 address '192.168.0.2/24' + set interfaces wireguard wg01 peer ospf01 allowed-ips '::/0' + set interfaces wireguard wg01 peer ospf01 allowed-ips '0.0.0.0/0' + set interfaces wireguard wg01 peer ospf01 endpoint '10.1.1.100:12345' + 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 area 0.0.0.0 interface 'wg01' + set protocols ospfv3 area 0.0.0.0 interface 'lo' + +**Status** + +.. code-block:: none + + vyos@ospf01:~$ sh ipv6 ospfv3 neighbor + Neighbor ID Pri DeadTime State/IfState Duration I/F[State] + 192.168.0.2 1 00:00:37 Full/PointToPoint 00:18:03 wg01[PointToPoint] + + vyos@ospf02# run sh ipv6 ospfv3 neighbor + Neighbor ID Pri DeadTime State/IfState Duration I/F[State] + 192.168.0.1 1 00:00:39 Full/PointToPoint 00:19:44 wg01[PointToPoint] + diff --git a/docs/configuration/protocols/ospfv3.rst b/docs/configuration/protocols/ospfv3.rst deleted file mode 100644 index f0e28983..00000000 --- a/docs/configuration/protocols/ospfv3.rst +++ /dev/null @@ -1,71 +0,0 @@ -OSPFv3 (IPv6) -############# - -A typical configuration using 2 nodes. - -**Node 1:** - -.. code-block:: none - - set protocols ospfv3 area 0.0.0.0 interface eth1 - 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 - -**Node 2:** - -.. code-block:: none - - set protocols ospfv3 area 0.0.0.0 interface eth1 - 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 - -.. note:: You can not easily redistribute IPv6 routes via OSPFv3 on a WireGuard - interface link. This requires you to configure link-local addresses manually - on the WireGuard interfaces, see :vytask:`T1483`. - -Example configuration for WireGuard interfaces: - -**Node 1** - -.. code-block:: none - - set interfaces wireguard wg01 address 'fe80::216:3eff:fe51:fd8c/64' - set interfaces wireguard wg01 address '192.168.0.1/24' - set interfaces wireguard wg01 peer ospf02 allowed-ips '::/0' - set interfaces wireguard wg01 peer ospf02 allowed-ips '0.0.0.0/0' - set interfaces wireguard wg01 peer ospf02 endpoint '10.1.1.101:12345' - 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 area 0.0.0.0 interface 'wg01' - set protocols ospfv3 area 0.0.0.0 interface 'lo' - -**Node 2** - -.. code-block:: none - - set interfaces wireguard wg01 address 'fe80::216:3eff:fe0a:7ada/64' - set interfaces wireguard wg01 address '192.168.0.2/24' - set interfaces wireguard wg01 peer ospf01 allowed-ips '::/0' - set interfaces wireguard wg01 peer ospf01 allowed-ips '0.0.0.0/0' - set interfaces wireguard wg01 peer ospf01 endpoint '10.1.1.100:12345' - 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 area 0.0.0.0 interface 'wg01' - set protocols ospfv3 area 0.0.0.0 interface 'lo' - -**Status** - -.. code-block:: none - - vyos@ospf01:~$ sh ipv6 ospfv3 neighbor - Neighbor ID Pri DeadTime State/IfState Duration I/F[State] - 192.168.0.2 1 00:00:37 Full/PointToPoint 00:18:03 wg01[PointToPoint] - - vyos@ospf02# run sh ipv6 ospfv3 neighbor - Neighbor ID Pri DeadTime State/IfState Duration I/F[State] - 192.168.0.1 1 00:00:39 Full/PointToPoint 00:19:44 wg01[PointToPoint] - -- cgit v1.2.3 From 037e05eaa54588fa58b2f5f81401bba6e28c8232 Mon Sep 17 00:00:00 2001 From: maehdros Date: Tue, 29 Dec 2020 15:19:45 +0100 Subject: Update ospf.rst Add a small command to see the OSPFv3 redistribute routes; I plan to write a bit more --- docs/configuration/protocols/ospf.rst | 6 ++++++ 1 file changed, 6 insertions(+) (limited to 'docs/configuration/protocols/ospf.rst') diff --git a/docs/configuration/protocols/ospf.rst b/docs/configuration/protocols/ospf.rst index ee6753c5..a8293f4d 100644 --- a/docs/configuration/protocols/ospf.rst +++ b/docs/configuration/protocols/ospf.rst @@ -92,6 +92,12 @@ A typical configuration using 2 nodes. set protocols ospfv3 parameters router-id 192.168.2.1 set protocols ospfv3 redistribute connected +**To see the redistributed routes:** + +.. code-block:: none + + show ipv6 ospfv3 redistribute + .. note:: You can not easily redistribute IPv6 routes via OSPFv3 on a WireGuard interface link. This requires you to configure link-local addresses manually on the WireGuard interfaces, see :vytask:`T1483`. -- cgit v1.2.3 From e9cc3b86b22e2ccb898608c6b5feb688492b06c0 Mon Sep 17 00:00:00 2001 From: maehdros Date: Tue, 29 Dec 2020 15:50:44 +0100 Subject: Update ospf.rst Update can not to cannot --- docs/configuration/protocols/ospf.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/configuration/protocols/ospf.rst') diff --git a/docs/configuration/protocols/ospf.rst b/docs/configuration/protocols/ospf.rst index a8293f4d..a4188c68 100644 --- a/docs/configuration/protocols/ospf.rst +++ b/docs/configuration/protocols/ospf.rst @@ -98,7 +98,7 @@ A typical configuration using 2 nodes. show ipv6 ospfv3 redistribute -.. note:: You can not easily redistribute IPv6 routes via OSPFv3 on a WireGuard +.. note:: You cannot easily redistribute IPv6 routes via OSPFv3 on a WireGuard interface link. This requires you to configure link-local addresses manually on the WireGuard interfaces, see :vytask:`T1483`. -- cgit v1.2.3 From 64781cbbfd6456a6b92abf6507aefb8d82e80d5f Mon Sep 17 00:00:00 2001 From: Leonid Voronkin Date: Wed, 6 Jan 2021 21:50:16 +0400 Subject: Update ospf.rst add command and their explanation --- docs/configuration/protocols/ospf.rst | 86 +++++++++++++++++++++++++++++++---- 1 file changed, 78 insertions(+), 8 deletions(-) (limited to 'docs/configuration/protocols/ospf.rst') diff --git a/docs/configuration/protocols/ospf.rst b/docs/configuration/protocols/ospf.rst index a4188c68..77bb34b0 100644 --- a/docs/configuration/protocols/ospf.rst +++ b/docs/configuration/protocols/ospf.rst @@ -19,20 +19,90 @@ OSPF is a widely used IGP in large enterprise networks. OSPFv2 (IPv4) ############# -In order to have a VyOS system exchanging routes with OSPF neighbors, you will -at least need to configure an OSPF area and some network. +.. cfgcmd:: set protocols ospf area -.. code-block:: none + This command is udes to enable the OSPF process. The area number can be + specified in decimal notation in the range from 0 to 4294967295. Or it + can be specified in dotted decimal notation similar to ip address. - set protocols ospf area 0 network 192.168.0.0/24 +.. cfgcmd:: set protocols ospf area network A.B.C.D/M -That is the minimum configuration you will need. -It is a good practice to define the router ID too. + This command specifies the OSPF enabled interface(s). If the interface has + an address from defined range then the command enables ospf on this + interface so router can provide network information to the other ospf + routers via this interface. -.. code-block:: none +.. cfgcmd:: set protocols ospf auto-cost reference-bandwidth - set protocols ospf parameters router-id 10.1.1.1 + This command sets the reference bandwidth for cost calculations, where + bandwidth can be in range from 1 to 4294967, 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). + +.. cfgcmd:: set protocols ospf default-information originate [always] [metric ] [metric-type <1|2>] [route-map ] + + 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 :cfgcmd:`always` keyword is given then the default is always advertised, + even when there is no default present in the routing table. The argument + :cfgcmd:`route-map` specifies to advertise the default route if the route map + is satisfied. + +.. cfgcmd:: set protocols ospf default-metric + + This command specifies the default metric value of redistributed routes. + The metric range is 0 to 16777214. + +.. cfgcmd:: set protocols ospf distance global + + This command change distance value of OSPF. The distance range is 1 to 255. + +.. cfgcmd:: set protocols ospf distance ospf + + This command change distance value of OSPF. The arguments are the distance + values for external routes, inter-area routes and intra-area routes + respectively. The distance range is 1 to 255. + + .. note:: Routes with a distance of 255 are effectively disabled and not + installed into the kernel. + +.. cfgcmd:: set protocols ospf parameters router-id + + This command 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! + +.. cfgcmd:: set protocols ospf parameters rfc1583-compatibility + + :rfc:`2328`, the successor to :rfc:`1583`, suggests according to section G.2 (changes) + in section 16.4.1 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. + +.. cfgcmd:: set protocols ospf passive-interface + + This command specifies interface as passive. Passive interface advertises its address, + but does not run the OSPF protocol (adjacencies are not formed and hello packets are + not generated). + +.. cfgcmd:: set protocols ospf passive-interface default + + This command specifies all interfaces as passive by default. Because this command changes + the configuration logic to a default passive; therefore, interfaces where router adjacencies + are expected need to be configured with the :cfgcmd:`passive-interface-exclude` command. + +.. cfgcmd:: set protocols ospf passive-interface-exclude + + This command allows exclude interface from passive state. This command is used if the + command :cfgcmd:`passive-interface default` was configured. +Configuration example +--------------------- Below you can see a typical configuration using 2 nodes, redistribute loopback address and the node 1 sending the default route: -- cgit v1.2.3 From bf5a8171be5d5a3985d7f7a134af7f086bc90b29 Mon Sep 17 00:00:00 2001 From: Leonid Voronkin Date: Thu, 7 Jan 2021 15:08:11 +0400 Subject: Update ospf.rst --- docs/configuration/protocols/ospf.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs/configuration/protocols/ospf.rst') diff --git a/docs/configuration/protocols/ospf.rst b/docs/configuration/protocols/ospf.rst index 77bb34b0..acb1bce8 100644 --- a/docs/configuration/protocols/ospf.rst +++ b/docs/configuration/protocols/ospf.rst @@ -25,10 +25,10 @@ OSPFv2 (IPv4) specified in decimal notation in the range from 0 to 4294967295. Or it can be specified in dotted decimal notation similar to ip address. -.. cfgcmd:: set protocols ospf area network A.B.C.D/M +.. cfgcmd:: set protocols ospf area network This command specifies the OSPF enabled interface(s). If the interface has - an address from defined range then the command enables ospf on this + an address from defined range then the command enables OSPF on this interface so router can provide network information to the other ospf routers via this interface. -- cgit v1.2.3 From 188cf6695622c5cd43d695a01c38327efedfd239 Mon Sep 17 00:00:00 2001 From: Leonid Voronkin Date: Fri, 8 Jan 2021 21:39:29 +0400 Subject: ospf: update routing protocol command definitions --- docs/configuration/protocols/ospf.rst | 259 +++++++++++++++++++++++++++++++++- 1 file changed, 253 insertions(+), 6 deletions(-) (limited to 'docs/configuration/protocols/ospf.rst') diff --git a/docs/configuration/protocols/ospf.rst b/docs/configuration/protocols/ospf.rst index acb1bce8..77ed4a37 100644 --- a/docs/configuration/protocols/ospf.rst +++ b/docs/configuration/protocols/ospf.rst @@ -19,6 +19,9 @@ OSPF is a widely used IGP in large enterprise networks. OSPFv2 (IPv4) ############# +General configuration +--------------------- + .. cfgcmd:: set protocols ospf area This command is udes to enable the OSPF process. The area number can be @@ -49,11 +52,6 @@ OSPFv2 (IPv4) :cfgcmd:`route-map` specifies to advertise the default route if the route map is satisfied. -.. cfgcmd:: set protocols ospf default-metric - - This command specifies the default metric value of redistributed routes. - The metric range is 0 to 16777214. - .. cfgcmd:: set protocols ospf distance global This command change distance value of OSPF. The distance range is 1 to 255. @@ -70,10 +68,27 @@ OSPFv2 (IPv4) .. cfgcmd:: set protocols ospf parameters router-id This command 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. + 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! +.. cfgcmd:: set protocols ospf parameters abr-type + + This command selects ABR model. OSPF router supports four ABR models: + + "cisco" – a router will be considered as ABR if it has several configured links to + the networks in different areas one of which is a backbone area. Moreover, the link + to the backbone area should be active (working). + "ibm" – identical to "cisco" model but in this case a backbone area link may not be active. + "standard" – router has several active links to different areas. + "shortcut" – identical to "standard" but in this model a router is allowed to use a + connected areas topology without involving a backbone area for inter-area connections. + + Detailed information about "cisco" and "ibm" models differences can be found in :rfc:`3509`. + A "shortcut" model allows ABR to create routes between areas based on the topology of the + areas connected to this router but not using a backbone area in case if non-backbone route + will be cheaper. For more information about "shortcut" model, see :t:`ospf-shortcut-abr-02.txt` + .. cfgcmd:: set protocols ospf parameters rfc1583-compatibility :rfc:`2328`, the successor to :rfc:`1583`, suggests according to section G.2 (changes) @@ -101,6 +116,238 @@ OSPFv2 (IPv4) This command allows exclude interface from passive state. This command is used if the command :cfgcmd:`passive-interface default` was configured. +.. cfgcmd:: set protocols ospf refresh timers + + The router automatically updates link-state information with its neighbors. Only an obsolete + information is updated which age has exceeded a specific threshold. This parameter changes + a threshold value, which by default is 1800 seconds (half an hour). The value is applied + to the whole OSPF router. The timer range is 10 to 1800. + + +Areas configuration +------------------- + +.. cfgcmd:: set protocols ospf area area-type stub + + This command specifies 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-5) 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. + +.. cfgcmd:: set protocols ospf area area-type stub no-summary + + This command specifies the area to be a Totally Stub Area. In addition to stub area + limitations this area type prevents an ABR from injecting Network-Summary (type-3) + LSAs into the specified stub area. Only default summary route is allowed. + +.. cfgcmd:: set protocols ospf area area-type stub default-cost + + This command sets the cost of default-summary LSAs announced to stubby areas. + The cost range is 0 to 16777215. + +.. cfgcmd:: set protocols ospf area area-type nssa + + This command specifies the area to be a Not So Stubby Area. External routing information + is imported into an NSSA in Type-7 LSAs. Type-7 LSAs are similar to Type-5 AS-external + LSAs, except that they can only be flooded into the NSSA. In order to further propagate + the NSSA external information, the Type-7 LSA must be translated to a Type-5 + AS-external-LSA by the NSSA ABR. + +.. cfgcmd:: set protocols ospf area area-type nssa no-summary + + This command specifies the area to be a NSSA Totally Stub Area. ABRs for such an area do + not need to pass Network-Summary (type-3) LSAs (except the default summary route), + ASBR-Summary LSAs (type-4) and AS-External LSAs (type-5) into the area. But Type-7 LSAs + that convert to Type-5 at the NSSA ABR are allowed. + +.. cfgcmd:: set protocols ospf area area-type nssa default-cost + + This command sets the default cost of LSAs announced to NSSA areas. + The cost range is 0 to 16777215. + +.. cfgcmd:: set protocols ospf area area-type nssa translate + + Specifies whether this NSSA border router will unconditionally translate Type-7 LSAs into + Type-5 LSAs. When role is Always, Type-7 LSAs are translated into Type-5 LSAs regardless + of the translator state of other NSSA border routers. When role is Candidate, this router + participates in the translator election to determine if it will perform the translations + duties. When role is Never, this router will never translate Type-7 LSAs into Type-5 LSAs. + +.. cfgcmd:: set protocols ospf area authentication plaintext-password + + This command specifies that simple password authentication should be used for the given + area. The password must also be configured on a per-interface basis. + +.. cfgcmd:: set protocols ospf area authentication md5 + + This command 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. + +.. cfgcmd:: set protocols ospf area shortcut + + This parameter allows to "shortcut" routes (non-backbone) for inter-area routes. There + are three modes available for routes shortcutting: + + "default" – this area will be used for shortcutting only if ABR does not have a link + to the backbone area or this link was lost. + "enable" – the area will be used for shortcutting every time the route that goes through + it is cheaper. + "disable" – this area is never used by ABR for routes shortcutting. + +.. cfgcmd:: set protocols ospf area virtual-link + + Provides a backbone area coherence by virtual link establishment. + + In general, OSPF protocol requires a backbone area (area 0) to be coherent and fully + connected. I.e. any backbone area router must have a route to any other backbone area + router. Moreover, every ABR must have a link to backbone area. However, it is not always + possible to have a physical link to a backbone area. In this case between two ABR (one + of them has a link to the backbone area) in the area (not stub area) a virtual link is organized. + + – area identifier through which a virtual link goes. + – ABR router-id with which a virtual link is established. Virtual link must be + configured on both routers. + + Formally, a virtual link looks like a point-to-point network connecting two ABR from one + area one of which physically connected to a backbone area. This pseudo-network is considered + to belong to a backbone area. + + +Interfaces configuration +------------------------ + +.. cfgcmd:: set interfaces ip ospf authentication plaintext-password + + This command sets OSPF authentication key to a simple password. After setting, all OSPF + packets are authenticated. Key has length up to 8 chars. + + Simple text password authentication is insecure and deprecated in favour of MD5 HMAC + authentication. + +.. cfgcmd:: set interfaces ip ospf authentication md5 key-id md5-key + + This command specifys that MD5 HMAC authentication must be used on this interface. It sets + OSPF authentication key to a cryptographic password. Key-id 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. The key can be long up to 16 chars (larger strings will be truncated), + and is associated with the given key-id. + +.. cfgcmd:: set interfaces ip ospf bandwidth + + This command sets the interface bandwidth for cost calculations, where + bandwidth can be in range from 1 to 100000, specified in Mbits/s. + +.. cfgcmd:: set interfaces ip ospf cost + + This command sets link cost for the specified interface. The cost value is set to + router-LSA’s metric field and used for SPF calculation. The cost range is 1 to 65535. + +.. cfgcmd:: set interfaces ip ospf dead-interval + + Set number of seconds for router Dead Interval 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. The interval range is 1 to 65535. + +.. cfgcmd:: set interfaces ip ospf hello-interval + + Set number of seconds for Hello Interval 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. The interval range is 1 to 65535. + +.. cfgcmd:: set interfaces ip ospf mtu-ignore + + This command disables check of the MTU value in the OSPF DBD packets. Thus, use + of this command allows the OSPF adjacency to reach the FULL state even though + there is an interface MTU mismatch between two OSPF routers. + +.. cfgcmd:: set interfaces ip ospf network + + This command allows to specify the distribution type for the network connected + to this interface: + + "broadcast" – broadcast IP addresses distribution. + "non-broadcast" – address distribution in NBMA networks topology. + "point-to-multipoint" – address distribution in point-to-multipoint networks. + "point-to-point" – address distribution in point-to-point networks. + +.. cfgcmd:: set interfaces ip ospf priority + + This command sets Router Priority 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. The interval range is 0 to 255. + +.. cfgcmd:: set interfaces ip ospf retransmit-interval + + This command sets number of seconds for RxmtInterval timer value. This value is used + when retransmitting Database Description and Link State Request packets if acknowledge + was not received. The default value is 5 seconds. The interval range is 3 to 65535. + +.. cfgcmd:: set interfaces ip ospf transmit-delay + + This command sets number of seconds for InfTransDelay value. It allows to set and adjust + for each interface the delay interval before starting the synchronizing process of the + router's database with all neighbors. The default value is 1 seconds. The interval range + is 3 to 65535. + + +Redistribution configuration +---------------------------- + +.. cfgcmd:: set protocols ospf redistribute bgp + + Redistribute BGP routes to OSPF process. + +.. cfgcmd:: set protocols ospf redistribute connected + + Redistribute connected routes to OSPF process. + +.. cfgcmd:: set protocols ospf redistribute kernel + + Redistribute kernel routes to OSPF process. + +.. cfgcmd:: set protocols ospf redistribute rip + + Redistribute RIP routes to OSPF process. + +.. cfgcmd:: set protocols ospf redistribute static + + Redistribute static routes to OSPF process. + +.. cfgcmd:: set protocols ospf default-metric + + This command specifies the default metric value of redistributed routes. + The metric range is 0 to 16777214. + +.. cfgcmd:: set protocols ospf redistribute metric + + This command specifies metric for redistributed routes from given route source. There + are five modes available for route source: bgp, connected, kernel, rip, static. The + metric range is 1 to 16. + +.. cfgcmd:: set protocols ospf redistribute metric-type <1|2> + + This command specifies metric type for redistributed routes. Difference between two metric + types that metric type 1 is a metric which is "commensurable" with inner OSPF links. When + calculating a metric to the external destination, the full path metric is calculated as a + metric sum path of a router which had advertised this link plus the link metric. Thus, a + route with the least summary metric will be selected. If external link is advertised with + metric type 2 the path is selected which lies through the router which advertised this link + with the least metric despite of the fact that internal path to this router is longer (with + more cost). However, if two routers advertised an external link and with metric type 2 the + preference is given to the path which lies through the router with a shorter internal path. + If two different routers advertised two links to the same external destimation but with + different metric type, metric type 1 is preferred. If type of a metric left undefined the + router will consider these external links to have a default metric type 2. + +.. cfgcmd:: set protocols ospf redistribute route-map + + This command allows to use route map to filter redistributed routes from given route source. + There are five modes available for route source: bgp, connected, kernel, rip, static. + + Configuration example --------------------- -- cgit v1.2.3 From e9a0b934175a89ce4998e2157e5ba98ffa016665 Mon Sep 17 00:00:00 2001 From: Leonid Voronkin Date: Sat, 9 Jan 2021 23:49:26 +0400 Subject: ospf: updates --- docs/configuration/protocols/ospf.rst | 323 +++++++++++++++++++++++++++++++--- 1 file changed, 300 insertions(+), 23 deletions(-) (limited to 'docs/configuration/protocols/ospf.rst') diff --git a/docs/configuration/protocols/ospf.rst b/docs/configuration/protocols/ospf.rst index 77ed4a37..7d9950e6 100644 --- a/docs/configuration/protocols/ospf.rst +++ b/docs/configuration/protocols/ospf.rst @@ -1,5 +1,3 @@ -.. include:: /_include/need_improvement.txt - .. _routing-ospf: #### @@ -19,7 +17,7 @@ OSPF is a widely used IGP in large enterprise networks. OSPFv2 (IPv4) ############# -General configuration +General Configuration --------------------- .. cfgcmd:: set protocols ospf area @@ -43,6 +41,17 @@ General configuration have a cost of 1. Cost of lower bandwidth links will be scaled with reference to this cost). +.. cfgcmd:: set protocols ospf parameters router-id + + This command 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! + + +Optional Configuration +---------------------- + .. cfgcmd:: set protocols ospf default-information originate [always] [metric ] [metric-type <1|2>] [route-map ] Originate an AS-External (type-5) LSA describing a default route into all @@ -65,23 +74,36 @@ General configuration .. note:: Routes with a distance of 255 are effectively disabled and not installed into the kernel. -.. cfgcmd:: set protocols ospf parameters router-id +.. cfgcmd:: set protocols ospf log-adjacency-changes [detail] + + This command allows to log changes in adjacency. With the optional + :cfgcmd:`detail` argument, all changes in adjacency status are shown. + Without :cfgcmd:`detail`, only changes to full or regressions are shown. + +.. cfgcmd:: set protocols ospf max-metric router-lsa |on-startup > + + This enables :rfc:`3137` support, where the OSPF process describes its + transit links in its router-LSA as having infinite distance so that other + routers will avoid calculating transit paths through the router while + still being able to reach networks through the router. - This command 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! + This support may be enabled administratively (and indefinitely) with the + :cfgcmd:`administrative` command. It may also be enabled conditionally. + Conditional enabling of max-metric router-lsas can be for a period of + seconds after startup with the :cfgcmd:`on-startup ` command + and/or for a period of seconds prior to shutdown with the + :cfgcmd:`on-shutdown ` command. The time range is 5 to 86400. .. cfgcmd:: set protocols ospf parameters abr-type This command selects ABR model. OSPF router supports four ABR models: - "cisco" – a router will be considered as ABR if it has several configured links to + **cisco** – a router will be considered as ABR if it has several configured links to the networks in different areas one of which is a backbone area. Moreover, the link to the backbone area should be active (working). - "ibm" – identical to "cisco" model but in this case a backbone area link may not be active. - "standard" – router has several active links to different areas. - "shortcut" – identical to "standard" but in this model a router is allowed to use a + **ibm** – identical to "cisco" model but in this case a backbone area link may not be active. + **standard** – router has several active links to different areas. + **shortcut** – identical to "standard" but in this model a router is allowed to use a connected areas topology without involving a backbone area for inter-area connections. Detailed information about "cisco" and "ibm" models differences can be found in :rfc:`3509`. @@ -123,8 +145,18 @@ General configuration a threshold value, which by default is 1800 seconds (half an hour). The value is applied to the whole OSPF router. The timer range is 10 to 1800. +.. cfgcmd:: set protocols ospf timers throttle spf + + This command sets the initial delay, the initial-holdtime and the maximum-holdtime between + when SPF is calculated and the event which triggered the calculation. The times are specified + in milliseconds and must be in the range of 0 to 600000 milliseconds. :cfgcmd:`delay` sets + the initial SPF schedule delay in milliseconds. The default value is 200 ms. + :cfgcmd:`initial-holdtime` sets the minimum hold time between two consecutive SPF calculations. + The default value is 1000 ms. :cfgcmd:`max-holdtime` sets the maximum wait time between two + consecutive SPF calculations. The default value is 10000 ms. + -Areas configuration +Areas Configuration ------------------- .. cfgcmd:: set protocols ospf area area-type stub @@ -189,11 +221,11 @@ Areas configuration This parameter allows to "shortcut" routes (non-backbone) for inter-area routes. There are three modes available for routes shortcutting: - "default" – this area will be used for shortcutting only if ABR does not have a link + **default** – this area will be used for shortcutting only if ABR does not have a link to the backbone area or this link was lost. - "enable" – the area will be used for shortcutting every time the route that goes through + **enable** – the area will be used for shortcutting every time the route that goes through it is cheaper. - "disable" – this area is never used by ABR for routes shortcutting. + **disable** – this area is never used by ABR for routes shortcutting. .. cfgcmd:: set protocols ospf area virtual-link @@ -214,7 +246,7 @@ Areas configuration to belong to a backbone area. -Interfaces configuration +Interfaces Configuration ------------------------ .. cfgcmd:: set interfaces ip ospf authentication plaintext-password @@ -267,10 +299,10 @@ Interfaces configuration This command allows to specify the distribution type for the network connected to this interface: - "broadcast" – broadcast IP addresses distribution. - "non-broadcast" – address distribution in NBMA networks topology. - "point-to-multipoint" – address distribution in point-to-multipoint networks. - "point-to-point" – address distribution in point-to-point networks. + **broadcast** – broadcast IP addresses distribution. + **non-broadcast** – address distribution in NBMA networks topology. + **point-to-multipoint** – address distribution in point-to-multipoint networks. + **point-to-point** – address distribution in point-to-point networks. .. cfgcmd:: set interfaces ip ospf priority @@ -293,7 +325,32 @@ Interfaces configuration is 3 to 65535. -Redistribution configuration +Manual Neighbor Configuration +----------------------------- + +OSPF routing devices normally discover their neighbors dynamically by listening to the broadcast +or multicast hello packets on the network. Because an NBMA network does not support broadcast (or +multicast), the device cannot discover its neighbors dynamically, so you must configure all the +neighbors statically. + +.. cfgcmd:: set protocols ospf neighbor + + This command specifies the IP address of the neighboring device. + +.. cfgcmd:: set protocols ospf neighbor poll-interval + + This command specifies the length of time, in seconds, before the routing device sends hello + packets out of the interface before it establishes adjacency with a neighbor. The range is 1 + to 65535 seconds. The default value is 60 seconds. + +.. cfgcmd:: set protocols ospf neighbor priority + + This command specifies the router priority value of the nonbroadcast neighbor associated with + the IP address specified. The default is 0. This keyword does not apply to point-to-multipoint + interfaces. + + +Redistribution Configuration ---------------------------- .. cfgcmd:: set protocols ospf redistribute bgp @@ -348,7 +405,227 @@ Redistribution configuration There are five modes available for route source: bgp, connected, kernel, rip, static. -Configuration example +Operational Mode Commands +------------------------- + +.. opcmd:: show ip ospf neighbor + + This command displays the neighbors status. + +.. code-block:: none + + Neighbor ID Pri State Dead Time Address Interface RXmtL RqstL DBsmL + 10.0.13.1 1 Full/DR 38.365s 10.0.13.1 eth0:10.0.13.3 0 0 0 + 10.0.23.2 1 Full/Backup 39.175s 10.0.23.2 eth1:10.0.23.3 0 0 0 + +.. opcmd:: show ip ospf neighbor detail + + This command displays the neighbors information in a detailed form, not just + a summary table. + +.. code-block:: none + + Neighbor 10.0.13.1, interface address 10.0.13.1 + In the area 0.0.0.0 via interface eth0 + Neighbor priority is 1, State is Full, 5 state changes + Most recent state change statistics: + Progressive change 11m55s ago + DR is 10.0.13.1, BDR is 10.0.13.3 + Options 2 *|-|-|-|-|-|E|- + Dead timer due in 34.854s + Database Summary List 0 + Link State Request List 0 + Link State Retransmission List 0 + Thread Inactivity Timer on + Thread Database Description Retransmision off + Thread Link State Request Retransmission on + Thread Link State Update Retransmission on + + Neighbor 10.0.23.2, interface address 10.0.23.2 + In the area 0.0.0.1 via interface eth1 + Neighbor priority is 1, State is Full, 4 state changes + Most recent state change statistics: + Progressive change 41.193s ago + DR is 10.0.23.3, BDR is 10.0.23.2 + Options 2 *|-|-|-|-|-|E|- + Dead timer due in 35.661s + Database Summary List 0 + Link State Request List 0 + Link State Retransmission List 0 + Thread Inactivity Timer on + Thread Database Description Retransmision off + Thread Link State Request Retransmission on + Thread Link State Update Retransmission on + +.. opcmd:: show ip ospf neighbor + + This command displays the neighbors information in a detailed form for a neighbor + whose IP address is specified. + +.. opcmd:: show ip ospf neighbor + + This command displays the neighbors status for a neighbor on the specified + interface. + +.. opcmd:: show ip ospf interface [intname] + + This command displays state and configuration of OSPF the specified interface, + or all interfaces if no interface is given. + +.. code-block:: none + + eth0 is up + ifindex 2, MTU 1500 bytes, BW 4294967295 Mbit + Internet Address 10.0.13.3/24, Broadcast 10.0.13.255, Area 0.0.0.0 + MTU mismatch detection: enabled + Router ID 10.0.23.3, Network Type BROADCAST, Cost: 1 + Transmit Delay is 1 sec, State Backup, Priority 1 + Backup Designated Router (ID) 10.0.23.3, Interface Address 10.0.13.3 + Multicast group memberships: OSPFAllRouters OSPFDesignatedRouters + Timer intervals configured, Hello 10s, Dead 40s, Wait 40s, Retransmit 5 + Hello due in 4.470s + Neighbor Count is 1, Adjacent neighbor count is 1 + eth1 is up + ifindex 3, MTU 1500 bytes, BW 4294967295 Mbit + Internet Address 10.0.23.3/24, Broadcast 10.0.23.255, Area 0.0.0.1 + MTU mismatch detection: enabled + Router ID 10.0.23.3, Network Type BROADCAST, Cost: 1 + Transmit Delay is 1 sec, State DR, Priority 1 + Backup Designated Router (ID) 10.0.23.2, Interface Address 10.0.23.2 + Saved Network-LSA sequence number 0x80000002 + Multicast group memberships: OSPFAllRouters OSPFDesignatedRouters + Timer intervals configured, Hello 10s, Dead 40s, Wait 40s, Retransmit 5 + Hello due in 4.563s + Neighbor Count is 1, Adjacent neighbor count is 1 + +.. opcmd:: show ip ospf route + + This command displays the OSPF routing table, as determined by the most recent + SPF calculation. + +.. code-block:: none + + ============ OSPF network routing table ============ + N IA 10.0.12.0/24 [3] area: 0.0.0.0 + via 10.0.13.3, eth0 + N 10.0.13.0/24 [1] area: 0.0.0.0 + directly attached to eth0 + N IA 10.0.23.0/24 [2] area: 0.0.0.0 + via 10.0.13.3, eth0 + N 10.0.34.0/24 [2] area: 0.0.0.0 + via 10.0.13.3, eth0 + + ============ OSPF router routing table ============= + R 10.0.23.3 [1] area: 0.0.0.0, ABR + via 10.0.13.3, eth0 + R 10.0.34.4 [2] area: 0.0.0.0, ASBR + via 10.0.13.3, eth0 + + ============ OSPF external routing table =========== + N E2 172.16.0.0/24 [2/20] tag: 0 + via 10.0.13.3, eth0 + +The table consists of following data: + +**OSPF network routing table** – includes a list of acquired routes for all +accessible networks (or aggregated area ranges) of OSPF system. "IA" flag means +that route destination is in the area to which the router is not connected, i.e. +it’s an inter-area path. In square brackets a summary metric for all links through +which a path lies to this network is specified. "via" prefix defines a +router-gateway, i.e. the first router on the way to the destination (next hop). +**OSPF router routing table** – includes a list of acquired routes to all +accessible ABRs and ASBRs. +**OSPF external routing table** – includes a list of acquired routes that are +external to the OSPF process. "E" flag points to the external link metric type +(E1 – metric type 1, E2 – metric type 2). External link metric is printed in the +"/" format. + +.. opcmd:: show ip ospf border-routers + + This command displays a table of paths to area boundary and autonomous system + boundary routers. + +.. opcmd:: show ip ospf database + + This command displays a summary table with a database contents (LSA). + +.. code-block:: none + + OSPF Router with ID (10.0.13.1) + + Router Link States (Area 0.0.0.0) + + Link ID ADV Router Age Seq# CkSum Link count + 10.0.13.1 10.0.13.1 984 0x80000005 0xd915 1 + 10.0.23.3 10.0.23.3 1186 0x80000008 0xfe62 2 + 10.0.34.4 10.0.34.4 1063 0x80000004 0x4e3f 1 + + Net Link States (Area 0.0.0.0) + + Link ID ADV Router Age Seq# CkSum + 10.0.13.1 10.0.13.1 994 0x80000003 0x30bb + 10.0.34.4 10.0.34.4 1188 0x80000001 0x9411 + + Summary Link States (Area 0.0.0.0) + + Link ID ADV Router Age Seq# CkSum Route + 10.0.12.0 10.0.23.3 1608 0x80000001 0x6ab6 10.0.12.0/24 + 10.0.23.0 10.0.23.3 981 0x80000003 0xe232 10.0.23.0/24 + + AS External Link States + + Link ID ADV Router Age Seq# CkSum Route + 172.16.0.0 10.0.34.4 1063 0x80000001 0xc40d E2 172.16.0.0/24 [0x0] + +.. opcmd:: show ip ospf database [A.B.C.D] [adv-router |self-originate] + + This command displays a database contents for a specific link advertisement type. + + The type can be the following: + asbr-summary, external, network, nssa-external, opaque-area, opaque-as, + opaque-link, router, summary. + + [A.B.C.D] – link-state-id. With this specified the command displays portion of + the network environment that is being described by the advertisement. The value + entered depends on the advertisement’s LS type. It must be entered in the form + of an IP address. + + :cfgcmd:`adv-router ` – router id, which link advertisements need to be + reviewed. + + :cfgcmd:`self-originate` displays only self-originated LSAs from the local router. + +.. code-block:: none + + OSPF Router with ID (10.0.13.1) + + Router Link States (Area 0.0.0.0) + + LS age: 1213 + Options: 0x2 : *|-|-|-|-|-|E|- + LS Flags: 0x3 + Flags: 0x0 + LS Type: router-LSA + Link State ID: 10.0.13.1 + Advertising Router: 10.0.13.1 + LS Seq Number: 80000009 + Checksum: 0xd119 + Length: 36 + + Number of Links: 1 + + Link connected to: a Transit Network + (Link ID) Designated Router address: 10.0.13.1 + (Link Data) Router Interface address: 10.0.13.1 + Number of TOS metrics: 0 + TOS 0 Metric: 1 + +.. opcmd:: show ip ospf database max-age + + This command displays LSAs in MaxAge list. + + +Configuration Example --------------------- Below you can see a typical configuration using 2 nodes, redistribute loopback -- cgit v1.2.3 From 40996bae01a4b2c2070a3f76b2630f8e4dd25528 Mon Sep 17 00:00:00 2001 From: Leonid Voronkin Date: Tue, 19 Jan 2021 19:39:13 +0400 Subject: OSPF: added OSPFv3 commands and formated OSPFv2 Added OSPFv3 configuration and operation commands. OSPFv2 formatted according to Style Guide. added summarization commands for OSPFv2. --- docs/configuration/protocols/ospf.rst | 691 +++++++++++++++++++++++----------- 1 file changed, 473 insertions(+), 218 deletions(-) (limited to 'docs/configuration/protocols/ospf.rst') diff --git a/docs/configuration/protocols/ospf.rst b/docs/configuration/protocols/ospf.rst index 7d9950e6..7270febc 100644 --- a/docs/configuration/protocols/ospf.rst +++ b/docs/configuration/protocols/ospf.rst @@ -20,11 +20,8 @@ OSPFv2 (IPv4) General Configuration --------------------- -.. cfgcmd:: set protocols ospf area - - This command is udes to enable the OSPF process. The area number can be - specified in decimal notation in the range from 0 to 4294967295. Or it - can be specified in dotted decimal notation similar to ip address. +VyOS does not have a special command to start the OSPF process. The OSPF process +starts when the first ospf enabled interface is configured. .. cfgcmd:: set protocols ospf area network @@ -32,40 +29,48 @@ General Configuration an address from defined range then the command enables OSPF on this interface so router can provide network information to the other ospf routers via this interface. + + This command is also used to enable the OSPF process. The area number can be + specified in decimal notation in the range from 0 to 4294967295. Or it + can be specified in dotted decimal notation similar to ip address. .. cfgcmd:: set protocols ospf auto-cost reference-bandwidth - This command sets the reference bandwidth for cost calculations, where - bandwidth can be in range from 1 to 4294967, 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 + This command sets the reference bandwidth for cost calculations, where + bandwidth can be in range from 1 to 4294967, 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). .. cfgcmd:: set protocols ospf parameters router-id This command 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! + 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! Optional Configuration ---------------------- -.. cfgcmd:: set protocols ospf default-information originate [always] [metric ] [metric-type <1|2>] [route-map ] +.. cfgcmd:: set protocols ospf default-information originate [always] + [metric ] [metric-type <1|2>] [route-map ] 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 :cfgcmd:`always` keyword is given then the default is always advertised, - even when there is no default present in the routing table. The argument - :cfgcmd:`route-map` specifies to advertise the default route if the route map - is satisfied. + If the :cfgcmd:`always` keyword is given then the default is always + advertised, even when there is no default present in the routing table. + The argument :cfgcmd:`route-map` specifies to advertise the default route + if the route map is satisfied. .. cfgcmd:: set protocols ospf distance global - This command change distance value of OSPF. The distance range is 1 to 255. + This command change distance value of OSPF globally. + The distance range is 1 to 255. -.. cfgcmd:: set protocols ospf distance ospf +.. cfgcmd:: set protocols ospf distance ospf + This command change distance value of OSPF. The arguments are the distance values for external routes, inter-area routes and intra-area routes @@ -80,7 +85,8 @@ Optional Configuration :cfgcmd:`detail` argument, all changes in adjacency status are shown. Without :cfgcmd:`detail`, only changes to full or regressions are shown. -.. cfgcmd:: set protocols ospf max-metric router-lsa |on-startup > +.. cfgcmd:: set protocols ospf max-metric router-lsa + |on-startup > This enables :rfc:`3137` support, where the OSPF process describes its transit links in its router-LSA as having infinite distance so that other @@ -94,65 +100,76 @@ Optional Configuration and/or for a period of seconds prior to shutdown with the :cfgcmd:`on-shutdown ` command. The time range is 5 to 86400. -.. cfgcmd:: set protocols ospf parameters abr-type +.. cfgcmd:: set protocols ospf parameters abr-type + This command selects ABR model. OSPF router supports four ABR models: - **cisco** – a router will be considered as ABR if it has several configured links to - the networks in different areas one of which is a backbone area. Moreover, the link - to the backbone area should be active (working). - **ibm** – identical to "cisco" model but in this case a backbone area link may not be active. + **cisco** – a router will be considered as ABR if it has several configured + links to the networks in different areas one of which is a backbone area. + Moreover, the link to the backbone area should be active (working). + **ibm** – identical to "cisco" model but in this case a backbone area link + may not be active. **standard** – router has several active links to different areas. - **shortcut** – identical to "standard" but in this model a router is allowed to use a - connected areas topology without involving a backbone area for inter-area connections. + **shortcut** – identical to "standard" but in this model a router is + allowed to use a connected areas topology without involving a backbone + area for inter-area connections. - Detailed information about "cisco" and "ibm" models differences can be found in :rfc:`3509`. - A "shortcut" model allows ABR to create routes between areas based on the topology of the - areas connected to this router but not using a backbone area in case if non-backbone route - will be cheaper. For more information about "shortcut" model, see :t:`ospf-shortcut-abr-02.txt` + Detailed information about "cisco" and "ibm" models differences can be + found in :rfc:`3509`. A "shortcut" model allows ABR to create routes + between areas based on the topology of the areas connected to this router + but not using a backbone area in case if non-backbone route will be + cheaper. For more information about "shortcut" model, + see :t:`ospf-shortcut-abr-02.txt` .. cfgcmd:: set protocols ospf parameters rfc1583-compatibility - :rfc:`2328`, the successor to :rfc:`1583`, suggests according to section G.2 (changes) - in section 16.4.1 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. + :rfc:`2328`, the successor to :rfc:`1583`, suggests according to section + G.2 (changes) in section 16.4.1 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. .. cfgcmd:: set protocols ospf passive-interface - This command specifies interface as passive. Passive interface advertises its address, - but does not run the OSPF protocol (adjacencies are not formed and hello packets are - not generated). + This command specifies interface as passive. Passive interface advertises + its address, but does not run the OSPF protocol (adjacencies are not formed + and hello packets are not generated). .. cfgcmd:: set protocols ospf passive-interface default - This command specifies all interfaces as passive by default. Because this command changes - the configuration logic to a default passive; therefore, interfaces where router adjacencies - are expected need to be configured with the :cfgcmd:`passive-interface-exclude` command. + This command specifies all interfaces as passive by default. Because this + command changes the configuration logic to a default passive; therefore, + interfaces where router adjacencies are expected need to be configured + with the :cfgcmd:`passive-interface-exclude` command. .. cfgcmd:: set protocols ospf passive-interface-exclude - This command allows exclude interface from passive state. This command is used if the - command :cfgcmd:`passive-interface default` was configured. + This command allows exclude interface from passive state. This command is + used if the command :cfgcmd:`passive-interface default` was configured. .. cfgcmd:: set protocols ospf refresh timers - The router automatically updates link-state information with its neighbors. Only an obsolete - information is updated which age has exceeded a specific threshold. This parameter changes - a threshold value, which by default is 1800 seconds (half an hour). The value is applied - to the whole OSPF router. The timer range is 10 to 1800. - -.. cfgcmd:: set protocols ospf timers throttle spf - - This command sets the initial delay, the initial-holdtime and the maximum-holdtime between - when SPF is calculated and the event which triggered the calculation. The times are specified - in milliseconds and must be in the range of 0 to 600000 milliseconds. :cfgcmd:`delay` sets - the initial SPF schedule delay in milliseconds. The default value is 200 ms. - :cfgcmd:`initial-holdtime` sets the minimum hold time between two consecutive SPF calculations. - The default value is 1000 ms. :cfgcmd:`max-holdtime` sets the maximum wait time between two + The router automatically updates link-state information with its neighbors. + Only an obsolete information is updated which age has exceeded a specific + threshold. This parameter changes a threshold value, which by default is + 1800 seconds (half an hour). The value is applied to the whole OSPF router. + The timer range is 10 to 1800. + +.. cfgcmd:: set protocols ospf timers throttle spf + + + This command sets the initial delay, the initial-holdtime and the + maximum-holdtime between when SPF is calculated and the event which + triggered the calculation. The times are specified in milliseconds and must + be in the range of 0 to 600000 milliseconds. :cfgcmd:`delay` sets the + initial SPF schedule delay in milliseconds. The default value is 200 ms. + :cfgcmd:`initial-holdtime` sets the minimum hold time between two + consecutive SPF calculations. The default value is 1000 ms. + :cfgcmd:`max-holdtime` sets the maximum wait time between two consecutive SPF calculations. The default value is 10000 ms. @@ -161,108 +178,147 @@ Areas Configuration .. cfgcmd:: set protocols ospf area area-type stub - This command specifies 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-5) 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. + This command specifies 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-5) 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. .. cfgcmd:: set protocols ospf area area-type stub no-summary - This command specifies the area to be a Totally Stub Area. In addition to stub area - limitations this area type prevents an ABR from injecting Network-Summary (type-3) - LSAs into the specified stub area. Only default summary route is allowed. + This command specifies the area to be a Totally Stub Area. In addition to + stub area limitations this area type prevents an ABR from injecting + Network-Summary (type-3) LSAs into the specified stub area. Only default + summary route is allowed. -.. cfgcmd:: set protocols ospf area area-type stub default-cost +.. cfgcmd:: set protocols ospf area area-type stub default-cost + - This command sets the cost of default-summary LSAs announced to stubby areas. - The cost range is 0 to 16777215. + This command sets the cost of default-summary LSAs announced to stubby + areas. The cost range is 0 to 16777215. .. cfgcmd:: set protocols ospf area area-type nssa - This command specifies the area to be a Not So Stubby Area. External routing information - is imported into an NSSA in Type-7 LSAs. Type-7 LSAs are similar to Type-5 AS-external - LSAs, except that they can only be flooded into the NSSA. In order to further propagate - the NSSA external information, the Type-7 LSA must be translated to a Type-5 - AS-external-LSA by the NSSA ABR. + This command specifies the area to be a Not So Stubby Area. External + routing information is imported into an NSSA in Type-7 LSAs. Type-7 LSAs + are similar to Type-5 AS-external LSAs, except that they can only be + flooded into the NSSA. In order to further propagate the NSSA external + information, the Type-7 LSA must be translated to a Type-5 AS-external-LSA + by the NSSA ABR. .. cfgcmd:: set protocols ospf area area-type nssa no-summary - This command specifies the area to be a NSSA Totally Stub Area. ABRs for such an area do - not need to pass Network-Summary (type-3) LSAs (except the default summary route), - ASBR-Summary LSAs (type-4) and AS-External LSAs (type-5) into the area. But Type-7 LSAs - that convert to Type-5 at the NSSA ABR are allowed. + This command specifies the area to be a NSSA Totally Stub Area. ABRs for + such an area do not need to pass Network-Summary (type-3) LSAs (except the + default summary route), ASBR-Summary LSAs (type-4) and AS-External LSAs + (type-5) into the area. But Type-7 LSAs that convert to Type-5 at the NSSA + ABR are allowed. -.. cfgcmd:: set protocols ospf area area-type nssa default-cost +.. cfgcmd:: set protocols ospf area area-type nssa default-cost + This command sets the default cost of LSAs announced to NSSA areas. The cost range is 0 to 16777215. -.. cfgcmd:: set protocols ospf area area-type nssa translate +.. cfgcmd:: set protocols ospf area area-type nssa translate + - Specifies whether this NSSA border router will unconditionally translate Type-7 LSAs into - Type-5 LSAs. When role is Always, Type-7 LSAs are translated into Type-5 LSAs regardless - of the translator state of other NSSA border routers. When role is Candidate, this router - participates in the translator election to determine if it will perform the translations - duties. When role is Never, this router will never translate Type-7 LSAs into Type-5 LSAs. + Specifies whether this NSSA border router will unconditionally translate + Type-7 LSAs into Type-5 LSAs. When role is Always, Type-7 LSAs are + translated into Type-5 LSAs regardless of the translator state of other + NSSA border routers. When role is Candidate, this router participates in + the translator election to determine if it will perform the translations + duties. When role is Never, this router will never translate Type-7 LSAs + into Type-5 LSAs. .. cfgcmd:: set protocols ospf area authentication plaintext-password - This command specifies that simple password authentication should be used for the given - area. The password must also be configured on a per-interface basis. + This command specifies that simple password authentication should be used + for the given area. The password must also be configured on a per-interface + basis. .. cfgcmd:: set protocols ospf area authentication md5 - This command 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. + This command 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. + +.. cfgcmd:: set protocols ospf area range [cost ] + + This command summarizes intra area paths from specified area into one + summary-LSA (Type-3) announced to other areas. This command can be used + only in ABR and ONLY router-LSAs (Type-1) and network-LSAs (Type-2) + (i.e. LSAs with scope area) can be summarized. AS-external-LSAs (Type-5) + can’t be summarized - their scope is AS. The optional argument + :cfgcmd:`cost` specifies the aggregated link metric. The metric range is 0 + to 16777215. + +.. cfgcmd:: set protocols ospf area range not-advertise + + This command instead of summarizing intra area paths filter them - i.e. + intra area paths from this range are not advertised into other areas. + This command makes sense in ABR only. + +.. cfgcmd:: set protocols ospf area range substitute + + + One Type-3 summary-LSA with routing info is announced into + backbone area if defined area contains at least one intra-area network + (i.e. described with router-LSA or network-LSA) from range . + This command makes sense in ABR only. .. cfgcmd:: set protocols ospf area shortcut - This parameter allows to "shortcut" routes (non-backbone) for inter-area routes. There - are three modes available for routes shortcutting: + This parameter allows to "shortcut" routes (non-backbone) for inter-area + routes. There are three modes available for routes shortcutting: - **default** – this area will be used for shortcutting only if ABR does not have a link - to the backbone area or this link was lost. - **enable** – the area will be used for shortcutting every time the route that goes through - it is cheaper. + **default** – this area will be used for shortcutting only if ABR does not + have a link to the backbone area or this link was lost. + **enable** – the area will be used for shortcutting every time the route + that goes through it is cheaper. **disable** – this area is never used by ABR for routes shortcutting. .. cfgcmd:: set protocols ospf area virtual-link Provides a backbone area coherence by virtual link establishment. - In general, OSPF protocol requires a backbone area (area 0) to be coherent and fully - connected. I.e. any backbone area router must have a route to any other backbone area - router. Moreover, every ABR must have a link to backbone area. However, it is not always - possible to have a physical link to a backbone area. In this case between two ABR (one - of them has a link to the backbone area) in the area (not stub area) a virtual link is organized. + In general, OSPF protocol requires a backbone area (area 0) to be coherent + and fully connected. I.e. any backbone area router must have a route to any + other backbone area router. Moreover, every ABR must have a link to + backbone area. However, it is not always possible to have a physical link + to a backbone area. In this case between two ABR (one of them has a link to + the backbone area) in the area (not stub area) a virtual link is organized. – area identifier through which a virtual link goes. - – ABR router-id with which a virtual link is established. Virtual link must be - configured on both routers. + – ABR router-id with which a virtual link is established. Virtual + link must be configured on both routers. - Formally, a virtual link looks like a point-to-point network connecting two ABR from one - area one of which physically connected to a backbone area. This pseudo-network is considered - to belong to a backbone area. + Formally, a virtual link looks like a point-to-point network connecting two + ABR from one area one of which physically connected to a backbone area. + This pseudo-network is considered to belong to a backbone area. Interfaces Configuration ------------------------ -.. cfgcmd:: set interfaces ip ospf authentication plaintext-password +.. cfgcmd:: set interfaces ip ospf authentication + plaintext-password - This command sets OSPF authentication key to a simple password. After setting, all OSPF - packets are authenticated. Key has length up to 8 chars. + This command sets OSPF authentication key to a simple password. After + setting, all OSPF packets are authenticated. Key has length up to 8 chars. - Simple text password authentication is insecure and deprecated in favour of MD5 HMAC - authentication. + Simple text password authentication is insecure and deprecated in favour of + MD5 HMAC authentication. -.. cfgcmd:: set interfaces ip ospf authentication md5 key-id md5-key +.. cfgcmd:: set interfaces ip ospf authentication md5 + key-id md5-key - This command specifys that MD5 HMAC authentication must be used on this interface. It sets - OSPF authentication key to a cryptographic password. Key-id 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. The key can be long up to 16 chars (larger strings will be truncated), + This command specifys that MD5 HMAC authentication must be used on this + interface. It sets OSPF authentication key to a cryptographic password. + Key-id 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. + The key can be long up to 16 chars (larger strings will be truncated), and is associated with the given key-id. .. cfgcmd:: set interfaces ip ospf bandwidth @@ -272,66 +328,73 @@ Interfaces Configuration .. cfgcmd:: set interfaces ip ospf cost - This command sets link cost for the specified interface. The cost value is set to - router-LSA’s metric field and used for SPF calculation. The cost range is 1 to 65535. + This command sets link cost for the specified interface. The cost value is + set to router-LSA’s metric field and used for SPF calculation. The cost + range is 1 to 65535. .. cfgcmd:: set interfaces ip ospf dead-interval - Set number of seconds for router Dead Interval 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. The interval range is 1 to 65535. + Set number of seconds for router Dead Interval 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. The + interval range is 1 to 65535. .. cfgcmd:: set interfaces ip ospf hello-interval - Set number of seconds for Hello Interval 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. The interval range is 1 to 65535. + Set number of seconds for Hello Interval 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. The interval range is 1 + to 65535. .. cfgcmd:: set interfaces ip ospf mtu-ignore - This command disables check of the MTU value in the OSPF DBD packets. Thus, use - of this command allows the OSPF adjacency to reach the FULL state even though - there is an interface MTU mismatch between two OSPF routers. + This command disables check of the MTU value in the OSPF DBD packets. Thus, + use of this command allows the OSPF adjacency to reach the FULL state even + though there is an interface MTU mismatch between two OSPF routers. .. cfgcmd:: set interfaces ip ospf network - This command allows to specify the distribution type for the network connected - to this interface: + This command allows to specify the distribution type for the network + connected to this interface: **broadcast** – broadcast IP addresses distribution. **non-broadcast** – address distribution in NBMA networks topology. - **point-to-multipoint** – address distribution in point-to-multipoint networks. + **point-to-multipoint** – address distribution in point-to-multipoint + networks. **point-to-point** – address distribution in point-to-point networks. .. cfgcmd:: set interfaces ip ospf priority - This command sets Router Priority 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. The interval range is 0 to 255. + This command sets Router Priority 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. The interval range is 0 to 255. -.. cfgcmd:: set interfaces ip ospf retransmit-interval +.. cfgcmd:: set interfaces ip ospf retransmit-interval + - This command sets number of seconds for RxmtInterval timer value. This value is used - when retransmitting Database Description and Link State Request packets if acknowledge - was not received. The default value is 5 seconds. The interval range is 3 to 65535. + This command sets number of seconds for RxmtInterval timer value. This + value is used when retransmitting Database Description and Link State + Request packets if acknowledge was not received. The default value is 5 + seconds. The interval range is 3 to 65535. .. cfgcmd:: set interfaces ip ospf transmit-delay - This command sets number of seconds for InfTransDelay value. It allows to set and adjust - for each interface the delay interval before starting the synchronizing process of the - router's database with all neighbors. The default value is 1 seconds. The interval range - is 3 to 65535. + This command sets number of seconds for InfTransDelay value. It allows to + set and adjust for each interface the delay interval before starting the + synchronizing process of the router's database with all neighbors. The + default value is 1 seconds. The interval range is 3 to 65535. Manual Neighbor Configuration ----------------------------- -OSPF routing devices normally discover their neighbors dynamically by listening to the broadcast -or multicast hello packets on the network. Because an NBMA network does not support broadcast (or -multicast), the device cannot discover its neighbors dynamically, so you must configure all the -neighbors statically. +OSPF routing devices normally discover their neighbors dynamically by +listening to the broadcast or multicast hello packets on the network. +Because an NBMA network does not support broadcast (or multicast), the +device cannot discover its neighbors dynamically, so you must configure all +the neighbors statically. .. cfgcmd:: set protocols ospf neighbor @@ -339,39 +402,26 @@ neighbors statically. .. cfgcmd:: set protocols ospf neighbor poll-interval - This command specifies the length of time, in seconds, before the routing device sends hello - packets out of the interface before it establishes adjacency with a neighbor. The range is 1 - to 65535 seconds. The default value is 60 seconds. + This command specifies the length of time, in seconds, before the routing + device sends hello packets out of the interface before it establishes + adjacency with a neighbor. The range is 1 to 65535 seconds. The default + value is 60 seconds. .. cfgcmd:: set protocols ospf neighbor priority - This command specifies the router priority value of the nonbroadcast neighbor associated with - the IP address specified. The default is 0. This keyword does not apply to point-to-multipoint - interfaces. + This command specifies the router priority value of the nonbroadcast + neighbor associated with the IP address specified. The default is 0. + This keyword does not apply to point-to-multipoint interfaces. Redistribution Configuration ---------------------------- -.. cfgcmd:: set protocols ospf redistribute bgp +.. cfgcmd:: set protocols ospf redistribute - Redistribute BGP routes to OSPF process. - -.. cfgcmd:: set protocols ospf redistribute connected - - Redistribute connected routes to OSPF process. - -.. cfgcmd:: set protocols ospf redistribute kernel - - Redistribute kernel routes to OSPF process. - -.. cfgcmd:: set protocols ospf redistribute rip - - Redistribute RIP routes to OSPF process. - -.. cfgcmd:: set protocols ospf redistribute static - - Redistribute static routes to OSPF process. + This command redistributes routing information from the given route source + to the OSPF process. There are five modes available for route source: bgp, + connected, kernel, rip, static. .. cfgcmd:: set protocols ospf default-metric @@ -380,29 +430,33 @@ Redistribution Configuration .. cfgcmd:: set protocols ospf redistribute metric - This command specifies metric for redistributed routes from given route source. There - are five modes available for route source: bgp, connected, kernel, rip, static. The - metric range is 1 to 16. + This command specifies metric for redistributed routes from given route + source. There are five modes available for route source: bgp, connected, + kernel, rip, static. The metric range is 1 to 16. .. cfgcmd:: set protocols ospf redistribute metric-type <1|2> - This command specifies metric type for redistributed routes. Difference between two metric - types that metric type 1 is a metric which is "commensurable" with inner OSPF links. When - calculating a metric to the external destination, the full path metric is calculated as a - metric sum path of a router which had advertised this link plus the link metric. Thus, a - route with the least summary metric will be selected. If external link is advertised with - metric type 2 the path is selected which lies through the router which advertised this link - with the least metric despite of the fact that internal path to this router is longer (with - more cost). However, if two routers advertised an external link and with metric type 2 the - preference is given to the path which lies through the router with a shorter internal path. - If two different routers advertised two links to the same external destimation but with - different metric type, metric type 1 is preferred. If type of a metric left undefined the - router will consider these external links to have a default metric type 2. + This command specifies metric type for redistributed routes. Difference + between two metric types that metric type 1 is a metric which is + "commensurable" with inner OSPF links. When calculating a metric to the + external destination, the full path metric is calculated as a metric sum + path of a router which had advertised this link plus the link metric. + Thus, a route with the least summary metric will be selected. If external + link is advertised with metric type 2 the path is selected which lies + through the router which advertised this link with the least metric + despite of the fact that internal path to this router is longer (with more + cost). However, if two routers advertised an external link and with metric + type 2 the preference is given to the path which lies through the router + with a shorter internal path. If two different routers advertised two + links to the same external destimation but with different metric type, + metric type 1 is preferred. If type of a metric left undefined the router + will consider these external links to have a default metric type 2. .. cfgcmd:: set protocols ospf redistribute route-map - This command allows to use route map to filter redistributed routes from given route source. - There are five modes available for route source: bgp, connected, kernel, rip, static. + This command allows to use route map to filter redistributed routes from + given route source. There are five modes available for route source: bgp, + connected, kernel, rip, static. Operational Mode Commands @@ -420,8 +474,8 @@ Operational Mode Commands .. opcmd:: show ip ospf neighbor detail - This command displays the neighbors information in a detailed form, not just - a summary table. + This command displays the neighbors information in a detailed form, not + just a summary table. .. code-block:: none @@ -459,18 +513,18 @@ Operational Mode Commands .. opcmd:: show ip ospf neighbor - This command displays the neighbors information in a detailed form for a neighbor - whose IP address is specified. + This command displays the neighbors information in a detailed form for a + neighbor whose IP address is specified. .. opcmd:: show ip ospf neighbor This command displays the neighbors status for a neighbor on the specified interface. -.. opcmd:: show ip ospf interface [intname] +.. opcmd:: show ip ospf interface [] - This command displays state and configuration of OSPF the specified interface, - or all interfaces if no interface is given. + This command displays state and configuration of OSPF the specified + interface, or all interfaces if no interface is given. .. code-block:: none @@ -500,8 +554,8 @@ Operational Mode Commands .. opcmd:: show ip ospf route - This command displays the OSPF routing table, as determined by the most recent - SPF calculation. + This command displays the OSPF routing table, as determined by the most + recent SPF calculation. .. code-block:: none @@ -527,23 +581,24 @@ Operational Mode Commands The table consists of following data: -**OSPF network routing table** – includes a list of acquired routes for all -accessible networks (or aggregated area ranges) of OSPF system. "IA" flag means -that route destination is in the area to which the router is not connected, i.e. -it’s an inter-area path. In square brackets a summary metric for all links through -which a path lies to this network is specified. "via" prefix defines a -router-gateway, i.e. the first router on the way to the destination (next hop). +**OSPF network routing table** – includes a list of acquired routes for all +accessible networks (or aggregated area ranges) of OSPF system. "IA" flag +means that route destination is in the area to which the router is not +connected, i.e. it’s an inter-area path. In square brackets a summary metric +for all links through which a path lies to this network is specified. "via" +prefix defines a router-gateway, i.e. the first router on the way to the +destination (next hop). **OSPF router routing table** – includes a list of acquired routes to all accessible ABRs and ASBRs. **OSPF external routing table** – includes a list of acquired routes that are external to the OSPF process. "E" flag points to the external link metric type -(E1 – metric type 1, E2 – metric type 2). External link metric is printed in the -"/" format. +(E1 – metric type 1, E2 – metric type 2). External link metric is printed in +the "/" format. .. opcmd:: show ip ospf border-routers - This command displays a table of paths to area boundary and autonomous system - boundary routers. + This command displays a table of paths to area boundary and autonomous + system boundary routers. .. opcmd:: show ip ospf database @@ -577,23 +632,26 @@ external to the OSPF process. "E" flag points to the external link metric type Link ID ADV Router Age Seq# CkSum Route 172.16.0.0 10.0.34.4 1063 0x80000001 0xc40d E2 172.16.0.0/24 [0x0] -.. opcmd:: show ip ospf database [A.B.C.D] [adv-router |self-originate] +.. opcmd:: show ip ospf database [A.B.C.D] + [adv-router |self-originate] - This command displays a database contents for a specific link advertisement type. + This command displays a database contents for a specific link advertisement + type. The type can be the following: asbr-summary, external, network, nssa-external, opaque-area, opaque-as, opaque-link, router, summary. - [A.B.C.D] – link-state-id. With this specified the command displays portion of - the network environment that is being described by the advertisement. The value - entered depends on the advertisement’s LS type. It must be entered in the form - of an IP address. + [A.B.C.D] – link-state-id. With this specified the command displays portion + of the network environment that is being described by the advertisement. + The value entered depends on the advertisement’s LS type. It must be + entered in the form of an IP address. - :cfgcmd:`adv-router ` – router id, which link advertisements need to be - reviewed. + :cfgcmd:`adv-router ` – router id, which link advertisements need + to be reviewed. - :cfgcmd:`self-originate` displays only self-originated LSAs from the local router. + :cfgcmd:`self-originate` displays only self-originated LSAs from the local + router. .. code-block:: none @@ -666,6 +724,203 @@ address and the node 1 sending the default route: OSPFv3 (IPv6) ############# +General Configuration +--------------------- + +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 area interface + + This command specifies the OSPFv3 enabled interface. This command is also + used to enable the OSPF process. The area number can be specified in + decimal notation in the range from 0 to 4294967295. Or it can be specified + in dotted decimal notation similar to ip address. + +.. cfgcmd:: set protocols ospfv3 parameters router-id + + This command sets the router-ID of the OSPFv3 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 OSPFv3 domain to + the OSPFv3 speaker – bad things will happen if multiple OSPFv3 speakers are + configured with the same router-ID! + + +Optional Configuration +---------------------- + +.. cfgcmd:: set protocols ospfv3 distance global + + This command change distance value of OSPFv3 globally. + The distance range is 1 to 255. + +.. cfgcmd:: set protocols ospfv3 distance ospfv3 + + + This command change distance value of OSPFv3. The arguments are the + distance values for external routes, inter-area routes and intra-area + routes respectively. The distance range is 1 to 255. + + +Areas Configuration +------------------- + +.. cfgcmd:: set protocols ospfv3 area range + + This command summarizes intra area paths from specified area into one + Type-3 Inter-Area Prefix LSA announced to other areas. This command can be + used only in ABR. + +.. cfgcmd:: set protocols ospfv3 area range not-advertise + + This command instead of summarizing intra area paths filter them - i.e. + intra area paths from this range are not advertised into other areas. This + command makes sense in ABR only. + + +Interfaces Configuration +------------------------ + +.. cfgcmd:: set interfaces ipv6 ospfv3 cost + + This command sets link cost for the specified interface. The cost value is + set to router-LSA’s metric field and used for SPF calculation. The cost + range is 1 to 65535. + +.. cfgcmd:: set interfaces ipv6 ospfv3 dead-interval + + + Set number of seconds for router Dead Interval 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. The + interval range is 1 to 65535. + +.. cfgcmd:: set interfaces ipv6 ospfv3 hello-interval + + + Set number of seconds for Hello Interval 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. The interval range is 1 + to 65535. + +.. cfgcmd:: set interfaces ipv6 ospfv3 mtu-ignore + + This command disables check of the MTU value in the OSPF DBD packets. + Thus, use of this command allows the OSPF adjacency to reach the FULL + state even though there is an interface MTU mismatch between two OSPF + routers. + +.. cfgcmd:: set interfaces ipv6 ospfv3 network + + This command allows to specify the distribution type for the network + connected to this interface: + + **broadcast** – broadcast IP addresses distribution. + **point-to-point** – address distribution in point-to-point networks. + +.. cfgcmd:: set interfaces ipv6 ospfv3 priority + + This command sets Router Priority 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. The interval range is 0 to 255. + +.. cfgcmd:: set interfaces ipv6 ospfv3 passive + + This command specifies interface as passive. Passive interface advertises + its address, but does not run the OSPF protocol (adjacencies are not formed + and hello packets are not generated). + +.. cfgcmd:: set interfaces ipv6 ospfv3 retransmit-interval + + + This command sets number of seconds for RxmtInterval timer value. This + value is used when retransmitting Database Description and Link State + Request packets if acknowledge was not received. The default value is 5 + seconds. The interval range is 3 to 65535. + +.. cfgcmd:: set interfaces ipv6 ospfv3 transmit-delay + + + This command sets number of seconds for InfTransDelay value. It allows to + set and adjust for each interface the delay interval before starting the + synchronizing process of the router's database with all neighbors. The + default value is 1 seconds. The interval range is 3 to 65535. + + +Redistribution Configuration +---------------------------- + +.. cfgcmd:: set protocols ospfv3 redistribute + + This command redistributes routing information from the given route source + to the OSPFv3 process. There are five modes available for route source: + bgp, connected, kernel, ripng, static. + +.. cfgcmd:: set protocols ospf redistribute route-map + + This command allows to use route map to filter redistributed routes from + given route source. There are five modes available for route source: bgp, + connected, kernel, ripng, static. + + +Operational Mode Commands +------------------------- + +.. opcmd:: show ipv6 ospfv3 neighbor + + This command displays the neighbors status. + +.. opcmd:: show ipv6 ospfv3 neighbor detail + + This command displays the neighbors information in a detailed form, not + just a summary table. + +.. opcmd:: show ipv6 ospfv3 neighbor + + This command displays the neighbors information in a detailed form for + a neighbor whose IP address is specified. + +.. opcmd:: show ipv6 ospfv3 neighbor + + This command displays the neighbors status for a neighbor on the specified + interface. + +.. opcmd:: show ipv6 ospfv3 interface [prefix]|[ [prefix]] + + This command displays state and configuration of OSPF the specified + interface, or all interfaces if no interface is given. Whith the argument + :cfgcmd:`prefix` this command shows connected prefixes to advertise. + +.. opcmd:: show ipv6 ospfv3 route + + This command displays the OSPF routing table, as determined by the most + recent SPF calculation. + +.. opcmd:: show ipv6 ospfv3 border-routers + + This command displays a table of paths to area boundary and autonomous + system boundary routers. + +.. opcmd:: show ipv6 ospfv3 database + + This command displays a summary table with a database contents (LSA). + +.. opcmd:: show ipv6 ospfv3 database [A.B.C.D] + [adv-router |self-originate] + + This command displays a database contents for a specific link + advertisement type. + +.. opcmd:: show ipv6 ospfv3 redistribute + + This command displays external information redistributed into OSPFv3 + + +Configuration Example +--------------------- + A typical configuration using 2 nodes. **Node 1:** @@ -692,9 +947,9 @@ A typical configuration using 2 nodes. show ipv6 ospfv3 redistribute -.. note:: You cannot easily redistribute IPv6 routes via OSPFv3 on a WireGuard - interface link. This requires you to configure link-local addresses manually - on the WireGuard interfaces, see :vytask:`T1483`. +.. note:: You cannot easily redistribute IPv6 routes via OSPFv3 on a + WireGuard interface link. This requires you to configure link-local + addresses manually on the WireGuard interfaces, see :vytask:`T1483`. Example configuration for WireGuard interfaces: @@ -739,4 +994,4 @@ Example configuration for WireGuard interfaces: vyos@ospf02# run sh ipv6 ospfv3 neighbor Neighbor ID Pri DeadTime State/IfState Duration I/F[State] 192.168.0.1 1 00:00:39 Full/PointToPoint 00:19:44 wg01[PointToPoint] - + -- cgit v1.2.3 From 44647b95cb474a0fe19314540f04858c92a80074 Mon Sep 17 00:00:00 2001 From: Leonid Voronkin Date: Wed, 27 Jan 2021 11:50:52 +0400 Subject: ospf: change redistribution metric value due to T3194 --- docs/configuration/protocols/ospf.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) (limited to 'docs/configuration/protocols/ospf.rst') diff --git a/docs/configuration/protocols/ospf.rst b/docs/configuration/protocols/ospf.rst index 7270febc..585454da 100644 --- a/docs/configuration/protocols/ospf.rst +++ b/docs/configuration/protocols/ospf.rst @@ -430,9 +430,9 @@ Redistribution Configuration .. cfgcmd:: set protocols ospf redistribute metric - This command specifies metric for redistributed routes from given route - source. There are five modes available for route source: bgp, connected, - kernel, rip, static. The metric range is 1 to 16. + This command specifies metric for redistributed routes from the given + route source. There are five modes available for route source: bgp, + connected, kernel, rip, static. The metric range is 1 to 16777214. .. cfgcmd:: set protocols ospf redistribute metric-type <1|2> @@ -455,8 +455,8 @@ Redistribution Configuration .. cfgcmd:: set protocols ospf redistribute route-map This command allows to use route map to filter redistributed routes from - given route source. There are five modes available for route source: bgp, - connected, kernel, rip, static. + the given route source. There are five modes available for route source: + bgp, connected, kernel, rip, static. Operational Mode Commands -- cgit v1.2.3 From 3a92f63ec0057709b3f57aa18202758c43cee33e Mon Sep 17 00:00:00 2001 From: Christian Poessinger Date: Sat, 30 Jan 2021 13:30:21 +0100 Subject: ospf: adjust sections to section guidelines --- docs/configuration/protocols/ospf.rst | 156 ++++++++++++++++++---------------- 1 file changed, 82 insertions(+), 74 deletions(-) (limited to 'docs/configuration/protocols/ospf.rst') diff --git a/docs/configuration/protocols/ospf.rst b/docs/configuration/protocols/ospf.rst index 585454da..2c098714 100644 --- a/docs/configuration/protocols/ospf.rst +++ b/docs/configuration/protocols/ospf.rst @@ -14,23 +14,27 @@ addressing model. OSPF is a widely used IGP in large enterprise networks. +************* OSPFv2 (IPv4) -############# +************* -General Configuration ---------------------- +Configuration +============= + +General +------- VyOS does not have a special command to start the OSPF process. The OSPF process starts when the first ospf enabled interface is configured. .. cfgcmd:: set protocols ospf area network - This command specifies the OSPF enabled interface(s). If the interface has - an address from defined range then the command enables OSPF on this - interface so router can provide network information to the other ospf + This command specifies the OSPF enabled interface(s). If the interface has + an address from defined range then the command enables OSPF on this + interface so router can provide network information to the other ospf routers via this interface. - - This command is also used to enable the OSPF process. The area number can be + + This command is also used to enable the OSPF process. The area number can be specified in decimal notation in the range from 0 to 4294967295. Or it can be specified in dotted decimal notation similar to ip address. @@ -51,14 +55,14 @@ starts when the first ospf enabled interface is configured. with the same router-ID! -Optional Configuration ----------------------- +Optional +-------- .. cfgcmd:: set protocols ospf default-information originate [always] [metric ] [metric-type <1|2>] [route-map ] - Originate an AS-External (type-5) LSA describing a default route into all - external-routing capable areas, of the specified metric and metric type. + 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 :cfgcmd:`always` keyword is given then the default is always advertised, even when there is no default present in the routing table. The argument :cfgcmd:`route-map` specifies to advertise the default route @@ -72,10 +76,10 @@ Optional Configuration .. cfgcmd:: set protocols ospf distance ospf - This command change distance value of OSPF. The arguments are the distance - values for external routes, inter-area routes and intra-area routes + This command change distance value of OSPF. The arguments are the distance + values for external routes, inter-area routes and intra-area routes respectively. The distance range is 1 to 255. - + .. note:: Routes with a distance of 255 are effectively disabled and not installed into the kernel. @@ -92,14 +96,14 @@ Optional Configuration 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) with the :cfgcmd:`administrative` command. It may also be enabled conditionally. Conditional enabling of max-metric router-lsas can be for a period of seconds after startup with the :cfgcmd:`on-startup ` command and/or for a period of seconds prior to shutdown with the :cfgcmd:`on-shutdown ` command. The time range is 5 to 86400. - + .. cfgcmd:: set protocols ospf parameters abr-type @@ -173,8 +177,8 @@ Optional Configuration consecutive SPF calculations. The default value is 10000 ms. -Areas Configuration -------------------- +Area Configuration +------------------ .. cfgcmd:: set protocols ospf area area-type stub @@ -220,7 +224,7 @@ Areas Configuration This command sets the default cost of LSAs announced to NSSA areas. The cost range is 0 to 16777215. - + .. cfgcmd:: set protocols ospf area area-type nssa translate @@ -241,7 +245,7 @@ Areas Configuration .. cfgcmd:: set protocols ospf area authentication md5 This command specify that OSPF packets must be authenticated with MD5 HMACs - within the given area. Keying material must also be configured on a + within the given area. Keying material must also be configured on a per-interface basis. .. cfgcmd:: set protocols ospf area range [cost ] @@ -278,7 +282,7 @@ Areas Configuration **enable** – the area will be used for shortcutting every time the route that goes through it is cheaper. **disable** – this area is never used by ABR for routes shortcutting. - + .. cfgcmd:: set protocols ospf area virtual-link Provides a backbone area coherence by virtual link establishment. @@ -299,10 +303,10 @@ Areas Configuration This pseudo-network is considered to belong to a backbone area. -Interfaces Configuration ------------------------- +Interface Configuration +----------------------- -.. cfgcmd:: set interfaces ip ospf authentication +.. cfgcmd:: set interfaces ip ospf authentication plaintext-password This command sets OSPF authentication key to a simple password. After @@ -318,14 +322,14 @@ Interfaces Configuration interface. It sets OSPF authentication key to a cryptographic password. Key-id 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. - The key can be long up to 16 chars (larger strings will be truncated), + The key can be long up to 16 chars (larger strings will be truncated), and is associated with the given key-id. .. cfgcmd:: set interfaces ip ospf bandwidth - This command sets the interface bandwidth for cost calculations, where + This command sets the interface bandwidth for cost calculations, where bandwidth can be in range from 1 to 100000, specified in Mbits/s. - + .. cfgcmd:: set interfaces ip ospf cost This command sets link cost for the specified interface. The cost value is @@ -352,10 +356,10 @@ Interfaces Configuration This command disables check of the MTU value in the OSPF DBD packets. Thus, use of this command allows the OSPF adjacency to reach the FULL state even though there is an interface MTU mismatch between two OSPF routers. - + .. cfgcmd:: set interfaces ip ospf network - This command allows to specify the distribution type for the network + This command allows to specify the distribution type for the network connected to this interface: **broadcast** – broadcast IP addresses distribution. @@ -370,7 +374,7 @@ Interfaces Configuration 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. The interval range is 0 to 255. - + .. cfgcmd:: set interfaces ip ospf retransmit-interval @@ -378,7 +382,7 @@ Interfaces Configuration value is used when retransmitting Database Description and Link State Request packets if acknowledge was not received. The default value is 5 seconds. The interval range is 3 to 65535. - + .. cfgcmd:: set interfaces ip ospf transmit-delay This command sets number of seconds for InfTransDelay value. It allows to @@ -406,7 +410,7 @@ the neighbors statically. device sends hello packets out of the interface before it establishes adjacency with a neighbor. The range is 1 to 65535 seconds. The default value is 60 seconds. - + .. cfgcmd:: set protocols ospf neighbor priority This command specifies the router priority value of the nonbroadcast @@ -422,16 +426,16 @@ Redistribution Configuration This command redistributes routing information from the given route source to the OSPF process. There are five modes available for route source: bgp, connected, kernel, rip, static. - + .. cfgcmd:: set protocols ospf default-metric - + This command specifies the default metric value of redistributed routes. The metric range is 0 to 16777214. .. cfgcmd:: set protocols ospf redistribute metric - This command specifies metric for redistributed routes from the given - route source. There are five modes available for route source: bgp, + This command specifies metric for redistributed routes from the given + route source. There are five modes available for route source: bgp, connected, kernel, rip, static. The metric range is 1 to 16777214. .. cfgcmd:: set protocols ospf redistribute metric-type <1|2> @@ -465,7 +469,7 @@ Operational Mode Commands .. opcmd:: show ip ospf neighbor This command displays the neighbors status. - + .. code-block:: none Neighbor ID Pri State Dead Time Address Interface RXmtL RqstL DBsmL @@ -568,13 +572,13 @@ Operational Mode Commands via 10.0.13.3, eth0 N 10.0.34.0/24 [2] area: 0.0.0.0 via 10.0.13.3, eth0 - + ============ OSPF router routing table ============= R 10.0.23.3 [1] area: 0.0.0.0, ABR via 10.0.13.3, eth0 R 10.0.34.4 [2] area: 0.0.0.0, ASBR via 10.0.13.3, eth0 - + ============ OSPF external routing table =========== N E2 172.16.0.0/24 [2/20] tag: 0 via 10.0.13.3, eth0 @@ -588,7 +592,7 @@ connected, i.e. it’s an inter-area path. In square brackets a summary metric for all links through which a path lies to this network is specified. "via" prefix defines a router-gateway, i.e. the first router on the way to the destination (next hop). -**OSPF router routing table** – includes a list of acquired routes to all +**OSPF router routing table** – includes a list of acquired routes to all accessible ABRs and ASBRs. **OSPF external routing table** – includes a list of acquired routes that are external to the OSPF process. "E" flag points to the external link metric type @@ -599,7 +603,7 @@ the "/" format. This command displays a table of paths to area boundary and autonomous system boundary routers. - + .. opcmd:: show ip ospf database This command displays a summary table with a database contents (LSA). @@ -607,51 +611,51 @@ the "/" format. .. code-block:: none OSPF Router with ID (10.0.13.1) - + Router Link States (Area 0.0.0.0) - + Link ID ADV Router Age Seq# CkSum Link count 10.0.13.1 10.0.13.1 984 0x80000005 0xd915 1 10.0.23.3 10.0.23.3 1186 0x80000008 0xfe62 2 10.0.34.4 10.0.34.4 1063 0x80000004 0x4e3f 1 - + Net Link States (Area 0.0.0.0) - + Link ID ADV Router Age Seq# CkSum 10.0.13.1 10.0.13.1 994 0x80000003 0x30bb 10.0.34.4 10.0.34.4 1188 0x80000001 0x9411 - + Summary Link States (Area 0.0.0.0) - + Link ID ADV Router Age Seq# CkSum Route 10.0.12.0 10.0.23.3 1608 0x80000001 0x6ab6 10.0.12.0/24 10.0.23.0 10.0.23.3 981 0x80000003 0xe232 10.0.23.0/24 - + AS External Link States - + Link ID ADV Router Age Seq# CkSum Route 172.16.0.0 10.0.34.4 1063 0x80000001 0xc40d E2 172.16.0.0/24 [0x0] - + .. opcmd:: show ip ospf database [A.B.C.D] [adv-router |self-originate] This command displays a database contents for a specific link advertisement type. - + The type can be the following: asbr-summary, external, network, nssa-external, opaque-area, opaque-as, opaque-link, router, summary. - + [A.B.C.D] – link-state-id. With this specified the command displays portion of the network environment that is being described by the advertisement. The value entered depends on the advertisement’s LS type. It must be entered in the form of an IP address. - + :cfgcmd:`adv-router ` – router id, which link advertisements need to be reviewed. - + :cfgcmd:`self-originate` displays only self-originated LSAs from the local - router. + router. .. code-block:: none @@ -669,7 +673,7 @@ the "/" format. LS Seq Number: 80000009 Checksum: 0xd119 Length: 36 - + Number of Links: 1 Link connected to: a Transit Network @@ -721,11 +725,15 @@ address and the node 1 sending the default route: set policy route-map CONNECT rule 10 match interface lo +************* OSPFv3 (IPv6) -############# +************* -General Configuration ---------------------- +Configuration +============= + +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. @@ -746,15 +754,15 @@ process starts when the first ospf enabled interface is configured. configured with the same router-ID! -Optional Configuration ----------------------- +Optional +-------- .. cfgcmd:: set protocols ospfv3 distance global This command change distance value of OSPFv3 globally. The distance range is 1 to 255. -.. cfgcmd:: set protocols ospfv3 distance ospfv3 +.. cfgcmd:: set protocols ospfv3 distance ospfv3 This command change distance value of OSPFv3. The arguments are the @@ -762,8 +770,8 @@ Optional Configuration routes respectively. The distance range is 1 to 255. -Areas Configuration -------------------- +Area Configuration +------------------ .. cfgcmd:: set protocols ospfv3 area range @@ -778,8 +786,8 @@ Areas Configuration command makes sense in ABR only. -Interfaces Configuration ------------------------- +Interface Configuration +----------------------- .. cfgcmd:: set interfaces ipv6 ospfv3 cost @@ -810,7 +818,7 @@ Interfaces Configuration Thus, use of this command allows the OSPF adjacency to reach the FULL state even though there is an interface MTU mismatch between two OSPF routers. - + .. cfgcmd:: set interfaces ipv6 ospfv3 network This command allows to specify the distribution type for the network @@ -825,7 +833,7 @@ Interfaces Configuration 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. The interval range is 0 to 255. - + .. cfgcmd:: set interfaces ipv6 ospfv3 passive This command specifies interface as passive. Passive interface advertises @@ -839,7 +847,7 @@ Interfaces Configuration value is used when retransmitting Database Description and Link State Request packets if acknowledge was not received. The default value is 5 seconds. The interval range is 3 to 65535. - + .. cfgcmd:: set interfaces ipv6 ospfv3 transmit-delay @@ -892,7 +900,7 @@ Operational Mode Commands This command displays state and configuration of OSPF the specified interface, or all interfaces if no interface is given. Whith the argument :cfgcmd:`prefix` this command shows connected prefixes to advertise. - + .. opcmd:: show ipv6 ospfv3 route This command displays the OSPF routing table, as determined by the most @@ -902,7 +910,7 @@ Operational Mode Commands This command displays a table of paths to area boundary and autonomous system boundary routers. - + .. opcmd:: show ipv6 ospfv3 database This command displays a summary table with a database contents (LSA). @@ -947,7 +955,7 @@ A typical configuration using 2 nodes. show ipv6 ospfv3 redistribute -.. note:: You cannot easily redistribute IPv6 routes via OSPFv3 on a +.. note:: You cannot easily redistribute IPv6 routes via OSPFv3 on a WireGuard interface link. This requires you to configure link-local addresses manually on the WireGuard interfaces, see :vytask:`T1483`. @@ -994,4 +1002,4 @@ Example configuration for WireGuard interfaces: vyos@ospf02# run sh ipv6 ospfv3 neighbor Neighbor ID Pri DeadTime State/IfState Duration I/F[State] 192.168.0.1 1 00:00:39 Full/PointToPoint 00:19:44 wg01[PointToPoint] - + -- cgit v1.2.3 From c2ebc4a3c9cf5fd240357054288a1da7b827dc5a Mon Sep 17 00:00:00 2001 From: Christian Poessinger Date: Sat, 30 Jan 2021 13:35:32 +0100 Subject: ospf: T3267: move "interface ip ospf" CLI nodes to "protocols ospf" tree --- docs/configuration/protocols/ospf.rst | 27 ++++++++++++++++----------- 1 file changed, 16 insertions(+), 11 deletions(-) (limited to 'docs/configuration/protocols/ospf.rst') diff --git a/docs/configuration/protocols/ospf.rst b/docs/configuration/protocols/ospf.rst index 2c098714..41ab7cac 100644 --- a/docs/configuration/protocols/ospf.rst +++ b/docs/configuration/protocols/ospf.rst @@ -306,7 +306,7 @@ Area Configuration Interface Configuration ----------------------- -.. cfgcmd:: set interfaces ip ospf authentication +.. cfgcmd:: set protocols ospf interface authentication plaintext-password This command sets OSPF authentication key to a simple password. After @@ -315,7 +315,7 @@ Interface Configuration Simple text password authentication is insecure and deprecated in favour of MD5 HMAC authentication. -.. cfgcmd:: set interfaces ip ospf authentication md5 +.. cfgcmd:: set protocols ospf interface authentication md5 key-id md5-key This command specifys that MD5 HMAC authentication must be used on this @@ -325,25 +325,25 @@ Interface Configuration The key can be long up to 16 chars (larger strings will be truncated), and is associated with the given key-id. -.. cfgcmd:: set interfaces ip ospf bandwidth +.. cfgcmd:: set protocols ospf interface bandwidth This command sets the interface bandwidth for cost calculations, where bandwidth can be in range from 1 to 100000, specified in Mbits/s. -.. cfgcmd:: set interfaces ip ospf cost +.. cfgcmd:: set protocols ospf interface cost This command sets link cost for the specified interface. The cost value is set to router-LSA’s metric field and used for SPF calculation. The cost range is 1 to 65535. -.. cfgcmd:: set interfaces ip ospf dead-interval +.. cfgcmd:: set protocols ospf interface dead-interval Set number of seconds for router Dead Interval 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. The interval range is 1 to 65535. -.. cfgcmd:: set interfaces ip ospf hello-interval +.. cfgcmd:: set protocols ospf interface hello-interval Set number of seconds for Hello Interval timer value. Setting this value, Hello packet will be sent every timer value seconds on the specified @@ -351,13 +351,18 @@ Interface Configuration common network. The default value is 10 seconds. The interval range is 1 to 65535. -.. cfgcmd:: set interfaces ip ospf mtu-ignore +.. cfgcmd:: set protocols ospf interface bfd + + This command enables :abbr:`BFD (Bidirectional Forwarding Detection)` on + this OSPF link interface. + +.. cfgcmd:: set protocols ospf interface mtu-ignore This command disables check of the MTU value in the OSPF DBD packets. Thus, use of this command allows the OSPF adjacency to reach the FULL state even though there is an interface MTU mismatch between two OSPF routers. -.. cfgcmd:: set interfaces ip ospf network +.. cfgcmd:: set protocols ospf interface network This command allows to specify the distribution type for the network connected to this interface: @@ -368,14 +373,14 @@ Interface Configuration networks. **point-to-point** – address distribution in point-to-point networks. -.. cfgcmd:: set interfaces ip ospf priority +.. cfgcmd:: set protocols ospf interface priority This command sets Router Priority 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. The interval range is 0 to 255. -.. cfgcmd:: set interfaces ip ospf retransmit-interval +.. cfgcmd:: set protocols ospf interface retransmit-interval This command sets number of seconds for RxmtInterval timer value. This @@ -383,7 +388,7 @@ Interface Configuration Request packets if acknowledge was not received. The default value is 5 seconds. The interval range is 3 to 65535. -.. cfgcmd:: set interfaces ip ospf transmit-delay +.. cfgcmd:: set protocols ospf interface transmit-delay This command sets number of seconds for InfTransDelay value. It allows to set and adjust for each interface the delay interval before starting the -- cgit v1.2.3 From 7fb7ae40f4b8546e34e43269e93d51edd3b25cd4 Mon Sep 17 00:00:00 2001 From: Christian Poessinger Date: Tue, 2 Feb 2021 23:08:33 +0100 Subject: ospf: add hello-multiplier --- docs/configuration/protocols/ospf.rst | 9 +++++++++ 1 file changed, 9 insertions(+) (limited to 'docs/configuration/protocols/ospf.rst') diff --git a/docs/configuration/protocols/ospf.rst b/docs/configuration/protocols/ospf.rst index 41ab7cac..e1957cec 100644 --- a/docs/configuration/protocols/ospf.rst +++ b/docs/configuration/protocols/ospf.rst @@ -343,6 +343,15 @@ Interface Configuration attached to a common network. The default value is 40 seconds. The interval range is 1 to 65535. +.. cfgcmd:: set protocols ospf interface hello-multiplier + + The hello-multiplier specifies how many Hellos to send per second, from 1 + (every second) to 10 (every 100ms). 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. + .. cfgcmd:: set protocols ospf interface hello-interval Set number of seconds for Hello Interval timer value. Setting this value, -- cgit v1.2.3