Project

General

Profile

Configuration File Format » History » Version 15

A K M Mahmudul Hoque, 05/07/2014 07:52 AM

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 12 A K M Mahmudul Hoque
       interval  1                         ; interest sending interval in seconds. Default value 1
30 9 A K M Mahmudul Hoque
                                           ; 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 12 A K M Mahmudul Hoque
           name /ndn/memphis.edu/cs/castor        ; name prefix of the neighbor router consists
38
                                                  ; of network, site-name and router-name
39 1 A K M Mahmudul Hoque
           
40 12 A K M Mahmudul Hoque
           face-uri  udp://castor.cs.memphis.edu  ; face id of the face connected to the neighbor
41
           link-cost 20.6                         ; cost of the connecting link to neighbor
42 1 A K M Mahmudul Hoque
       }
43
    }
44
45
    ; the hyperbolic section contains the configuration settings of enabling a router to calculate
46 3 A K M Mahmudul Hoque
    ; routing table using [hyperbolic routing table calculation](http://arxiv.org/abs/0805.1266) method
47
48
    hyperbolic
49
    {
50 9 A K M Mahmudul Hoque
    ; commands in this section follows a strict order
51 2 A K M Mahmudul Hoque
    ; the switch is used to set hyperbolic routing calculation in NLSR
52 1 A K M Mahmudul Hoque
53 9 A K M Mahmudul Hoque
        state off              ; default value 'off', set value 'on' to enable hyperbolic routing table 
54 4 A K M Mahmudul Hoque
                               ; calculation which turns link state routing 'off'. set value to 'dry-run"
55 9 A K M Mahmudul Hoque
                               ; to test hyperbolic routing and compare with link state routing.
56
     
57 1 A K M Mahmudul Hoque
58 9 A K M Mahmudul Hoque
        radius   123.456       ; radius of the router in hyperbolic coordinate system
59
        angle    1.45          ; angle of the router in hyperbolic coordinate system
60 5 A K M Mahmudul Hoque
    }
61 1 A K M Mahmudul Hoque
62 9 A K M Mahmudul Hoque
63 6 A K M Mahmudul Hoque
    ; the fib section is used to configure fib entry's type to ndn FIB updated by NLSR
64
65
    fib
66 1 A K M Mahmudul Hoque
    {
67 6 A K M Mahmudul Hoque
    ; the max-faces-per-prefix is used to limit the number of faces for each name prefixes
68
    ; by NLSR in ndn FIB
69 5 A K M Mahmudul Hoque
    
70 9 A K M Mahmudul Hoque
        max-faces-per-prefix 3   ; default value 0. Valid value 0-60. By default (value 0) NLSR adds
71
                                 ; all available faces for each reachable name prefixes in NDN FIB
72
     
73 7 A K M Mahmudul Hoque
    }
74
75 1 A K M Mahmudul Hoque
    ; the advertising section contains the configuration settings of the name prefixes 
76
    ; hosted by this router
77
78
    advertising
79
    {
80
    ; the ndnname is used to advertised name from the router. To advertise each name prefix
81
    ; configure one block of ndnname configuration command for every name prefix.
82
    
83
        prefix /ndn/edu/memphis/cs/netlab           ; name in ndn URI format
84
        prefix /ndn/edu/memphis/sports/basketball 
85 14 A K M Mahmudul Hoque
    }
86
87 15 A K M Mahmudul Hoque
    ; the general section contains all the general settings for router
88 14 A K M Mahmudul Hoque
89
    general
90
    {
91
    ; lsa-refresh-time is the time in seconds, after which router will refresh its LSAs
92
    
93
        lsa-refresh-time 1800      ; default value 1800. Valid values 240-7200
94
95
    ; log-level is to set the levels of log for NLSR
96
97
        log-level  INFO            ; default value INFO, valid value DEBUG, INFO
98 5 A K M Mahmudul Hoque
    }