Return to pimd.conf CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / pimd

pimd 2.3.2

    1: # Exmaple configuration file for pimd, the original PIM-SM router
    2: #
    3: # See the pimd(8) man page for details on all the settings.  This file
    4: # only gives very brief examples and is intended as a quick start.
    5: #
    6: # NOTE: The order of the settings matter!
    7: #
    8: ##
    9: # default-route-distance <1-255>
   10: # default-route-metric   <1-1024>
   11: # hello-interval         <30-18724>
   12: #
   13: # igmp-query-interval  <SEC>
   14: # igmp-querier-timeout <SEC>
   15: #
   16: # phyint <local-addr | ifname>
   17: #        [disable | enable] [igmpv2 | igmpv3]
   18: #        [dr-priority <1-4294967294>]
   19: #        [ttl-threshold <1-255>] [distance <1-255>] [metric <1-1024>]
   20: #        [altnet <network> [/<masklen> | masklen <masklen>]]
   21: #        [scoped <network> [/<masklen> | masklen <masklen>]]
   22: #
   23: # bsr-candidate [local-addr | ifname] [priority <0-255>]
   24: # rp-candidate  [local-addr | ifname] [priority <0-255> ] [time <10-16383>]
   25: #                group-prefix <group-addr>[/<masklen> | masklen <masklen>]
   26: #                group-prefix <group-addr>[/<masklen> | masklen <masklen>]
   27: #                   .
   28: #                   .
   29: #                group-prefix <group-addr>[/<masklen> | masklen <masklen>]
   30: # rp-address    <local-addr> [<group-addr>[/<masklen> | masklen <masklen>]
   31: #
   32: # spt-threshold [rate <KBPS> | packets <NUM> | infinity] [interval <SEC>]
   33: ##
   34: #
   35: # By default PIM is activated on all interfaces.  Use `phyint disable`
   36: # on interfaces where PIM should not run.  You can also use the `-N,
   37: # --disable-vifs` command line option along with `enable` to get the
   38: # inverse behavior.
   39: #
   40: # The routing protocol admin distance (or metric preference per the RFC)
   41: # is used in PIM Assert elections to elect the forwarder of multicast.
   42: # Currently pimd cannot obtain distance and metric from the underlying
   43: # routing protocols, so a default distance may need to be configured per
   44: # interface.  If left out, the default-route-distance is used for the
   45: # phyint.  In PIM assert elections the router advertising the lowest
   46: # preference (distance) will be selected as forwarder (upstream router)
   47: # for that LAN.  An admin distance of 101 should be sufficiently high so
   48: # that asserts from Cisco or GateD routers are prefered over poor-little
   49: # pimd.
   50: #
   51: # It is reccommended that preferences (admin distance) be set such that
   52: # metrics are never consulted.  However, default metrics may also be set
   53: # and default to 1024.
   54: #
   55: # A phyint directive can use either the interface name, ifname, or the
   56: # IP address.  The distance and metric settings define administrative
   57: # distance and metric, respectively, for PIM Assert messages sent on
   58: # that interface.  Usually you do not need this, but if you do, think of
   59: # them like distance and metric defined on an inbound interface (iif),
   60: # but used by PIM Asserts on the outbound interfaces (oifs).
   61: #
   62: # If you want to add "alternative (sub)net" to a physical interface,
   63: # e.g., if you want to make incoming traffic with a non-local source address
   64: # to appear as it is coming from a local subnet, then use the command:
   65: #
   66: #   phyint <local-addr | ifname> altnet <net-addr> masklen <len>
   67: #
   68: # NOTE: if you use this command, make sure you know what you are doing!
   69: #
   70: # If you want administratively scoped multicast filtering, use the
   71: # following command:
   72: #
   73: #   phyint <local-addr | ifname> scoped <net-addr> masklen <masklen>
   74: #
   75: # This allows interfaces to be configured as an administrative boundary
   76: # for the specified scoped address, or address range.  Packets belonging
   77: # to the scoped range will not be forwarded.  Use `--enable-scoped-acls`
   78: # flag to the configure script to activate this at build time.
   79: #
   80: # Both rp-candidate and bsr-candidate are enabled in the default config,
   81: # below.  Disabling them for all PIM capable routers is a bad idea. At
   82: # least one PIM router in the backbone must act as a bootstrap router.
   83: # The optional local-addr or ifname arguments after the rp-candidate and
   84: # bsr-candidate settings specify the local address to be used in the
   85: # Cand-RP and Cand-BSR messages.  In case ifname is given as argument,
   86: # the first IPv4 address of that interface is used.  If either is
   87: # unspecified, the largest local IP address will be used, excluding
   88: # phyint interfaces where PIM has been disabled.
   89: #
   90: # The time argument to rp-candidate specifies how often to send Cand-RP
   91: # messages.  The default value is 30 seconds.  Use smaller values for
   92: # faster convergence.
   93: #
   94: # The group-prefix setting is the prefix(es) advertised if rp-candidate.
   95: # It is possible to set up to 255 group-prefix records.
   96: #
   97: # Using the rp-address setting it is possible to set a static rendezvous
   98: # point.  The argument can be either a unicast or a multicast address
   99: # followed by an optional group address and optional masklen to that.
  100: #
  101: # The spt-threshold specifies the minimum rate in kbps before the last
  102: # hop router initiates a switch to the shortest path.  The `packets`
  103: # argument is an alternative notation, `infinity` means to never switch,
  104: # and `interval` specifies the interval for periodical testing of the
  105: # threshold.  Currently, `interval` must be at least 5 (seconds)
  106: #
  107: # Interface defaults, like default-route-distance and -metric must be
  108: # set before the phyint section -- the .conf parser is not clever.
  109: #default-route-distance	  101      # smaller is better
  110: #default-route-metric     1024     # smaller is better
  111: #hello-interval           30       # Don't set lower than 30
  112: 
  113: # The phyint settings currently *MUST BE* ordered after the default
  114: # source preference and metric settings, but before everything else.
  115: 
  116: # By default, all non-loopback multicast capable interfaces are enabled.
  117: # If you want to use loopback, set the interface multicast flag on it.
  118: #phyint eth0 disable
  119: 
  120: # IGMP default query interval and querier timeout.  The latter should
  121: # per RFC always be (robustness * interval) + (query-response / 2), for
  122: # pimd this means: (3 * 12) + (10 / 2) = 41, we've rounded it up to
  123: # honor the late Douglas Adams.  You can set it to a higher value, but
  124: # it is not recommended to set it lower.
  125: #igmp-query-interval  12
  126: #igmp-querier-timeout 42
  127: 
  128: # Bigger value means  "higher" priority
  129: bsr-candidate priority 5
  130: 
  131: # Smaller value means "higher" priority
  132: rp-candidate time 30 priority 20
  133: 
  134: # Candidate for being RP of complete IPv4 multicast range
  135: #group-prefix 224.0.0.0 masklen 4
  136: 
  137: # Static rendez-vous point
  138: #rp-address 192.168.10.1 224.0.0.0/4
  139: 
  140: # Switch to shortest-path tree after first packet, but only after 100 sec.
  141: spt-threshold packets 0 interval 100