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