aa566911fa1721b60307060825d6364cb15efe3d
[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 2004-11-29 06:29:28 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 cleanup_interval
135 Interval between regular cleanups (in seconds).
136 .TP
137 .B multi_read_count
138 Number of packets to read off each of the UDP and TUN fds when
139 returned as readable by select (default: 10).  Avoids incurring the
140 unnecessary system call overhead of select on busy servers.
141 .TP
142 .B scheduler_fifo
143 Sets the scheduling policy for the
144 .B l2tpns
145 process to
146 .BR SCHED_FIFO .
147 This causes the kernel to immediately preempt any currently running
148 .B SCHED_OTHER
149 (normal) process in favour of
150 .B l2tpns
151 when it becomes runnable. 
152 .br
153 Ignored on uniprocessor systems.
154 .TP
155 .B lock_pages
156 Keep all pages mapped by the
157 .B l2tpns
158 process in memory.
159 .TP
160 .B icmp_rate
161 Maximum number of host unreachable ICMP packets to send per second.
162 .TP
163 .B cluster_address
164 Multicast cluster address (default: 239.192.13.13).
165 .TP
166 .B cluster_interface
167 Interface for cluster packets (default: eth0).
168 .TP
169 .B cluster_hb_interval
170 Interval in tenths of a second between cluster heartbeat/pings.
171 .TP
172 .B cluster_hb_timeout
173 Cluster heartbeat timeout in tenths of a second.  A new master will be
174 elected when this interval has been passed without seeing a heartbeat
175 from the master.
176 .RE
177 .SS BGP ROUTING
178 The routing configuration section is entered by the command
179 .IP
180 .BI "router bgp " as
181 .PP
182 where
183 .I as
184 specifies the local AS number.
185 .PP
186 Subsequent lines prefixed with
187 .BI "neighbour " peer
188 define the attributes of BGP neighhbours.  Valid commands are:
189 .IP
190 .BI "neighbour " peer " remote-as " as
191 .br
192 .BI "neighbour " peer " timers " "keepalive hold"
193 .PP
194 Where
195 .I peer
196 specifies the BGP neighbour as either a hostname or IP address,
197 .I as
198 is the remote AS number and
199 .IR keepalive ,
200 .I hold
201 are the timer values in seconds.
202 .SS NAMED ACCESS LISTS
203 Named access lists may be defined with either of
204 .IP
205 .BI "ip access\-list standard " name
206 .br
207 .BI "ip access\-list extended " name
208 .PP
209 Subsequent lines starting with
210 .B permit
211 or
212 .B deny
213 define the body of the access\-list.
214 .PP
215 .B Standard Access Lists
216 .RS 4n
217 Standard access lists are defined with:
218 .IP
219 .RB { permit | deny }
220 .IR source " [" dest ]
221 .PP
222 Where
223 .I source
224 and
225 .I dest
226 specify IP matches using one of:
227 .IP
228 .I address
229 .I wildard
230 .br
231 .B host
232 .I address
233 .br
234 .B any
235 .PP
236 .I address
237 and
238 .I wildard
239 are in dotted-quad notation, bits in the
240 .I wildard
241 indicate which address bits in
242 .I address
243 are relevant to the match (0 = exact match; 1 = don't care).
244 .PP
245 The shorthand
246 .RB ' host
247 .IR address '
248 is equivalent to
249 .RI ' address
250 .BR 0.0.0.0 ';
251 .RB ' any '
252 to
253 .RB ' 0.0.0.0
254 .BR 255.255.255.255 '.
255 .RE
256 .PP
257 .B Extended Access Lists
258 .RS 4n
259 Extended access lists are defined with:
260 .IP
261 .RB { permit | deny }
262 .I proto
263 .IR source " [" ports "] " dest " [" ports "] [" flags ]
264 .PP
265 Where
266 .I proto
267 is one of
268 .BR ip ,
269 .B tcp
270 or
271 .BR udp ,
272 and
273 .I source
274 and
275 .I dest
276 are as described above for standard lists.
277 .PP
278 For TCP and UDP matches, source and destination may be optionally
279 followed by a
280 .I ports
281 specification:
282 .IP
283 .RB { eq | neq | gt | lt }
284 .I port
285 .br
286 .B
287 range
288 .I from to
289 .PP
290 .I flags
291 may be one of:
292 .RS
293 .HP
294 .RB { match\-any | match\-all }
295 .RB { + | - }{ fin | syn | rst | psh | ack | urg }
296 \&...
297 .br
298 Match packets with any or all of the tcp flags set
299 .RB ( + )
300 or clear
301 .RB ( - ).
302 .HP
303 .B established
304 .br
305 Match "established" TCP connections:  packets with
306 .B RST
307 or
308 .B ACK
309 set, and
310 .B SYN
311 clear.
312 .HP
313 .B fragments
314 .br
315 Match IP fragments.  May not be specified on rules with layer 4
316 matches.
317 .RE
318 .SH SEE ALSO
319 .BR l2tpns (8)