xref: /openbsd/usr.sbin/eigrpctl/eigrpctl.8 (revision 328c3f4b)
1.\"	$OpenBSD: eigrpctl.8,v 1.7 2023/03/02 17:09:53 jmc Exp $
2.\"
3.\" Copyright (c) 2015 Renato Westphal <renato@openbsd.org>
4.\" Copyright (c) 2004, 2005 Esben Norby <norby@openbsd.org>
5.\"
6.\" Permission to use, copy, modify, and distribute this software for any
7.\" purpose with or without fee is hereby granted, provided that the above
8.\" copyright notice and this permission notice appear in all copies.
9.\"
10.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17.\"
18.Dd $Mdocdate: March 2 2023 $
19.Dt EIGRPCTL 8
20.Os
21.Sh NAME
22.Nm eigrpctl
23.Nd control the EIGRP routing daemon
24.Sh SYNOPSIS
25.Nm
26.Op Fl s Ar socket
27.Ar command
28.Op Ar argument ...
29.Sh DESCRIPTION
30The
31.Nm
32program controls the
33.Xr eigrpd 8
34daemon.
35Commands may be abbreviated to the minimum unambiguous prefix; for example,
36.Cm s i
37for
38.Cm show interfaces .
39.Pp
40The following options are available:
41.Bl -tag -width Ds
42.It Fl s Ar socket
43Use
44.Ar socket
45instead of the default
46.Pa /var/run/eigrpd.sock
47to communicate with
48.Xr eigrpd 8 .
49.El
50.Pp
51The following commands are available:
52.Bl -tag -width Ds
53.It Xo
54.Cm clear neighbors
55.Op Cm family Ar family
56.Op Cm as Ar as
57.Op Ar address
58.Xc
59Delete entries from the neighbor table.
60.Ar family ,
61.Ar as ,
62and
63.Ar address
64can be used to limit the scope of the command to the given address family, autonomous system and/or address.
65If no argument is given, all neighbors from all EIGRP instances will be deleted.
66.It Cm fib couple
67Insert the learned routes into the Forwarding Information Base
68a.k.a. the kernel routing table.
69.It Cm fib decouple
70Remove the learned routes from the Forwarding Information Base
71a.k.a. the kernel routing table.
72Decoupling the FIB from an EIGRP router may create routing loops and could cause
73major routing issues in the complete EIGRP cloud.
74Only routers with just one link to the EIGRP cloud can safely decouple the FIB.
75.It Cm log brief
76Disable verbose debug logging.
77.It Cm log verbose
78Enable verbose debug logging.
79.It Cm reload
80Reload the configuration file.
81.It Xo
82.Cm show fib
83.Op Cm family Ar family
84.Op Ar filter
85.Xc
86Show the Forwarding Information Base.
87.Ar family ,
88if given, limit the output to the given address family.
89.Ar filter
90can be any of the following:
91.Pp
92.Bl -tag -width "interfaceXXinterfaceXX" -compact
93.It Cm connected
94Show only connected routes.
95.It Cm interface Op Ar interface
96Show only interfaces or the specified
97.Ar interface .
98.It Cm eigrp
99Show only EIGRP routes.
100.It Cm static
101Show only static routes.
102.El
103.Pp
104.Cm connected ,
105.Cm eigrp
106and
107.Cm static
108may be specified together.
109.It Xo
110.Cm show interfaces
111.Op Cm family Ar family
112.Op Cm as Ar as
113.Op Ar interface
114.Xc
115Show details for all EIGRP enabled interfaces or the specified
116.Ar interface .
117.Ar family
118and
119.Ar as ,
120if given, limit the output to the given address family and/or autonomous system.
121.It Xo
122.Cm show neighbor
123.Op Cm family Ar family
124.Op Cm as Ar as
125.Xc
126Show neighbors.
127.Ar family
128and
129.Ar as ,
130if given, limit the output to the given address family and/or autonomous system.
131.It Xo
132.Cm show topology
133.Op Cm family Ar family
134.Op Cm as Ar as
135.Op Ar prefix | filter
136.Xc
137Show the topology table.
138.Ar family
139and
140.Ar as ,
141if given, limit the output to the given address family and/or autonomous system.
142.Ar prefix
143can be specified to show the entries matching a destination prefix.
144.Ar filter
145can be any of the following:
146.Pp
147.Bl -tag -width "interfaceXXinterfaceXX" -compact
148.It Cm active
149Show only active entries.
150.It Cm all-links
151Show all entries.
152.El
153.It Xo
154.Cm show traffic
155.Op Cm family Ar family
156.Op Cm as Ar as
157.Xc
158Show traffic statistics.
159.Ar family
160and
161.Ar as ,
162if given, limit the output to the given address family and/or autonomous system.
163.El
164.Sh FILES
165.Bl -tag -width "/var/run/eigrpd.sockXX" -compact
166.It Pa /var/run/eigrpd.sock
167.Ux Ns -domain
168socket used for communication with
169.Xr eigrpd 8 .
170.El
171.Sh SEE ALSO
172.Xr eigrpd.conf 5 ,
173.Xr eigrpd 8
174.Sh HISTORY
175The
176.Nm
177program first appeared in
178.Ox 5.9 .
179.Sh AUTHORS
180The
181.Nm
182program was written by
183.An Renato Westphal Aq Mt renato@openbsd.org .
184