xref: /openbsd-src/usr.sbin/ldpctl/ldpctl.8 (revision d13be5d47e4149db2549a9828e244d59dbc43f15)
1.\"	$OpenBSD: ldpctl.8,v 1.6 2010/09/01 13:59:17 claudio Exp $
2.\"
3.\" Copyright (c) 2009 Michele Marchetto <michele@openbsd.org>
4.\" Copyright (c) 2004, 2005 Esben Norby <norby@openbsd.org>
5.\"
6.\" Permission to use, copy, modify, and distribute this software for any
7.\" purpose with or without fee is hereby granted, provided that the above
8.\" copyright notice and this permission notice appear in all copies.
9.\"
10.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17.\"
18.Dd $Mdocdate: September 1 2010 $
19.Dt LDPCTL 8
20.Os
21.Sh NAME
22.Nm ldpctl
23.Nd control the Label Distribution Protocol daemon
24.Sh SYNOPSIS
25.Nm
26.Ar command
27.Op Ar argument ...
28.Sh DESCRIPTION
29The
30.Nm
31program controls the
32.Xr ldpd 8
33daemon.
34Commands may be abbreviated to the minimum unambiguous prefix; for example,
35.Cm s i
36for
37.Cm show interfaces .
38.Pp
39The following commands are available:
40.Bl -tag -width Ds
41.It Cm fib couple
42Insert the learned routes into the Label Forwarding Information Base a.k.a.
43the kernel routing table.
44.It Cm fib decouple
45Remove the learned routes from the Label Forwarding Information Base a.k.a.
46the kernel routing table.
47.It Cm log brief
48Disable verbose debug logging.
49.It Cm log verbose
50Enable verbose debug logging.
51.It Cm show fib Op Ar destination | filter
52Show the Label Forwarding Information Base.
53.Ar destination
54can be specified to show the route matching a destination IP address.
55.Ar filter
56can be any of the following:
57.Pp
58.Bl -tag -width "interfaceXXinterfaceXX" -compact
59.It Cm connected
60Show only connected routes.
61.It Cm interface
62Show only interfaces.
63.It Cm static
64Show only static routes.
65.El
66.Pp
67.Cm connected ,
68and
69.Cm static
70may be specified together.
71.It Cm show interfaces
72Show details for all interfaces.
73.It Cm show neighbor
74Show neighbors.
75.It Cm show lib
76Show the Label Information Base.
77.El
78.Sh FILES
79.Bl -tag -width "/var/run/ldpd.sockXX" -compact
80.It /var/run/ldpd.sock
81.Ux Ns -domain
82socket used for communication with
83.Xr ldpd 8 .
84.El
85.Sh SEE ALSO
86.Xr ldpd.conf 5 ,
87.Xr ldpd 8
88.Sh HISTORY
89The
90.Nm
91program first appeared in
92.Ox 4.6 .
93