1.\" $KAME: rrenumd.conf.5,v 1.8 2001/02/06 02:17:23 jinmei Exp $ 2.\" 3.\" Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project. 4.\" All rights reserved. 5.\" 6.\" Redistribution and use in source and binary forms, with or without 7.\" modification, are permitted provided that the following conditions 8.\" are met: 9.\" 1. Redistributions of source code must retain the above copyright 10.\" notice, this list of conditions and the following disclaimer. 11.\" 2. Redistributions in binary form must reproduce the above copyright 12.\" notice, this list of conditions and the following disclaimer in the 13.\" documentation and/or other materials provided with the distribution. 14.\" 3. Neither the name of the project nor the names of its contributors 15.\" may be used to endorse or promote products derived from this software 16.\" without specific prior written permission. 17.\" 18.\" THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND 19.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 20.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 21.\" ARE DISCLAIMED. IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE 22.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 23.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 24.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 25.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 26.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 27.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 28.\" SUCH DAMAGE. 29.\" 30.Dd November 5, 1998 31.Dt RRENUMD.CONF 5 32.Os 33.Sh NAME 34.\" 35.Nm rrenumd.conf 36.Nd configuration file for router renumbering daemon 37.\" 38.Sh DESCRIPTION 39The rrenumd config file describes how the router renumbering packet 40must be constructed and to which destinations it should be sent. 41This file consists of a sequence of statements terminated by a semi-colon (`;'). 42Statements are composed of tokens 43separated by white space, which can be any combination of blanks, tabs 44and newlines. 45This structure simplifies identification of 46the parts of the configuration associated with each other. 47Lines beginning with 48.Ql # 49are comments. 50.\" 51.Sh Meta Syntax 52Keywords and special characters that the parser expects exactly are 53displayed using the 54.Ic bold 55font. 56Parameters are specifying with 57.Ar underline . 58Parameters shown in 59square brackets (`[' and `]') are used to show optional 60keywords and parameters. 61The vertical bar (`|') is used to indicate 62between a choice of optional parameters. 63Curly braces (`{' and 64`}') are used to group keywords and parameters when necessary. 65.\" 66.Sh Interface specification 67There are some statements that may or have to specify interface. 68Interfaces are specified in the form of "name unit", such as 69.Ar lo0 70and 71.Ar ep1 . 72.\" 73.Sh Configuration Statements 74.Bl -tag -width Ds 75.\" 76.It Ic debug on|off ; 77Enables configuration file parser debugging. 78If 79.Ic on 80is specified, 81then debugging is enabled, 82If 83.Ic off 84is specified, 85then debugging is disabled. 86It is disabled by default. 87.\" 88.It Ic dest Ar dest-list Op Ar retrycmd ; 89Specifies destinations to which router renumbering messages should be 90sent. 91.Ar dest-list 92can be any combination of single or multiple numerical IPv6 addrs, 93or Full Qualified Domain Names. 94.Ar retrycmd 95has following syntax. 96.\" 97.Bl -tag -width Ds 98.It Ic retry Ar retry-num 99.Ar retry-num 100specifies how many router renumbering messages are sent repeatedly. 101.El 102.It Op Ic add|change|setglobal 103.Cm match-prefix Ar match-prefix-val 104.Bk -words 105.Op /match-prefix-len 106.Ek 107.Bk -words 108.Op Cm maxlen Ar maxlen-val 109.Ek 110.Bk -words 111.Op Cm minlen Ar minlen-val 112.Ek 113.Bk -words 114.Op Cm use-prefix Ar use-prefix-val 115.Ek 116.Bk -words 117.Op /use-prefix-len 118.Ek 119.Bk -words 120.Op Cm keeplen Ar keeplen-val 121.Ek 122.Bk -words 123.Op Ar use-prefix-values ; 124.Ek 125.Pp 126Specifies contents of sending router renumbering message with seqnum 0. 127If 128.Cm add|change|setglobal 129is not specified, then 130.Cm add 131is assumed. 132.Ar use-prefix-values 133has following syntax. 134.Pp 135{ 136.Op Cm vltime Ar vltime-val 137.Bk -words 138.Op Cm pltime Ar pltime-val 139.Ek 140.Bk -words 141.Op Cm raf_onlink Cm on|off 142.Ek 143.Bk -words 144.Op Cm raf_auto Cm on|off 145.Ek 146.Bk -words 147.Op Cm rrf_decrprefd Cm on|off 148.Ek 149.Bk -words 150.Op Cm rrf_decrvalid Cm on|off 151.Ek 152} 153.Pp 154Each value has following meaning. 155.Pp 156.Bl -tag -width Ds -compact 157.It Cm match-prefix Ar match-prefix-val Op /match-prefix-len 158Specify 159.Ar match-prefix-val 160that is used for matching with preassigned prefixes to which 161.Cm add|change|setglobal 162command should be applied. 163.Ar /match-prefix-len 164Specify the starting part of 165.Ar match-prefix-val 166to be used for matching with preassigned prefixes, as decimal bit number. 167.It Cm maxlen Ar maxlen-val 168Specify the maximum length of prefixes which is allowed to be 169matched to 170.Ar match-prefix-val , 171as decimal bit number. 172.It Cm minlen Ar minlen-val 173Specify the minimum length of prefixes which is allowed to be matched to 174.Ar match-prefix-val , 175as decimal bit number. 176.It Cm use-prefix Ar use-prefix-val Op /usr-prefix-len 177Specify 178.Ar use-prefix-val 179that is used for prefixes to be added on 180.Cm add|change|setglobal 181command. 182.Ar /use-prefix-len 183Specify the starting part of 184.Ar use-prefix-val 185copied to the starting part of prefixes to be added on 186.Cm add|change|setglobal 187command, as decimal bit number. 188.It Cm keeplen Ar keeplen-val 189Specify the medium part of 190.Ar use-prefix-val 191just next to the starting part specified by 192.Ar use-prefix-len , 193as decimal bit number. 194Contiguous bits part in the same bit position of an existent prefix 195matched with 196.Ar match-prefix-val 197is copied to the same bit position of prefixes to be added. 198.It Cm vltime Ar vmtime-val 199Assign an 200.Ar time 201as prefix valid life time for a prefix to be added. 202Valid value for 203.Ar time 204is decimal seconds number or special format as "d00h00m00s00", 205where 00 can take any decimal number, and "d" means days, "h" means hours, 206"m" means minutes, "s" means seconds. 207And alternatively, special keyword 208"infinity" can be also be specified. 209.It Cm pltime Ar pltime-val 210Assign an 211.Ar time 212as prefix preferred life time for a prefix to be added. 213Valid value for 214.Ar time 215is same as for 216.Ar vltime-val . 217.It Cm raf_onlink Cm on|off 218Let the prefix to be added to have on-link or off-link nature 219for the assigned interface. 220If 221.Cm on 222is specified, the prefix have on-link nature 223(e.g.\& the prefix 224belong to the link). 225If 226.Cm off 227is specified, the prefix have off-link nature 228(e.g.\& the 229prefix does not belong to the link). 230.It Cm raf_auto Cm on|off 231Enable or disable the autonomous address auto configuration 232for the prefix to be added. 233If 234.Cm on 235is specified, autonomous address auto configuration is 236enabled. 237If 238.Cm off 239is specified, it is disabled. 240.It Cm rrf_decrprefd Cm on|off 241Enable or disable the decrementation of the pltime. 242If 243.Cm on 244is specified, decrementation of the pltime is enabled. 245If 246.Cm off 247is specified, decrementation of the pltime is disabled. 248.It Cm rrf_decrvalid Cm on|off 249Enable or disable the decrementation of the vltime. 250If 251.Cm on 252is specified, decrementation of the vltime is enabled. 253If 254.Cm off 255is specified, decrementation of the vltime is disabled. 256.El 257.\" 258.It seqnum Ar seqnum-val { Ar rrenum-cmd } ; 259Specifies contents of sending router renumbering message with some 260specific seqnum. 261Multiple of this statement can be specified if they 262have different 263.Ar seqnum-val 264each other. 265.Ar rrenum-cmd 266has just same syntax with above add|change|setglobal statement. 267.El 268.\" 269.Sh EXAMPLES 270For each configuration file example shown below, we suppose 271every IPv6 subnet has its own prefix beginning with 272fec0:0:0::/48 and with its own subnet number 273(in this case, 274subnet number is 7th and 8th octet value of the prefix). 275.Pp 276If you want to assign prefixes beginning with 3ffe:501:ffff::/48 277to each subnet, then following configuration will be enough, 278if each of your routers supports IPv6 multicast forwarding. 279The subnet number of the existing fec0:0:0::/48 prefix and the 280newly assigned 3ffe:501:ffff::/48 prefix will be same. 281.\" 282.Bd -literal -offset indent 283dest ff05::2; 284 285add match-prefix fec0:0:0:: /48 use-prefix 3ffe:501:ffff:: /48 keeplen 16; 286.Ed 287.Pp 288.\" 289If your routers do not support IPv6 multicast forwarding, 290you will need to specify each destination at 291.Cm dest 292command. 293.\" 294.Bd -literal -offset indent 295dest fec0:0:0:1:260:8ff:fe24:fb3a fec0:0:0:2:200:eff:fe2e:dfe1 fec0:0:0:3:5254:ff:fedc:5217; 296 297add match-prefix fec0:0:0:: /48 use-prefix 3ffe:501:ffff:: /48 keeplen 16; 298.Ed 299.Pp 300.\" 301If you are going to do renumbering, then following procedure will be natural. 302.Bl -enum -offset indent 303.It 304Assign a new prefix. 305.It 306Set old prefix lifetimes to some appropriate transition 307period. 308In the following example we use 1 week for valid 309lifetime, and 0 for preferred lifetime. 310Also, enable old prefix lifetime expiration 311(By default, it is static and does not expire). 312.It 313After the transition period, old prefixes should become 314invalid, and may have been deleted. 315To make sure that they are deleted, send new router 316renumbering message, which specifies old prefixes as match 317prefix, and no use prefix. 318.El 319.Pp 320.\" 321The following configuration file will do 1 and 2. 322.\" 323.Bd -literal -offset indent 324dest ff05::2; 325 326seqnum 0 { 327 add match-prefix fec0:0:0:: /48 use-prefix 3ffe:501:fffe:: /48 keeplen 16; 328 }; 329 330seqnum 1 { 331 change match-prefix 3ffe:501:ffff:: /48 use-prefix 3ffe:501:ffff:: /48 keeplen 16 vltime d7 pltime 0 rrf_decrvalid on rrf_decrprefd on; 332 }; 333.Ed 334.Pp 335.\" 336And the following configuration file will do 3 337(should be 338used for the router renumbering message to be sent 1 week 339afterward). 340.\" 341.Bd -literal -offset indent 342dest ff05::2; 343 344change match-prefix 3ffe:501:ffff:: /48; 345.Ed 346.Pp 347.\" 348In the above example, only 349.Cm add 350and 351.Cm change 352commands are used, and there is no example for 353.Cm setglobal 354command. 355.Cm setglobal 356command is almost same with 357.Cm change 358command except that it deletes all pre-defined IPv6 global address. 359.Sh SEE ALSO 360.Xr prefix 8 , 361.Xr rrenumd 8 362.Sh HISTORY 363The 364.Nm 365configuration file was first appeared in KAME IPv6 protocol stack kit. 366.\" .Sh BUGS 367.\" (to be written) 368