1.\" $FreeBSD$ 2.\" $KAME: rtadvd.conf.5,v 1.49 2003/07/24 21:51:26 jinmei Exp $ 3.\" 4.\" Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project. 5.\" All rights reserved. 6.\" 7.\" Redistribution and use in source and binary forms, with or without 8.\" modification, are permitted provided that the following conditions 9.\" are met: 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. 18.\" 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 29.\" SUCH DAMAGE. 30.\" 31.Dd May 17, 1998 32.Dt RTADVD.CONF 5 33.Os 34.Sh NAME 35.Nm rtadvd.conf 36.Nd config file for router advertisement daemon 37.Sh DESCRIPTION 38This file describes how the router advertisement packets must be constructed 39for each of the interfaces. 40.Pp 41As described in 42.Xr rtadvd 8 , 43you do not have to set this configuration file up at all, 44unless you need some special configurations. 45You may even omit the file as a whole. 46In such cases, the 47.Nm rtadvd 48daemon will automatically configure itself using default values 49specified in the specification. 50.Pp 51It obeys the famous 52.Xr termcap 5 53file format. 54Each line in the file describes a network interface. 55Fields are separated by a colon 56.Pq Sq \&: , 57and each field contains one capability description. 58Lines may be concatenated by the 59.Sq \e 60character. 61The comment marker is the 62.Sq \&# 63character. 64.Sh CAPABILITIES 65Capabilities describe the value to be filled into ICMPv6 router 66advertisement messages and to control 67.Xr rtadvd 8 68behavior. 69Therefore, you are encouraged to read IETF neighbor discovery documents 70if you would like to modify the sample configuration file. 71.Pp 72Note that almost all items have default values. 73If you omit an item, the default value of the item will be used. 74.Pp 75There are two items which control the interval of sending router advertisements. 76These items can be omitted, then 77.Nm rtadvd 78will use the default values. 79.Bl -tag -width indent 80.It Cm \&maxinterval 81(num) The maximum time allowed between sending unsolicited 82multicast router advertisements 83.Pq unit: seconds . 84The default value is 600. 85Its value must be no less than 4 seconds 86and no greater than 1800 seconds. 87.It Cm \&mininterval 88(num) The minimum time allowed between sending unsolicited multicast 89router advertisements 90.Pq unit: seconds . 91The default value is the one third of value of 92.Cm maxinterval . 93Its value must be no less than 3 seconds and no greater than .75 * 94the value of 95.Cm maxinterval . 96.El 97.Pp 98The following items are for ICMPv6 router advertisement message 99header. 100These items can be omitted, then 101.Nm rtadvd 102will use the default values. 103.Bl -tag -width indent 104.It Cm \&chlim 105(num) The value for Cur Hop Limit field. 106The default value is 64. 107.It Cm \&raflags 108(str or num) A 8-bit flags field in router advertisement message header. 109This field can be specified either as a case-sensitive string or as an 110integer. 111A sting consists of characters each of which corresponds to a 112particular flag bit(s). 113An integer should be the logical OR of all enabled bits. 114Bit 7 115.Po 116.Li 'm' or 0x80 117.Pc 118means Managed address configuration flag bit, 119and Bit 6 120.Po 121.Li 'o' or 0x40 122.Pc 123means Other stateful configuration flag bit. 124Bit 4 125.Po 126.Li 0x10 127.Pc 128and Bit 3 129.Po 130.Li 0x08 131.Pc 132are used to encode router preference. 133Bits 01 134.Po 135or 'h' 136.Pc 137means high, 00 means medium, and 11 138.Po 139or 'l' 140.Pc 141means low. 142Bits 10 is reserved, and must not be specified. 143There is no character to specify the medium preference explicitly. 144The default value of the entire flag is 0 145.Po 146or a null string, 147.Pc 148which means no additional 149configuration methods, and the medium router preference. 150.It Cm \&rltime 151(num) Router lifetime field 152.Pq unit: seconds . 153The value must be either zero or between 154the value of 155.Cm maxinterval 156and 9000. 157When 158.Nm rtadvd 159runs on a host, this value must explicitly set 0 on all the 160advertising interfaces as described in 161.Xr rtadvd 8 . 162The default value is 1800. 163.It Cm \&rtime 164(num) Reachable time field 165.Pq unit: milliseconds . 166The default value is 0, which means unspecified by this router. 167.It Cm \&retrans 168(num) Retrans Timer field 169.Pq unit: milliseconds . 170The default value is 0, which means unspecified by this router. 171.El 172.Pp 173The following items are for ICMPv6 prefix information option, 174which will be attached to router advertisement header. 175These items can be omitted, then 176.Nm rtadvd 177will automatically get appropriate prefixes from the kernel's routing table, 178and advertise the prefixes with the default parameters. 179Keywords other than 180.Cm clockskew 181can be augmented with a number, like 182.Dq Li prefix2 , 183to specify multiple prefixes. 184.Bl -tag -width indent 185.It Cm \&clockskew 186(num) Time skew to adjust link propagation delays and clock skews 187between routers on the link 188.Pq unit: seconds . 189This value is used in consistency check for locally-configured and 190advertised prefix lifetimes, and has its meaning when the local router 191configures a prefix on the link with a lifetime that decrements in 192real time. 193If the value is 0, it means the consistency check will be skipped 194for such prefixes. 195The default value is 0. 196.It Cm \&prefixlen 197(num) Prefix length field. 198The default value is 64. 199.It Cm \&pinfoflags 200(str or num) A 8-bit flags field in prefix information option. 201This field can be specified either as a case-sensitive string or as an 202integer. 203A sting consists of characters each of which corresponds to a 204particular flag bit(s). 205An integer should be the logical OR of all enabled bits. 206Bit 7 207.Po 208.Li 'l' or 0x80 209.Pc 210means On-link flag bit, 211and Bit 6 212.Po 213.Li 'a' or 0x40 214.Pc 215means Autonomous address-configuration flag bit. 216The default value is "la" or 0xc0, i.e., both bits are set. 217.It Cm \&addr 218(str) The address filled into Prefix field. 219Since 220.Dq \&: 221is used for 222.Xr termcap 5 223file format as well as IPv6 numeric address, the field MUST be quoted by 224doublequote character. 225.It Cm \&vltime 226(num) Valid lifetime field 227.Pq unit: seconds . 228The default value is 2592000 (30 days). 229.It Cm \&vltimedecr 230(bool) This item means the advertised valid lifetime will decrements 231in real time, which is disabled by default. 232.It Cm \&pltime 233(num) Preferred lifetime field 234.Pq unit: seconds . 235The default value is 604800 (7 days). 236.It Cm \&pltimedecr 237(bool) This item means the advertised preferred lifetime will decrements 238in real time, which is disabled by default. 239.El 240.Pp 241The following item is for ICMPv6 MTU option, 242which will be attached to router advertisement header. 243This item can be omitted, then 244.Nm rtadvd 245will use the default value. 246.Bl -tag -width indent 247.It Cm \&mtu 248(num or str) MTU (maximum transmission unit) field. 249If 0 is specified, it means that the option will not be included. 250The default value is 0. 251If the special string 252.Dq auto 253is specified for this item, MTU option will be included and its value 254will be set to the interface MTU automatically. 255.El 256.Pp 257The following item controls ICMPv6 source link-layer address option, 258which will be attached to router advertisement header. 259As noted above, you can just omit the item, then 260.Nm rtadvd 261will use the default value. 262.Bl -tag -width indent 263.It Cm \&nolladdr 264(bool) By default 265.Po 266if 267.Cm \&nolladdr 268is not specified 269.Pc , 270.Xr rtadvd 8 271will try to get link-layer address for the interface from the kernel, 272and attach that in source link-layer address option. 273If this capability exists, 274.Xr rtadvd 8 275will not attach source link-layer address option to 276router advertisement packets. 277.El 278.Pp 279The following item controls ICMPv6 home agent information option, 280which was defined with mobile IPv6 support. 281It will be attached to router advertisement header just like other options do. 282.Bl -tag -width indent 283.It Cm \&hapref 284(num) Specifies home agent preference. 285If set to non-zero, 286.Cm \&hatime 287must be present as well. 288.It Cm \&hatime 289(num) Specifies home agent lifetime. 290.El 291.Pp 292When mobile IPv6 support is turned on for 293.Xr rtadvd 8 , 294advertisement interval option will be attached to router advertisement 295packet, by configuring 296.Cm \&maxinterval 297explicitly. 298.Pp 299The following items are for ICMPv6 route information option, 300which will be attached to router advertisement header. 301These items are optional. 302Each items can be augmented with number, like 303.Dq Li rtplen2 , 304to specify multiple routes. 305.Bl -tag -width indent 306.It Cm \&rtprefix 307(str) The prefix filled into the Prefix field of route information option. 308Since 309.Dq \&: 310is used for 311.Xr termcap 5 312file format as well as IPv6 numeric address, the field MUST be quoted by 313doublequote character. 314.It Cm \&rtplen 315(num) Prefix length field in route information option. 316The default value is 64. 317.It Cm \&rtflags 318(str or num) A 8-bit flags field in route information option. 319Currently only the preference values are defined. 320The notation is same as that of the raflags field. 321Bit 4 322.Po 323.Li 0x10 324.Pc 325and 326Bit 3 327.Po 328.Li 0x08 329.Pc 330are used to encode the route preference for the route. 331The default value is 0x00, i.e. medium preference. 332.It Cm \&rtltime 333(num) route lifetime field in route information option. 334.Pq unit: seconds . 335Since the specification does not define the default value of this 336item, the value for this item should be specified by hand. 337However, 338.Nm rtadvd 339allows this item to be unspecified, and uses the router lifetime 340as the default value in such a case, just for compatibility with an 341old version of the program. 342.El 343.Pp 344In the above list, each keyword beginning with 345.Dq Li rt 346could be replaced with the one beginning with 347.Dq Li rtr 348for backward compatibility reason. 349For example, 350.Cm rtrplen 351is accepted instead of 352.Cm rtplen . 353However, keywords that start with 354.Dq Li rtr 355have basically been obsoleted, and should not be used any more. 356.Pp 357You can also refer one line from another by using 358.Cm tc 359capability. 360See 361.Xr termcap 5 362for details on the capability. 363.Sh EXAMPLES 364As presented above, all of the advertised parameters have default values 365defined in specifications, and hence you usually do not have to set them 366by hand, unless you need special non-default values. 367It can cause interoperability problem if you use an ill-configured 368parameter. 369.Pp 370To override a configuration parameter, you can specify the parameter alone. 371With the following configuration, 372.Xr rtadvd 8 373overrides the router lifetime parameter for the 374.Li ne0 375interface. 376.Bd -literal -offset 377ne0:\\ 378 :rltime#0: 379.Ed 380.Pp 381The following example manually configures prefixes advertised from the 382.Li ef0 383interface. 384The configuration must be used with the 385.Fl s 386option to 387.Xr rtadvd 8 . 388.Bd -literal -offset 389ef0:\\ 390 :addr="3ffe:501:ffff:1000::":prefixlen#64: 391.Ed 392.Pp 393The following example presents the default values in an explicit manner. 394The configuration is provided just for reference purposes; 395YOU DO NOT NEED TO HAVE IT AT ALL. 396.Bd -literal -offset 397default:\\ 398 :chlim#64:raflags#0:rltime#1800:rtime#0:retrans#0:\\ 399 :pinfoflags="la":vltime#2592000:pltime#604800:mtu#0: 400ef0:\\ 401 :addr="3ffe:501:ffff:1000::":prefixlen#64:tc=default: 402.Ed 403.Sh SEE ALSO 404.Xr termcap 5 , 405.Xr rtadvd 8 , 406.Xr rtsol 8 407.Pp 408Thomas Narten, Erik Nordmark and W. A. Simpson, 409.Do 410Neighbor Discovery for IP version 6 (IPv6) 411.Dc , 412RFC 2461 413.Pp 414Richard Draves, 415.Do 416Default Router Preferences and More-Specific Routes 417.Dc , 418draft-ietf-ipngwg-router-selection-xx.txt 419.Sh HISTORY 420The 421.Xr rtadvd 8 422and the configuration file 423.Nm 424first appeared in WIDE Hydrangea IPv6 protocol stack kit. 425.\" .Sh BUGS 426.\" (to be written) 427