1.\" $FreeBSD$ 2.\" $KAME: rtadvd.conf.5,v 1.35 2001/05/25 07:40:22 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.Pp 65.Sh CAPABILITIES 66Capabilities describe the value to be filled into ICMPv6 router 67advertisement messages and to control 68.Xr rtadvd 8 69behavior. 70Therefore, you are encouraged to read IETF neighbor discovery documents 71if you would like to modify the sample configuration file. 72.Pp 73Note that almost all items have default values. 74If you omit an item, the default value of the item will be used. 75.Pp 76There are two items which control the interval of sending router advertisements. 77These items can be omitted, then 78.Nm rtadvd 79will use the default values. 80.Bl -tag -width indent 81.It Cm \&maxinterval 82(num) The maximum time allowed between sending unsolicited 83multicast router advertisements 84.Pq unit: seconds . 85The default value is 600. 86Its value must be no less than 4 seconds 87and no greater than 1800 seconds. 88.It Cm \&mininterval 89(num) The minimum time allowed between sending unsolicited multicast 90router advertisements 91.Pq unit: seconds . 92The default value is the one third of value of 93.Cm maxinterval . 94Its value must be no less than 3 seconds and no greater than .75 * 95the value of 96.Cm maxinterval . 97.El 98.Pp 99The following items are for ICMPv6 router advertisement message 100header. 101These items can be omitted, then 102.Nm rtadvd 103will use the default values. 104.Bl -tag -width indent 105.It Cm \&chlim 106(num) The value for Cur Hop Limit field. 107The default value is 64. 108.It Cm \&raflags 109(num) Flags field in router advertisement message header. 110Bit 7 111.Po 112.Li 0x80 113.Pc 114means Managed address configuration flag bit, 115and Bit 6 116.Po 117.Li 0x40 118.Pc 119means Other stateful configuration flag bit. 120Bit 4 121.Po 122.Li 0x10 123.Pc 124and Bit 3 125.Po 126.Li 0x08 127.Pc 128are used to encode router preference. 1290x01 means high, 0x00 means medium, and 0x11 means low. 130The default value is 0. 131.It Cm \&rltime 132(num) Router lifetime field 133.Pq unit: seconds . 134Its value must be no greater than 3600000. 135When 136.Nm rtadvd 137runs on a host, this value must explicitly set 0 on all the 138advertising interfaces as described in 139.Xr rtadvd 8 . 140The default value is 1800. 141.It Cm \&rtime 142(num) Reachable time field 143.Pq unit: milliseconds . 144The default value is 0, which means unspecified by this router. 145.It Cm \&retrans 146(num) Retrans Timer field 147.Pq unit: milliseconds . 148The default value is 0, which means unspecified by this router. 149.El 150.Pp 151The following items are for ICMPv6 prefix information option, 152which will be attached to router advertisement header. 153These items can be omitted, then 154.Nm rtadvd 155will automatically get appropriate prefixes from the kernel's routing table, 156and advertise the prefixes with the default parameters. 157.Bl -tag -width indent 158.It Cm \&clockskew 159(num) Time skew to adjust link propagation delays and clock skews 160betwen routers on the link 161.Pq unit: seconds . 162This value is used in consistency check for locally-configured and 163advertised prefix lifetimes, and has its meaning when the local router 164configures a prefix on the link with a lifetime that decrements in 165real time. 166If the value is 0, it means the consistency check will be skipped 167for such prefixes. 168The default value is 0. 169.It Cm \&addrs 170(num) Number of prefixes. 171Its default is 0, so it must explicitly be set to positve values 172if you want to specify any prefix information option. 173If its value is 0, 174.Xr rtadvd 8 175looks up the system routing table and 176advertise the prefixes corresponding to interface routes 177on the interface. 178If its value is more than 1, you must specify the index of the prefix 179for each item below. 180Indices vary from 0 to N-1, where N is the 181value of 182.Cm addrs . 183Each index shall follow the name of each item, e.g., 184.Dq prefixlen2 . 185.It Cm \&prefixlen 186(num) Prefix length field. 187The default value is 64. 188.It Cm \&pinfoflags 189(num) Flags field in prefix information option. 190Bit 7 191.Po 192.Li 0x80 193.Pc 194means On-link flag bit, 195and Bit 6 196.Po 197.Li 0x40 198.Pc 199means Autonomous address-configuration flag bit. 200The default value is 0xc0, i.e., both bits are set. 201.It Cm \&addr 202(str) The address filled into Prefix field. 203Since 204.Dq \&: 205is used for 206.Xr termcap 5 207file format as well as IPv6 numeric address, the field MUST be quoted by 208doublequote character. 209This field cannot be 210omitted if the value of 211.Cm addrs 212is more than 0. 213.It Cm \&vltime 214(num) Valid lifetime field 215.Pq unit: seconds . 216The default value is 2592000 (30 days). 217.It Cm \&vltimedecr 218(bool) This item means the advertised valid lifetime will decrements 219in real time, which is disabled by default. 220.It Cm \&pltime 221(num) Preferred lifetime field 222.Pq unit: seconds . 223The default value is 604800 (7 days). 224.It Cm \&pltimedecr 225(bool) This item means the advertised preferred lifetime will decrements 226in real time, which is disabled by default. 227.El 228.Pp 229The following item is for ICMPv6 MTU option, 230which will be attached to router advertisement header. 231This item can be omitted, then 232.Nm rtadvd 233will use the default value. 234.Bl -tag -width indent 235.It Cm \&mtu 236(num or str) MTU (maximum transmission unit) field. 237If 0 is specified, it means that the option will not be included. 238The default value is 0. 239If the special string 240.Dq auto 241is specified for this item, MTU option will be included and its value 242will be set to the interface MTU automatically. 243.El 244.Pp 245The following item controls ICMPv6 source link-layer address option, 246which will be attached to router advertisement header. 247As noted above, you can just omit the item, then 248.Nm rtadvd 249will use the default value. 250.Bl -tag -width indent 251.It Cm \&nolladdr 252(bool) By default 253.Po 254if 255.Cm \&nolladdr 256is not specified 257.Pc , 258.Xr rtadvd 8 259will try to get link-layer address for the interface from the kernel, 260and attach that in source link-layer address option. 261If this capability exists, 262.Xr rtadvd 8 263will not attach source link-layer address option to 264router advertisement packets. 265.El 266.Pp 267The following item controls ICMPV6 home agent information option, 268which was defined with mobile IPv6 support. 269It will be attached to router advertisement header just like other options do. 270.Bl -tag -width indent 271.It Cm \&hapref 272(num) Specifies home agent preference. 273If set to non-zero, 274.Cm \&hatime 275must be present as well. 276.It Cm \&hatime 277(num) Specifies home agent lifetime. 278.El 279.Pp 280When mobile IPv6 support is turned on for 281.Xr rtadvd 8 , 282advertisement interval option will be attached to router advertisement 283packet, by configuring 284.Cm \&maxinterval 285explicitly. 286.Pp 287The following items are for ICMPv6 route information option, 288which will be attached to router advertisement header. 289These items are optional. 290.Bl -tag -width indent 291.It Cm \&routes 292(num) Number of routes. 293Its default is 0, so it must explicitly be set to positve values 294if you want to specify any route information option. 295If its value is 0, no route information is sent. 296If its value is more than 1, you must specify the index of the routes 297for each item below. 298Indices vary from 0 to N-1, where N is the 299value of 300.Cm routes. 301Each index shall follow the name of each item, e.g., 302.Dq rtrplen2 . 303.It Cm \&rtrplen 304(num) Prefix length field in route information option. 305The default value is 64. 306.It Cm \&rtrflags 307(num) Flags field in route information option. 308Bit 4 309.Po 310.Li 0x10 311.Pc 312and 313and Bit 3 314.Po 315.Li 0x08 316.Pc 317are used to encode router preference for the route. 318The default value is 0x00, i.e. medium router preference. 319.It Cm \&rtrprefix 320(str) The prefix filled into the Prefix field of route information option. 321Since 322.Dq \&: 323is used for 324.Xr termcap 5 325file format as well as IPv6 numeric address, the field MUST be quoted by 326doublequote character. 327This field cannot be 328omitted if the value of 329.Cm addrs 330is more than 0. 331.It Cm \&rtrltime 332(num) route lifetime field in route information option. 333.Pq unit: seconds . 334The default value is 2592000 (30 days). (not specified in draft-draves-router-selection-01.txt now) 335.El 336You can also refer one line from another by using 337.Cm tc 338capability. 339See 340.Xr termcap 5 341for details on the capability. 342.Sh EXAMPLES 343As presented above, all of the advertised parameters have default values 344defined in specifications, and hence you usually do not have to set them 345by hand, unless you need special non-default values. 346It can cause interoperability problem if you use an ill-configured 347parameter. 348.Pp 349To override a configuration parameter, you can specify the parameter alone. 350With the following configuration, 351.Xr rtadvd 8 352overrides the router lifetime parameter for the 353.Li ne0 354interface. 355.Bd -literal -offset 356ne0:\\ 357 :rltime#0: 358.Ed 359.Pp 360The following example manually configures prefixes advertised from the 361.Li ef0 362interface. 363The configuration must be used with the 364.Fl s 365option to 366.Xr rtadvd 8 . 367.Bd -literal -offset 368ef0:\\ 369 :addrs#1:addr="3ffe:501:ffff:1000::":prefixlen#64: 370.Ed 371.Pp 372The following example presents the default values in an explicit manner. 373The configuration is provided just for reference purposes; 374YOU DO NOT NEED TO HAVE IT AT ALL. 375.Bd -literal -offset 376default:\\ 377 :chlim#64:raflags#0:rltime#1800:rtime#0:retrans#0:\\ 378 :pinfoflags#192:vltime#2592000:pltime#604800:mtu#0: 379ef0:\\ 380 :addrs#1:addr="3ffe:501:ffff:1000::":prefixlen#64:tc=default: 381.Ed 382.Sh SEE ALSO 383.Xr termcap 5 , 384.Xr rtadvd 8 , 385.Xr rtsol 8 386.Pp 387Thomas Narten, Erik Nordmark and W. A. Simpson, 388.Do 389Neighbor Discovery for IP version 6 (IPv6) 390.Dc , 391RFC 2461 392.Pp 393Richard Draves, 394.Do 395Default Router Preferences and More-Specific Routes 396.Dc , 397draft-ietf-ipngwg-router-selection-01.txt 398.Sh HISTORY 399The 400.Xr rtadvd 8 401and the configuration file 402.Nm 403first appeared in WIDE Hydrangea IPv6 protocol stack kit. 404.\" .Sh BUGS 405.\" (to be written) 406