Add cluster_port parameter for Multiple clusters

[l2tpns.git] / Docs / startup-config.5.pod

=pod

=head1 NAME

startup-config - configuration file for l2tpns

=head1 SYNOPSIS

/etc/l2tpns/startup-config

=head1 DESCRIPTION

B<startup-config> is the configuration file for B<l2tpns>

The format is plain text, in the same format as accepted by
the configuration mode of l2tpns's telnet administrative 
interface. Comments are indicated by either the character # or !.

=head2 SETTINGS

Settings are specified with

=over

=item B<set> F<variable> F<value>

=back

A list of the possible configuration directives follows. Each of these should be set by a line like:

=over

=item B<set> I<configstring> I<"value">

=item B<set> I<ipaddress> I<192.168.1.1>

=item B<set> I<boolean> I<true>

=back

The following F<variables> may be set:

=over

=item B<accounting_dir> (string)

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.

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 B<account_all_origin> is set to true (origin value: L=LAC data, R=Remote LNS data, P=PPPOE data).

=item B<account_all_origin> (boolean)

If set to true, all origin of the usage is dumped to the accounting file (LAC+Remote LNS+PPPOE)(default false).

=item B<allow_duplicate_users> (boolean)

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.

=item B<auth_tunnel_change_addr_src> (boolean)

This parameter authorize to change the source IP of the tunnels l2tp. This parameter can be used when the remotes BAS/LAC are l2tpns server configured in cluster mode, but that the interface to remote LNS are not clustered (the tunnel can be coming from different source IP) (default: no).

=item B<bind_address> (ip address)

It's the listen address of the l2tp udp protocol sent and received to LAC. 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.

=item B<bind_multi_address> (ip address)

This parameter permit to listen several addresss of the l2tp udp protocol (and set several address to the tun interface).

WHEN this parameter is set, It OVERWRITE the parameters "bind_address" and "iftun_address".

these can be interesting when you want do load-balancing in cluster mode of the uploaded from the LAC. For example you can set a bgp.prepend(MY_AS) for Address1 on LNS1 and a bgp.prepend(MY_AS) for Address2 on LNS2 (see BGP AS-path prepending).

example of use with 2 address:

B<set> I<bind_multi_address> "64.14.13.41, 64.14.13.42"

=item B<cluster_address> (ip address)

Multicast cluster address (default: 239.192.13.13). See the section on Clustering for more information.

=item B<Bcluster_port> (int)

UDP cluster port (default: 32792). See the section on Clustering for more information.

=item B<cluster_interface> (string)

Interface for cluster packets (default: eth0).

=item B<cluster_mcast_ttl> (int)

TTL for multicast packets (default: 1).

=item B<cluster_hb_interval> (int)

Interval in tenths of a second between cluster heartbeat/pings.

=item B<cluster_hb_timeout> (int)

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.

=item B<cluster_master_min_adv> (int)

Determines the minumum number of up to date slaves required before the master will drop routes (default: 1).

=item B<debug> (int)

Set the level of debugging messages written to the log file. The value should
be between 0 and 5, with 0 being no debugging, and 5 being the highest.
A rough description of the levels is:

=over

=item 0. Critical Errors - Things are probably broken

=item 1. Errors - Things might have gone wrong, but probably will recover

=item 2. Warnings - Just in case you care what is not quite perfect

=item 3. Information - Parameters of control packets

=item 4. Calls - For tracing the execution of the code

=item 5. Packets - Everything, including a hex dump of all packets processed... probably twice

=back

Note that the higher you set the debugging level, the slower the program will run. Also, at level 5 a LOT of information will be logged. This should only ever be used for working out why it doesn't work at all.

=item B<dump_speed> (boolean)

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 CLI.

=item B<disable_sending_hello> (boolean)

Disable l2tp sending HELLO message for Apple compatibility. Some OS X implementation of l2tp no manage the L2TP "HELLO message". (default: no).

=item B<echo_timeout> (int)

Time between last packet sent and LCP ECHO generation (default: 10 (seconds)).

=item B<guest_account>

Allow multiple logins matching this specific username.

=item B<icmp_rate> (int)

Maximum number of host unreachable ICMP packets to send per second.

=item B<idle_echo_timeout> (int)

Drop sessions who have not responded within idle_echo_timeout seconds (default: 240 (seconds))

=item B<iftun_address> (ip address)

This parameter is used when you want a tun interface address different from the address of "bind_address" (For use in cases of specific configuration). If no address is given to iftun_address and bind_address, 1.1.1.1 is used.

=item B<l2tp_mtu> (int)

MTU of interface for L2TP traffic (default: 1500). Used to set link MRU and adjust TCP MSS.

=item B<l2tp_secret> (string)

