xref: /openbsd-src/usr.sbin/ospfctl/ospfctl.8 (revision 5054e3e78af0749a9bb00ba9a024b3ee2d90290f)
1.\"	$OpenBSD: ospfctl.8,v 1.24 2009/11/03 08:09:15 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: November 3 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 log brief
58Disable verbose debug logging.
59.It Cm log verbose
60Enable verbose debug logging.
61.It Cm reload
62Reload the configuration file.
63.It Cm show database Op Ar filter
64Show the link state database.
65.Ar filter
66can be any one of the following:
67.Pp
68.Bl -tag -width "self-originatedXX" -compact
69.It Cm area Ar ID
70Show only LSAs from the specified area
71.Ar ID .
72.It Cm asbr
73Show only ASBR LSAs.
74.It Cm external
75Show only AS-External LSAs.
76.It Cm network
77Show only Network LSAs.
78.It Cm router
79Show only Router LSAs.
80.It Cm self-originated
81Show only self-originated LSAs.
82.It Cm summary
83Show only Summary LSAs.
84.El
85.It Cm show fib Op Ar destination | filter
86Show the Forwarding Information Base.
87.Ar destination
88can be specified to show the route matching a destination IP address.
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 ospf
99Show only OSPF routes.
100.It Cm static
101Show only static routes.
102.El
103.Pp
104.Cm connected ,
105.Cm ospf
106and
107.Cm static
108may be specified together.
109.It Cm show interfaces Op Ar interface
110Show details for all interfaces or the specified
111.Ar interface .
112.It Cm show neighbor Op Cm detail
113Show neighbors.
114.Cm detail
115can be specified for additional detail.
116.It Cm show rib Op Cm detail
117Show the Routing Information Base.
118.Cm detail
119can be specified for additional detail.
120.It Cm show summary
121Show summary information.
122.El
123.Sh FILES
124.Bl -tag -width "/var/run/ospfd.sockXX" -compact
125.It /var/run/ospfd.sock
126.Ux Ns -domain
127socket used for communication with
128.Xr ospfd 8 .
129.El
130.Sh SEE ALSO
131.Xr ospfd.conf 5 ,
132.Xr ospfd 8
133.Sh HISTORY
134The
135.Nm
136program first appeared in
137.Ox 3.7 .
138