xref: /openbsd/usr.sbin/ospfctl/ospfctl.8 (revision 76d0caae)
1.\"	$OpenBSD: ospfctl.8,v 1.27 2015/07/27 18:48:05 sobrado 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: July 27 2015 $
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.
34Commands may be abbreviated to the minimum unambiguous prefix; for example,
35.Cm s s
36for
37.Cm show summary .
38.Pp
39The following options are available:
40.Bl -tag -width Ds
41.It Fl s Ar socket
42Use
43.Ar socket
44instead of the default
45.Pa /var/run/ospfd.sock
46to communicate with
47.Xr ospfd 8 .
48.El
49.Pp
50The following commands are available:
51.Bl -tag -width Ds
52.It Cm fib couple
53Insert the learned routes into the Forwarding Information Base
54a.k.a. the kernel routing table.
55.It Cm fib decouple
56Remove the learned routes from the Forwarding Information Base
57a.k.a. the kernel routing table.
58Decoupling the FIB from an OSPF router may create routing loops and could cause
59major routing issues in the complete OSPF cloud.
60Only routers with just one link to the OSPF cloud can safely decouple the FIB.
61.It Cm fib reload
62Refetches and relearns the routes in the Forwarding Information Base
63a.k.a. the kernel routing table.
64.It Cm log brief
65Disable verbose debug logging.
66.It Cm log verbose
67Enable verbose debug logging.
68.It Cm reload
69Reload the configuration file.
70.It Cm show database Op Ar filter
71Show the link state database.
72.Ar filter
73can be any one of the following:
74.Pp
75.Bl -tag -width "self-originatedXX" -compact
76.It Cm area Ar ID
77Show only LSAs from the specified area
78.Ar ID .
79.It Cm asbr
80Show only ASBR LSAs.
81.It Cm external
82Show only AS-External LSAs.
83.It Cm network
84Show only Network LSAs.
85.It Cm router
86Show only Router LSAs.
87.It Cm self-originated
88Show only self-originated LSAs.
89.It Cm summary
90Show only Summary LSAs.
91.El
92.It Cm show fib Op Ar destination | filter
93Show the Forwarding Information Base.
94.Ar destination
95can be specified to show the route matching a destination IP address.
96.Ar filter
97can be any of the following:
98.Pp
99.Bl -tag -width "interfaceXXinterfaceXX" -compact
100.It Cm connected
101Show only connected routes.
102.It Cm interface Op Ar interface
103Show only interfaces or the specified
104.Ar interface .
105.It Cm ospf
106Show only OSPF routes.
107.It Cm static
108Show only static routes.
109.El
110.Pp
111.Cm connected ,
112.Cm ospf
113and
114.Cm static
115may be specified together.
116.It Cm show interfaces Op Ar interface
117Show details for all interfaces or the specified
118.Ar interface .
119.It Cm show neighbor Op Cm detail
120Show neighbors.
121.Cm detail
122can be specified for additional detail.
123.It Cm show rib Op Cm detail
124Show the Routing Information Base.
125.Cm detail
126can be specified for additional detail.
127.It Cm show summary
128Show summary information.
129.El
130.Sh FILES
131.Bl -tag -width "/var/run/ospfd.sockXX" -compact
132.It Pa /var/run/ospfd.sock
133.Ux Ns -domain
134socket used for communication with
135.Xr ospfd 8 .
136.El
137.Sh SEE ALSO
138.Xr ospfd.conf 5 ,
139.Xr ospfd 8
140.Sh HISTORY
141The
142.Nm
143program first appeared in
144.Ox 3.7 .
145