usr.sbin/pim6dd/pim6dd.conf.5

   1 .\"     $KAME: pim6dd.conf.5,v 1.6 2000/07/10 08:52:59 itojun Exp $
   2 .\"
   3 .\" Copyright (C) 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
  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.
  17 .\"
  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
  28 .\" SUCH DAMAGE.
  29 .\"
  30 .\"     $FreeBSD$
  31 .\"
  32 .Dd November 17, 1998
  33 .Dt PIM6DD.CONF 5
  34 .Os
  35 .Sh NAME
  36 .Nm pim6dd.conf
  37 .Nd "config file for pim6dd, PIM for IPv6 dense mode daemon
  38 .\"
  39 .Sh DESCRIPTION
  40 The file describes how the
  41 .Xr pim6dd 8
  42 daemon treats each interface on the system.
  43 By default(including the case where there is no configuration file),
  44 PIM will be activated on all interfaces, which can be overridden
  45 by the file.
  46 Lines beginning with
  47 .Ql #
  48 are comments.
  49 .Pp
  50 The following configuration directives are availble:
  51 .Pp
  52 .Bl -tag -width Ds -compact
  53 .It Xo
  54 .Ic default_source_preference Ar preference
  55 .Xc
  56 Specifies a default preference value when sending a PIM assert message.
  57 Preferences are used by assert elections to determine upstream routers.
  58 Currently
  59 .Xr pim6dd 8
  60 does not have an effective method to obtain preferences and metrics from the
  61 unicast routing protocols, so you may want to set a default value by hand.
  62 .\"
  63 .It Ic default_source_metric Ar metric
  64 Specifies a default metric value when sending a PIM assert message.
  65 Since
  66 .Xr pim6dd 8
  67 cannot get an effective metric of unicast routing,
  68 it is recommended that preferences is set such that metrics are never
  69 consulted. However, default metrics may also be set, and
  70 its default value is 1024.
  71 .\"
  72 .It Xo
  73 .Ic phyint Ar interface
  74 .Op disable
  75 .Xc
  76 Specifies
  77 .Xr pim6dd 8
  78 to ignore the interface even if the interface is multicast-capable.
  79 Interfaces are specified in the form of "name unit", such as
  80 .Ar gif0
  81 and
  82 .Ar ep1 .
  83 .\"
  84 .It Xo
  85 .Ic phyint Ar interface
  86 .Op preference Ar preference
  87 .Op metric Ar metric
  88 .Xc
  89 Specifies the preference and/or metric values when sending a PIM
  90 assert message on the interface.
  91 .\"
  92 .It Xo
  93 .Ic filter Ar groupaddrs Ar interfaces...
  94 .Xc
  95 Specifies an output filter by defining an administrative scope.
  96 If an incoming multicast packet's destination
  97 matches the specified
  98 .Ar groupaddrs ,
  99 the packet is not sent on the
 100 .Ar interfaces .
 101 Moreover, if there is no other interface than the specified
 102 interfaces,
 103 .Xr pim6dd 8
 104 sends a prune message to the upstream neighbor.
 105 Valid formats of
 106 .Ar groupaddrs
 107 are as follows.
 108 .Bl -tag -width Ds -compact
 109 .It Ar multicastaddr1-multicastaddr2
 110 specifies a numerical range of a scope.
 111 Multicast addresses
 112 from
 113 .Ar multicastaddr1
 114 to
 115 .Ar multicastaddr2
 116 will be filtered out.
 117 Note that neither a white space nor a tab character must not be
 118 inserted before nor after
 119 .Ql - .
 120 .It Ar multicastaddr/prefixlen
 121 specifies a group prefix of a scope.
 122 Multicast addresses which match the specified prefix will be filtered
 123 out.
 124 If
 125 .Ar prefixlen
 126 is omitted, it means the exact match for
 127 .Ar multicastaddr .
 128 .El
 129 .Ar interfaces
 130 are specified as a blank separated list of interfaces. Each interface is
 131 specified in the form of "name unit".
 132 .El
 133 .\"
 134 .Sh EXAMPLES
 135 .Bd -literal -offset
 136 # phyint gif0 disable
 137 # phyint ep0 preference 101
 138 phyint de0 disable
 139 filter ff15::4000/120 gif1 gif2
 140 filter ff18::1000-ff18::1050 gif3
 141 .Ed
 142 .Sh SEE ALSO
 143 .Xr pim6dd 8
 144 .Sh HISTORY
 145 The
 146 .Xr pim6dd 8
 147 command and the configuration file
 148 .Nm
 149 are based on
 150 .Nm pimdd ,
 151 which is an IPv4 multicast routing daemon
 152 developed at the University of Oregon.
 153 .Nm pimdd
 154 has been derived from PIM sparse-mode
 155 .Nm pimd
 156 developed at University of Southern California.
 157 Part of these two programs above has also been derived from
 158 .Nm mrouted .
 159 .Nm mrouted
 160 is COPYRIGHT 1989 by The Board of Trustees of
 161 Leland Stanford Junior University.
 162 .Pp
 163 IPv6 and IPsec support based on the KAME Project (http://www.kame.net/) stack
 164 was initially integrated into
 165 .Fx 4.0