The secret used by l2tpns for authenticating tunnel request. Must be the same as the LAC, or authentication will fail. Only actually be used if the LAC requests authentication.

=item B<lock_pages> (boolean)

Keep all pages mapped by the l2tpns process in memory.

=item B<log_file> (string)

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.

=item B<multi_read_count> (int)

Number of packets to read off each of the UDP and TUN fds when returned as readable by select (default: 10). Avoids incurring the unnecessary system call overhead of select on busy servers.

=item B<packet_limit> (int>

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).

=item B<peer_address> (ip address)

Address to send to clients as the default gateway.

=item B<pid_file> (string)

If set, the process id will be written to the specified file. The value must be an absolute path.

=item B<ppp_keepalive> (boolean)

Change this value to no to force generation of LCP ECHO every echo_timeout seconds, even there are activity on the link (default: yes)

=item B<ppp_restart_time> (int)

=item B<ppp_max_configure> (int)

=item B<ppp_max_failure> (int)

PPP counter and timer values, as described in Section 4.1 of RFC1661.

I<ppp_restart_time>, Restart timer for PPP protocol negotiation in seconds (default: 3).

I<ppp_max_configure>, Number of configure requests to send before giving up (default: 10).

I<ppp_max_failure>, Number of Configure-Nak requests to send before sending a Configure-Reject (default: 5).

=item B<primary_dns> (ip address), B<secondary_dns> (ip address)

Whenever a PPP connection is established, DNS 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.

=item B<primary_radius> (ip address), B<secondary_radius> (ip address)

Sets the RADIUS servers used for both authentication and accounting. If the primary server does not respond, then the secondary RADIUS server will be tried.

Note: in addition to the source IP address and identifier, the RADIUS 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).

=item B<primary_radius_port> (short), B<secondary_radius_port> (short)

Sets the authentication ports for the primary and secondary RADIUS servers. The accounting port is one more than the authentication port. If no RADIUS ports are given, the authentication port defaults to 1645, and the accounting port to 1646.

=item B<radius_accounting> (boolean)

If set to true, then RADIUS accounting packets will be sent. This means that a B<Start> record will be sent when the session is successfully authenticated, and a B<Stop> record will be sent when the session is closed.

=item B<radius_interim> (int)

If radius_accounting is on, defines the interval between sending of RADIUS interim accounting records (in seconds).

=item B<radius_secret> (string)

This secret will be used in all RADIUS queries. If this is not set then RADIUS queries will fail.

=item B<radius_authtypes> (string)

A comma separated list of supported RADIUS authentication methods ("pap" or "chap"), in order of preference (default "pap").

=item B<radius_dae_port> (short)

Port for DAE RADIUS (Packet of Death/Disconnect, Change of Authorization) requests (default: 3799).

=item B<radius_bind_min>, B<radius_bind_max> (int)

Define a port range in which to bind sockets used to send and receive RADIUS packets. Must be at least RADIUS_FDS (64) wide. Simplifies firewalling of RADIUS ports (default: dynamically assigned).

=item B<random_device> (string)

Path to random data source (default /dev/urandom). Use "" to use the rand() library function.

=item B<scheduler_fifo> (boolean)

Sets the scheduling policy for the l2tpns process to SCHED_FIFO. This causes the kernel to immediately preempt any currently running SCHED_OTHER (normal) process in favour of l2tpns when it becomes runnable. Ignored on uniprocessor systems.

=item B<send_garp> (boolean)

Determines whether or not to send a gratuitous ARP for the bind_address when the server is ready to handle traffic (default: true). This value is ignored if BGP is configured.

=item B<tundevicename> (string)

Name of the tun interface (default: "tun0").

=item B<throttle_speed> (int)

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 CLI, but changes will not affect currently connected users.

=item B<throttle_buckets> (int)

Number of token buckets to allocate for throttling. Each throttled session requires two buckets (in and out).

=back

=head2 DHCPv6 And IPv6 SETTINGS

=over

=item B<dhcp6_preferred_lifetime> (int)

The preferred lifetime for the IPv6 address and the IPv6 prefix address, expressed in units of seconds (see rfc3315).

=item B<dhcp6_valid_lifetime> (int)

The valid lifetime for the IPv6 address and the IPv6 prefix address, expressed in units of seconds (see rfc3315).

=item B<dhcp6_server_duid> (int)

DUID Based on Link-layer Address (DUID-LL) (see rfc3315).

=item B<primary_ipv6_dns>, B<secondary_ipv6_dns> (Ipv6 address)

IPv6 DNS servers will be sent to the user (see rfc3646). 

=item B<default_ipv6_domain_list> (string)

The Domain Search List (ex: "fdn.fr") (see rfc3646).

=item B<ipv6_prefix> (Ipv6 address)

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.

=back

=head2 LAC SETTINGS

=over

