Deleted Added
full compact
rrenumd.conf.5 (71898) rrenumd.conf.5 (78064)
1.\" $KAME$
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

--- 12 unchanged lines hidden (view full) ---

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.\"
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

--- 12 unchanged lines hidden (view full) ---

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.\" $FreeBSD: head/usr.sbin/rrenumd/rrenumd.conf.5 71898 2001-02-01 16:44:04Z ru $
30.\" $FreeBSD: head/usr.sbin/rrenumd/rrenumd.conf.5 78064 2001-06-11 12:39:29Z ume $
31.\"
32.Dd November 5, 1998
33.Dt RRENUMD.CONF 5
34.Os KAME
35.Sh NAME
36.\"
37.Nm rrenumd.conf
38.Nd configuration file for router renumbering daemon

--- 18 unchanged lines hidden (view full) ---

57font.
58Parameters are specifying with
59.Ar underline .
60Parameters shown in
61square brackets (`[' and `]') are used to show optional
62keywords and parameters.
63The vertical bar (`|') is used to indicate
64between a choice of optional parameters.
31.\"
32.Dd November 5, 1998
33.Dt RRENUMD.CONF 5
34.Os KAME
35.Sh NAME
36.\"
37.Nm rrenumd.conf
38.Nd configuration file for router renumbering daemon

--- 18 unchanged lines hidden (view full) ---

57font.
58Parameters are specifying with
59.Ar underline .
60Parameters shown in
61square brackets (`[' and `]') are used to show optional
62keywords and parameters.
63The vertical bar (`|') is used to indicate
64between a choice of optional parameters.
65Parentheses (`(' and
66`)') are used to group keywords and parameters when necessary.
65Curly braces (`{' and
66`}') are used to group keywords and parameters when necessary.
67.\"
68.Sh Interface specification
69There are some statements that may or have to specify interface.
70Interfaces are specified in the form of "name unit", such as
71.Ar lo0
72and
73.Ar ep1 .
74.\"

--- 4 unchanged lines hidden (view full) ---

79Enables configuration file parser debugging.
80If
81.Ic on
82is specified,
83then debugging is enabled,
84If
85.Ic off
86is specified,
67.\"
68.Sh Interface specification
69There are some statements that may or have to specify interface.
70Interfaces are specified in the form of "name unit", such as
71.Ar lo0
72and
73.Ar ep1 .
74.\"

--- 4 unchanged lines hidden (view full) ---

79Enables configuration file parser debugging.
80If
81.Ic on
82is specified,
83then debugging is enabled,
84If
85.Ic off
86is specified,
87then debugging is disabled. It is disabled by default.
87then debugging is disabled.
88It is disabled by default.
88.\"
89.It Ic dest Ar dest-list Op Ar retrycmd ;
90Specifies destinations to which router renumbering messages should be
91sent.
92.Ar dest-list
93can be any combination of single or multiple numerical IPv6 addrs,
94or Full Qualified Domain Names.
95.Ar retrycmd
96has following syntax.
97.\"
98.Bl -tag -width Ds
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
89.\"
90.It Ic dest Ar dest-list Op Ar retrycmd ;
91Specifies destinations to which router renumbering messages should be
92sent.
93.Ar dest-list
94can be any combination of single or multiple numerical IPv6 addrs,
95or Full Qualified Domain Names.
96.Ar retrycmd
97has following syntax.
98.\"
99.Bl -tag -width Ds
100.It Ic retry Ar retry-num
101.Ar retry-num
102specifies how many router renumbering messages are sent repeatedly.
103.El
104.It Op Ic add|change|setglobal
105.Cm match-prefix Ar match-prefix-val
106.Bk -words
105.Op /match-prefix-len
107.Op /match-prefix-len
108.Ek
109.Bk -words
106.Op Cm maxlen Ar maxlen-val
110.Op Cm maxlen Ar maxlen-val
111.Ek
112.Bk -words
107.Op Cm minlen Ar minlen-val
113.Op Cm minlen Ar minlen-val
114.Ek
115.Bk -words
108.Op Cm use-prefix Ar use-prefix-val
116.Op Cm use-prefix Ar use-prefix-val
117.Ek
118.Bk -words
109.Op /use-prefix-len
119.Op /use-prefix-len
120.Ek
121.Bk -words
110.Op Cm keeplen Ar keeplen-val
122.Op Cm keeplen Ar keeplen-val
123.Ek
124.Bk -words
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
125.Op Ar use-prefix-values ;
126.Pp
127Specifies contents of sending router renumbering message with seqnum 0.
128If
129.Cm add|change|setglobal
130is not specified, then
131.Cm add
132is assumed.
133.Ar use-prefix-values
134has following syntax.
135.Pp
136{
137.Op Cm vltime Ar vltime-val
138.Bk -words
124.Op Cm pltime Ar pltime-val
139.Op Cm pltime Ar pltime-val
140.Ek
141.Bk -words
125.Op Cm raf_onlink Cm on|off
142.Op Cm raf_onlink Cm on|off
143.Ek
144.Bk -words
126.Op Cm raf_auto Cm on|off
145.Op Cm raf_auto Cm on|off
146.Ek
147.Bk -words
127.Op Cm rrf_decrprefd Cm on|off
148.Op Cm rrf_decrprefd Cm on|off
149.Ek
150.Bk -words
128.Op Cm rrf_decrvalid Cm on|off
151.Op Cm rrf_decrvalid Cm on|off
152.Ek
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

--- 21 unchanged lines hidden (view full) ---

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
153}
154.Pp
155Each value has following meaning.
156.Pp
157.Bl -tag -width Ds -compact
158.It Cm match-prefix Ar match-prefix-val Op /match-prefix-len
159Specify
160.Ar match-prefix-val

--- 21 unchanged lines hidden (view full) ---

182command.
183.Ar /use-prefix-len
184Specify the starting part of
185.Ar use-prefix-val
186copied to the starting part of prefixes to be added on
187.Cm add|change|setglobal
188command, as decimal bit number.
189.It Cm keeplen Ar keeplen-val
166Specify the midium part of
190Specify the medium 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,
191.Ar use-prefix-val
192just next to the starting part specified by
193.Ar use-prefix-len
194, as decimal bit number.
195Contiguous bits part in the same bit position of an existent prefix
196matched with
197.Ar match-prefix-val
198is copied to the same bit position of prefixes to be added.
199.It Cm vltime Ar vmtime-val
200Assign an
201.Ar time
202as prefix valid life time for a prefix to be added.
203Valid value for
204.Ar time
205is decimal seconds number or special format as "d00h00m00s00",
206where 00 can take any decimal number, and "d" means days, "h" means hours,
183"m" means minutes, "s" means seconds. And alternatively, special keyword
207"m" means minutes, "s" means seconds.
208And 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
209"infinity" can be also be specified.
210.It Cm pltime Ar pltime-val
211Assign an
212.Ar time
213as prefix preferred life time for a prefix to be added.
214Valid value for
215.Ar time
216is same as for
217.Ar vltime-val .
218.It Cm raf_onlink Cm on|off
219Let the prefix to be added to have on-link or off-link nature
195for the assigned interface. If
220for the assigned interface.
221If
196.Cm on
222.Cm on
197is specified, the prefix have on-link nature. (e.g. the prefix
198belong to the link) If
223is specified, the prefix have on-link nature
224(e.g. the prefix
225belong to the link).
226If
199.Cm off
227.Cm off
200is specified, the prefix have off-link nature. (e.g. the
201prefix does not belong to the link)
228is specified, the prefix have off-link nature
229(e.g. the
230prefix does not belong to the link).
202.It Cm raf_auto Cm on|off
203Enable or disable the autonomous address auto configuration
231.It Cm raf_auto Cm on|off
232Enable or disable the autonomous address auto configuration
204for the prefix to be added. If
233for the prefix to be added.
234If
205.Cm on
206is specified, autonomous address auto configuration is
235.Cm on
236is specified, autonomous address auto configuration is
207enabled. If
237enabled.
238If
208.Cm off
209is specified, it is disabled.
210.It Cm rrf_decrprefd Cm on|off
239.Cm off
240is specified, it is disabled.
241.It Cm rrf_decrprefd Cm on|off
211Enable or disable the decrementation of the pltime. If
242Enable or disable the decrementation of the pltime.
243If
212.Cm on
244.Cm on
213is specified, decrementation of the pltime is enabled. If
245is specified, decrementation of the pltime is enabled.
246If
214.Cm off
215is specified, decrementation of the pltime is disabled.
216.It Cm rrf_decrvalid Cm on|off
247.Cm off
248is specified, decrementation of the pltime is disabled.
249.It Cm rrf_decrvalid Cm on|off
217Enable or disable the decrementation of the vltime. If
250Enable or disable the decrementation of the vltime.
251If
218.Cm on
252.Cm on
219is specified, decrementation of the vltime is enabled. If
253is specified, decrementation of the vltime is enabled.
254If
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
255.Cm off
256is specified, decrementation of the vltime is disabled.
257.El
258.\"
259.It seqnum Ar seqnum-val { Ar rrenum-cmd } ;
260Specifies contents of sending router renumbering message with some
226specific seqnum. Multiple of this statement can be specified if they
261specific seqnum.
262Multiple 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 EXAMPLES
235For each configuration file example shown below, we suppose
236every IPv6 subnet has its own prefix beginning with
263have different
264.Ar seqnum-val
265each other.
266.Ar rrenum-cmd
267has just same syntax with above add|change|setglobal statement.
268.El
269.\"
270.Sh EXAMPLES
271For each configuration file example shown below, we suppose
272every 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)
273fec0:0:0::/48 and with its own subnet number
274(in this case,
275subnet number is 7th and 8th octet value of the prefix).
239.Pp
276.Pp
240If you want to assigne prefixes beginning with fec0:1:1::/48
277If you want to assign prefixes beginning with 3ffe:501:ffff::/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
278to each subnet, then following configuration will be enough,
279if each of your routers supports IPv6 multicast forwarding.
280The subnet number of the existing fec0:0:0::/48 prefix and the
244newly assigned fec0:1:1::/48 prefix will be same.
281newly assigned 3ffe:501:ffff::/48 prefix will be same.
245.\"
246.Bd -literal -offset indent
247dest ff05::2;
248
282.\"
283.Bd -literal -offset indent
284dest ff05::2;
285
249add match-prefix fec0:0:0:: /48 use-prefix fec0:1:1:: /48 keeplen 16;
286add match-prefix fec0:0:0:: /48 use-prefix 3ffe:501:ffff:: /48 keeplen 16;
250.Ed
251.Pp
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
287.Ed
288.Pp
289.\"
290If your routers don't support IPv6 multicast forwarding,
291you'll need to specify each destination at
292.Cm dest
293command.
294.\"
295.Bd -literal -offset indent
296dest fec0:0:0:1:260:8ff:fe24:fb3a fec0:0:0:2:200:eff:fe2e:dfe1 fec0:0:0:3:5254:ff:fedc:5217;
297
261add match-prefix fec0:0:0:: /48 use-prefix fec0:1:1:: /48 keeplen 16;
298add match-prefix fec0:0:0:: /48 use-prefix 3ffe:501:ffff:: /48 keeplen 16;
262.Ed
263.Pp
264.\"
265If you are going to do renumbering, then following procedure will be natural.
266.Bl -enum -offset indent
267.It
299.Ed
300.Pp
301.\"
302If you are going to do renumbering, then following procedure will be natural.
303.Bl -enum -offset indent
304.It
268Assigne new prefix.
305Assign a new prefix.
269.It
270Set old prefix lifetimes to some appropriate transition
306.It
307Set old prefix lifetimes to some appropriate transition
271period. In the followng example we use 1 week for valid
308period.
309In the followng example we use 1 week for valid
272lifetime, and 0 for preferred lifetime.
310lifetime, and 0 for preferred lifetime.
273Also, enable old prefix lifetime expiration.
274(By default, it is static and does not expire)
311Also, enable old prefix lifetime expiration
312(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.Pp
283.\"
284The following configuration file will do 1 and 2.
285.\"
286.Bd -literal -offset indent
287dest ff05::2;
288
289seqnum 0 {
313.It
314After the transition period, old prefixes should become
315invalid, and may have been deleted.
316To make sure that they are deleted, send new router
317renumbering message, which specifies old prefixes as match
318prefix, and no use prefix.
319.El
320.Pp
321.\"
322The following configuration file will do 1 and 2.
323.\"
324.Bd -literal -offset indent
325dest ff05::2;
326
327seqnum 0 {
290 add match-prefix fec0:0:0:: /48 use-prefix fec0:2:2:: /48 keeplen 16;
328 add match-prefix fec0:0:0:: /48 use-prefix 3ffe:501:fffe:: /48 keeplen 16;
291 };
292
293seqnum 1 {
329 };
330
331seqnum 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;
332 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;
295 };
296.Ed
297.Pp
298.\"
333 };
334.Ed
335.Pp
336.\"
299And the following configuration file will do 3. (should be
337And the following configuration file will do 3
338(should be
300used for the router renumbering message to be sent 1 week
339used for the router renumbering message to be sent 1 week
301afterward)
340afterward).
302.\"
303.Bd -literal -offset indent
304dest ff05::2;
305
341.\"
342.Bd -literal -offset indent
343dest ff05::2;
344
306change match-prefix fec0:1:1:: /48;
345change match-prefix 3ffe:501:ffff:: /48;
307.Ed
308.Pp
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.Sh SEE ALSO
346.Ed
347.Pp
348.\"
349In the above example, only
350.Cm add
351and
352.Cm change
353commands are used, and there is no example for
354.Cm setglobal
355command.
356.Cm setglobal
357command is almost same with
358.Cm change
359command except that it deletes all pre-defined IPv6 global address.
360.Sh SEE ALSO
322.Xr rrenumd 8
361.Xr rrenumd 8 ,
323.Xr prefix 8
324.Sh HISTORY
325The
326.Nm
327configuration file was first appeared in KAME IPv6 protocol stack kit.
328.\" .Sh BUGS
329.\" (to be written)
362.Xr prefix 8
363.Sh HISTORY
364The
365.Nm
366configuration file was first appeared in KAME IPv6 protocol stack kit.
367.\" .Sh BUGS
368.\" (to be written)