usr.sbin/rrenumd/rrenumd.conf.5

   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
  40 The rrenumd config file describes how the router renumbering packet
  41 must be constructed and to which destinations it should be sent.
  42 This file consists of a sequence of statements terminated by a semi-colon (`;').
  43 Statements are composed of tokens
  44 separated by white space, which can be any combination of blanks, tabs
  45 and newlines.
  46 This structure simplifies identification of
  47 the parts of the configuration associated with each other.
  48 Lines beginning with
  49 .Ql #
  50 are comments.
  51 .\"
  52 .Sh Meta Syntax
  53 Keywords and special characters that the parser expects exactly are
  54 displayed using the
  55 .Ic bold
  56 font.
  57 Parameters are specifying with
  58 .Ar underline .
  59 Parameters shown in
  60 square brackets (`[' and `]') are used to show optional
  61 keywords and parameters.
  62 The vertical bar (`|') is used to indicate
  63 between a choice of optional parameters.
  64 Curly braces (`{' and
  65 `}') are used to group keywords and parameters when necessary.
  66 .\"
  67 .Sh Interface specification
  68 There are some statements that may or have to specify interface.
  69 Interfaces are specified in the form of "name unit", such as
  70 .Ar lo0
  71 and
  72 .Ar ep1 .
  73 .\"
  74 .Sh Configuration Statements
  75 .Bl -tag -width Ds
  76 .\"
  77 .It Ic debug on|off ;
  78 Enables configuration file parser debugging.
  79 If
  80 .Ic on
  81 is specified,
  82 then debugging is enabled,
  83 If
  84 .Ic off
  85 is specified,
  86 then debugging is disabled.
  87 It is disabled by default.
  88 .\"
  89 .It Ic dest Ar dest-list Op Ar retrycmd ;
  90 Specifies destinations to which router renumbering messages should be
  91 sent.
  92 .Ar dest-list
  93 can be any combination of single or multiple numerical IPv6 addrs,
  94 or Full Qualified Domain Names.
  95 .Ar retrycmd
  96 has following syntax.
  97
  98 .\"
  99 .Bl -tag -width Ds -compact
 100 .It Ic retry Ar retry-num
 101 .Ar retry-num
 102 specifies 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 .Op /match-prefix-len
 107 .Op Cm maxlen Ar maxlen-val
 108 .Op Cm minlen Ar minlen-val
 109 .Op Cm use-prefix Ar use-prefix-val
 110 .Op /use-prefix-len
 111 .Op Cm keeplen Ar keeplen-val
 112 .Op Ar use-prefix-values ;
 113 .Pp
 114 Specifies contents of sending router renumbering message with seqnum 0.
 115 If
 116 .Cm add|change|setglobal
 117 is not specified, then
 118 .Cm add
 119 is assumed.
 120 .Ar use-prefix-values
 121 has following syntax.
 122 .Pp
 123 {
 124 .Op Cm vltime Ar vltime-val
 125 .Op Cm pltime Ar pltime-val
 126 .Op Cm raf_onlink Cm on|off
 127 .Op Cm raf_auto Cm on|off
 128 .Op Cm rrf_decrprefd Cm on|off
 129 .Op Cm rrf_decrvalid Cm on|off
 130 }
 131 .Pp
 132 Each value has following meaning.
 133 .Pp
 134 .Bl -tag -width Ds -compact
 135 .It Cm match-prefix Ar match-prefix-val Op /match-prefix-len
 136 Specify
 137 .Ar match-prefix-val
 138 that is used for matching with preassigned prefixes to which
 139 .Cm add|change|setglobal
 140 command should be applied.
 141 .Ar /match-prefix-len
 142 Specify the starting part of
 143 .Ar match-prefix-val
 144 to be used for matching with preassigned prefixes, as decimal bit number.
 145 .It Cm maxlen Ar maxlen-val
 146 Specify the maximum length of prefixes which is allowed to be
 147 matched to
 148 .Ar match-prefix-val ,
 149 as decimal bit number.
 150 .It Cm minlen Ar minlen-val
 151 Specify the minimum length of prefixes which is allowed to be matched to
 152 .Ar match-prefix-val ,
 153 as decimal bit number.
 154 .It Cm use-prefix Ar use-prefix-val Op /usr-prefix-len
 155 Specify
 156 .Ar use-prefix-val
 157 that is used for prefixes to be added on
 158 .Cm add|change|setglobal
 159 command.
 160 .Ar /use-prefix-len
 161 Specify the starting part of
 162 .Ar use-prefix-val
 163 copied to the starting part of prefixes to be added on
 164 .Cm add|change|setglobal
 165 command, as decimal bit number.
 166 .It Cm keeplen Ar keeplen-val
 167 Specify the medium part of
 168 .Ar use-prefix-val
 169 just next to the starting part specified by
 170 .Ar use-prefix-len
 171 , as decimal bit number.
 172 Contiguous bits part in the same bit position of an existent prefix
 173 matched with
 174 .Ar match-prefix-val
 175 is copied to the same bit position of prefixes to be added.
 176 .It Cm vltime Ar vmtime-val
 177 Assign an
 178 .Ar time
 179 as prefix valid life time for a prefix to be added.
 180 Valid value for
 181 .Ar time
 182 is decimal seconds number or special format as "d00h00m00s00",
 183 where 00 can take any decimal number, and "d" means days, "h" means hours,
 184 "m" means minutes, "s" means seconds.
 185 And alternatively, special keyword
 186 "infinity" can be also be specified.
 187 .It Cm pltime Ar pltime-val
 188 Assign an
 189 .Ar time
 190 as prefix preferred life time for a prefix to be added.
 191 Valid value for
 192 .Ar time
 193 is same as for
 194 .Ar vltime-val .
 195 .It Cm raf_onlink Cm on|off
 196 Let the prefix to be added to have on-link or off-link nature
 197 for the assigned interface.
 198 If
 199 .Cm on
 200 is specified, the prefix have on-link nature.
 201 (e.g. the prefix
 202 belong to the link) If
 203 .Cm off
 204 is specified, the prefix have off-link nature.
 205 (e.g. the
 206 prefix does not belong to the link)
 207 .It Cm raf_auto Cm on|off
 208 Enable or disable the autonomous address auto configuration
 209 for the prefix to be added.
 210 If
 211 .Cm on
 212 is specified, autonomous address auto configuration is
 213 enabled.
 214 If
 215 .Cm off
 216 is specified, it is disabled.
 217 .It Cm rrf_decrprefd Cm on|off
 218 Enable or disable the decrementation of the pltime.
 219 If
 220 .Cm on
 221 is specified, decrementation of the pltime is enabled.
 222 If
 223 .Cm off
 224 is specified, decrementation of the pltime is disabled.
 225 .It Cm rrf_decrvalid Cm on|off
 226 Enable or disable the decrementation of the vltime.
 227 If
 228 .Cm on
 229 is specified, decrementation of the vltime is enabled.
 230 If
 231 .Cm off
 232 is specified, decrementation of the vltime is disabled.
 233 .El
 234 .\"
 235 .It seqnum Ar seqnum-val { Ar rrenum-cmd } ;
 236 Specifies contents of sending router renumbering message with some
 237 specific seqnum.
 238 Multiple of this statement can be specified if they
 239 have different
 240 .Ar seqnum-val
 241 each other.
 242 .Ar rrenum-cmd
 243 has just same syntax with above add|change|setglobal statement.
 244 .El
 245 .\"
 246 .Sh EXAMPLE
 247 For each configuration file example shown below, we suppose
 248 every IPv6 subnet has its own prefix beginning with
 249 fec0:0:0::/48 and with its own subnet number.
 250 (in this case,
 251 subnet number is 7th and 8th octet value of the prefix)
 252 .Pp
 253 If you want to assign prefixes beginning with fec0:1:1::/48
 254 to each subnet, then following configuration will be enough,
 255 if each of your routers supports IPv6 multicast forwarding.
 256 The subnet number of the existing fec0:0:0::/48 prefix and the
 257 newly assigned fec0:1:1::/48 prefix will be same.
 258 .\"
 259 .Bd -literal -offset indent
 260 dest ff05::2;
 261
 262 add match-prefix fec0:0:0:: /48 use-prefix fec0:1:1:: /48 keeplen 16;
 263 .Ed
 264 .\"
 265
 266 If your routers don't support IPv6 multicast forwarding,
 267 you'll need to specify each destination at
 268 .Cm dest
 269 command.
 270 .\"
 271 .Bd -literal -offset indent
 272 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;
 273
 274 add match-prefix fec0:0:0:: /48 use-prefix fec0:1:1:: /48 keeplen 16;
 275 .Ed
 276 .\"
 277
 278 If you are going to do renumbering, then following procedure will be natural.
 279 .Bl -enum -offset indent
 280 .It
 281 Assign new prefix.
 282 .It
 283 Set old prefix lifetimes to some appropriate transition
 284 period.
 285 In the followng example we use 1 week for valid
 286 lifetime, and 0 for preferred lifetime.
 287 Also, enable old prefix lifetime expiration.
 288 (By default, it is static and does not expire)
 289 .It
 290 After the transition period, old prefixes should become
 291 invalid, and may have been deleted.
 292 To make sure that they are deleted, send new router
 293 renumbering message, which specifies old prefixes as match
 294 prefix, and no use prefix.
 295 .El
 296 .\"
 297
 298 The following configuration file will do 1 and 2.
 299 .\"
 300 .Bd -literal -offset indent
 301 dest ff05::2;
 302
 303 seqnum 0 {
 304         add match-prefix fec0:0:0:: /48 use-prefix fec0:2:2:: /48 keeplen 16;
 305         };
 306
 307 seqnum 1 {
 308         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;
 309         };
 310 .Ed
 311 .\"
 312
 313 And the following configuration file will do 3. (should be
 314 used for the router renumbering message to be sent 1 week
 315 afterward)
 316 .\"
 317 .Bd -literal -offset indent
 318 dest ff05::2;
 319
 320 change match-prefix fec0:1:1:: /48;
 321 .Ed
 322 .\"
 323
 324 In the above example, only
 325 .Cm add
 326 and
 327 .Cm change
 328 commands are used, and there is no example for
 329 .Cm setglobal
 330 command.
 331 .Cm setglobal
 332 command is almost same with
 333 .Cm change
 334 command except that it deletes all pre-defined IPv6 global address.
 335
 336 .Sh SEE ALSO
 337 .Xr rrenumd 8 ,
 338 .Xr prefix 8
 339 .Sh HISTORY
 340 The
 341 .Nm
 342 configuration file was first appeared in KAME IPv6 protocol stack kit.
 343 .\" .Sh BUGS
 344 .\" (to be written)