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