Configuration File Format » History » Version 10
A K M Mahmudul Hoque, 05/05/2014 12:01 PM
1 | 1 | A K M Mahmudul Hoque | ## Configuration File Format |
---|---|---|---|
2 | |||
3 | NLSR is configured using an [INFO file](http://www.boost.org/doc/libs/1_42_0/doc/html/boost_propertytree/parsers.html#boost_propertytree.parsers.info_parser). |
||
4 | |||
5 | ## Example configuration |
||
6 | |||
7 | ; the router section contains the setting of network, site name |
||
8 | ; and router name which all together makes router-prefix |
||
9 | |||
10 | router |
||
11 | { |
||
12 | 9 | A K M Mahmudul Hoque | ; mandatory configuration command section |
13 | 8 | A K M Mahmudul Hoque | |
14 | 9 | A K M Mahmudul Hoque | network /ndn ; name of the network the router belongs to in ndn URI format |
15 | site /memphis.edu ; name of the site the router belongs to in ndn URI format |
||
16 | router /cs/pollux ; name of the network the router belongs to in ndn URI format |
||
17 | 1 | A K M Mahmudul Hoque | } |
18 | |||
19 | ; the hello section describes the configuration settings for NLSR hello protocol |
||
20 | |||
21 | hello |
||
22 | { |
||
23 | 9 | A K M Mahmudul Hoque | ; in case hello interest timed out, router will try 'retrials' times at 'interval' seconds |
24 | ; interval before giving up for any neighbors (deciding link is down) |
||
25 | |||
26 | retrials 3 ; interest retry number in integer. Default value 3 |
||
27 | ; valid values 1-10 |
||
28 | |||
29 | interval ; interest sending interval in seconds. Default value 1 |
||
30 | ; valid values 1-15 |
||
31 | |||
32 | ; neighbor command is used to configure router's neighbor. Each neighbor will need |
||
33 | 1 | A K M Mahmudul Hoque | ; one block of neighbor command |
34 | |||
35 | 9 | A K M Mahmudul Hoque | neighbor |
36 | 1 | A K M Mahmudul Hoque | { |
37 | name /ndn/memphis.edu/cs/castor ; name prefix of the neighbor router consists |
||
38 | ; of network, site-name and router-name |
||
39 | |||
40 | host cs.castor.memphis.edu ; hostname or ip address of neighbor router |
||
41 | link-cost 20.6 ; cost of the connecting link to neighbor |
||
42 | } |
||
43 | } |
||
44 | |||
45 | ; the synchronization section contains all the configuration settings for router's update |
||
46 | ; synchronization with neighbors in the network |
||
47 | |||
48 | synchronization |
||
49 | { |
||
50 | ; all routers in the network must have same sync-prefix. Routers synchronizes routing updates |
||
51 | ; in this prefix across the network. This prefix is routable to each neighbor from every router |
||
52 | |||
53 | 9 | A K M Mahmudul Hoque | sync-prefix /ndn/nlsr/sync ; name in URI format. Default value /ndn/nlsr/sync |
54 | 2 | A K M Mahmudul Hoque | |
55 | 1 | A K M Mahmudul Hoque | ; lsa-refresh-time is the time in seconds, after which router will refresh its LSAs |
56 | |||
57 | 9 | A K M Mahmudul Hoque | lsa-refresh-time 1800 ; default value 1800. Valid values 240-7200 |
58 | 2 | A K M Mahmudul Hoque | } |
59 | |||
60 | 1 | A K M Mahmudul Hoque | ; the hyperbolic section contains the configuration settings of enabling a router to calculate |
61 | 3 | A K M Mahmudul Hoque | ; routing table using [hyperbolic routing table calculation](http://arxiv.org/abs/0805.1266) method |
62 | |||
63 | hyperbolic |
||
64 | { |
||
65 | 9 | A K M Mahmudul Hoque | ; commands in this section follows a strict order |
66 | 2 | A K M Mahmudul Hoque | ; the switch is used to set hyperbolic routing calculation in NLSR |
67 | 1 | A K M Mahmudul Hoque | |
68 | 9 | A K M Mahmudul Hoque | state off ; default value 'off', set value 'on' to enable hyperbolic routing table |
69 | 4 | A K M Mahmudul Hoque | ; calculation which turns link state routing 'off'. set value to 'dry-run" |
70 | 9 | A K M Mahmudul Hoque | ; to test hyperbolic routing and compare with link state routing. |
71 | |||
72 | 1 | A K M Mahmudul Hoque | |
73 | 9 | A K M Mahmudul Hoque | radius 123.456 ; radius of the router in hyperbolic coordinate system |
74 | angle 1.45 ; angle of the router in hyperbolic coordinate system |
||
75 | 5 | A K M Mahmudul Hoque | } |
76 | 1 | A K M Mahmudul Hoque | |
77 | 9 | A K M Mahmudul Hoque | |
78 | 6 | A K M Mahmudul Hoque | ; the fib section is used to configure fib entry's type to ndn FIB updated by NLSR |
79 | |||
80 | fib |
||
81 | 1 | A K M Mahmudul Hoque | { |
82 | 6 | A K M Mahmudul Hoque | ; the tunnel configuration is used to set the tunnel type of the FIB entries by NLSR |
83 | 1 | A K M Mahmudul Hoque | |
84 | 9 | A K M Mahmudul Hoque | tunnel-type udp ; default tunnel type is 'udp', set value to 'tcp' for TCP tunnel |
85 | |||
86 | 6 | A K M Mahmudul Hoque | |
87 | ; the max-faces-per-prefix is used to limit the number of faces for each name prefixes |
||
88 | ; by NLSR in ndn FIB |
||
89 | 5 | A K M Mahmudul Hoque | |
90 | 9 | A K M Mahmudul Hoque | max-faces-per-prefix 3 ; default value 0. Valid value 0-60. By default (value 0) NLSR adds |
91 | ; all available faces for each reachable name prefixes in NDN FIB |
||
92 | |||
93 | 7 | A K M Mahmudul Hoque | } |
94 | |||
95 | ; the advertising section contains the configuration settings of the name prefixes |
||
96 | ; hosted by this router |
||
97 | |||
98 | advertising |
||
99 | { |
||
100 | ; the ndnname is used to advertised name from the router. To advertise each name prefix |
||
101 | ; configure one block of ndnname configuration command for every name prefix. |
||
102 | |||
103 | 10 | A K M Mahmudul Hoque | prefix /ndn/edu/memphis/cs/netlab ; name in ndn URI format |
104 | prefix /ndn/edu/memphis/sports/basketball |
||
105 | 5 | A K M Mahmudul Hoque | } |