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