xref: /openbsd/usr.sbin/dvmrpd/dvmrpd.conf.5 (revision 404b540a)
1.\"	$OpenBSD: dvmrpd.conf.5,v 1.6 2008/01/31 20:00:08 jmc Exp $
2.\"
3.\" Copyright (c) 2005, 2006 Esben Norby <norby@openbsd.org>
4.\" Copyright (c) 2004 Claudio Jeker <claudio@openbsd.org>
5.\" Copyright (c) 2003, 2004 Henning Brauer <henning@openbsd.org>
6.\" Copyright (c) 2002 Daniel Hartmeier <dhartmei@openbsd.org>
7.\"
8.\" Permission to use, copy, modify, and distribute this software for any
9.\" purpose with or without fee is hereby granted, provided that the above
10.\" copyright notice and this permission notice appear in all copies.
11.\"
12.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
13.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
14.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
15.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
16.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
17.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
18.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
19.\"
20.Dd $Mdocdate: January 31 2008 $
21.Dt DVMRPD.CONF 5
22.Os
23.Sh NAME
24.Nm dvmrpd.conf
25.Nd Distance Vector Multicast Routing Protocol daemon configuration file
26.Sh DESCRIPTION
27The
28.Xr dvmrpd 8
29daemon implements the Distance Vector Multicast Routing Protocol as described
30in draft-ietf-idmr-dvmrp-v3-11 DVMRP Version 3.
31.Sh SECTIONS
32The
33.Nm
34config file is divided into three main sections.
35.Bl -tag -width xxxx
36.It Sy Macros
37User-defined variables may be defined and used later, simplifying the
38configuration file.
39.It Sy Global Configuration
40Global settings for
41.Xr dvmrpd 8 .
42A number of global settings can be overruled in specific areas or interfaces.
43.It Sy Groups
44Groups are used to group similar interfaces, simplifying configuration.
45.El
46.Sh MACROS
47Macros can be defined that will later be expanded in context.
48Macro names must start with a letter, and may contain letters, digits,
49and underscores.
50Macro names may not be reserved words (for example,
51.Ic area ,
52.Ic interface ,
53or
54.Ic hello-interval ) .
55Macros are not expanded inside quotes.
56.Pp
57For example:
58.Bd -literal -offset indent
59hi="60"
60group {
61	interface em0 {
62		query-interval $hi
63	}
64}
65.Ed
66.Pp
67The same can be accomplished by specifying the query-interval
68globally or within the group declaration.
69.Sh GLOBAL CONFIGURATION
70All interface related settings can be configured globally, per group and per
71interface.
72The only settings that can be set globally and not overruled are listed below.
73.Bl -tag -width Ds
74.It Xo
75.Ic mfc-update
76.Pq Ic yes Ns \&| Ns Ic no
77.Xc
78If set to
79.Ic yes ,
80the kernel Multicast Forwarding Cache is updated with information from the
81daemon.
82The default is
83.Ic yes .
84.El
85.Sh GROUPS
86Groups can be used to easily configure similar interfaces.
87All interface-specific parameters can
88be configured per group, overruling the global settings.
89.Bl -tag -width Ds
90.It Ic group
91Specify a group section, grouping one or more interfaces.
92.Bd -literal -offset indent
93group {
94	robustness 4
95
96	interface em0
97	interface em1
98}
99.Ed
100.El
101.Sh INTERFACES
102Each interface can have several parameters configured individually, otherwise
103they are inherited.
104.Bd -literal -offset indent
105interface em0 {
106}
107.Ed
108.Pp
109Interface-specific parameters are listed below.
110.Bl -tag -width Ds
111.It Ic igmp-version Ar number
112Do not use a newer version than specified.
113Valid range 1\(en2.
114The default version used is 2.
115.It Ic last-member-query-count Ar count
116The default value is equal to the default robustness variable;
117valid range is 1\(en255.
118.It Ic last-member-query-interval Ar seconds
119The default value is 10; valid range is 1\(en65535.
120.It Ic metric Ar cost
121Set the interface metric a.k.a. cost.
122The default value is 1; valid range is
1231\(en31.
124.It Ic passive
125Prevent transmission and reception of IGMP and DVMRP packets on this interface.
126.It Ic query-interval Ar seconds
127Set the query interval.
128The default value is 125 seconds; valid range is 1\(en65535 seconds.
129.It Ic query-response-interval Ar seconds
130Set the query-response-interval; note that this must be less
131than the query-interval.
132The default value is 100 seconds; valid range is 1\(en65535 seconds.
133.It Ic robustness Ar factor
134Set the robustness factor; note that this value might
135have an impact on other variables.
136The default value is 2; valid range is 1\(en4.
137.It Ic startup-query-count Ar count
138Set the startup-query-interval, used during startup to speed up the process of
139building the IGMP table for an interface.
140The default value is equal to the default robustness variable; valid range is
141the same as the robustness variable.
142.It Ic startup-query-interval Ar seconds
143Used during startup, see the startup-query-interval.
144The default value is query-interval / 4; valid range is the same as the
145query-interval.
146.El
147.Sh FILES
148.Bl -tag -width "/etc/dvmrpd.conf" -compact
149.It Pa /etc/dvmrpd.conf
150.Xr dvmrpd 8
151configuration file
152.El
153.Sh SEE ALSO
154.Xr dvmrpctl 8 ,
155.Xr dvmrpd 8 ,
156.Xr rc.conf.local 8
157.Rs
158.%R "draft-ietf-idmr-dvmrp-v3-11"
159.%T "DVMRP Version 3"
160.%D August 2000
161.Re
162.Sh HISTORY
163The
164.Nm
165file format first appeared in
166.Ox 4.0 .
167