From e91f6960bae16314e9429719c2c2321edb484a44 Mon Sep 17 00:00:00 2001 From: Ondrej Zajicek Date: Tue, 7 Dec 2010 23:36:48 +0100 Subject: Documentation update (multipath). --- doc/bird.sgml | 47 +++++++++++++++++++++++++++++++++++------------ 1 file changed, 35 insertions(+), 12 deletions(-) (limited to 'doc') diff --git a/doc/bird.sgml b/doc/bird.sgml index 1eaf382..c7816f0 100644 --- a/doc/bird.sgml +++ b/doc/bird.sgml @@ -1525,6 +1525,7 @@ on nonbroadcast networks. protocol ospf <name> { rfc1583compat <switch>; tick <num>; + ecmp <switch> [limit <num>]; area <id> { stub cost <num>; networks { @@ -1550,6 +1551,8 @@ protocol ospf <name> { rx buffer [normal|large|<num>]; type [broadcast|nonbroadcast|pointopoint]; strict nonbroadcast <switch>; + check link <switch>; + ecmp weight <num>; authentication [none|simple|cryptographic]; password "<text>"; password "<text>" { @@ -1583,11 +1586,25 @@ protocol ospf <name> { calculation with RFC 1583. Default value is no. - + + tick num + The routing table calculation and clean-up of areas' databases + is not performed when a single link state + change arrives. To lower the CPU utilization, it's processed later + at periodical intervals of ecmp switch [limit number] + This option specifies whether OSPF is allowed to generate + ECMP (equal-cost multipath) routes. Such routes are used when + there are several directions to the destination, each with + the same (computed) cost. This option also allows to specify + a limit on maximal number of nexthops in one route. By + default, ECMP is disabled. If enabled, default value of the + limit is 16. + area id This defines an OSPF area with given area ID (an integer or an IPv4 - address, similarly to a router ID). - The most important area is + address, similarly to a router ID). The most important area is the backbone (ID 0) to which every other area must be connected. stub cost num @@ -1595,12 +1612,6 @@ protocol ospf <name> { Setting this value marks area stub with defined cost of default route. Default value is no. (Area is not stub.) - tick num - The routing table calculation and clean-up of areas' databases - is not performed when a single link state - change arrives. To lower the CPU utilization, it's processed later - at periodical intervals of networks { Definition of area IP ranges. This is used in summary LSA origination. Hidden networks are not propagated into other areas. @@ -1693,15 +1704,20 @@ protocol ospf <name> { strict nonbroadcast switch If set, don't send hello to any undefined neighbor. This switch - is ignored on any non-NBMA network. Default is No. + is ignored on any non-NBMA network. Default value is no. check link switch - if set, a hardware link state (reported by OS) is taken into + If set, a hardware link state (reported by OS) is taken into consideration. When a link disappears (e.g. an ethernet cable is unplugged), neighbors are immediately considered unreachable and only the address of the iface (instead of whole network prefix) is propagated. It is possible that some hardware - drivers or platforms do not implement this feature. Default: off. + drivers or platforms do not implement this feature. Default value is no. + + ecmp weight num + When ECMP (multipath) routes are allowed, this value specifies + a relative weight used for nexthops going through the iface. + Allowed values are 1-256. Default value is 1. authentication none No passwords are sent in OSPF packets. This is the default value. @@ -2059,6 +2075,9 @@ definition of the protocol contains mainly a list of static routes: route Static route through a neighboring router. + route + Static multipath route. Contains several nexthops (gateways), possibly + with their weights. route Static device route through an interface to hosts on a directly connected network. route Special routes @@ -2082,6 +2101,10 @@ definition of the protocol contains mainly a list of static routes: protocol static { table testable; # Connect to a non-default routing table route 0.0.0.0/0 via 62.168.0.13; # Default route + route 10.0.0.0/8 multipath # Multipath route + via 62.168.0.14 weight 2 + via 62.168.1.10 + via 62.168.1.11; route 62.168.0.0/25 reject; # Sink route route 10.2.0.0/24 via "arc0"; # Secondary network } -- cgit v1.2.3