1.\" $NetBSD: rtadvd.conf.5,v 1.7 2002/02/02 01:44:59 wiz Exp $ 2.\" $KAME: rtadvd.conf.5,v 1.32 2001/01/19 05:32:05 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(num) Flags field in router advertisement message header. 109Bit 7 110.Po 111.Li 0x80 112.Pc 113means Managed address configuration flag bit, 114and Bit 6 115.Po 116.Li 0x40 117.Pc 118means Other stateful configuration flag bit. 119The default value is 0. 120.It Cm \&rltime 121(num) Router lifetime field 122.Pq unit: seconds . 123Its value must be no greater than 3600000. 124When 125.Nm rtadvd 126runs on a host, this value must explicitly set 0 on all the 127advertising interfaces as described in 128.Xr rtadvd 8 . 129The default value is 1800. 130.It Cm \&rtime 131(num) Reachable time field 132.Pq unit: milliseconds . 133The default value is 0, which means unspecified by this router. 134.It Cm \&retrans 135(num) Retrans Timer field 136.Pq unit: milliseconds . 137The default value is 0, which means unspecified by this router. 138.El 139.Pp 140The following items are for ICMPv6 prefix information option, 141which will be attached to router advertisement header. 142These items can be omitted, then 143.Nm rtadvd 144will automatically get appropriate prefixes from the kernel's routing table, 145and advertise the prefixes with the default parameters. 146.Bl -tag -width indent 147.It Cm \&clockskew 148(num) Time skew to adjust link propagation delays and clock skews 149betwen routers on the link 150.Pq unit: seconds . 151This value is used in consistency check for locally-configured and 152advertised prefix lifetimes, and has its meaning when the local router 153configures a prefix on the link with a lifetime that decrements in 154real time. 155If the value is 0, it means the consistency check will be skipped 156for such prefixes. 157The default value is 0. 158.It Cm \&addrs 159(num) Number of prefixes. 160Its default is 0, so it must explicitly be set to positve values 161if you want to specify any prefix information option. 162If its value is 0, 163.Xr rtadvd 8 164looks up the system routing table and 165advertise the prefixes corresponding to interface routes 166on the interface. 167If its value is more than 1, you must specify the index of the prefix 168for each item below. 169Indices vary from 0 to N-1, where N is the 170value of 171.Cm addrs . 172Each index shall follow the name of each item, e.g., 173.Dq prefixlen2 . 174.It Cm \&prefixlen 175(num) Prefix length field. 176The default value is 64. 177.It Cm \&pinfoflags 178(num) Flags field in prefix information option. 179Bit 7 180.Po 181.Li 0x80 182.Pc 183means On-link flag bit, 184and Bit 6 185.Po 186.Li 0x40 187.Pc 188means Autonomous address-configuration flag bit. 189The default value is 0xc0, i.e., both bits are set. 190.It Cm \&addr 191(str) The address filled into Prefix field. 192Since 193.Dq \&: 194is used for 195.Xr termcap 5 196file format as well as IPv6 numeric address, the field MUST be quoted by 197doublequote character. 198This field cannot be 199omitted if the value of 200.Cm addrs 201is more than 0. 202.It Cm \&vltime 203(num) Valid lifetime field 204.Pq unit: seconds . 205The default value is 2592000 (30 days). 206.It Cm \&vltimedecr 207(bool) This item means the advertised valid lifetime will decrements 208in real time, which is disabled by default. 209.It Cm \&pltime 210(num) Preferred lifetime field 211.Pq unit: seconds . 212The default value is 604800 (7 days). 213.It Cm \&pltimedecr 214(bool) This item means the advertised preferred lifetime will decrements 215in real time, which is disabled by default. 216.El 217.Pp 218The following item is for ICMPv6 MTU option, 219which will be attached to router advertisement header. 220This item can be omitted, then 221.Nm rtadvd 222will use the default value. 223.Bl -tag -width indent 224.It Cm \&mtu 225(num or str) MTU (maximum transmission unit) field. 226If 0 is specified, it means that the option will not be included. 227The default value is 0. 228If the special string 229.Dq auto 230is specified for this item, MTU option will be included and its value 231will be set to the interface MTU automatically. 232.El 233.Pp 234The following item controls ICMPv6 source link-layer address option, 235which will be attached to router advertisement header. 236As noted above, you can just omit the item, then 237.Nm rtadvd 238will use the default value. 239.Bl -tag -width indent 240.It Cm \&nolladdr 241(bool) By default 242.Po 243if 244.Cm \&nolladdr 245is not specified 246.Pc , 247.Xr rtadvd 8 248will try to get link-layer address for the interface from the kernel, 249and attach that in source link-layer address option. 250If this capability exists, 251.Xr rtadvd 8 252will not attach source link-layer address option to 253router advertisement packets. 254.El 255.Pp 256You can also refer one line from another by using 257.Cm tc 258capability. 259See 260.Xr termcap 5 261for details on the capability. 262.Sh EXAMPLES 263As presented above, all of the advertised parameters have default values 264defined in specifications, and hence you usually do not have to set them 265by hand, unless you need special non-default values. 266It can cause interoperability problem if you use an ill-configured 267parameter. 268.Pp 269To override a configuration parameter, you can specify the parameter alone. 270With the following configuration, 271.Xr rtadvd 8 272overrides the router lifetime parameter for the 273.Li ne0 274interface. 275.Bd -literal -offset 276ne0:\\ 277 :rltime#0: 278.Ed 279.Pp 280The following example manually configures prefixes advertised from the 281.Li ef0 282interface. 283The configuration must be used with the 284.Fl s 285option to 286.Xr rtadvd 8 . 287.Bd -literal -offset 288ef0:\\ 289 :addrs#1:addr="3ffe:501:ffff:1000::":prefixlen#64: 290.Ed 291.Pp 292The following example presents the default values in an explicit manner. 293The configuration is provided just for reference purposes; 294YOU DO NOT NEED TO HAVE IT AT ALL. 295.Bd -literal -offset 296default:\\ 297 :chlim#64:raflags#0:rltime#1800:rtime#0:retrans#0:\\ 298 :pinfoflags#192:vltime#2592000:pltime#604800:mtu#0: 299ef0:\\ 300 :addrs#1:addr="3ffe:501:ffff:1000::":prefixlen#64:tc=default: 301.Ed 302.Sh SEE ALSO 303.Xr termcap 5 , 304.Xr rtadvd 8 , 305.Xr rtsol 8 306.Pp 307Thomas Narten, Erik Nordmark and W. A. Simpson, 308.Do 309Neighbor Discovery for IP version 6 (IPv6) 310.Dc , 311RFC 2461 312.Sh HISTORY 313The 314.Xr rtadvd 8 315and the configuration file 316.Nm 317first appeared in WIDE Hydrangea IPv6 protocol stack kit. 318.\" .Sh BUGS 319.\" (to be written) 320