Project

General

Profile

Configuration File Format » History » Version 16

A K M Mahmudul Hoque, 05/07/2014 12:54 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 16 A K M Mahmudul Hoque
    ; the general section contains all the general settings for router
8
9
    general
10
    {
11
    ; lsa-refresh-time is the time in seconds, after which router will refresh its LSAs
12 1 A K M Mahmudul Hoque
    
13 16 A K M Mahmudul Hoque
        lsa-refresh-time 1800      ; default value 1800. Valid values 240-7200
14
15
    ; log-level is to set the levels of log for NLSR
16
17
        log-level  INFO            ; default value INFO, valid value DEBUG, INFO
18
    }
19
20
    ; the router section contains the configuration setting of network, site name 
21
    ; and router. Router prefix is built by concatenating them as 
22
    ; /<network>/<site>/<router>
23
    
24 9 A K M Mahmudul Hoque
    router
25 8 A K M Mahmudul Hoque
    {
26 9 A K M Mahmudul Hoque
    ; mandatory configuration command section
27
    
28
        network /ndn         ; name of the network the router belongs to in ndn URI format
29 1 A K M Mahmudul Hoque
        site /memphis.edu    ; name of the site the router belongs to in ndn URI format
30
        router /cs/pollux    ; name of the network the router belongs to in ndn URI format
31
    }
32
33
    ; the hello section describes the configuration settings for NLSR hello protocol
34
    
35
    hello
36
    {
37 16 A K M Mahmudul Hoque
    ; in case hello interest timed out, router will try 'retries' times at 'interval' seconds
38 9 A K M Mahmudul Hoque
    ; interval before giving up for any neighbors (deciding link is down)     
39
40 16 A K M Mahmudul Hoque
       retries 3                           ; interest retries number in integer. Default value 3
41 1 A K M Mahmudul Hoque
                                           ; valid values 1-10
42 9 A K M Mahmudul Hoque
43 1 A K M Mahmudul Hoque
       interval  1                         ; interest sending interval in seconds. Default value 1
44
                                           ; valid values 1-15
45 16 A K M Mahmudul Hoque
    }
46 1 A K M Mahmudul Hoque
47 16 A K M Mahmudul Hoque
    ; the neighbors section contains the configuration for router's neighbors
48
49
    neighbors
50
    {
51 9 A K M Mahmudul Hoque
    ; neighbor command is used to configure router's neighbor. Each neighbor will need
52 1 A K M Mahmudul Hoque
    ; one block of neighbor command
53
    
54 9 A K M Mahmudul Hoque
       neighbor
55 1 A K M Mahmudul Hoque
       {
56 12 A K M Mahmudul Hoque
           name /ndn/memphis.edu/cs/castor        ; name prefix of the neighbor router consists
57
                                                  ; of network, site-name and router-name
58 1 A K M Mahmudul Hoque
           
59 12 A K M Mahmudul Hoque
           face-uri  udp://castor.cs.memphis.edu  ; face id of the face connected to the neighbor
60
           link-cost 20.6                         ; cost of the connecting link to neighbor
61 1 A K M Mahmudul Hoque
       }
62
    }
63
64
    ; the hyperbolic section contains the configuration settings of enabling a router to calculate
65 3 A K M Mahmudul Hoque
    ; routing table using [hyperbolic routing table calculation](http://arxiv.org/abs/0805.1266) method
66
67
    hyperbolic
68
    {
69 9 A K M Mahmudul Hoque
    ; commands in this section follows a strict order
70 2 A K M Mahmudul Hoque
    ; the switch is used to set hyperbolic routing calculation in NLSR
71 1 A K M Mahmudul Hoque
72 9 A K M Mahmudul Hoque
        state off              ; default value 'off', set value 'on' to enable hyperbolic routing table 
73 4 A K M Mahmudul Hoque
                               ; calculation which turns link state routing 'off'. set value to 'dry-run"
74 9 A K M Mahmudul Hoque
                               ; to test hyperbolic routing and compare with link state routing.
75
     
76 1 A K M Mahmudul Hoque
77 9 A K M Mahmudul Hoque
        radius   123.456       ; radius of the router in hyperbolic coordinate system
78
        angle    1.45          ; angle of the router in hyperbolic coordinate system
79 5 A K M Mahmudul Hoque
    }
80 1 A K M Mahmudul Hoque
81
82
    ; the fib section is used to configure fib entry's type to ndn FIB updated by NLSR
83
84
    fib
85
    {
86
    ; the max-faces-per-prefix is used to limit the number of faces for each name prefixes
87
    ; by NLSR in ndn FIB
88
    
89
        max-faces-per-prefix 3   ; default value 0. Valid value 0-60. By default (value 0) NLSR adds
90
                                 ; all available faces for each reachable name prefixes in NDN FIB
91 14 A K M Mahmudul Hoque
     
92
    }
93 15 A K M Mahmudul Hoque
94 14 A K M Mahmudul Hoque
    ; the advertising section contains the configuration settings of the name prefixes 
95
    ; hosted by this router
96
97
    advertising
98
    {
99
    ; the ndnname is used to advertised name from the router. To advertise each name prefix
100
    ; configure one block of ndnname configuration command for every name prefix.
101
    
102
        prefix /ndn/edu/memphis/cs/netlab           ; name in ndn URI format
103
        prefix /ndn/edu/memphis/sports/basketball 
104 5 A K M Mahmudul Hoque
    }