xref: /openbsd/usr.sbin/ldpctl/ldpctl.8 (revision 73471bf0)
1.\"	$OpenBSD: ldpctl.8,v 1.13 2016/05/23 19:06:03 renato 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: May 23 2016 $
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 Xo
42.Cm clear neighbors
43.Op Ar address
44.Xc
45Delete entries from the neighbor table.
46.Ar address
47can be used to limit the scope of the command to the given neighbor.
48.It Cm fib couple
49Insert the learned labels into the Label Forwarding Information Base a.k.a.
50the kernel routing table.
51.It Cm fib decouple
52Remove the learned labels from the Label Forwarding Information Base a.k.a.
53the kernel routing table.
54.It Cm log brief
55Disable verbose debug logging.
56.It Cm log verbose
57Enable verbose debug logging.
58.It Cm reload
59Reload the configuration file.
60.It Xo
61.Cm show fib
62.Op Cm family Ar family
63.Op Ar destination | filter
64.Xc
65Show the Label Forwarding Information Base.
66.Ar family ,
67if given, limit the output to the given address family.
68.Ar destination
69can be specified to show the route matching a destination IP address.
70.Ar filter
71can be any of the following:
72.Pp
73.Bl -tag -width "interfaceXXinterfaceXX" -compact
74.It Cm connected
75Show only connected routes.
76.It Cm interface
77Show only interfaces.
78.It Cm static
79Show only static routes.
80.El
81.Pp
82.Cm connected ,
83and
84.Cm static
85may be specified together.
86.It Xo
87.Cm show interfaces
88.Op Cm family Ar family
89.Xc
90Show details for all interfaces.
91.Ar family ,
92if given, limit the output to the given address family.
93.It Xo
94.Cm show discovery
95.Op Cm family Ar family
96.Xc
97Show adjacencies.
98.Ar family ,
99if given, limit the output to the given address family.
100.It Xo
101.Cm show neighbor
102.Op Cm family Ar family
103.Xc
104Show neighbors.
105.Ar family ,
106if given, limit the output to the given address family.
107.It Xo
108.Cm show lib
109.Op Cm family Ar family
110.Xc
111Show the Label Information Base.
112.Ar family ,
113if given, limit the output to the given address family.
114.It Cm show l2vpn bindings
115Show the PWID Label Information Base.
116.It Cm show l2vpn pseudowires
117Show the status of the configured pseudowires.
118.El
119.Sh FILES
120.Bl -tag -width "/var/run/ldpd.sockXX" -compact
121.It Pa /var/run/ldpd.sock
122.Ux Ns -domain
123socket used for communication with
124.Xr ldpd 8 .
125.El
126.Sh SEE ALSO
127.Xr ldpd.conf 5 ,
128.Xr ldpd 8
129.Sh HISTORY
130The
131.Nm
132program first appeared in
133.Ox 4.6 .
134