xref: /netbsd/usr.sbin/ldpd/ldpd.8 (revision 6550d01e)
1.\" $NetBSD: ldpd.8,v 1.4 2010/12/31 06:15:08 wiz Exp $
2.\"
3.\" Copyright (c) 2010 The NetBSD Foundation, Inc.
4.\" All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\"  1. Redistributions of source code must retain the above copyright
10.\"     notice, this list of conditions and the following disclaimer.
11.\"  2. Redistributions in binary form must reproduce the above copyright
12.\"     notice, this list of conditions and the following disclaimer in the
13.\"     documentation and/or other materials provided with the distribution.
14.\"
15.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
16.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
17.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
18.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
19.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
20.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
21.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
22.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
23.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
24.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
25.\" POSSIBILITY OF SUCH DAMAGE.
26.\"
27.Dd December 7, 2010
28.Dt LDPD 8
29.Os
30.Sh NAME
31.Nm ldpd
32.Nd Label Distribution Protocol Daemon
33.Sh SYNOPSIS
34.Nm
35.Op Fl DdfhW
36.Op Fl c Ar config_file
37.Op Fl p Ar port
38.Sh DESCRIPTION
39.Nm
40is a utility used to automatically distribute labels between two MPLS LSRs
41almost conforming to RFC3036.
42Right now it is in BETA stage and many features
43are not implemented or may not work.
44As a security measure you SHOULD filter the LDP well-known (646)
45TCP and UDP ports using your favourite packet filter before starting
46.Nm .
47Also this is the current measure used to filter neighbours.
48You should see some logs reported via
49.Xr syslog 3
50interface.
51.Pp
52You can increase the log verbosity using the
53.Fl W
54and
55.Fl D
56flags.
57Also you can telnet to the control port (default: 2626) and use
58this interface in order to get informations about protocol, neighbours
59etc. but also to set runtime parameters.
60The required password is the same as the root password.
61.Pp
62.Nm
63computes existing routes and tries to match them on MPLS labels
64announced by other LDP peers.
65This means that
66.Dq normal
67routes will be changed into tagged routes, and MPLS routing table
68will be populated.
69It will also announce its mappings to its peers.
70.Nm
71will listen on a route socket and compute the necessary changes in
72order to change untagged routes into tagged routes.
73This means that one may use one's favourite dynamic routing protocol
74daemon without modifications.
75.Pp
76The options are as follows:
77.Bl -tag -width 15n
78.It Fl c Ar config_file
79Specifies a path to the config file.
80Default:
81.Pa /etc/ldpd.conf
82.It Fl D
83Enable debug mode.
84.It Fl d
85Don't use route interception code.
86.It Fl f
87Run in foreground.
88Use STDOUT for warning and debug messages.
89.It Fl h
90Outputs supported flags.
91.It Fl p Ar port
92Changes the TCP control port (default: 2626).
93.It Fl W
94Enable output of warning messages.
95.El
96.Sh SEE ALSO
97.Rs
98.%R RFC
99.%N 3036
100.%D January 2001
101.%T LDP Specification
102.Re
103.Sh HISTORY
104The
105.Nm
106command appeared in
107.Nx 6.0 .
108.Sh BUGS
109.Nm
110supports only IPv4.
111