Docs/startup-config.5

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