Docs/startup-config.5

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