3 .\" Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
4 .\" All rights reserved.
6 .\" Redistribution and use in source and binary forms, with or without
7 .\" modification, are permitted provided that the following conditions
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.
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
38 .Nd configuration file for router renumbering daemon
41 The rrenumd config file describes how the router renumbering packet
42 must be constructed and to which destinations it should be sent.
43 This file consists of a sequence of statements terminated by a semi-colon (`;').
44 Statements are composed of tokens
45 separated by white space, which can be any combination of blanks, tabs
47 This structure simplifies identification of
48 the parts of the configuration associated with each other.
54 Keywords and special characters that the parser expects exactly are
58 Parameters are specifying with
61 square brackets (`[' and `]') are used to show optional
62 keywords and parameters.
63 The vertical bar (`|') is used to indicate
64 between a choice of optional parameters.
66 `)') are used to group keywords and parameters when necessary.
68 .Sh Interface specification
69 There are some statements that may or have to specify interface.
70 Interfaces are specified in the form of "name unit", such as
75 .Sh Configuration Statements
79 Enables configuration file parser debugging.
83 then debugging is enabled,
87 then debugging is disabled. It is disabled by default.
89 .It Ic dest Ar dest-list Op Ar retrycmd ;
90 Specifies destinations to which router renumbering messages should be
93 can be any combination of single or multiple numerical IPv6 addrs,
94 or Full Qualified Domain Names.
99 .It Ic retry Ar retry-num
101 specifies how many router renumbering messages are sent repeatedly.
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
110 .Op Cm keeplen Ar keeplen-val
111 .Op Ar use-prefix-values ;
113 Specifies contents of sending router renumbering message with seqnum 0.
115 .Cm add|change|setglobal
116 is not specified, then
119 .Ar use-prefix-values
120 has following syntax.
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
131 Each value has following meaning.
133 .Bl -tag -width Ds -compact
134 .It Cm match-prefix Ar match-prefix-val Op /match-prefix-len
137 that is used for matching with preassigned prefixes to which
138 .Cm add|change|setglobal
139 command should be applied.
140 .Ar /match-prefix-len
141 Specify the starting part of
143 to be used for matching with preassigned prefixes, as decimal bit number.
144 .It Cm maxlen Ar maxlen-val
145 Specify the maximum length of prefixes which is allowed to be
147 .Ar match-prefix-val ,
148 as decimal bit number.
149 .It Cm minlen Ar minlen-val
150 Specify the minimum length of prefixes which is allowed to be matched to
151 .Ar match-prefix-val ,
152 as decimal bit number.
153 .It Cm use-prefix Ar use-prefix-val Op /usr-prefix-len
156 that is used for prefixes to be added on
157 .Cm add|change|setglobal
160 Specify the starting part of
162 copied to the starting part of prefixes to be added on
163 .Cm add|change|setglobal
164 command, as decimal bit number.
165 .It Cm keeplen Ar keeplen-val
166 Specify the midium part of
168 just next to the starting part specified by
170 , as decimal bit number.
171 Contiguous bits part in the same bit position of an existent prefix
174 is copied to the same bit position of prefixes to be added.
175 .It Cm vltime Ar vmtime-val
178 as prefix valid life time for a prefix to be added.
181 is decimal seconds number or special format as "d00h00m00s00",
182 where 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
188 as prefix preferred life time for a prefix to be added.
193 .It Cm raf_onlink Cm on|off
194 Let the prefix to be added to have on-link or off-link nature
195 for the assigned interface. If
197 is specified, the prefix have on-link nature. (e.g. the prefix
198 belong to the link) If
200 is specified, the prefix have off-link nature. (e.g. the
201 prefix does not belong to the link)
202 .It Cm raf_auto Cm on|off
203 Enable or disable the autonomous address auto configuration
204 for the prefix to be added. If
206 is specified, autonomous address auto configuration is
209 is specified, it is disabled.
210 .It Cm rrf_decrprefd Cm on|off
211 Enable or disable the decrementation of the pltime. If
213 is specified, decrementation of the pltime is enabled. If
215 is specified, decrementation of the pltime is disabled.
216 .It Cm rrf_decrvalid Cm on|off
217 Enable or disable the decrementation of the vltime. If
219 is specified, decrementation of the vltime is enabled. If
221 is specified, decrementation of the vltime is disabled.
224 .It seqnum Ar seqnum-val { Ar rrenum-cmd } ;
225 Specifies contents of sending router renumbering message with some
226 specific seqnum. Multiple of this statement can be specified if they
231 has just same syntax with above add|change|setglobal statement.
235 For each configuration file example shown below, we suppose
236 every IPv6 subnet has its own prefix beginning with
237 fec0:0:0::/48 and with its own subnet number. (in this case,
238 subnet number is 7th and 8th octet value of the prefix)
240 If you want to assigne prefixes beginning with fec0:1:1::/48
241 to each subnet, then following configuration will be enough,
242 if each of your routers supports IPv6 multicast forwarding.
243 The subnet number of the existing fec0:0:0::/48 prefix and the
244 newly assigned fec0:1:1::/48 prefix will be same.
246 .Bd -literal -offset indent
249 add match-prefix fec0:0:0:: /48 use-prefix fec0:1:1:: /48 keeplen 16;
253 If your routers don't support IPv6 multicast forwarding,
254 you'll need to specify each destination at
258 .Bd -literal -offset indent
259 dest fec0:0:0:1:260:8ff:fe24:fb3a fec0:0:0:2:200:eff:fe2e:dfe1 fec0:0:0:3:5254:ff:fedc:5217;
261 add match-prefix fec0:0:0:: /48 use-prefix fec0:1:1:: /48 keeplen 16;
265 If you are going to do renumbering, then following procedure will be natural.
266 .Bl -enum -offset indent
270 Set old prefix lifetimes to some appropriate transition
271 period. In the followng example we use 1 week for valid
272 lifetime, and 0 for preferred lifetime.
273 Also, enable old prefix lifetime expiration.
274 (By default, it is static and does not expire)
276 After the transition period, old prefixes should become
277 invalid, and may have been deleted.
278 To make sure that they are deleted, send new router
279 renumbering message, which specifies old prefixes as match
280 prefix, and no use prefix.
284 The following configuration file will do 1 and 2.
286 .Bd -literal -offset indent
290 add match-prefix fec0:0:0:: /48 use-prefix fec0:2:2:: /48 keeplen 16;
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;
299 And the following configuration file will do 3. (should be
300 used for the router renumbering message to be sent 1 week
303 .Bd -literal -offset indent
306 change match-prefix fec0:1:1:: /48;
310 In the above example, only
314 commands are used, and there is no example for
318 command is almost same with
320 command except that it deletes all pre-defined IPv6 global address.
327 configuration file was first appeared in KAME IPv6 protocol stack kit.