xref: /openbsd-src/usr.sbin/ospfctl/ospfctl.8 (revision a28daedfc357b214be5c701aa8ba8adb29a7f1c2)
1.\"	$OpenBSD: ospfctl.8,v 1.20 2009/04/08 15:58:55 jmc Exp $
2.\"
3.\" Copyright (c) 2004, 2005 Esben Norby <norby@openbsd.org>
4.\"
5.\" Permission to use, copy, modify, and distribute this software for any
6.\" purpose with or without fee is hereby granted, provided that the above
7.\" copyright notice and this permission notice appear in all copies.
8.\"
9.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16.\"
17.Dd $Mdocdate: April 8 2009 $
18.Dt OSPFCTL 8
19.Os
20.Sh NAME
21.Nm ospfctl
22.Nd control the Open Shortest Path First daemon
23.Sh SYNOPSIS
24.Nm
25.Op Fl s Ar socket
26.Ar command
27.Op Ar argument ...
28.Sh DESCRIPTION
29The
30.Nm
31program controls the
32.Xr ospfd 8
33daemon.
34.Pp
35The following options are available:
36.Bl -tag -width Ds
37.It Fl s Ar socket
38Use
39.Ar socket
40instead of the default
41.Pa /var/run/ospfd.sock
42to communicate with
43.Xr ospfd 8 .
44.El
45.Pp
46The following commands are available:
47.Bl -tag -width Ds
48.It Cm fib couple
49Insert the learned routes into the Forwarding Information Base
50a.k.a. the kernel routing table.
51.It Cm fib decouple
52Remove the learned routes from the Forwarding Information Base
53a.k.a. the kernel routing table.
54Decoupling the FIB from an OSPF router may create routing loops and could cause
55major routing issues in the complete OSPF cloud.
56Only routers with just one link to the OSPF cloud can safely decouple the FIB.
57.It Cm reload
58Reload the configuration file.
59.It Cm show database Op Ar filter
60Show the link state database.
61.Ar filter
62can be any one of the following:
63.Pp
64.Bl -tag -width "self-originatedXX" -compact
65.It Cm area Ar ID
66Show only LSAs from the specified area
67.Ar ID .
68.It Cm asbr
69Show only ASBR LSAs.
70.It Cm external
71Show only AS-External LSAs.
72.It Cm network
73Show only Network LSAs.
74.It Cm router
75Show only Router LSAs.
76.It Cm self-originated
77Show only self-originated LSAs.
78.It Cm summary
79Show only Summary LSAs.
80.El
81.It Cm show fib Op Ar destination | filter
82Show the Forwarding Information Base.
83.Ar destination
84can be specified to show the route matching a destination IP address.
85.Ar filter
86can be any of the following:
87.Pp
88.Bl -tag -width "interfaceXXinterfaceXX" -compact
89.It Cm connected
90Show only connected routes.
91.It Cm interface Op Ar interface
92Show only interfaces or the specified
93.Ar interface .
94.It Cm ospf
95Show only OSPF routes.
96.It Cm static
97Show only static routes.
98.El
99.Pp
100.Cm connected ,
101.Cm ospf
102and
103.Cm static
104may be specified together.
105.It Cm show interfaces Op Ar interface
106Show details for all interfaces or the specified
107.Ar interface .
108.It Cm show neighbor Op Cm detail
109Show neighbors.
110.Cm detail
111can be specified for additional detail.
112.It Cm show rib Op Cm detail
113Show the Routing Information Base.
114.Cm detail
115can be specified for additional detail.
116.It Cm show summary
117Show summary information.
118.El
119.Sh FILES
120.Bl -tag -width "/var/run/ospfd.sockXX" -compact
121.It /var/run/ospfd.sock
122Unix-domain socket used for communication with
123.Xr ospfd 8 .
124.El
125.Sh SEE ALSO
126.Xr ospfd.conf 5 ,
127.Xr ospfd 8
128.Sh HISTORY
129The
130.Nm
131program first appeared in
132.Ox 3.7 .
133