quagga plugin routes additional
[olsrd.git] / lib / quagga / README_QUAGGA
1 ---------------------------------------------------------------------
2 QUAGGA PLUGIN FOR OLSRD
3 by Immo 'FaUl' Wehrenberg <immo@chaostreff-dortmund.de>
4
5 addittions by:  Sven-Ola Tuecke <sven-ola-aet-gmx.de>
6                 Vasilis Tsiligiannis <acinonyxs@yahoo.gr>
7 ---------------------------------------------------------------------
8
9 This is the Quagga Plugin for OLSRd. 
10 It allows olsrd to redistribute from various quagga-protocols 
11 as well as to export olsr-routes to quagga so that they can be
12 redistributed by the quagga-routing-daemons.
13
14 You also need a source distribution of quagga-0.98.6 or quagga-0.99.21.
15 The quagga source tree needs to be patched with quagga-0.98.6.diff or
16 quagga-0.99.21.diff, respectively, compiled and installed via
17 'make install'.
18
19 ---------------------------------------------------------------------
20 PLUGIN PARAMETERS (PlParam)
21 ---------------------------------------------------------------------
22
23 PlParam "Redistribute" "<protocol>"
24         where protocol is one of the following:
25         system, kernel, connect, static, rip, ripng, ospf, ospf6,
26         isis, bgp, hsls
27         May be used more then once
28
29 PlParam "ExportRoutes" "<only/additional>"
30         exports olsr-routes to quagga only, or to quagga and kernel
31         no routes are exported to quagga (normal behaviour) if not set.
32
33 PlParam "LocalPref" "<true/false>"
34         sets the Zebra SELECTED-flag on the routes exported to zebra
35         which means these routes are prefered in any case.
36
37 PlParam "Distance" "0-255"
38         allows to set the administrative distance to routes exported 
39         to zebra.
40
41 PlParam "SockPath" "<path>"
42         sets the path to zebra socket
43         defaults to "/var/run/quagga/zserv.api" if not set.
44
45 PlParam "Port" "<port>"
46         sets the port on which zebra is listening
47         overrides 'SockPath' parameter if set.
48
49 PlParam "Version" "<version>"
50         sets the version of packet format to communicate with zebra.
51         use:
52            "0" for Quagga 0.98.x
53            "1" for Quagga 0.99.17 up to 0.99.20.1
54            "2" for Quagga 0.99.21 and above
55         defaults to "0".
56
57 ---------------------------------------------------------------------
58 SAMPLE CONFIG
59 ---------------------------------------------------------------------
60
61 add in /usr/local/etc/olsrd.conf:
62
63 LoadPlugin "olsrd_quagga.so.0.2.2"
64 {
65         PlParam "Redistribute" "ospf"
66         PlParam "Redistribute" "bgp"
67         PlParam "ExportRoutes" "only"
68         PlParam "Distance" "125" 
69         PlParam "LocalPref" "false"
70         PlParam "SockPath" "/var/run/zserv.api"
71         PlParam "Version" "2"
72 }
73
74
75 ---------------------------------------------------------------------
76 EOF / 31.05.2012