=item B<bind_address_remotelns> (ip address)

Address of the interface to listen the remote LNS tunnels. If no address is given, all interfaces are listened (Any Address).

=item B<bind_portremotelns> (short)

Port to bind for the Remote LNS (default: 65432).

=back

A static REMOTES LNS configuration can be entered by the command:

=over

=item B<setforward> I<MASK> I<IP> I<PORT> I<SECRET>

where MASK specifies the mask of users who have forwarded to remote LNS (ex: "/friendISP@company.com").

where IP specifies the IP of the remote LNS (ex: "66.66.66.55").

where PORT specifies the L2TP Port of the remote LNS (Normally should be 1701) (ex: 1701).

where SECRET specifies the secret password the remote LNS (ex: mysecret).

=back 

The static REMOTE LNS configuration can be used when the friend ISP not have a proxied Radius.

If a proxied Radius is used, It will return the RADIUS attributes:

=over

=item Tunnel-Type:1 = L2TP

=item Tunnel-Medium-Type:1 = IPv4

=item Tunnel-Password:1 = "LESECRETL2TP"

=item Tunnel-Server-Endpoint:1 = "88.xx.xx.x1"

=item Tunnel-Assignment-Id:1 = "friendisp_lns1"

=item Tunnel-Type:2 += L2TP

=item Tunnel-Medium-Type:2 += IPv4

=item Tunnel-Password:2 += "LESECRETL2TP"

=item Tunnel-Server-Endpoint:2 += "88.xx.xx.x2"

=item Tunnel-Assignment-Id:2 += "friendisp_lns2"

=back

=head2 PPPOE SETTINGS

=over

=item B<pppoe_if_to_bind> (string)

PPPOE server interface to bind (ex: "eth0.12"), If not specified the server PPPOE is not enabled. For the pppoe clustering, all the interfaces PPPOE of the clusters must use the same HW address (MAC address).

=item B<pppoe_service_name> (string)

PPPOE service name (default: NULL).

=item B<pppoe_ac_name> (string)

PPPOE access concentrator name (default: "l2tpns-pppoe").

=item B<pppoe_only_equal_svc_name> (boolean)

If set to yes, the PPPOE server only accepts clients with a "service-name" different from NULL and a "service-name" equal to server "service-name" (default: no).

=back

=head2 BGP ROUTING

The routing configuration section is entered by the command

B<router> B<bgp> I<as>

where I<as> specifies the local AS number.

Subsequent lines prefixed with B<neighbour> I<peer> define the attributes of BGP neighhbours. Valid commands are:

B<neighbour> I<peer> B<remote-as> I<as>

B<neighbour> I<peer> B<timers> I<keepalive> I<hold>

Where I<peer> specifies the BGP neighbour as either a hostname or IP address, I<as> is the remote AS number and I<keepalive>, I<hold> are the timer values in seconds.

=head2 NAMED ACCESS LISTS

Named access lists may be defined with either of

=over

=item

B<ip> B<access-list> B<standard> I<name>

=item

B<ip> B<access-list> B<extended> I<name>

=back

Subsequent lines starting with permit or deny define the body of the access-list.

=head3 Standard Access Lists

Standard access lists are defined with:

=over

=item

{B<permit>|B<deny>} I<source> [I<dest>]

=back

Where I<source> and I<dest> specify IP matches using one of:

=over

=item

I<address> I<wildard>

=item

B<host> I<address>

=item

B<any>

=back

I<address> and I<wildard> are in dotted-quad notation, bits in the I<wildard> indicate which address bits in I<address> are relevant to the match (0 = exact match; 1 = don't care).

The shorthand 'host address' is equivalent to 'I<address> B<0.0.0.0>'; 'B<any>' to 'B<0.0.0.0> B<255.255.255.255>'.

=head3 Extended Access Lists

Extended access lists are defined with:

=over

=item

{B<permit>|B<deny>} I<proto> I<source> [I<ports>] I<dest> [I<ports>] [I<flags>]

=back

Where I<proto> is one of B<ip>, B<tcp> or B<udp>, and I<source> and I<dest> are as described above for standard lists.

For TCP and UDP matches, source and destination may be optionally followed by a ports specification:

=over

=item

{B<eq|neq|gt|lt>} I<port>

=item

B<range> I<from> I<to>

=back

I<flags> may be one of:

=over

=item {B<match-any|match-all>} {B<+|->}{B<fin|syn|rst|psh|ack|urg>} ...

Match packets with any or all of the tcp flags set (+) or clear (-).

=item B<established>

Match "established" TCP connections: packets with RST or ACK set, and SYN clear.

=item B<fragments>

Match IP fragments. May not be specified on rules with layer 4 matches.

=back

=head1 SEE ALSO

L<l2tpns(8)>

=cut