865d257a9cd155d104c87ac23743ca86b278d465
[l2tpns.git] / Docs / startup-config.5
1 .\" -*- nroff -*-
2 .de Id
3 .ds Dt \\$4 \\$5
4 ..
5 .Id $Id: startup-config.5,v 1.16 2006/04/27 09:53:50 bodea Exp $
6 .TH STARTUP-CONFIG 5 "\*(Dt" L2TPNS "File Formats and Conventions"
7 .SH NAME
8 startup\-config \- configuration file for l2tpns
9 .SH SYNOPSIS
10 /etc/l2tpns/startup-config
11 .SH DESCRIPTION
12 .B startup-config
13 is the configuration file for
14 .BR l2tpns .
15 .PP
16 The format is plain text, in the same format as accepted by the
17 configuration mode of
18 .BR l2tpns 's
19 telnet administrative interface.  Comments are indicated by either the
20 character
21 .B #
22 or
23 .BR ! .
24 .SS SETTINGS
25 Settings are specified with
26 .IP
27 .BI "set " "variable value"
28 .PP
29 The following
30 .IR variable s
31 may be set:
32 .RS
33 .TP
34 .B debug
35 Set the level of debugging messages written to the log file.  The
36 value should be between 0 and 5, with 0 being no debugging, and 5
37 being the highest.
38 .TP
39 .B log_file
40 This will be where all logging and debugging information is written
41 to.  This may be either a filename, such as
42 .BR /var/log/l2tpns ,
43 or the string
44 .BR syslog : \fIfacility\fR ,
45 where
46 .I facility
47 is any one of the syslog logging facilities, such as
48 .BR local5 .
49 .TP
50 .B pid_file
51 If set, the process id will be written to the specified file.  The
52 value must be an absolute path.
53 .TP
54 .B random_device
55 Path to random data source (default
56 .BR /dev/urandom ).
57 Use "" to use the rand() library function.
58 .TP
59 .B l2tp_secret
60 The secret used by
61 .B l2tpns
62 for authenticating tunnel request.  Must be the same as the LAC, or
63 authentication will fail.  Only actually be used if the LAC requests
64 authentication.
65 .TP
66 .B l2tp_mtu
67 MTU of interface for L2TP traffic (default: 1500).  Used to set link
68 MRU and adjust TCP MSS.
69 .TP
70 .B ppp_restart_time
71 Restart timer for PPP protocol negotiation in seconds (default: 3).
72 .TP
73 .B ppp_max_configure
74 Number of configure requests to send before giving up (default: 10).
75 .TP
76 .B ppp_max_failure
77 Number of Configure-Nak requests to send before sending a
78 Configure-Reject (default: 5).
79 .TP
80 .BR primary_dns , " secondary_dns"
81 Whenever a PPP connection is established, DNS servers will be sent to the
82 user, both a primary and a secondary.  If either is set to 0.0.0.0, then that
83 one will not be sent.
84 .TP
85 .BR primary_radius , " secondary_radius"
86 Sets the RADIUS servers used for both authentication and accounting. 
87 If the primary server does not respond, then the secondary RADIUS
88 server will be tried.
89 .TP
90 .BR primary_radius_port , " secondary_radius_port"
91 Sets the authentication ports for the primary and secondary RADIUS
92 servers.  The accounting port is one more than the authentication
93 port.  If no ports are given, authentication defaults to 1645, and
94 accounting to 1646.
95 .TP
96 .B radius_accounting
97 If set to true, then RADIUS accounting packets will be sent.  A
98 .B Start
99 record will be sent when the session is successfully authenticated,
100 and a
101 .B Stop
102 record when the session is closed.
103 .TP
104 .B radius_interim
105 If
106 .B radius_accounting
107 is on, defines the interval between sending of RADIUS interim
108 accounting records (in seconds).
109 .TP
110 .B radius_secret
111 Secret to be used in RADIUS packets.
112 .TP
113 .B radius_authtypes
114 A comma separated list of supported RADIUS authentication methods
115 ("pap" or "chap"), in order of preference (default "pap").
116 .TP
117 .B radius_dae_port
118 Port for DAE RADIUS (Packet of Death/Disconnect, Change of Authorization)
119 requests (default: 3799).
120 .TP
121 .B allow_duplicate_users
122 Allow multiple logins with the same username.  If false (the default),
123 any prior session with the same username will be dropped when a new
124 session is established.
125 .TP
126 .B guest_account
127 Allow multiple logins matching this specific username.
128 .TP
129 .B bind_address
130 When the tun interface is created, it is assigned the address
131 specified here.  If no address is given, 1.1.1.1 is used.  Packets
132 containing user traffic should be routed via this address if given,
133 otherwise the primary address of the machine.
134 .TP
135 .B peer_address
136 Address to send to clients as the default gateway.
137 .TP
138 .B send_garp
139 Determines whether or not to send a gratuitous ARP for the
140 .B bind_address
141 when the server is ready to handle traffic (default: true).  This
142 setting is ignored if BGP is configured.
143 .TP
144 .B throttle_speed
145 Sets the default speed (in kbits/s) which sessions will be limited to.
146 .TP
147 .B throttle_buckets
148 Number of token buckets to allocate for throttling.  Each throttled
149 session requires two buckets (in and out).
150 .TP
151 .B accounting_dir
152 If set to a directory, then every 5 minutes the current usage for
153 every connected use will be dumped to a file in this directory.
154 .TP
155 .B setuid
156 After starting up and binding the interface, change UID to this.  This
157 doesn't work properly.
158 .TP
159 .B dump_speed
160 If set to true, then the current bandwidth utilization will be logged
161 every second.  Even if this is disabled, you can see this information
162 by running the
163 .B uptime
164 command on the CLI.
165 .TP
166 .B multi_read_count
167 Number of packets to read off each of the UDP and TUN fds when
168 returned as readable by select (default: 10).  Avoids incurring the
169 unnecessary system call overhead of select on busy servers.
170 .TP
171 .B scheduler_fifo
172 Sets the scheduling policy for the
173 .B l2tpns
174 process to
175 .BR SCHED_FIFO .
176 This causes the kernel to immediately preempt any currently running
177 .B SCHED_OTHER
178 (normal) process in favour of
179 .B l2tpns
180 when it becomes runnable. 
181 .br
182 Ignored on uniprocessor systems.
183 .TP
184 .B lock_pages
185 Keep all pages mapped by the
186 .B l2tpns
187 process in memory.
188 .TP
189 .B icmp_rate
190 Maximum number of host unreachable ICMP packets to send per second.
191 .TP
192 .B packet_limit
193 Maximum number of packets of downstream traffic to be handled each
194 tenth of a second per session.  If zero, no limit is applied (default: 
195 0).  Intended as a DoS prevention mechanism and not a general
196 throttling control (packets are dropped, not queued).
197 .TP
198 .B cluster_address
199 Multicast cluster address (default: 239.192.13.13).
200 .TP
201 .B cluster_interface
202 Interface for cluster packets (default: eth0).
203 .TP
204 .B cluster_mcast_ttl
205 TTL for multicast packets (default: 1).
206 .TP
207 .B cluster_hb_interval
208 Interval in tenths of a second between cluster heartbeat/pings.
209 .TP
210 .B cluster_hb_timeout
211 Cluster heartbeat timeout in tenths of a second.  A new master will be
212 elected when this interval has been passed without seeing a heartbeat
213 from the master.
214 .TP
215 .B cluster_master_min_adv
216 Determines the minumum number of up to date slaves required before the
217 master will drop routes (default: 1).
218 .TP
219 .B ipv6_prefix
220 Enable negotiation of IPv6.  This forms the the first 64 bits of the
221 client allocated address.  The remaining 64 come from the allocated
222 IPv4 address and 4 bytes of 0s.
223 .RE
224 .SS BGP ROUTING
225 The routing configuration section is entered by the command
226 .IP
227 .BI "router bgp " as
228 .PP
229 where
230 .I as
231 specifies the local AS number.
232 .PP
233 Subsequent lines prefixed with
234 .BI "neighbour " peer
235 define the attributes of BGP neighhbours.  Valid commands are:
236 .IP
237 .BI "neighbour " peer " remote-as " as
238 .br
239 .BI "neighbour " peer " timers " "keepalive hold"
240 .PP
241 Where
242 .I peer
243 specifies the BGP neighbour as either a hostname or IP address,
244 .I as
245 is the remote AS number and
246 .IR keepalive ,
247 .I hold
248 are the timer values in seconds.
249 .SS NAMED ACCESS LISTS
250 Named access lists may be defined with either of
251 .IP
252 .BI "ip access\-list standard " name
253 .br
254 .BI "ip access\-list extended " name
255 .PP
256 Subsequent lines starting with
257 .B permit
258 or
259 .B deny
260 define the body of the access\-list.
261 .PP
262 .B Standard Access Lists
263 .RS 4n
264 Standard access lists are defined with:
265 .IP
266 .RB { permit | deny }
267 .IR source " [" dest ]
268 .PP
269 Where
270 .I source
271 and
272 .I dest
273 specify IP matches using one of:
274 .IP
275 .I address
276 .I wildard
277 .br
278 .B host
279 .I address
280 .br
281 .B any
282 .PP
283 .I address
284 and
285 .I wildard
286 are in dotted-quad notation, bits in the
287 .I wildard
288 indicate which address bits in
289 .I address
290 are relevant to the match (0 = exact match; 1 = don't care).
291 .PP
292 The shorthand
293 .RB ' host
294 .IR address '
295 is equivalent to
296 .RI ' address
297 .BR 0.0.0.0 ';
298 .RB ' any '
299 to
300 .RB ' 0.0.0.0
301 .BR 255.255.255.255 '.
302 .RE
303 .PP
304 .B Extended Access Lists
305 .RS 4n
306 Extended access lists are defined with:
307 .IP
308 .RB { permit | deny }
309 .I proto
310 .IR source " [" ports "] " dest " [" ports "] [" flags ]
311 .PP
312 Where
313 .I proto
314 is one of
315 .BR ip ,
316 .B tcp
317 or
318 .BR udp ,
319 and
320 .I source
321 and
322 .I dest
323 are as described above for standard lists.
324 .PP
325 For TCP and UDP matches, source and destination may be optionally
326 followed by a
327 .I ports
328 specification:
329 .IP
330 .RB { eq | neq | gt | lt }
331 .I port
332 .br
333 .B
334 range
335 .I from to
336 .PP
337 .I flags
338 may be one of:
339 .RS
340 .HP
341 .RB { match\-any | match\-all }
342 .RB { + | - }{ fin | syn | rst | psh | ack | urg }
343 \&...
344 .br
345 Match packets with any or all of the tcp flags set
346 .RB ( + )
347 or clear
348 .RB ( - ).
349 .HP
350 .B established
351 .br
352 Match "established" TCP connections:  packets with
353 .B RST
354 or
355 .B ACK
356 set, and
357 .B SYN
358 clear.
359 .HP
360 .B fragments
361 .br
362 Match IP fragments.  May not be specified on rules with layer 4
363 matches.
364 .RE
365 .SH SEE ALSO
366 .BR l2tpns (8)