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