xref: /openbsd-src/usr.sbin/ospf6ctl/ospf6ctl.8 (revision dd3b9a80516716eb7d3616a923f2076c1f1589de)
1.\"	$OpenBSD: ospf6ctl.8,v 1.14 2023/06/21 09:47:03 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: June 21 2023 $
18.Dt OSPF6CTL 8
19.Os
20.Sh NAME
21.Nm ospf6ctl
22.Nd control the OSPF for IPv6 routing 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 ospf6d 8
33daemon.
34.Pp
35The following options are available:
36.Bl -tag -width Ds
37.It Fl s Ar socket
38Use
39.Ar socket
40instead of the default
41.Pa /var/run/ospf6d.sock
42to communicate with
43.Xr ospfd 8 .
44.El
45.Pp
46Commands may be abbreviated to the minimum unambiguous prefix; for example,
47.Cm s s
48for
49.Cm show summary .
50.Pp
51The following commands are available:
52.Bl -tag -width Ds
53.It Cm fib couple
54Insert the learned routes into the Forwarding Information Base (FIB),
55a.k.a. the kernel routing table.
56.It Cm fib decouple
57Remove the learned routes from the FIB.
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.
70This command currently has no effect.
71.It Cm show database Op Ar filter
72Show the link state database.
73.Ar filter
74can be any one of the following:
75.Pp
76.Bl -tag -width "self-originatedXX" -compact
77.It Cm area Ar ID
78Show only LSAs from the specified area
79.Ar ID .
80.It Cm asbr
81Show only ASBR LSAs.
82.It Cm external
83Show only AS-External LSAs.
84.It Cm intra
85Show only Intra-Area-Prefix LSAs.
86.It Cm link
87Show only Link LSAs.
88.It Cm network
89Show only Network LSAs.
90.It Cm router
91Show only Router LSAs.
92.It Cm self-originated
93Show only self-originated LSAs.
94.It Cm summary
95Show only Summary LSAs.
96.El
97.It Cm show fib Op Ar destination | filter
98Show the Forwarding Information Base.
99.Ar destination
100can be specified to show the route matching a destination IP address.
101.Ar filter
102can be any of the following:
103.Pp
104.Bl -tag -width "interfaceXXinterfaceXX" -compact
105.It Cm connected
106Show only connected routes.
107.It Cm interface Op Ar interface
108Show only interfaces or the specified
109.Ar interface .
110.It Cm ospf
111Show only OSPF routes.
112.It Cm static
113Show only static routes.
114.El
115.Pp
116.Cm connected ,
117.Cm ospf
118and
119.Cm static
120may be specified together.
121.It Cm show interfaces Op Ar interface
122Show details for all interfaces or the specified
123.Ar interface .
124.It Cm show neighbor Op Cm detail
125Show neighbors.
126.Cm detail
127can be specified for additional detail.
128.It Cm show rib Op Cm detail
129Show the Routing Information Base.
130.Cm detail
131can be specified for additional detail.
132.It Cm show summary
133Show summary information.
134.El
135.Sh FILES
136.Bl -tag -width "/var/run/ospf6d.sockXX" -compact
137.It Pa /var/run/ospf6d.sock
138.Ux Ns -domain
139socket used for communication with
140.Xr ospf6d 8 .
141.El
142.Sh SEE ALSO
143.Xr ospf6d.conf 5 ,
144.Xr ospf6d 8
145.Sh HISTORY
146The
147.Nm
148program first appeared in
149.Ox 4.2 .
150