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