xref: /openbsd/usr.sbin/ospf6ctl/ospf6ctl.8 (revision 4cfece93)
1.\"	$OpenBSD: ospf6ctl.8,v 1.12 2018/06/06 05:52:59 remi 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 6 2018 $
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.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 log brief
62Disable verbose debug logging.
63.It Cm log verbose
64Enable verbose debug logging.
65.It Cm reload
66Reload the configuration file.
67This command currently has no effect.
68.It Cm show database Op Ar filter
69Show the link state database.
70.Ar filter
71can be any one of the following:
72.Pp
73.Bl -tag -width "self-originatedXX" -compact
74.It Cm area Ar ID
75Show only LSAs from the specified area
76.Ar ID .
77.It Cm asbr
78Show only ASBR LSAs.
79.It Cm external
80Show only AS-External LSAs.
81.It Cm intra
82Show only Intra-Area-Prefix LSAs.
83.It Cm link
84Show only Link LSAs.
85.It Cm network
86Show only Network LSAs.
87.It Cm router
88Show only Router LSAs.
89.It Cm self-originated
90Show only self-originated LSAs.
91.It Cm summary
92Show only Summary LSAs.
93.El
94.It Cm show fib Op Ar destination | filter
95Show the Forwarding Information Base.
96.Ar destination
97can be specified to show the route matching a destination IP address.
98.Ar filter
99can be any of the following:
100.Pp
101.Bl -tag -width "interfaceXXinterfaceXX" -compact
102.It Cm connected
103Show only connected routes.
104.It Cm interface Op Ar interface
105Show only interfaces or the specified
106.Ar interface .
107.It Cm ospf
108Show only OSPF routes.
109.It Cm static
110Show only static routes.
111.El
112.Pp
113.Cm connected ,
114.Cm ospf
115and
116.Cm static
117may be specified together.
118.It Cm show interfaces Op Ar interface
119Show details for all interfaces or the specified
120.Ar interface .
121.It Cm show neighbor Op Cm detail
122Show neighbors.
123.Cm detail
124can be specified for additional detail.
125.It Cm show rib Op Cm detail
126Show the Routing Information Base.
127.Cm detail
128can be specified for additional detail.
129.It Cm show summary
130Show summary information.
131.El
132.Sh FILES
133.Bl -tag -width "/var/run/ospf6d.sockXX" -compact
134.It Pa /var/run/ospf6d.sock
135.Ux Ns -domain
136socket used for communication with
137.Xr ospf6d 8 .
138.El
139.Sh SEE ALSO
140.Xr ospf6d.conf 5 ,
141.Xr ospf6d 8
142.Sh HISTORY
143The
144.Nm
145program first appeared in
146.Ox 4.2 .
147