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