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