usr.sbin/pim6sd/pim6sd.conf.5

   1 .\" Copyright (C) 1999 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: pim6sd.conf.5,v 1.7 1999/12/03 07:31:45 jinmei Exp $
  29 .\"     $FreeBSD$
  30 .\"
  31 .Dd Oct 6, 1999
  32 .Dt PIM6SD.CONF 5
  33 .Os KAME
  34 .Sh NAME
  35 .Nm pim6sd.conf
  36 .Nd config file for pim6sd, PIM-SM daemon for IPv6
  37 .\"
  38 .Sh DESCRIPTION
  39 The
  40 .Nm pim6sd
  41 configuration file consists of a sequence of statements terminated
  42 by a semi-colon (`;'), each of which specifies how the daemon treats
  43 each interface on the system, specifies some parameters of the PIM
  44 protocol, and requires some special behavior defined by the protocol.
  45 .Pp
  46 Each statement can be constructed by multiple lines.
  47 .Pp
  48 Lines beginning with
  49 .Ql #
  50 are comments.
  51 .\".Pp
  52 .\"Note that
  53 .\".Nm pim6sd
  54 .\"works even without the configuration file, although the daemon
  55 .\"will warn that there is no configuration file.
  56 .\"In such a case, the daemon will automatically set the default value
  57 .\"to each configurable parameter.
  58 .\"
  59 .Pp
  60 The following statements can be specified in the configuration file.
  61 .Pp
  62 .Bl -tag -width Ds -compact
  63 .It Xo
  64 .Ic log
  65 .Ar option...
  66 .Ic ;
  67 .Xc
  68 Specify debug messages to be printed out. Each
  69 .Ar option
  70 usually specifies a subset of the messages to be printed.
  71 If an
  72 .Ar option
  73 begins with
  74 .Ic no ,
  75 it means that the set of the messages that are specified by the option
  76 will not be printed. For example,
  77 .Ic `all nomld'
  78 means that all the messages except MLD related ones will be printed.
  79 Valid options are
  80 .Ic mld_proto, mld_timer, mld_member, mld, switch, trace, mtrace, traceroute,
  81 .Ic timeout, callout, pkt, packets, interfaces, vif, kernel, cache, mfc,
  82 .Ic k_cache, k_mfc, rsrr, pim_detail, pim_hello, pim_neighbors, pim_register,
  83 .Ic registers, pim_join_prune, pim_j_p, pim_jp, pim_bootstrap, pim_bsr, bsr,
  84 .Ic bootstrap, pim_asserts, pim_cand_rp, pim_c_rp, pim_rp, rp, pim_routes,
  85 .Ic pim_routing, pim_mrt, pim_timers, pim_rpf, rpf, pim, routes, routing,
  86 .Ic mrt, routers, mrouters, neighbors, timers, asserts,
  87 and
  88 .Ic all .
  89 .\"
  90 .It Xo
  91 .Ic reverselookup (yes \(ba no);
  92 .Xc
  93 Specifies if a hostname for an IPv6 address should be resolved
  94 on logging.
  95 .Ic yes
  96 means a hostname should be resolved, and
  97 .Ic no
  98 means should not.
  99 By default, a hostname is not resolved.
 100 .\"
 101 .It Xo
 102 .Ic phyint Ar interface
 103 .Op disable
 104 .Ic ;
 105 .Xc
 106 Specifies
 107 .Nm
 108 to ignore the interface even if the interface is multicast-capable.
 109 Note that PIM will be activated on all interfaces by default(including
 110 the case where there is no configuration file).
 111 Interfaces are specified in the form of "name unit", such as
 112 .Ar gif0
 113 and
 114 .Ar ep1.
 115 .\"
 116 .It Xo
 117 .Ic phyint Ar interface
 118 .Op preference Ar preference
 119 .Op metric Ar metric
 120 .Op nolistener
 121 .Ic ;
 122 .Xc
 123 Specifies the preference and/or metric values when sending a PIM
 124 assert message on the interface.
 125 If another optional parameter
 126 .Ic nolistener
 127 is specified,
 128 .Nm pim6sd
 129 will not send any MLD packets on the interface.
 130 This option is usually meaningless but will be useful when
 131 MLD messages are noisy (e.g. when debugging) and there is surely no
 132 listner on the interface.
 133 .\"
 134 .It Xo
 135 .Ic default_source_preference Ar preference;
 136 .Xc
 137 Specifies a default preference value when sending a PIM assert message.
 138 Preferences are used by assert elections to determine upstream routers.
 139 Currently
 140 .Nm pim6sd
 141 cannot reliably obtain preferences and metrics from the
 142 unicast routing protocols, so a default value may be configured.
 143 The default preference is 1024.
 144 .\"
 145 .It Ic default_source_metric Ar metric;
 146 Specifies a default metric value when sending a PIM assert message.
 147 It is recommended that preferences be set such that metrics are never
 148 consulted. However, default metrics may also be set and will default to
 149 1024.
 150 .\"
 151 .It Xo
 152 .Ic granularity Ar second;
 153 .Xc
 154 Specifies timer granularity in seconds.
 155 The default value is 5.
 156 .\"
 157 .It Xo
 158 .Ic hello_period Ar period Ar coef;
 159 .Xc
 160 .Ar Period
 161 specifies the period in second between 2 hello messages.
 162 .Ar Coef
 163 is the coefficient to determine the hello holdtime;
 164 the holdtime will be
 165 .Ar period
 166 *
 167 .Ar coef .
 168 The default values of the period and the coefficient are 30 and 3.5,
 169 respectively. The default holdtime is 105 seconds as a result.
 170 .\"
 171 .It Xo
 172 .Ic join_prune_period Ar period Ar coef;
 173 .Xc
 174 .Ar Period
 175 specifies the period in second between 2 join/prune messages.
 176 .Ar Coef
 177 is the coefficient to determine the join/prune holdtime;
 178 the holdtime will be
 179 .Ar period
 180 *
 181 .Ar coef .
 182 The default values of the period and the coefficient are 60 and 3.5,
 183 respectively. Consequently, the default holdtime is 210 seconds.
 184 .\"
 185 .It Xo
 186 .Ic data_timeout Ar timer;
 187 .Xc
 188 Specifies the time after which (S,G) state for a silent source will be
 189 deleted.
 190 The default value is 210.
 191 .\"
 192 .It Xo
 193 .Ic register_suppression_timeout Ar interval;
 194 .Xc
 195 .Ar Interval
 196 specifies the interval between receiving a Register-Stop and allowing
 197 PIM Register to be send again.
 198 The default value is 60.
 199 .\"
 200 .It Xo
 201 .Ic probe_time Ar timer;
 202 .Xc
 203 .Ar Timer
 204 specifies the time between sending a null Register and the
 205 Register-Suppression-Timer expiring unless it is restarted by
 206 receiving a Register-Stop.
 207 The default value is 5.
 208 .\"
 209 .It Xo
 210 .Ic assert_timeout Ar interval;
 211 .Xc
 212 .Ar Interval
 213 specifies the interval between the last time an Assert is received and
 214 the time at which the assert is timeout.
 215 The default value is 180.
 216 .\"
 217 .It Xo
 218 .Ic cand_rp
 219 .Op Ar interface
 220 .Op Ic time Ar time
 221 .Op Ic priority Ar priority
 222 .Ic ;
 223 .Xc
 224 Specifies to act as a candidate Rendezvous Point(RP).
 225 It is recommended to specify
 226 .Ic cand_rp
 227 only in typical usage.
 228 All other parameters are optional and will be set automatically.
 229 If an
 230 .Ar interface
 231 is specified,
 232 .Nm pim6sd
 233 will search for a global address on the specified interface
 234 and set the address in Candidate RP Advertisements.
 235 An optional parameter
 236 .Ic time
 237 specifies the interval of two succeeding advertisements in seconds.
 238 Its default value is 60.
 239 2.5 *
 240 .Ar time
 241 will be set to Candidate-RP-Advertisement messages.
 242 Another optional parameter
 243 .Ic priority
 244 specifies the priority of the RP.
 245 The default value is 0, which means the highest priority.
 246 .\"
 247 .It Xo
 248 .Ic group_prefix Ar prefix;
 249 .Xc
 250 When acting as a Rendezvous Point(RP),
 251 .Ar prefix
 252 specifies a group prefix that the RP will handle.
 253 .\"
 254 .It Xo
 255 .Ic cand_bootstrap_router
 256 .Op Ar interface
 257 .Op Ic time Ar time
 258 .Op Ic priority Ar priority
 259 .Ic ;
 260 .Xc
 261 Specifies to act as a candidate bootstrap router(BSR).
 262 It is recommended to specify
 263 .Ic cand_bootstrap_router
 264 only in typical usage.
 265 All other parameters are optional and will be set automatically.
 266 If an
 267 .Ar interface
 268 is specified,
 269 .Nm pim6sd
 270 will search for a global address on the specified interface
 271 and set the address in Bootstrap messages.
 272 An optional parameter
 273 .Ic time
 274 specifies the interval of two succeeding bootstraps in seconds.
 275 Its default value is 60.
 276 Another optional parameter
 277 .Ic priority
 278 specifies the priority of the RP.
 279 The default value is 0, which means the lowest priority.
 280 .\"
 281 .It Xo
 282 .Ic switch_register_threshold Ic rate Ar rate Ic interval Ar interval;
 283 .Xc
 284 Specifies the threshold that a Rendezvous Point(RP) switches to a shortest
 285 path tree, which is valid only when acting as an RP.
 286 .Ic rate
 287 specifies the threshold in bits per second, and
 288 .Ic interval
 289 specifies the interval of checking the rate in seconds.
 290 The default values are 50000 and 20, respectively.
 291 \"
 292 .It Xo
 293 .Ic switch_data_threshold Ic rate Ar rate Ic interval Ar interval;
 294 .Xc
 295 Specifies the threshold that a last hop router switches to a shortest
 296 path tree.
 297 .Ic rate
 298 specifies the threshold in bits per second, and
 299 .Ic interval
 300 specifies the interval of checking the rate in seconds.
 301 The default values are 50000 and 20, respectively.
 302 .El
 303 .\"
 304 .Sh EXAMPLE
 305 .Bd -literal -offset
 306 #phyint gif0 disable;
 307 #phyint ep0 preference 101;
 308 phyint de0 disable;
 309 #
 310 #followings are for a candidate Rendezvous Point, which should usually
 311 #be disabled.
 312 cand_bootstrap_router;
 313 cand_rp;
 314 .Ed
 315 .Sh SEE ALSO
 316 .Xr pim6sd 8
 317 .Sh HISTORY
 318 The
 319 .Nm pim6sd
 320 command is developed by Mickael Hoerdt at LSIIT Laboratory.
 321 It is based on IPv4 PIM sparse-mode
 322 .Nm pimd
 323 developed at University of Southern California,
 324 which has also been derived from
 325 .Nm mrouted.
 326 .Nm Mrouted
 327 is COPYRIGHT 1989 by The Board of Trustees of
 328 Leland Stanford Junior University.
 329 .\" .Sh BUGS
 330 .\" (to be written)