xref: /openbsd/usr.sbin/ospfctl/ospfctl.8 (revision 7b36286a)
1.\"	$OpenBSD: ospfctl.8,v 1.17 2007/08/03 04:38:16 pyr 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: August 3 2007 $
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.Ar command
26.Op Ar arguments ...
27.Sh DESCRIPTION
28The
29.Nm
30program controls the
31.Xr ospfd 8
32daemon.
33.Pp
34The following commands are available:
35.Bl -tag -width Ds
36.It Cm fib couple
37Insert the learned routes into the Forwarding Information Base
38a.k.a. the kernel routing table.
39.It Cm fib decouple
40Remove the learned routes from the Forwarding Information Base
41a.k.a. the kernel routing table.
42Decoupling the FIB from an OSPF router may create routing loops and could cause
43major routing issues in the complete OSPF cloud.
44Only routers with just one link to the OSPF cloud can safely decouple the FIB.
45.It Cm reload
46Reload the configuration file.
47.It Cm show database Op Ar filter
48Show the link state database.
49.Ar filter
50can be any one of the following:
51.Pp
52.Bl -tag -width "self-originatedXX" -compact
53.It Cm area Ar ID
54Show only LSAs from the specified area
55.Ar ID .
56.It Cm asbr
57Show only ASBR LSAs.
58.It Cm external
59Show only AS-External LSAs.
60.It Cm network
61Show only Network LSAs.
62.It Cm router
63Show only Router LSAs.
64.It Cm self-originated
65Show only self-originated LSAs.
66.It Cm summary
67Show only Summary LSAs.
68.El
69.It Cm show fib Op Ar destination | filter
70Show the Forwarding Information Base.
71.Ar destination
72can be specified to show the route matching a destination IP address.
73.Ar filter
74can be any of the following:
75.Pp
76.Bl -tag -width "interfaceXXinterfaceXX" -compact
77.It Cm connected
78Show only connected routes.
79.It Cm interface Op Ar interface
80Show only interfaces or the specified
81.Ar interface .
82.It Cm ospf
83Show only OSPF routes.
84.It Cm static
85Show only static routes.
86.El
87.Pp
88.Cm connected ,
89.Cm ospf
90and
91.Cm static
92may be specified together.
93.It Cm show interfaces Op Ar interface
94Show details for all interfaces or the specified
95.Ar interface .
96.It Cm show neighbor Op Cm detail
97Show neighbors.
98.Cm detail
99can be specified for additional detail.
100.It Cm show rib Op Cm detail
101Show the Routing Information Base.
102.Cm detail
103can be specified for additional detail.
104.It Cm show summary
105Show summary information.
106.El
107.Sh FILES
108.Bl -tag -width "/var/run/ospfd.sockXX" -compact
109.It /var/run/ospfd.sock
110Unix-domain socket used for communication with
111.Xr ospfd 8 .
112.El
113.Sh SEE ALSO
114.Xr ospfd.conf 5 ,
115.Xr ospfd 8
116.Sh HISTORY
117The
118.Nm
119program first appeared in
120.Ox 3.7 .
121