xref: /openbsd/usr.sbin/eigrpctl/eigrpctl.8 (revision 9b7c3dbb)
1.\"	$OpenBSD: eigrpctl.8,v 1.5 2016/01/15 12:57:48 renato 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: January 15 2016 $
19.Dt EIGRPCTL 8
20.Os
21.Sh NAME
22.Nm eigrpctl
23.Nd control the Enhanced Interior Gateway Routing Protocol daemon
24.Sh SYNOPSIS
25.Nm
26.Ar command
27.Op Ar argument ...
28.Sh DESCRIPTION
29The
30.Nm
31program controls the
32.Xr eigrpd 8
33daemon.
34Commands may be abbreviated to the minimum unambiguous prefix; for example,
35.Cm s i
36for
37.Cm show interfaces .
38.Pp
39The following commands are available:
40.Bl -tag -width Ds
41.It Xo
42.Cm clear neighbors
43.Op Cm family Ar family
44.Op Cm as Ar as
45.Op Ar address
46.Xc
47Delete entries from the neighbor table.
48.Ar family ,
49.Ar as ,
50and
51.Ar address
52can be used to limit the scope of the command to the given address family, autonomous system and/or address.
53If no argument is given, all neighbors from all EIGRP instances will be deleted.
54.It Cm fib couple
55Insert the learned routes into the Forwarding Information Base
56a.k.a. the kernel routing table.
57.It Cm fib decouple
58Remove the learned routes from the Forwarding Information Base
59a.k.a. the kernel routing table.
60Decoupling the FIB from an EIGRP router may create routing loops and could cause
61major routing issues in the complete EIGRP cloud.
62Only routers with just one link to the EIGRP cloud can safely decouple the FIB.
63.It Cm log brief
64Disable verbose debug logging.
65.It Cm log verbose
66Enable verbose debug logging.
67.It Cm reload
68Reload the configuration file.
69.It Xo
70.Cm show fib
71.Op Cm family Ar family
72.Op Ar filter
73.Xc
74Show the Forwarding Information Base.
75.Ar family ,
76if given, limit the output to the given address family.
77.Ar filter
78can be any of the following:
79.Pp
80.Bl -tag -width "interfaceXXinterfaceXX" -compact
81.It Cm connected
82Show only connected routes.
83.It Cm interface Op Ar interface
84Show only interfaces or the specified
85.Ar interface .
86.It Cm eigrp
87Show only EIGRP routes.
88.It Cm static
89Show only static routes.
90.El
91.Pp
92.Cm connected ,
93.Cm eigrp
94and
95.Cm static
96may be specified together.
97.It Xo
98.Cm show interfaces
99.Op Cm family Ar family
100.Op Cm as Ar as
101.Op Ar interface
102.Xc
103Show details for all EIGRP enabled interfaces or the specified
104.Ar interface .
105.Ar family
106and
107.Ar as ,
108if given, limit the output to the given address family and/or autonomous system.
109.It Xo
110.Cm show neighbor
111.Op Cm family Ar family
112.Op Cm as Ar as
113.Xc
114Show neighbors.
115.Ar family
116and
117.Ar as ,
118if given, limit the output to the given address family and/or autonomous system.
119.It Xo
120.Cm show topology
121.Op Cm family Ar family
122.Op Cm as Ar as
123.Op Ar prefix | filter
124.Xc
125Show the topology table.
126.Ar family
127and
128.Ar as ,
129if given, limit the output to the given address family and/or autonomous system.
130.Ar prefix
131can be specified to show the entries matching a destination prefix.
132.Ar filter
133can be any of the following:
134.Pp
135.Bl -tag -width "interfaceXXinterfaceXX" -compact
136.It Cm active
137Show only active entries.
138.It Cm all-links
139Show all entries.
140.El
141.It Xo
142.Cm show traffic
143.Op Cm family Ar family
144.Op Cm as Ar as
145.Xc
146Show traffic statistics.
147.Ar family
148and
149.Ar as ,
150if given, limit the output to the given address family and/or autonomous system.
151.El
152.Sh FILES
153.Bl -tag -width "/var/run/eigrpd.sockXX" -compact
154.It Pa /var/run/eigrpd.sock
155.Ux Ns -domain
156socket used for communication with
157.Xr eigrpd 8 .
158.El
159.Sh SEE ALSO
160.Xr eigrpd.conf 5 ,
161.Xr eigrpd 8
162.Sh HISTORY
163The
164.Nm
165program first appeared in
166.Ox 5.9 .
167.Sh AUTHORS
168The
169.Nm
170program was written by
171.An Renato Westphal Aq Mt renato@openbsd.org .
172