xref: /netbsd-src/usr.sbin/ldpd/ldpd.conf.5 (revision fdd524d4ccd2bb0c6f67401e938dabf773eb0372)
1.\"	$NetBSD: ldpd.conf.5,v 1.2 2013/10/18 12:29:52 wiz Exp $
2.\"
3.\" Copyright (c) 2013 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 October 18, 2013
28.Dt LDPD.CONF 5
29.Os
30.Sh NAME
31.Nm ldpd.conf
32.Nd ldpd configuration file
33.Sh SYNOPSIS
34.Nm
35.Sh DESCRIPTION
36The
37.Nm
38file defines the
39.Xr ldpd 8
40initial setup and may contain information about LDP identificator, network,
41neighbour and interface parameters.
42Blank lines are allowed and comments lines should start with
43.Sq # .
44Non block lines should end with a semicolon.
45.Sh FILES
46.Bl -tag -width /etc/ldpd.conf -compact
47.It Pa /etc/ldpd.conf
48The file
49.Nm
50resides in
51.Pa /etc .
52.El
53.Sh CONFIGURATION
54The following options are accepted:
55.Bl -tag -width "keepalive-time"
56.It Li command-port
57Control and command TCP port (default: 2626)
58.It Li hello-time
59Interval in seconds on which hellos are sent out on interfaces (default: 6s)
60.It Li interface
61Interface block commands (see below)
62.It Li keepalive-time
63Keepalive interval in seconds for established peers (default: 4s)
64.It Li ldp-id
65Force using a certain LDP Identificator (default autogenerated, highest INET4
66address set on an interface excluding 127/8 range)
67.It Li min-label
68Minimum number used for generated labels (default: 16)
69.It Li max-label
70Maximum number used for generated labels (default: 1048576)
71.It Li neighbour
72Neighbour block subcommands (see below)
73.It Li no-default-route
74If set to 0
75.Xr ldpd 8
76will try to tag also the default route (default: 1)
77.El
78.Pp
79Interface block supports the following parameters
80.Bl -tag -width "transport-address"
81.It Li passive
82Don't send hellos on interface
83.It Li transport-address
84Transport INET4 address advertised in hellos sent on the mentioned interface
85.El
86.Pp
87Neighbour block supports the following parameters
88.Bl -tag -width "authenticate"
89.It Li authenticate
90Authenticate peer using TCP MD5 signature - needs options TCP_SIGNATURE.
91Default: off
92.El
93.Sh EXAMPLES
94The following is an example
95.Pa /etc/ldpd.conf
96file:
97.Pp
98.Bd -literal
99# Transport address needs to be an alias for this interface
100interface re0 {
101	transport-address 192.168.2.2
102}
103
104# Don't send hellos on en0
105interface en0 {
106	passive
107}
108
109# Force a certain LDP ID
110ldp-id 10.5.1.1;
111
112# Tag also the default route
113no-default-route 0;
114
115neighbour 192.168.2.1 {
116# TCP MD5 authentication - requires options TCP_SIGNATURE
117	authenticate
118}
119.Ed
120.Sh SEE ALSO
121.Xr mpls 4 ,
122.Xr ldpd 8
123.Sh HISTORY
124Support for
125.Nm
126first appeared in
127.Nx 6.0 .
128