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