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