xref: /netbsd-src/usr.sbin/ldpd/ldpd.8 (revision 413d532bcc3f62d122e56d92e13ac64825a40baf)
1.\" $NetBSD: ldpd.8,v 1.9 2013/02/04 11:02:32 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 February 4, 2013
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
41conforming to RFC5036.
42Currently some features described by RFC5036 are not fully implemented (see
43.Sx BUGS
44section).
45.Nm
46supports peering with IPv6 LDP speakers and IPv6 labels exchange, conforming
47to specifications in RFC5036 and draft-ietf-mpls-ldp-ipv6.
48.Pp
49.Nm
50logs information using the
51.Xr syslog 3
52interface.
53You can increase the log verbosity using the
54.Fl W
55and
56.Fl D
57flags.
58.Pp
59Administrators can use
60.Xr telnet 1
61to connect to the control port (default: 2626) and use
62this interface in order to get informations about protocol status,
63neighbours et cetera but also to set runtime parameters.
64The password required for connecting is the same as the root password.
65.Pp
66.Nm
67computes existing routes and tries to match them on MPLS labels
68announced by other LDP peers.
69This means that usual IP
70routes will be changed into tagged routes, and MPLS routing table
71will be populated.
72Any change in MPLS topology will also be announced to LDP neighbors.
73.Nm
74uses currently Independent Control Mapping and Downstream Unsolicited mode
75for Label Advertisment.
76.Nm
77will listen on a route socket and compute the necessary changes in
78order to change untagged routes into tagged routes.
79This means that one may use one's favourite dynamic routing protocol
80daemon without modifications.
81.Pp
82The options are as follows:
83.Bl -tag -width 15n
84.It Fl c Ar config_file
85Specifies a path to the config file.
86Default:
87.Pa /etc/ldpd.conf
88- see
89.Xr ldpd.conf 5
90for configuration file format.
91.It Fl D
92Enable debug mode.
93.It Fl d
94Don't use route interception code.
95.Nm
96will not make any changes to routing table if started with this option.
97.It Fl f
98Run in foreground.
99Use STDOUT for warning and debug messages.
100.It Fl h
101Outputs supported flags.
102.It Fl p Ar port
103Changes the TCP control port (default: 2626).
104.It Fl W
105Enable output of warning messages.
106.El
107.Sh SEE ALSO
108.Rs
109.%R RFC
110.%N 5036
111.%D October 2007
112.%T LDP Specification
113.Re
114.Rs
115.%R RFC
116.%N 3037
117.%D January 2001
118.%T LDP Applicability
119.Re
120.Rs
121.%R DRAFT
122.%N draft-ietf-mpls-ldp-ipv6-07
123.%D June 2012
124.%T Updates to LDP for IPv6
125.Re
126.Sh HISTORY
127The
128.Nm
129command appeared in
130.Nx 6.0 .
131.Sh BUGS
132.Nm
133doesn't implement Path Vector and Hop Count TLVs.
134.Sh SECURITY CONSIDERATIONS
135As a security measure you SHOULD filter the LDP well-known (646)
136TCP and UDP ports using your favourite packet filter before starting
137.Nm .
138This is the current way used to filter neighbours and to protect the
139system from possible external attacks like route injections.
140