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