Fix cluster slave; no add the ipv6 route address (/128) if included in the delegated...
[l2tpns.git] / Docs / startup-config.5
1 .\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
2 .\"
3 .\" Standard preamble:
4 .\" ========================================================================
5 .de Sp \" Vertical space (when we can't use .PP)
6 .if t .sp .5v
7 .if n .sp
8 ..
9 .de Vb \" Begin verbatim text
10 .ft CW
11 .nf
12 .ne \\$1
13 ..
14 .de Ve \" End verbatim text
15 .ft R
16 .fi
17 ..
18 .\" Set up some character translations and predefined strings.  \*(-- will
19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
23 .\" nothing in troff, for use with C<>.
24 .tr \(*W-
25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
26 .ie n \{\
27 .    ds -- \(*W-
28 .    ds PI pi
29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
31 .    ds L" ""
32 .    ds R" ""
33 .    ds C` ""
34 .    ds C' ""
35 'br\}
36 .el\{\
37 .    ds -- \|\(em\|
38 .    ds PI \(*p
39 .    ds L" ``
40 .    ds R" ''
41 'br\}
42 .\"
43 .\" Escape single quotes in literal strings from groff's Unicode transform.
44 .ie \n(.g .ds Aq \(aq
45 .el       .ds Aq '
46 .\"
47 .\" If the F register is turned on, we'll generate index entries on stderr for
48 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
49 .\" entries marked with X<> in POD.  Of course, you'll have to process the
50 .\" output yourself in some meaningful fashion.
51 .ie \nF \{\
52 .    de IX
53 .    tm Index:\\$1\t\\n%\t"\\$2"
54 ..
55 .    nr % 0
56 .    rr F
57 .\}
58 .el \{\
59 .    de IX
60 ..
61 .\}
62 .\"
63 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
64 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
65 .    \" fudge factors for nroff and troff
66 .if n \{\
67 .    ds #H 0
68 .    ds #V .8m
69 .    ds #F .3m
70 .    ds #[ \f1
71 .    ds #] \fP
72 .\}
73 .if t \{\
74 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
75 .    ds #V .6m
76 .    ds #F 0
77 .    ds #[ \&
78 .    ds #] \&
79 .\}
80 .    \" simple accents for nroff and troff
81 .if n \{\
82 .    ds ' \&
83 .    ds ` \&
84 .    ds ^ \&
85 .    ds , \&
86 .    ds ~ ~
87 .    ds /
88 .\}
89 .if t \{\
90 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
91 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
92 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
93 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
94 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
95 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
96 .\}
97 .    \" troff and (daisy-wheel) nroff accents
98 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
99 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
100 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
101 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
102 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
103 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
104 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
105 .ds ae a\h'-(\w'a'u*4/10)'e
106 .ds Ae A\h'-(\w'A'u*4/10)'E
107 .    \" corrections for vroff
108 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
109 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
110 .    \" for low resolution devices (crt and lpr)
111 .if \n(.H>23 .if \n(.V>19 \
112 \{\
113 .    ds : e
114 .    ds 8 ss
115 .    ds o a
116 .    ds d- d\h'-1'\(ga
117 .    ds D- D\h'-1'\(hy
118 .    ds th \o'bp'
119 .    ds Th \o'LP'
120 .    ds ae ae
121 .    ds Ae AE
122 .\}
123 .rm #[ #] #H #V #F C
124 .\" ========================================================================
125 .\"
126 .IX Title "STARTUP-CONFIG.5 1"
127 .TH STARTUP-CONFIG.5 1 "2014-09-11" "perl v5.14.2" "User Contributed Perl Documentation"
128 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
129 .\" way too many mistakes in technical documents.
130 .if n .ad l
131 .nh
132 .SH "NAME"
133 startup\-config \- configuration file for l2tpns
134 .SH "SYNOPSIS"
135 .IX Header "SYNOPSIS"
136 /etc/l2tpns/startup\-config
137 .SH "DESCRIPTION"
138 .IX Header "DESCRIPTION"
139 \&\fBstartup-config\fR is the configuration file for \fBl2tpns\fR
140 .PP
141 The format is plain text, in the same format as accepted by
142 the configuration mode of l2tpns's telnet administrative 
143 interface. Comments are indicated by either the character # or !.
144 .SS "\s-1SETTINGS\s0"
145 .IX Subsection "SETTINGS"
146 Settings are specified with
147 .IP "\fBset\fR \fIvariable\fR \fIvalue\fR" 4
148 .IX Item "set variable value"
149 .PP
150 A list of the possible configuration directives follows. Each of these should be set by a line like:
151 .ie n .IP "\fBset\fR \fIconfigstring\fR \fI""value""\fR" 4
152 .el .IP "\fBset\fR \fIconfigstring\fR \fI``value''\fR" 4
153 .IX Item "set configstring value"
154 .PD 0
155 .IP "\fBset\fR \fIipaddress\fR \fI192.168.1.1\fR" 4
156 .IX Item "set ipaddress 192.168.1.1"
157 .IP "\fBset\fR \fIboolean\fR \fItrue\fR" 4
158 .IX Item "set boolean true"
159 .PD
160 .PP
161 The following \fIvariables\fR may be set:
162 .IP "\fBaccounting_dir\fR (string)" 4
163 .IX Item "accounting_dir (string)"
164 If set to a directory, then every 5 minutes the current usage for every connected use will be dumped to a file in this directory. Each file dumped begins with a header, where each line is prefixed by #. Following the header is a single line for every connected user, fields separated by a space.
165 .Sp
166 The fields are username, ip, qos, uptxoctets, downrxoctets, origin (optional). The qos field is 1 if a standard user, and 2 if the user is throttled. The origin field is dump if \fBaccount_all_origin\fR is set to true (origin value: L=LAC data, R=Remote \s-1LNS\s0 data, P=PPPOE data).
167 .IP "\fBaccount_all_origin\fR (boolean)" 4
168 .IX Item "account_all_origin (boolean)"
169 If set to true, all origin of the usage is dumped to the accounting file (LAC+Remote \s-1LNS+PPPOE\s0)(default false).
170 .IP "\fBallow_duplicate_users\fR (boolean)" 4
171 .IX Item "allow_duplicate_users (boolean)"
172 Allow multiple logins with the same username. If false (the default), any prior session with the same username will be dropped when a new session is established.
173 .IP "\fBauth_tunnel_change_addr_src\fR (boolean)" 4
174 .IX Item "auth_tunnel_change_addr_src (boolean)"
175 This parameter authorize to change the source \s-1IP\s0 of the tunnels l2tp. This parameter can be used when the remotes \s-1BAS/LAC\s0 are l2tpns server configured in cluster mode, but that the interface to remote \s-1LNS\s0 are not clustered (the tunnel can be coming from different source \s-1IP\s0) (default: no).
176 .IP "\fBbind_address\fR (ip address)" 4
177 .IX Item "bind_address (ip address)"
178 It's the listen address of the l2tp udp protocol sent and received to \s-1LAC\s0. This address is also assigned to the tun interface if no iftun_address is specified. Packets containing user traffic should be routed via this address if given, otherwise the primary address of the machine.
179 .IP "\fBbind_multi_address\fR (ip address)" 4
180 .IX Item "bind_multi_address (ip address)"
181 This parameter permit to listen several addresss of the l2tp udp protocol (and set several address to the tun interface).
182 .Sp
183 \&\s-1WHEN\s0 this parameter is set, It \s-1OVERWRITE\s0 the parameters \*(L"bind_address\*(R" and \*(L"iftun_address\*(R".
184 .Sp
185 these can be interesting when you want do load-balancing in cluster mode of the uploaded from the \s-1LAC\s0. For example you can set a bgp.prepend(\s-1MY_AS\s0) for Address1 on \s-1LNS1\s0 and a bgp.prepend(\s-1MY_AS\s0) for Address2 on \s-1LNS2\s0 (see \s-1BGP\s0 AS-path prepending).
186 .Sp
187 example of use with 2 address:
188 .Sp
189 \&\fBset\fR \fIbind_multi_address\fR \*(L"64.14.13.41, 64.14.13.42\*(R"
190 .IP "\fBcluster_address\fR (ip address)" 4
191 .IX Item "cluster_address (ip address)"
192 Multicast cluster address (default: 239.192.13.13). See the section on Clustering for more information.
193 .IP "\fBcluster_interface\fR (string)" 4
194 .IX Item "cluster_interface (string)"
195 Interface for cluster packets (default: eth0).
196 .IP "\fBcluster_mcast_ttl\fR (int)" 4
197 .IX Item "cluster_mcast_ttl (int)"
198 \&\s-1TTL\s0 for multicast packets (default: 1).
199 .IP "\fBcluster_hb_interval\fR (int)" 4
200 .IX Item "cluster_hb_interval (int)"
201 Interval in tenths of a second between cluster heartbeat/pings.
202 .IP "\fBcluster_hb_timeout\fR (int)" 4
203 .IX Item "cluster_hb_timeout (int)"
204 Cluster heartbeat timeout in tenths of a second. A new master will be elected when this interval has been passed without seeing a heartbeat from the master.
205 .IP "\fBcluster_master_min_adv\fR (int)" 4
206 .IX Item "cluster_master_min_adv (int)"
207 Determines the minumum number of up to date slaves required before the master will drop routes (default: 1).
208 .IP "\fBdebug\fR (int)" 4
209 .IX Item "debug (int)"
210 Set the level of debugging messages written to the log file. The value should
211 be between 0 and 5, with 0 being no debugging, and 5 being the highest.
212 A rough description of the levels is:
213 .RS 4
214 .IP "0. Critical Errors \- Things are probably broken" 4
215 .IX Item "0. Critical Errors - Things are probably broken"
216 .PD 0
217 .IP "1. Errors \- Things might have gone wrong, but probably will recover" 4
218 .IX Item "1. Errors - Things might have gone wrong, but probably will recover"
219 .IP "2. Warnings \- Just in case you care what is not quite perfect" 4
220 .IX Item "2. Warnings - Just in case you care what is not quite perfect"
221 .IP "3. Information \- Parameters of control packets" 4
222 .IX Item "3. Information - Parameters of control packets"
223 .IP "4. Calls \- For tracing the execution of the code" 4
224 .IX Item "4. Calls - For tracing the execution of the code"
225 .IP "5. Packets \- Everything, including a hex dump of all packets processed... probably twice" 4
226 .IX Item "5. Packets - Everything, including a hex dump of all packets processed... probably twice"
227 .RE
228 .RS 4
229 .PD
230 .Sp
231 Note that the higher you set the debugging level, the slower the program will run. Also, at level 5 a \s-1LOT\s0 of information will be logged. This should only ever be used for working out why it doesn't work at all.
232 .RE
233 .IP "\fBdump_speed\fR (boolean)" 4
234 .IX Item "dump_speed (boolean)"
235 If set to true, then the current bandwidth utilization will be logged every second. Even if this is disabled, you can see this information by running the uptime command on the \s-1CLI\s0.
236 .IP "\fBdisable_sending_hello\fR (boolean)" 4
237 .IX Item "disable_sending_hello (boolean)"
238 Disable l2tp sending \s-1HELLO\s0 message for Apple compatibility. Some \s-1OS\s0 X implementation of l2tp no manage the L2TP \*(L"\s-1HELLO\s0 message\*(R". (default: no).
239 .IP "\fBecho_timeout\fR (int)" 4
240 .IX Item "echo_timeout (int)"
241 Time between last packet sent and \s-1LCP\s0 \s-1ECHO\s0 generation (default: 10 (seconds)).
242 .IP "\fBguest_account\fR" 4
243 .IX Item "guest_account"
244 Allow multiple logins matching this specific username.
245 .IP "\fBicmp_rate\fR (int)" 4
246 .IX Item "icmp_rate (int)"
247 Maximum number of host unreachable \s-1ICMP\s0 packets to send per second.
248 .IP "\fBidle_echo_timeout\fR (int)" 4
249 .IX Item "idle_echo_timeout (int)"
250 Drop sessions who have not responded within idle_echo_timeout seconds (default: 240 (seconds))
251 .IP "\fBiftun_address\fR (ip address)" 4
252 .IX Item "iftun_address (ip address)"
253 This parameter is used when you want a tun interface address different from the address of \*(L"bind_address\*(R" (For use in cases of specific configuration). If no address is given to iftun_address and bind_address, 1.1.1.1 is used.
254 .IP "\fBl2tp_mtu\fR (int)" 4
255 .IX Item "l2tp_mtu (int)"
256 \&\s-1MTU\s0 of interface for L2TP traffic (default: 1500). Used to set link \s-1MRU\s0 and adjust \s-1TCP\s0 \s-1MSS\s0.
257 .IP "\fBl2tp_secret\fR (string)" 4
258 .IX Item "l2tp_secret (string)"
259 The secret used by l2tpns for authenticating tunnel request. Must be the same as the \s-1LAC\s0, or authentication will fail. Only actually be used if the \s-1LAC\s0 requests authentication.
260 .IP "\fBlock_pages\fR (boolean)" 4
261 .IX Item "lock_pages (boolean)"
262 Keep all pages mapped by the l2tpns process in memory.
263 .IP "\fBlog_file\fR (string)" 4
264 .IX Item "log_file (string)"
265 This will be where all logging and debugging information is written to.This may be either a filename, such as /var/log/l2tpns, or the string syslog:facility, where facility is any one of the syslog logging facilities, such as local5.
266 .IP "\fBmulti_read_count\fR (int)" 4
267 .IX Item "multi_read_count (int)"
268 Number of packets to read off each of the \s-1UDP\s0 and \s-1TUN\s0 fds when returned as readable by select (default: 10). Avoids incurring the unnecessary system call overhead of select on busy servers.
269 .IP "\fBpacket_limit\fR (int>" 4
270 .IX Item "packet_limit (int>"
271 Maximum number of packets of downstream traffic to be handled each tenth of a second per session. If zero, no limit is applied (default: 0). Intended as a DoS prevention mechanism and not a general throttling control (packets are dropped, not queued).
272 .IP "\fBpeer_address\fR (ip address)" 4
273 .IX Item "peer_address (ip address)"
274 Address to send to clients as the default gateway.
275 .IP "\fBpid_file\fR (string)" 4
276 .IX Item "pid_file (string)"
277 If set, the process id will be written to the specified file. The value must be an absolute path.
278 .IP "\fBppp_restart_time\fR (int)" 4
279 .IX Item "ppp_restart_time (int)"
280 .PD 0
281 .IP "\fBppp_max_configure\fR (int)" 4
282 .IX Item "ppp_max_configure (int)"
283 .IP "\fBppp_max_failure\fR (int)" 4
284 .IX Item "ppp_max_failure (int)"
285 .PD
286 \&\s-1PPP\s0 counter and timer values, as described in Section 4.1 of \s-1RFC1661\s0.
287 .Sp
288 \&\fIppp_restart_time\fR, Restart timer for \s-1PPP\s0 protocol negotiation in seconds (default: 3).
289 .Sp
290 \&\fIppp_max_configure\fR, Number of configure requests to send before giving up (default: 10).
291 .Sp
292 \&\fIppp_max_failure\fR, Number of Configure-Nak requests to send before sending a Configure-Reject (default: 5).
293 .IP "\fBprimary_dns\fR (ip address), \fBsecondary_dns\fR (ip address)" 4
294 .IX Item "primary_dns (ip address), secondary_dns (ip address)"
295 Whenever a \s-1PPP\s0 connection is established, \s-1DNS\s0 servers will be sent to the user, both a primary and a secondary. If either is set to 0.0.0.0, then that one will not be sent.
296 .IP "\fBprimary_radius\fR (ip address), \fBsecondary_radius\fR (ip address)" 4
297 .IX Item "primary_radius (ip address), secondary_radius (ip address)"
298 Sets the \s-1RADIUS\s0 servers used for both authentication and accounting. If the primary server does not respond, then the secondary \s-1RADIUS\s0 server will be tried.
299 .Sp
300 Note: in addition to the source \s-1IP\s0 address and identifier, the \s-1RADIUS\s0 server must include the source port when detecting duplicates to supress (in order to cope with a large number of sessions comming on-line simultaneously l2tpns uses a set of udp sockets, each with a seperate identifier).
301 .IP "\fBprimary_radius_port\fR (short), \fBsecondary_radius_port\fR (short)" 4
302 .IX Item "primary_radius_port (short), secondary_radius_port (short)"
303 Sets the authentication ports for the primary and secondary \s-1RADIUS\s0 servers. The accounting port is one more than the authentication port. If no \s-1RADIUS\s0 ports are given, the authentication port defaults to 1645, and the accounting port to 1646.
304 .IP "\fBradius_accounting\fR (boolean)" 4
305 .IX Item "radius_accounting (boolean)"
306 If set to true, then \s-1RADIUS\s0 accounting packets will be sent. This means that a \fBStart\fR record will be sent when the session is successfully authenticated, and a \fBStop\fR record will be sent when the session is closed.
307 .IP "\fBradius_interim\fR (int)" 4
308 .IX Item "radius_interim (int)"
309 If radius_accounting is on, defines the interval between sending of \s-1RADIUS\s0 interim accounting records (in seconds).
310 .IP "\fBradius_secret\fR (string)" 4
311 .IX Item "radius_secret (string)"
312 This secret will be used in all \s-1RADIUS\s0 queries. If this is not set then \s-1RADIUS\s0 queries will fail.
313 .IP "\fBradius_authtypes\fR (string)" 4
314 .IX Item "radius_authtypes (string)"
315 A comma separated list of supported \s-1RADIUS\s0 authentication methods (\*(L"pap\*(R" or \*(L"chap\*(R"), in order of preference (default \*(L"pap\*(R").
316 .IP "\fBradius_dae_port\fR (short)" 4
317 .IX Item "radius_dae_port (short)"
318 Port for \s-1DAE\s0 \s-1RADIUS\s0 (Packet of Death/Disconnect, Change of Authorization) requests (default: 3799).
319 .IP "\fBradius_bind_min\fR, \fBradius_bind_max\fR (int)" 4
320 .IX Item "radius_bind_min, radius_bind_max (int)"
321 Define a port range in which to bind sockets used to send and receive \s-1RADIUS\s0 packets. Must be at least \s-1RADIUS_FDS\s0 (64) wide. Simplifies firewalling of \s-1RADIUS\s0 ports (default: dynamically assigned).
322 .IP "\fBrandom_device\fR (string)" 4
323 .IX Item "random_device (string)"
324 Path to random data source (default /dev/urandom). Use "" to use the \fIrand()\fR library function.
325 .IP "\fBscheduler_fifo\fR (boolean)" 4
326 .IX Item "scheduler_fifo (boolean)"
327 Sets the scheduling policy for the l2tpns process to \s-1SCHED_FIFO\s0. This causes the kernel to immediately preempt any currently running \s-1SCHED_OTHER\s0 (normal) process in favour of l2tpns when it becomes runnable. Ignored on uniprocessor systems.
328 .IP "\fBsend_garp\fR (boolean)" 4
329 .IX Item "send_garp (boolean)"
330 Determines whether or not to send a gratuitous \s-1ARP\s0 for the bind_address when the server is ready to handle traffic (default: true). This value is ignored if \s-1BGP\s0 is configured.
331 .IP "\fBtundevicename\fR (string)" 4
332 .IX Item "tundevicename (string)"
333 Name of the tun interface (default: \*(L"tun0\*(R").
334 .IP "\fBthrottle_speed\fR (int)" 4
335 .IX Item "throttle_speed (int)"
336 Sets the default speed (in kbits/s) which sessions will be limited to. If this is set to 0, then throttling will not be used at all. Note: You can set this by the \s-1CLI\s0, but changes will not affect currently connected users.
337 .IP "\fBthrottle_buckets\fR (int)" 4
338 .IX Item "throttle_buckets (int)"
339 Number of token buckets to allocate for throttling. Each throttled session requires two buckets (in and out).
340 .SS "DHCPv6 And IPv6 \s-1SETTINGS\s0"
341 .IX Subsection "DHCPv6 And IPv6 SETTINGS"
342 .IP "\fBdhcp6_preferred_lifetime\fR (int)" 4
343 .IX Item "dhcp6_preferred_lifetime (int)"
344 The preferred lifetime for the IPv6 address and the IPv6 prefix address, expressed in units of seconds (see rfc3315).
345 .IP "\fBdhcp6_valid_lifetime\fR (int)" 4
346 .IX Item "dhcp6_valid_lifetime (int)"
347 The valid lifetime for the IPv6 address and the IPv6 prefix address, expressed in units of seconds (see rfc3315).
348 .IP "\fBdhcp6_server_duid\fR (int)" 4
349 .IX Item "dhcp6_server_duid (int)"
350 \&\s-1DUID\s0 Based on Link-layer Address (DUID-LL) (see rfc3315).
351 .IP "\fBprimary_ipv6_dns\fR, \fBsecondary_ipv6_dns\fR (Ipv6 address)" 4
352 .IX Item "primary_ipv6_dns, secondary_ipv6_dns (Ipv6 address)"
353 IPv6 \s-1DNS\s0 servers will be sent to the user (see rfc3646).
354 .IP "\fBdefault_ipv6_domain_list\fR (string)" 4
355 .IX Item "default_ipv6_domain_list (string)"
356 The Domain Search List (ex: \*(L"fdn.fr\*(R") (see rfc3646).
357 .IP "\fBipv6_prefix\fR (Ipv6 address)" 4
358 .IX Item "ipv6_prefix (Ipv6 address)"
359 Enable negotiation of IPv6. This forms the the first 64 bits of the client allocated address. The remaining 64 come from the allocated IPv4 address and 4 bytes of 0.
360 .SS "\s-1LAC\s0 \s-1SETTINGS\s0"
361 .IX Subsection "LAC SETTINGS"
362 .IP "\fBbind_address_remotelns\fR (ip address)" 4
363 .IX Item "bind_address_remotelns (ip address)"
364 Address of the interface to listen the remote \s-1LNS\s0 tunnels. If no address is given, all interfaces are listened (Any Address).
365 .IP "\fBbind_portremotelns\fR (short)" 4
366 .IX Item "bind_portremotelns (short)"
367 Port to bind for the Remote \s-1LNS\s0 (default: 65432).
368 .PP
369 A static \s-1REMOTES\s0 \s-1LNS\s0 configuration can be entered by the command:
370 .IP "\fBsetforward\fR \fI\s-1MASK\s0\fR \fI\s-1IP\s0\fR \fI\s-1PORT\s0\fR \fI\s-1SECRET\s0\fR" 4
371 .IX Item "setforward MASK IP PORT SECRET"
372 where \s-1MASK\s0 specifies the mask of users who have forwarded to remote \s-1LNS\s0 (ex: \*(L"/friendISP@company.com\*(R").
373 .Sp
374 where \s-1IP\s0 specifies the \s-1IP\s0 of the remote \s-1LNS\s0 (ex: \*(L"66.66.66.55\*(R").
375 .Sp
376 where \s-1PORT\s0 specifies the L2TP Port of the remote \s-1LNS\s0 (Normally should be 1701) (ex: 1701).
377 .Sp
378 where \s-1SECRET\s0 specifies the secret password the remote \s-1LNS\s0 (ex: mysecret).
379 .PP
380 The static \s-1REMOTE\s0 \s-1LNS\s0 configuration can be used when the friend \s-1ISP\s0 not have a proxied Radius.
381 .PP
382 If a proxied Radius is used, It will return the \s-1RADIUS\s0 attributes:
383 .IP "Tunnel\-Type:1 = L2TP" 4
384 .IX Item "Tunnel-Type:1 = L2TP"
385 .PD 0
386 .IP "Tunnel\-Medium\-Type:1 = IPv4" 4
387 .IX Item "Tunnel-Medium-Type:1 = IPv4"
388 .ie n .IP "Tunnel\-Password:1 = ""\s-1LESECRETL2TP\s0""" 4
389 .el .IP "Tunnel\-Password:1 = ``\s-1LESECRETL2TP\s0''" 4
390 .IX Item "Tunnel-Password:1 = LESECRETL2TP"
391 .ie n .IP "Tunnel\-Server\-Endpoint:1 = ""88.xx.xx.x1""" 4
392 .el .IP "Tunnel\-Server\-Endpoint:1 = ``88.xx.xx.x1''" 4
393 .IX Item "Tunnel-Server-Endpoint:1 = 88.xx.xx.x1"
394 .ie n .IP "Tunnel\-Assignment\-Id:1 = ""friendisp_lns1""" 4
395 .el .IP "Tunnel\-Assignment\-Id:1 = ``friendisp_lns1''" 4
396 .IX Item "Tunnel-Assignment-Id:1 = friendisp_lns1"
397 .IP "Tunnel\-Type:2 += L2TP" 4
398 .IX Item "Tunnel-Type:2 += L2TP"
399 .IP "Tunnel\-Medium\-Type:2 += IPv4" 4
400 .IX Item "Tunnel-Medium-Type:2 += IPv4"
401 .ie n .IP "Tunnel\-Password:2 += ""\s-1LESECRETL2TP\s0""" 4
402 .el .IP "Tunnel\-Password:2 += ``\s-1LESECRETL2TP\s0''" 4
403 .IX Item "Tunnel-Password:2 += LESECRETL2TP"
404 .ie n .IP "Tunnel\-Server\-Endpoint:2 += ""88.xx.xx.x2""" 4
405 .el .IP "Tunnel\-Server\-Endpoint:2 += ``88.xx.xx.x2''" 4
406 .IX Item "Tunnel-Server-Endpoint:2 += 88.xx.xx.x2"
407 .ie n .IP "Tunnel\-Assignment\-Id:2 += ""friendisp_lns2""" 4
408 .el .IP "Tunnel\-Assignment\-Id:2 += ``friendisp_lns2''" 4
409 .IX Item "Tunnel-Assignment-Id:2 += friendisp_lns2"
410 .PD
411 .SS "\s-1PPPOE\s0 \s-1SETTINGS\s0"
412 .IX Subsection "PPPOE SETTINGS"
413 .IP "\fBpppoe_if_to_bind\fR (string)" 4
414 .IX Item "pppoe_if_to_bind (string)"
415 \&\s-1PPPOE\s0 server interface to bind (ex: \*(L"eth0.12\*(R"), If not specified the server \s-1PPPOE\s0 is not enabled. For the pppoe clustering, all the interfaces \s-1PPPOE\s0 of the clusters must use the same \s-1HW\s0 address (\s-1MAC\s0 address).
416 .IP "\fBpppoe_service_name\fR (string)" 4
417 .IX Item "pppoe_service_name (string)"
418 \&\s-1PPPOE\s0 service name (default: \s-1NULL\s0).
419 .IP "\fBpppoe_ac_name\fR (string)" 4
420 .IX Item "pppoe_ac_name (string)"
421 \&\s-1PPPOE\s0 access concentrator name (default: \*(L"l2tpns\-pppoe\*(R").
422 .IP "\fBpppoe_only_equal_svc_name\fR (boolean)" 4
423 .IX Item "pppoe_only_equal_svc_name (boolean)"
424 If set to yes, the \s-1PPPOE\s0 server only accepts clients with a \*(L"service-name\*(R" different from \s-1NULL\s0 and a \*(L"service-name\*(R" equal to server \*(L"service-name\*(R" (default: no).
425 .SS "\s-1BGP\s0 \s-1ROUTING\s0"
426 .IX Subsection "BGP ROUTING"
427 The routing configuration section is entered by the command
428 .PP
429 \&\fBrouter\fR \fBbgp\fR \fIas\fR
430 .PP
431 where \fIas\fR specifies the local \s-1AS\s0 number.
432 .PP
433 Subsequent lines prefixed with \fBneighbour\fR \fIpeer\fR define the attributes of \s-1BGP\s0 neighhbours. Valid commands are:
434 .PP
435 \&\fBneighbour\fR \fIpeer\fR \fBremote-as\fR \fIas\fR
436 .PP
437 \&\fBneighbour\fR \fIpeer\fR \fBtimers\fR \fIkeepalive\fR \fIhold\fR
438 .PP
439 Where \fIpeer\fR specifies the \s-1BGP\s0 neighbour as either a hostname or \s-1IP\s0 address, \fIas\fR is the remote \s-1AS\s0 number and \fIkeepalive\fR, \fIhold\fR are the timer values in seconds.
440 .SS "\s-1NAMED\s0 \s-1ACCESS\s0 \s-1LISTS\s0"
441 .IX Subsection "NAMED ACCESS LISTS"
442 Named access lists may be defined with either of
443 .IP "\(bu" 4
444 \&\fBip\fR \fBaccess-list\fR \fBstandard\fR \fIname\fR
445 .IP "\(bu" 4
446 \&\fBip\fR \fBaccess-list\fR \fBextended\fR \fIname\fR
447 .PP
448 Subsequent lines starting with permit or deny define the body of the access-list.
449 .PP
450 \fIStandard Access Lists\fR
451 .IX Subsection "Standard Access Lists"
452 .PP
453 Standard access lists are defined with:
454 .IP "\(bu" 4
455 {\fBpermit\fR|\fBdeny\fR} \fIsource\fR [\fIdest\fR]
456 .PP
457 Where \fIsource\fR and \fIdest\fR specify \s-1IP\s0 matches using one of:
458 .IP "\(bu" 4
459 \&\fIaddress\fR \fIwildard\fR
460 .IP "\(bu" 4
461 \&\fBhost\fR \fIaddress\fR
462 .IP "\(bu" 4
463 \&\fBany\fR
464 .PP
465 \&\fIaddress\fR and \fIwildard\fR are in dotted-quad notation, bits in the \fIwildard\fR indicate which address bits in \fIaddress\fR are relevant to the match (0 = exact match; 1 = don't care).
466 .PP
467 The shorthand 'host address' is equivalent to '\fIaddress\fR \fB0.0.0.0\fR'; '\fBany\fR' to '\fB0.0.0.0\fR \fB255.255.255.255\fR'.
468 .PP
469 \fIExtended Access Lists\fR
470 .IX Subsection "Extended Access Lists"
471 .PP
472 Extended access lists are defined with:
473 .IP "\(bu" 4
474 {\fBpermit\fR|\fBdeny\fR} \fIproto\fR \fIsource\fR [\fIports\fR] \fIdest\fR [\fIports\fR] [\fIflags\fR]
475 .PP
476 Where \fIproto\fR is one of \fBip\fR, \fBtcp\fR or \fBudp\fR, and \fIsource\fR and \fIdest\fR are as described above for standard lists.
477 .PP
478 For \s-1TCP\s0 and \s-1UDP\s0 matches, source and destination may be optionally followed by a ports specification:
479 .IP "\(bu" 4
480 {\fBeq|neq|gt|lt\fR} \fIport\fR
481 .IP "\(bu" 4
482 \&\fBrange\fR \fIfrom\fR \fIto\fR
483 .PP
484 \&\fIflags\fR may be one of:
485 .IP "{\fBmatch\-any|match\-all\fR} {\fB+|\-\fR}{\fBfin|syn|rst|psh|ack|urg\fR} ..." 4
486 .IX Item "{match-any|match-all} {+|-}{fin|syn|rst|psh|ack|urg} ..."
487 Match packets with any or all of the tcp flags set (+) or clear (\-).
488 .IP "\fBestablished\fR" 4
489 .IX Item "established"
490 Match \*(L"established\*(R" \s-1TCP\s0 connections: packets with \s-1RST\s0 or \s-1ACK\s0 set, and \s-1SYN\s0 clear.
491 .IP "\fBfragments\fR" 4
492 .IX Item "fragments"
493 Match \s-1IP\s0 fragments. May not be specified on rules with layer 4 matches.
494 .SH "SEE ALSO"
495 .IX Header "SEE ALSO"
496 \&\fIl2tpns\fR\|(8)