xref: /openbsd/usr.sbin/ldpd/ldpd.conf.5 (revision 404b540a)
1.\"	$OpenBSD: ldpd.conf.5,v 1.2 2009/06/02 16:17:14 michele Exp $
2.\"
3.\" Copyright (c) 2009 Michele Marchetto <michele@openbsd.org>
4.\" Copyright (c) 2005, 2006 Esben Norby <norby@openbsd.org>
5.\" Copyright (c) 2004 Claudio Jeker <claudio@openbsd.org>
6.\" Copyright (c) 2003, 2004 Henning Brauer <henning@openbsd.org>
7.\" Copyright (c) 2002 Daniel Hartmeier <dhartmei@openbsd.org>
8.\"
9.\" Permission to use, copy, modify, and distribute this software for any
10.\" purpose with or without fee is hereby granted, provided that the above
11.\" copyright notice and this permission notice appear in all copies.
12.\"
13.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
14.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
15.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
16.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
17.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
18.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
19.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
20.\"
21.Dd $Mdocdate: June 2 2009 $
22.Dt LDPD.CONF 5
23.Os
24.Sh NAME
25.Nm ldpd.conf
26.Nd Label Distribution Protocol daemon configuration file
27.Sh DESCRIPTION
28The
29.Xr ldpd 8
30daemon implements the Label Distribution Protocol as described in RFC 3036.
31.Sh SECTIONS
32The
33.Nm
34config file is divided into three main sections.
35.Bl -tag -width xxxx
36.It Sy Macros
37User-defined variables may be defined and used later, simplifying the
38configuration file.
39.It Sy Global Configuration
40Global settings for
41.Xr ldpd 8 .
42.It Sy Interfaces Configuration
43Interface-specific parameters.
44.El
45.Sh MACROS
46Much like
47.Xr cpp 1
48or
49.Xr m4 1 ,
50macros can be defined that will later be expanded in context.
51Macro names must start with a letter, and may contain letters, digits,
52and underscores.
53Macro names may not be reserved words (for example,
54.Ic cost ) .
55Macros are not expanded inside quotes.
56.Pp
57For example:
58.Bd -literal -offset indent
59hi="2"
60interface em0 {
61	cost $hi
62}
63.Ed
64.Sh GLOBAL CONFIGURATION
65Global settings concerns the main behaviour of the daemon.
66.Pp
67.Bl -tag -width Ds -compact
68.It Xo
69.Ic lfib-update
70.Pq Ic yes Ns \&| Ns Ic no
71.Xc
72If set to
73.Ic no ,
74do not update the Label Forwarding Information Base, a.k.a. the kernel routing
75table.
76The default is
77.Ic yes .
78.Pp
79.It Ic router-id Ar address
80Set the router ID; in combination with labelspace it forms the LSR-ID.
81.Pp
82.It Ic labelspace Ar number
83Set the label space advertised by
84.Xr ldpd 8 .
85.Pp
86.It Ic holdtime Ar seconds
87Set the hello holdtime in seconds.
88The maximum time
89.Xr ldpd 8
90will wait between two consecutive hello messages from a peer before it is
91marked as being down.
92The default value is 15.
93.Pp
94.It Ic hello-interval Ar seconds
95Set the hello interval in seconds.
96The default value is 5; valid range is 1\-65535.
97.Pp
98.It Ic keepalive Ar seconds
99Set the keepalive interval in seconds.
100The default value is 180; valid range is 1\-65535.
101.Pp
102.It Xo
103.Ic distribution
104.Pq Ic independent Ns \&| Ns Ic ordered
105.Xc
106Select the distribution mode.
107.Ic independent
108distributes labels at any time;
109.Ic ordered
110forces
111.Xr ldpd 8
112to wait a mapping from nexthop before distributing it to peers.
113.Pp
114.It Xo
115.Ic retention
116.Pq Ic liberal Ns \&| Ns Ic conservative
117.Xc
118Select the retention mode.
119.Ic conservative
120retains just the labels advertised from nexthop;
121.Ic liberal
122mode retains every label received, even those not advertised
123from nexthops.
124.Pp
125.It Xo
126.Ic advertisement
127.Pq Ic unsolicited Ns \&| Ns Ic ondemand
128.Xc
129Select the advertisement mode.
130.Ic unsolicited
131advertises labels according to the distribution mode;
132.Ic ondemand
133advertises labels solely upon explicit request from peers.
134.El
135.Sh INTERFACES
136Each interface can have several parameters configured individually, otherwise
137they are inherited.
138.Bd -literal -offset indent
139interface em0 {
140}
141.Ed
142.Pp
143Interface-specific parameters are listed below.
144.Bl -tag -width Ds
145.It Ic passive
146Prevent transmission and reception of LDP packets on this interface.
147.El
148.Sh FILES
149.Bl -tag -width "/etc/ldpd.conf" -compact
150.It Pa /etc/ldpd.conf
151.Xr ldpd 8
152configuration file
153.El
154.Sh SEE ALSO
155.Xr rc.conf.local 8 ,
156.Xr ldpctl 8 ,
157.Xr ldpd 8
158.Rs
159.Sh HISTORY
160The
161.Nm
162file format first appeared in
163.Ox 4.6 .
164