xref: /openbsd/usr.sbin/eigrpd/eigrpd.conf.5 (revision d415bd75)
1.\"	$OpenBSD: eigrpd.conf.5,v 1.11 2023/03/02 17:09:53 jmc Exp $
2.\"
3.\" Copyright (c) 2015 Renato Westphal <renato@openbsd.org>
4.\" Copyright (c) 2005 Esben Norby <norby@openbsd.org>
5.\" Copyright (c) 2004 Claudio Jeker <claudio@openbsd.org>
6.\" Copyright (c) 2003, 2004 Henning Brauer <henning@openbsd.org>
7.\" Copyright (c) 2002 Daniel Hartmeier <dhartmei@openbsd.org>
8.\"
9.\" Permission to use, copy, modify, and distribute this software for any
10.\" purpose with or without fee is hereby granted, provided that the above
11.\" copyright notice and this permission notice appear in all copies.
12.\"
13.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
14.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
15.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
16.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
17.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
18.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
19.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
20.\"
21.Dd $Mdocdate: March 2 2023 $
22.Dt EIGRPD.CONF 5
23.Os
24.Sh NAME
25.Nm eigrpd.conf
26.Nd EIGRP routing daemon configuration file
27.Sh DESCRIPTION
28The
29.Xr eigrpd 8
30daemon implements the Enhanced Interior Gateway Routing Protocol.
31.Pp
32The
33.Nm
34config file is divided into the following 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 eigrpd 8 .
42.It Sy Routing Instances
43Multiple routing instances can be defined.
44Routing instances are defined hierarchically
45by address-family and then autonomous-system.
46.It Sy Interfaces Configuration
47Interface-specific parameters.
48.El
49.Pp
50Argument names not beginning with a letter, digit, or underscore
51must be quoted.
52.Pp
53Additional configuration files can be included with the
54.Ic include
55keyword, for example:
56.Bd -literal -offset indent
57include "/etc/eigrpd.sub.conf"
58.Ed
59.Sh MACROS
60Macros can be defined that will later be expanded in context.
61Macro names must start with a letter, digit, or underscore,
62and may contain any of those characters.
63Macro names may not be reserved words (for example,
64.Ic bandwidth ,
65.Ic interface ,
66or
67.Ic hello-interval ) .
68Macros are not expanded inside quotes.
69.Pp
70For example:
71.Bd -literal -offset indent
72fastethernet="100000"
73address-family ipv4 {
74	autonomous-system 1 {
75		interface em1 {
76			bandwidth $fastethernet
77		}
78	}
79}
80.Ed
81.Pp
82The same can be accomplished by specifying the bandwidth
83globally or within the address-family or autonomous-system declaration.
84.Sh GLOBAL CONFIGURATION
85Several settings can be configured globally, per address-family, per
86autonomous-system and per interface.
87The only settings that can be set globally and not overruled are listed below.
88.Bl -tag -width Ds
89.It Ic fib-priority-internal Ar prio
90Set the routing priority of EIGRP internal routes to
91.Ar prio .
92The default is 28.
93.It Ic fib-priority-external Ar prio
94Set the routing priority of EIGRP external routes to
95.Ar prio .
96This option may be used as a simple loop-prevention mechanism when another
97routing protocol is being redistributed into EIGRP.
98The default is 28.
99.It Ic fib-priority-summary Ar prio
100Set the routing priority of EIGRP summary routes to
101.Ar prio .
102The default is 28.
103.It Xo
104.Ic fib-update
105.Pq Ic yes Ns | Ns Ic no
106.Xc
107If set to
108.Ic \&no ,
109do not update the Forwarding Information Base, a.k.a. the kernel
110routing table.
111The default is
112.Ic yes .
113.It Ic rdomain Ar tableid
114Specifies the routing table
115.Xr eigrpd 8
116should modify.
117Table 0 is the default table.
118.It Ic router-id Ar address
119Set the router ID; if not specified, the numerically lowest IP address of
120the router will be used.
121.El
122.Sh ROUTING INSTANCES
123Multiple routing instances can be defined.
124Routing instances are defined hierarchically
125by address-family and then autonomous-system.
126.Bd -literal -offset indent
127address-family ipv4 {
128	...
129	autonomous-system 1 {
130		...
131		interface em0 {
132			...
133		}
134	}
135}
136.Ed
137.Pp
138Routing-instance specific parameters are listed below.
139.Bl -tag -width Ds
140.It Ic active-timeout Ar minutes
141Set the maximum time to wait before declaring a route to be in the stuck
142in active state.
143If 0 is given, the active timeout is disabled.
144The default value is 3; valid range is 0\-65535.
145.It Xo
146.Ic address-family
147.Pq Ic ipv4 Ns | Ns Ic ipv6
148.Xc
149Specify an address-family section, grouping one or more autonomous-systems.
150.It Ic autonomous-system Ar number
151Specify the autonomous-system, grouping one or more interfaces.
152Valid range is 1\-65535.
153.It Ic default-metric Ar bandwidth delay reliability load mtu
154Specify a default metric for all routes redistributed into EIGRP.
155Valid ranges are: 1\-10000000 for the bandwidth, 1\-16777215 for the delay,
1561\-255 for the reliability, 1\-255 for the load and 1\-65535 for the mtu.
157.It Ic k-values Ar K1 Ar K2 Ar K3 Ar K4 Ar K5 Ar K6
158Set the coefficients used by the composite metric calculation.
159Two routers become neighbors only if their K-values are the same.
160For K1 and K3, The default value is 1.
161For K2, K4, K5 and K6 the default value is 0;
162valid range is 1\-254.
163.It Ic maximum-hops Ar number
164Advertise as unreachable the routes with a hop count higher than specified.
165The default value is 100; valid range is 1\-255.
166.It Ic maximum-paths Ar number
167Specify the maximum number of ECMP paths to be installed in the FIB for
168each route.
169The default value is 4; valid range is 1\-32.
170.It Xo
171.Op Ic no
172.Ic redistribute
173.Sm off
174.Po Ic static Ns | Ns Ic connected Ns | Ns Ic ospf | Ns Ic rip | Ns
175.Ic default Pc
176.Sm on
177.Op Ic metric Ar bandwidth delay reliability load mtu
178.Xc
179.It Xo
180.Op Ic no
181.Ic redistribute Ar prefix
182.Op Ic metric Ar bandwidth delay reliability load mtu
183.Xc
184If set to
185.Ic connected ,
186routes to directly attached networks will be announced over EIGRP.
187If set to
188.Ic static ,
189static routes will be announced over EIGRP.
190If set to
191.Ic ospf ,
192OSPF routes will be announced over EIGRP.
193If set to
194.Ic rip ,
195RIP routes will be announced over EIGRP.
196If set to
197.Ic default ,
198a default route pointing to this router will be announced over EIGRP.
199It is possible to specify a network range with
200.Ar prefix ;
201networks need to be part of that range to be redistributed.
202By default no additional routes will be announced over EIGRP.
203.Pp
204.Ic redistribute
205statements are evaluated in sequential order, from first to last.
206The first matching rule decides if a route should be redistributed or not.
207Matching rules starting with
208.Ic no
209will force the route to be not announced.
210The only exception is
211.Ic default ,
212which will be set no matter what, and additionally
213.Ic no
214cannot be used together with it.
215.Pp
216It is possible to set the route
217.Ic metric
218for each redistribute rule.
219.It Ic variance Ar multiplier
220Set the variance used to permit the installation of feasible successors in the
221FIB if their metric is lower than the metric of the successor multiplied by the
222specified multiplier.
223The default value is 1; valid range is 1\-128.
224.El
225.Sh INTERFACES
226Each interface can have several parameters configured individually, otherwise
227they are inherited.
228Interfaces can pertain to multiple routing instances.
229An interface is specified by its name.
230.Bd -literal -offset indent
231interface em0 {
232	...
233}
234.Ed
235.Pp
236Interface-specific parameters are listed below.
237.Bl -tag -width Ds
238.It Ic bandwidth Ar bandwidth
239Set the interface bandwidth in kilobits per second.
240The bandwidth is used as part of the EIGRP composite metric.
241The default value is 100000; valid range is 1\-10000000.
242.It Ic delay Ar delay
243Set the interface delay in tens of microseconds.
244The delay is used as part of the EIGRP composite metric.
245The default value is 10; valid range is 1\-16777215.
246.It Ic hello-interval Ar seconds
247Set the hello interval.
248The default value is 5; valid range is 1\-65535 seconds.
249.It Ic holdtime Ar seconds
250Set the hello holdtime.
251The default value is 15; valid range is 1\-65535 seconds.
252.It Ic passive
253Prevent transmission and reception of EIGRP packets on this interface.
254.It Xo
255.Ic split-horizon
256.Pq Ic yes Ns | Ns Ic no
257.Xc
258If set to
259.Ic \&no ,
260the split horizon rule will be disabled on this interface.
261This option should be used with caution since it can introduce routing loops
262in point-to-point or broadcast networks.
263The default is
264.Ic yes .
265.It Ic summary-address Ar address Ns Li / Ns Ar len
266Configure a summary aggregate address for this interface.
267Multiple summary addresses can be configured.
268.El
269.Sh FILES
270.Bl -tag -width /etc/examples/eigrpd.conf -compact
271.It Pa /etc/eigrpd.conf
272.Xr eigrpd 8
273configuration file.
274.It Pa /etc/examples/eigrpd.conf
275Example configuration file.
276.El
277.Sh SEE ALSO
278.Xr eigrpctl 8 ,
279.Xr eigrpd 8 ,
280.Xr rc.conf.local 8
281.Sh HISTORY
282The
283.Nm
284file format first appeared in
285.Ox 5.9 .
286.Sh AUTHORS
287The
288.Xr eigrpd 8
289program was written by
290.An Renato Westphal Aq Mt renato@openbsd.org .
291