2 .\" $KAME: rtadvd.conf.5,v 1.49 2003/07/24 21:51:26 jinmei Exp $
4 .\" Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
5 .\" All rights reserved.
7 .\" Redistribution and use in source and binary forms, with or without
8 .\" modification, are permitted provided that the following conditions
10 .\" 1. Redistributions of source code must retain the above copyright
11 .\" notice, this list of conditions and the following disclaimer.
12 .\" 2. Redistributions in binary form must reproduce the above copyright
13 .\" notice, this list of conditions and the following disclaimer in the
14 .\" documentation and/or other materials provided with the distribution.
15 .\" 3. Neither the name of the project nor the names of its contributors
16 .\" may be used to endorse or promote products derived from this software
17 .\" without specific prior written permission.
19 .\" THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
20 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
23 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36 .Nd config file for router advertisement daemon
38 This file describes how the router advertisement packets must be constructed
39 for each of the interfaces.
43 you do not have to set this configuration file up at all,
44 unless you need some special configurations.
45 You may even omit the file as a whole.
48 daemon will automatically configure itself using default values
49 specified in the specification.
54 Each line in the file describes a network interface.
55 Fields are separated by a colon
57 and each field contains one capability description.
58 Lines may be concatenated by the
61 The comment marker is the
65 Capabilities describe the value to be filled into ICMPv6 router
66 advertisement messages and to control
69 Therefore, you are encouraged to read IETF neighbor discovery documents
70 if you would like to modify the sample configuration file.
72 Note that almost all items have default values.
73 If you omit an item, the default value of the item will be used.
75 There are two items which control the interval of sending router advertisements.
76 These items can be omitted, then
78 will use the default values.
79 .Bl -tag -width indent
81 (num) The maximum time allowed between sending unsolicited
82 multicast router advertisements
84 The default value is 600.
85 Its value must be no less than 4 seconds
86 and no greater than 1800 seconds.
88 (num) The minimum time allowed between sending unsolicited multicast
91 The default value is the one third of value of
93 Its value must be no less than 3 seconds and no greater than .75 *
98 The following items are for ICMPv6 router advertisement message
100 These items can be omitted, then
102 will use the default values.
103 .Bl -tag -width indent
105 (num) The value for Cur Hop Limit field.
106 The default value is 64.
108 (str or num) A 8-bit flags field in router advertisement message header.
109 This field can be specified either as a case-sensitive string or as an
111 A sting consists of characters each of which corresponds to a
112 particular flag bit(s).
113 An integer should be the logical OR of all enabled bits.
118 means Managed address configuration flag bit,
123 means Other stateful configuration flag bit.
132 are used to encode router preference.
137 means high, 00 means medium, and 11
142 Bits 10 is reserved, and must not be specified.
143 There is no character to specify the medium preference explicitly.
144 The default value of the entire flag is 0
148 which means no additional
149 configuration methods, and the medium router preference.
151 (num) Router lifetime field
153 The value must be either zero or between
159 runs on a host, this value must explicitly set 0 on all the
160 advertising interfaces as described in
162 The default value is 1800.
164 (num) Reachable time field
165 .Pq unit: milliseconds .
166 The default value is 0, which means unspecified by this router.
168 (num) Retrans Timer field
169 .Pq unit: milliseconds .
170 The default value is 0, which means unspecified by this router.
173 The following items are for ICMPv6 prefix information option,
174 which will be attached to router advertisement header.
175 These items can be omitted, then
177 will automatically get appropriate prefixes from the kernel's routing table,
178 and advertise the prefixes with the default parameters.
181 can be augmented with a number, like
183 to specify multiple prefixes.
184 .Bl -tag -width indent
186 (num) Time skew to adjust link propagation delays and clock skews
187 between routers on the link
189 This value is used in consistency check for locally-configured and
190 advertised prefix lifetimes, and has its meaning when the local router
191 configures a prefix on the link with a lifetime that decrements in
193 If the value is 0, it means the consistency check will be skipped
195 The default value is 0.
197 (num) Prefix length field.
198 The default value is 64.
200 (str or num) A 8-bit flags field in prefix information option.
201 This field can be specified either as a case-sensitive string or as an
203 A sting consists of characters each of which corresponds to a
204 particular flag bit(s).
205 An integer should be the logical OR of all enabled bits.
210 means On-link flag bit,
215 means Autonomous address-configuration flag bit.
216 The default value is "la" or 0xc0, i.e., both bits are set.
218 (str) The address filled into Prefix field.
223 file format as well as IPv6 numeric address, the field MUST be quoted by
224 doublequote character.
226 (num) Valid lifetime field
228 The default value is 2592000 (30 days).
230 (bool) This item means the advertised valid lifetime will decrements
231 in real time, which is disabled by default.
233 (num) Preferred lifetime field
235 The default value is 604800 (7 days).
237 (bool) This item means the advertised preferred lifetime will decrements
238 in real time, which is disabled by default.
241 The following item is for ICMPv6 MTU option,
242 which will be attached to router advertisement header.
243 This item can be omitted, then
245 will use the default value.
246 .Bl -tag -width indent
248 (num or str) MTU (maximum transmission unit) field.
249 If 0 is specified, it means that the option will not be included.
250 The default value is 0.
251 If the special string
253 is specified for this item, MTU option will be included and its value
254 will be set to the interface MTU automatically.
257 The following item controls ICMPv6 source link-layer address option,
258 which will be attached to router advertisement header.
259 As noted above, you can just omit the item, then
261 will use the default value.
262 .Bl -tag -width indent
271 will try to get link-layer address for the interface from the kernel,
272 and attach that in source link-layer address option.
273 If this capability exists,
275 will not attach source link-layer address option to
276 router advertisement packets.
279 The following item controls ICMPv6 home agent information option,
280 which was defined with mobile IPv6 support.
281 It will be attached to router advertisement header just like other options do.
282 .Bl -tag -width indent
284 (num) Specifies home agent preference.
287 must be present as well.
289 (num) Specifies home agent lifetime.
292 When mobile IPv6 support is turned on for
294 advertisement interval option will be attached to router advertisement
295 packet, by configuring
299 The following items are for ICMPv6 route information option,
300 which will be attached to router advertisement header.
301 These items are optional.
302 Each items can be augmented with number, like
304 to specify multiple routes.
305 .Bl -tag -width indent
307 (str) The prefix filled into the Prefix field of route information option.
312 file format as well as IPv6 numeric address, the field MUST be quoted by
313 doublequote character.
315 (num) Prefix length field in route information option.
316 The default value is 64.
318 (str or num) A 8-bit flags field in route information option.
319 Currently only the preference values are defined.
320 The notation is same as that of the raflags field.
330 are used to encode the route preference for the route.
331 The default value is 0x00, i.e., medium preference.
333 (num) route lifetime field in route information option.
335 Since the specification does not define the default value of this
336 item, the value for this item should be specified by hand.
339 allows this item to be unspecified, and uses the router lifetime
340 as the default value in such a case, just for compatibility with an
341 old version of the program.
344 In the above list, each keyword beginning with
346 could be replaced with the one beginning with
348 for backward compatibility reason.
351 is accepted instead of
353 However, keywords that start with
355 have basically been obsoleted, and should not be used any more.
357 You can also refer one line from another by using
362 for details on the capability.
364 As presented above, all of the advertised parameters have default values
365 defined in specifications, and hence you usually do not have to set them
366 by hand, unless you need special non-default values.
367 It can cause interoperability problem if you use an ill-configured
370 To override a configuration parameter, you can specify the parameter alone.
371 With the following configuration,
373 overrides the router lifetime parameter for the
381 The following example manually configures prefixes advertised from the
384 The configuration must be used with the
390 :addr="3ffe:501:ffff:1000::":prefixlen#64:
393 The following example presents the default values in an explicit manner.
394 The configuration is provided just for reference purposes;
395 YOU DO NOT NEED TO HAVE IT AT ALL.
398 :chlim#64:raflags#0:rltime#1800:rtime#0:retrans#0:\\
399 :pinfoflags="la":vltime#2592000:pltime#604800:mtu#0:
401 :addr="3ffe:501:ffff:1000::":prefixlen#64:tc=default:
411 .%T Neighbor Discovery for IP version 6 (IPv6)
416 .%T Default Router Preferences and More-Specific Routes
417 .%R draft-ietf-ipngwg-router-selection-xx.txt
422 and the configuration file
424 first appeared in WIDE Hydrangea IPv6 protocol stack kit.