1.\" $FreeBSD: src/usr.sbin/rtadvd/rtadvd.conf.5,v 1.1.2.9 2002/12/29 16:35:43 schweikh Exp $ 2.\" $DragonFly: src/usr.sbin/rtadvd/rtadvd.conf.5,v 1.4 2008/08/10 21:29:16 hasso Exp $ 3.\" $KAME: rtadvd.conf.5,v 1.35 2001/05/25 07:40:22 jinmei Exp $ 4.\" 5.\" Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project. 6.\" All rights reserved. 7.\" 8.\" Redistribution and use in source and binary forms, with or without 9.\" modification, are permitted provided that the following conditions 10.\" are met: 11.\" 1. Redistributions of source code must retain the above copyright 12.\" notice, this list of conditions and the following disclaimer. 13.\" 2. Redistributions in binary form must reproduce the above copyright 14.\" notice, this list of conditions and the following disclaimer in the 15.\" documentation and/or other materials provided with the distribution. 16.\" 3. Neither the name of the project nor the names of its contributors 17.\" may be used to endorse or promote products derived from this software 18.\" without specific prior written permission. 19.\" 20.\" THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND 21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 23.\" ARE DISCLAIMED. IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE 24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 30.\" SUCH DAMAGE. 31.\" 32.Dd May 17, 1998 33.Dt RTADVD.CONF 5 34.Os 35.Sh NAME 36.Nm rtadvd.conf 37.Nd config file for router advertisement daemon 38.Sh DESCRIPTION 39This file describes how the router advertisement packets must be constructed 40for each of the interfaces. 41.Pp 42As described in 43.Xr rtadvd 8 , 44you do not have to set this configuration file up at all, 45unless you need some special configurations. 46You may even omit the file as a whole. 47In such cases, the 48.Nm rtadvd 49daemon will automatically configure itself using default values 50specified in the specification. 51.Pp 52It obeys the famous 53.Xr termcap 5 54file format. 55Each line in the file describes a network interface. 56Fields are separated by a colon 57.Pq Sq \&: , 58and each field contains one capability description. 59Lines may be concatenated by the 60.Sq \e 61character. 62The comment marker is the 63.Sq \&# 64character. 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(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(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.Pq Li 0x80 112means Managed address configuration flag bit, 113and Bit 6 114.Pq Li 0x40 115means Other stateful configuration flag bit. 116Bit 4 117.Pq Li 0x10 118and Bit 3 119.Pq Li 0x08 120are used to encode router preference. 1210x01 means high, 0x00 means medium, and 0x11 means low. 122The default value is 0. 123.It Cm \&rltime 124(num) Router lifetime field 125(unit: seconds). 126Its value must be no greater than 3600000. 127When 128.Nm rtadvd 129runs on a host, this value must explicitly set 0 on all the 130advertising interfaces as described in 131.Xr rtadvd 8 . 132The default value is 1800. 133.It Cm \&rtime 134(num) Reachable time field 135(unit: milliseconds). 136The default value is 0, which means unspecified by this router. 137.It Cm \&retrans 138(num) Retrans Timer field 139(unit: milliseconds). 140The default value is 0, which means unspecified by this router. 141.El 142.Pp 143The following items are for ICMPv6 prefix information option, 144which will be attached to router advertisement header. 145These items can be omitted, then 146.Nm rtadvd 147will automatically get appropriate prefixes from the kernel's routing table, 148and advertise the prefixes with the default parameters. 149.Bl -tag -width indent 150.It Cm \&clockskew 151(num) Time skew to adjust link propagation delays and clock skews 152between routers on the link 153(unit: seconds). 154This value is used in consistency check for locally-configured and 155advertised prefix lifetimes, and has its meaning when the local router 156configures a prefix on the link with a lifetime that decrements in 157real time. 158If the value is 0, it means the consistency check will be skipped 159for such prefixes. 160The default value is 0. 161.It Cm \&addrs 162(num) Number of prefixes. 163Its default is 0, so it must explicitly be set to positive values 164if you want to specify any prefix information option. 165If its value is 0, 166.Xr rtadvd 8 167looks up the system routing table and 168advertise the prefixes corresponding to interface routes 169on the interface. 170If its value is more than 1, you must specify the index of the prefix 171for each item below. 172Indices vary from 0 to N-1, where N is the 173value of 174.Cm addrs . 175Each index shall follow the name of each item, e.g., 176.Dq prefixlen2 . 177.It Cm \&prefixlen 178(num) Prefix length field. 179The default value is 64. 180.It Cm \&pinfoflags 181(num) Flags field in prefix information option. 182Bit 7 183.Pq Li 0x80 184means On-link flag bit, 185and Bit 6 186.Pq Li 0x40 187means Autonomous address-configuration flag bit. 188The default value is 0xc0, i.e., both bits are set. 189.It Cm \&addr 190(str) The address filled into Prefix field. 191Since 192.Dq \&: 193is used for 194.Xr termcap 5 195file format as well as IPv6 numeric address, the field MUST be quoted by 196doublequote character. 197This field cannot be 198omitted if the value of 199.Cm addrs 200is more than 0. 201.It Cm \&vltime 202(num) Valid lifetime field 203(unit: seconds). 204The default value is 2592000 (30 days). 205.It Cm \&vltimedecr 206(bool) This item means the advertised valid lifetime will decrements 207in real time, which is disabled by default. 208.It Cm \&pltime 209(num) Preferred lifetime field 210(unit: seconds). 211The default value is 604800 (7 days). 212.It Cm \&pltimedecr 213(bool) This item means the advertised preferred lifetime will decrements 214in real time, which is disabled by default. 215.El 216.Pp 217The following item is for ICMPv6 MTU option, 218which will be attached to router advertisement header. 219This item can be omitted, then 220.Nm rtadvd 221will use the default value. 222.Bl -tag -width indent 223.It Cm \&mtu 224(num or str) MTU (maximum transmission unit) field. 225If 0 is specified, it means that the option will not be included. 226The default value is 0. 227If the special string 228.Dq auto 229is specified for this item, MTU option will be included and its value 230will be set to the interface MTU automatically. 231.El 232.Pp 233The following item controls ICMPv6 source link-layer address option, 234which will be attached to router advertisement header. 235As noted above, you can just omit the item, then 236.Nm rtadvd 237will use the default value. 238.Bl -tag -width indent 239.It Cm \&nolladdr 240(bool) By default 241(if 242.Cm \&nolladdr 243is not specified), 244.Xr rtadvd 8 245will try to get link-layer address for the interface from the kernel, 246and attach that in source link-layer address option. 247If this capability exists, 248.Xr rtadvd 8 249will not attach source link-layer address option to 250router advertisement packets. 251.El 252.Pp 253The following item controls ICMPV6 home agent information option, 254which was defined with mobile IPv6 support. 255It will be attached to router advertisement header just like other options do. 256.Bl -tag -width indent 257.It Cm \&hapref 258(num) Specifies home agent preference. 259If set to non-zero, 260.Cm \&hatime 261must be present as well. 262.It Cm \&hatime 263(num) Specifies home agent lifetime. 264.El 265.Pp 266When mobile IPv6 support is turned on for 267.Xr rtadvd 8 , 268advertisement interval option will be attached to router advertisement 269packet, by configuring 270.Cm \&maxinterval 271explicitly. 272.Pp 273The following items are for ICMPv6 route information option, 274which will be attached to router advertisement header. 275These items are optional. 276.Bl -tag -width indent 277.It Cm \&routes 278(num) Number of routes. 279Its default is 0, so it must explicitly be set to positive values 280if you want to specify any route information option. 281If its value is 0, no route information is sent. 282If its value is more than 1, you must specify the index of the routes 283for each item below. 284Indices vary from 0 to N-1, where N is the 285value of 286.Cm routes . 287Each index shall follow the name of each item, e.g., 288.Dq rtrplen2 . 289.It Cm \&rtrplen 290(num) Prefix length field in route information option. 291The default value is 64. 292.It Cm \&rtrflags 293(num) Flags field in route information option. 294Bit 4 295.Pq Li 0x10 296and 297and Bit 3 298.Pq Li 0x08 299are used to encode router preference for the route. 300The default value is 0x00, i.e. medium router preference. 301.It Cm \&rtrprefix 302(str) The prefix filled into the Prefix field of route information option. 303Since 304.Dq \&: 305is used for 306.Xr termcap 5 307file format as well as IPv6 numeric address, the field MUST be quoted by 308doublequote character. 309This field cannot be 310omitted if the value of 311.Cm addrs 312is more than 0. 313.It Cm \&rtrltime 314(num) route lifetime field in route information option. 315(unit: seconds). 316The default value is 2592000 (30 days). (not specified in draft-draves-router-selection-01.txt now) 317.El 318You can also refer one line from another by using 319.Cm tc 320capability. 321See 322.Xr termcap 5 323for details on the capability. 324.Sh EXAMPLES 325As presented above, all of the advertised parameters have default values 326defined in specifications, and hence you usually do not have to set them 327by hand, unless you need special non-default values. 328It can cause interoperability problem if you use an ill-configured 329parameter. 330.Pp 331To override a configuration parameter, you can specify the parameter alone. 332With the following configuration, 333.Xr rtadvd 8 334overrides the router lifetime parameter for the 335.Li ne0 336interface. 337.Bd -literal -offset 338ne0:\\ 339 :rltime#0: 340.Ed 341.Pp 342The following example manually configures prefixes advertised from the 343.Li ef0 344interface. 345The configuration must be used with the 346.Fl s 347option to 348.Xr rtadvd 8 . 349.Bd -literal -offset 350ef0:\\ 351 :addrs#1:addr="2001:db8:ffff:1000::":prefixlen#64: 352.Ed 353.Pp 354The following example presents the default values in an explicit manner. 355The configuration is provided just for reference purposes; 356YOU DO NOT NEED TO HAVE IT AT ALL. 357.Bd -literal -offset 358default:\\ 359 :chlim#64:raflags#0:rltime#1800:rtime#0:retrans#0:\\ 360 :pinfoflags#192:vltime#2592000:pltime#604800:mtu#0: 361ef0:\\ 362 :addrs#1:addr="2001:db8:ffff:1000::":prefixlen#64:tc=default: 363.Ed 364.Sh SEE ALSO 365.Xr termcap 5 , 366.Xr rtadvd 8 , 367.Xr rtsol 8 368.Pp 369Thomas Narten, Erik Nordmark and W. A. Simpson, 370.Do 371Neighbor Discovery for IP version 6 (IPv6) 372.Dc , 373RFC 2461 374.Pp 375Richard Draves, 376.Do 377Default Router Preferences and More-Specific Routes 378.Dc , 379draft-ietf-ipngwg-router-selection-01.txt 380.Sh HISTORY 381The 382.Xr rtadvd 8 383and the configuration file 384.Nm 385first appeared in WIDE Hydrangea IPv6 protocol stack kit. 386.\" .Sh BUGS 387.\" (to be written) 388