olsrd.conf(5) | File Formats Manual | olsrd.conf(5) |
olsrd.conf - configuration file for olsrd(8)
The file olsrd.conf Which is located in /etc by default, contains run-time configuration for the Optimized Link State Routing daemon olsrd(8). Olsrd can however be set to read an alternative configuration file at startup using the -f command line argument. A configuration file parser/generator olsrd_cfgparser(2) can be built as both a standalone executable or a dynamically linked library from the olsrd sources. The DLL version can be used to easily create tools for generating/parsing olsrd configuration files.
The configuration file consists of comments, single options and option blocks.
Comments are everything following a # in a line. This data is discarded. Commenting out options is an easy way to make olsrd use the default value for that option.
Single options are single lines options that consists of a keword and a user supplied value. Note that a comment can follow such a option on the same line. Valid single options are:
Option blocks are configuration options that holds a body of sub-options encapsulated in curled braces( {} ). Valid options are:
MaxConnections [0-5] This option specifies how many connections that can exist simoultneously. Multiple connections have not been tested, and does not work! This option should only be used to control wheter or not processes can connect to olsrd by setting it either to 0, which will tell olsrd not to allow any connections, or by setting it to a positive value. Defaults to 0.
Host [IPv4 address]
This option specifies a single host that is allowed to connect to olsrd. By default only the loopback address(127.0.0.1) is set to be allowed. So if you want to be able to connect from another host you should add it here. This option can be repeated to add multiple hosts.
Net [IPv4 netaddress] [IPv4 netmask]
Here you can specify an entire netrange of IP addresses which olsrd will allow TCP connections from. This option can be repeated to add multiple networks.
[IPv4 netaddress] [IPv4 netmask]
Specifies a IPv4 network to announce in HNA messages. Multiple entries can be added. To announce Internet connectivity set 0.0.0.0 0.0.0.0
[IPv6 netaddress] [0-48]
Specifies a IPv6 network to announce in HNA messages. The second value is the prefix-length of the network address. Multiple entries can be added. To announce Internet connectivity set :: 0
PlParam [key] [value]
Sends a pair of parameters to the plugin at initialization. Consult individual plugin documentation to find the possible parameters.
AutoDetectChanges [yes|no]
Olsrd can autodetect changes in interface configurations( polling on the interval set by NicChgsPollInt ). This is Enabled by default but can be turned off pr. NIC to save CPU cycles.
Ip4Broadcast [IPv4 address]
Forces the given IPv4 (broadcast) address to be used as destination address for all outgoing OLSR traffic on the interface. One useful example is the address 255.255.255.255 Another usefule example may be to use the peer (unicast) ip of an ptp tunnel, olsr shall run on. If this option is not set, the broadcast address that the interface is configured with will be used. This address will also be updated in run-time if a change is detected. This feature is only available in linux versions!
Mode ["mesh"|"ether"] olsrd can be used on wireless interfaces and ethernet. To prevent unnecessary packet forwardings on switched ethernet interfaces the mode of an interface can be set to <ether. The default value of this option is mesh.
Ip6AddrType [site-local|global]
This option sets what IPv6 address type is to be used in interface address detection. Defaults to site-local.
Ip6MulticastSite [IPv6 address]
Sets the destionation of outgoing OLSR traffic on this interface to use the specified IPv6 multicast address as destination if the site-local address type is set on this interface.
Ip6MulticastGlobal [IPv6 address]
Sets the destionation of outgoing OLSR traffic on this interface to use the specified IPv6 multicast address as destination if the global address type is set on this interface.
HelloInterval [0.0-]
Sets the interval on which HELLO messages will be generated and transmitted on this interface.
HelloValidityTime [0.0-]
Sets the validity time to be announced in HELLO messages generated by this host on this interface. This value must be larger than than the HELLO generation interval to make any sense. Defaults to 3 * the generation interval.
TcInterval [0.0-]
Sets the interval on which TC messages will be generated and transmitted on this interface.
TcValidityTime [0.0-]
Sets the validity time to be announced in TC messages generated by this host on this interface. This value must be larger than than the TC generation interval to make any sense. Defaults to 3 * the generation interval.
MidInterval [0.0-]
Sets the interval on which MID messages will be generated and transmitted on this interface.
MidValidityTime [0.0-]
Sets the validity time to be announced in MID messages generated by this host on this interface. This value must be larger than than the MID generation interval to make any sense. Defaults to 3 * the generation interval.
HnaInterval [0.0-]
Sets the interval on which HNA messages will be generated and transmitted on this interface.
HnaValidityTime [0.0-]
Sets the validity time to be announced in HNA messages generated by this host on this interface. This value must be larger than than the HNA generation interval to make any sense. Defaults to 3 * the generation interval.
Weight [0-]
When multiple links exist between hosts the weight of the interface is used to determine the link to route by. Normally the weight is automatically calculated by olsrd based on the characteristics of the interface, but here you can specify a fixed value. Olsrd will choose links with the lowest value.
The homepage of olsrd is http://www.olsr.org
/etc/olsrd.conf
Mar 2009 | (C)2004 Andreas Tonnesen |